rowan/bitburner-filesync
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added some documentation

Browse source
This commit is contained in:
david 2023-04-12 17:57:34 +10:00
parent 544344bbb4
commit fbab8a375f
1 changed files with 24 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
src/fileWatch.ts
View file

@ -1,11 +1,33 @@
import CheapWatch from "cheap-watch"; import CheapWatch from "cheap-watch";
import { config } from "./config.js"; import { config } from "./config.js";
import { EventType } from "./eventTypes.js"; import { EventType } from "./eventTypes.js";
import { mkdir, readdir } from "fs/promises"; import { mkdir } from "fs/promises";
import { resolve } from "path"; import { resolve, relative, isAbsolute } from "path";
import type { Signal } from "signal-js"; import type { Signal } from "signal-js";
import type { File } from "./interfaces.js"; import type { File } from "./interfaces.js";
/**
* Returns true if the given file should be watched.
* @param file The provided file.
*/
function fileFilter(file: File) {
// If the file is excluded, skip all other checks and ignore it.
if (config.get("exclude").some(x => isSubDirOf(file.path, x))) return false;
if (config.get("allowedFiletypes").some((extension) => file.path.endsWith(extension))) return true;
if (file.stats.isDirectory()) return true;
return false;
}
/**
* Returns true if a directory is a subdirectory of a parent directory (not necessarily strict).
* @param dir The directory to perform the check on.
* @param parent The parent directory.
*/
function isSubDirOf(dir: string, parent: string) {
const relPath = relative(resolve(parent), resolve(dir));
return !!relPath && !relPath.startsWith('..') && !isAbsolute(relPath);
}
function isError(err: unknown): err is NodeJS.ErrnoException { function isError(err: unknown): err is NodeJS.ErrnoException {
return (err as NodeJS.ErrnoException).code !== undefined; return (err as NodeJS.ErrnoException).code !== undefined;
} }
@ -20,22 +42,6 @@ export async function setupWatch(signaller: Signal) {
} }
} }
const promises = config.get("exclude")
.map(path => readdir(resolve(path)).catch(err => {
console.log(`Failed to excluded item ${path}: ${err}`);
return [];
}));
const excludedFiles = new Set(await Promise.all(promises)
.then(lists => lists.flat()));
const fileFilter = (file: File) => {
// If the file is excluded, skip all other checks and ignore it.
if (excludedFiles.has(file.path)) return false;
if (config.get("allowedFiletypes").some((extension) => file.path.endsWith(extension))) return true;
if (file.stats.isDirectory()) return true;
return false;
};
const watch = new CheapWatch({ const watch = new CheapWatch({
dir: config.get("scriptsFolder"), dir: config.get("scriptsFolder"),
filter: fileFilter, filter: fileFilter,