zerodep
Version:
Zero dependency utils for various environments.
213 lines (211 loc) • 9.11 kB
JavaScript
;
// base fileSystem functions
const fs = require('fs');
const path = require('path');
module.exports = {
buffersAreEqual: function (buffer1, buffer2) {
return buffer1.equals(buffer2);
},
pathResolve: function (...args) {
return path.resolve(...args);
},
pathJoin: function (...args) {
return path.join(...args);
},
pathDirName: function (file) {
return path.dirname(file);
},
pathBaseName: function (file) {
return path.basename(file);
},
pathExtName: function (file) {
return path.extname(file);
},
entries: function (...pathResolveArgs) {
return fs.readdirSync(path.resolve(...pathResolveArgs));
},
files: function (...pathResolveArgs) {
return fs.readdirSync(path.resolve(...pathResolveArgs)).filter((file) => fs.lstatSync(path.resolve(...pathResolveArgs, file)).isFile());
},
dirs: function (...pathResolveArgs) {
return fs.readdirSync(path.resolve(...pathResolveArgs)).filter((file) => fs.lstatSync(path.resolve(...pathResolveArgs, file)).isDirectory());
},
links: function (...pathResolveArgs) {
return fs.readdirSync(path.resolve(...pathResolveArgs)).filter((file) => fs.lstatSync(path.resolve(...pathResolveArgs, file)).isSymbolicLink());
},
test: function (regex, ...pathResolveArgs) {
return regex.test(path.resolve(...pathResolveArgs));
},
exists: function (...pathResolveArgs) {
return fs.existsSync(path.resolve(...pathResolveArgs));
},
isFile: function (...pathResolveArgs) {
return this.exists(...pathResolveArgs) && fs.lstatSync(path.resolve(...pathResolveArgs)).isFile();
},
isDirectory: function (...pathResolveArgs) {
return this.exists(...pathResolveArgs) && fs.lstatSync(path.resolve(...pathResolveArgs)).isDirectory();
},
isLink: function (...pathResolveArgs) {
return this.exists(...pathResolveArgs) && fs.lstatSync(path.resolve(...pathResolveArgs)).isSymbolicLink();
},
isSocket: function (...pathResolveArgs) {
return this.exists(...pathResolveArgs) && fs.lstatSync(path.resolve(...pathResolveArgs)).isSocket();
},
link: function (target, link) {
// if target is dir use linkDir function
if (fs.lstatSync(target).isDirectory()) return this.linkDir(target, link);
// unlink if different
try {
const bufTarget = fs.readFileSync(target);
const bufLink = fs.readFileSync(link);
if (bufTarget.equals(bufLink)) {
return;
} else {
this.unlink(link);
}
} catch (error) {
console.log(`Linking ${target}...`);
}
// if reached here file is not linked
try {
fs.symlinkSync(target, link);
} catch (error) {
console.log(error.message);
}
},
linkDir: function (target, link) {
// if target is file use link function
if (fs.lstatSync(target).isFile()) return this.link(target, link);
// unlink if there is no match
try {
let bufTarget, bufLink, found;
['index.js', 'index.json', 'index.cjs', 'index.mjs'].forEach((file) => {
if (this.exists(target, file)) {
bufTarget = fs.readFileSync(path.resolve(target, file));
bufLink = fs.readFileSync(path.resolve(link, file));
if (bufTarget.equals(bufLink)) found = true;
}
});
if (found) {
return;
} else {
this.unlink(link);
}
} catch (error) {
console.log(`Linking ${target}...`);
}
// if reached here file is not linked
try {
fs.symlinkSync(target, link);
} catch (error) {
console.log(error.message);
}
},
unlink: function (...pathResolveArgs) {
if (fs.existsSync(path.resolve(...pathResolveArgs)) && fs.lstatSync(path.resolve(...pathResolveArgs)).isSymbolicLink()) {
try {
fs.unlinkSync(path.resolve(...pathResolveArgs));
} catch (error) {
console.error(error);
}
}
},
chdir: function (...pathResolveArgs) {
return process.chdir(path.resolve(...pathResolveArgs));
},
mkdir: function (...pathResolveArgs) {
return fs.mkdirSync(path.resolve(...pathResolveArgs), { recursive: true });
},
readFile: function (file, options) {
// If options.encoding is specified then returns a string. Otherwise it returns a buffer.
try {
return fs.readFileSync(file, options);
} catch (error) {
console.error(error);
}
},
writeFile: function (file, content, printSuccess = false) {
if (process.env.NODE_ENV) throw new Error("Can't run inside a started app!");
try {
this.mkdir(this.pathDirName(file));
fs.writeFileSync(file, content);
if (printSuccess) console.log(`File ${file} written successfully.`);
} catch (error) {
console.error(error);
}
},
appendFile: function (file, content, printSuccess = false) {
if (process.env.NODE_ENV) throw new Error("Can't run inside a started app!");
try {
this.mkdir(this.pathDirName(file));
fs.appendFileSync(file, content);
if (printSuccess) console.log(`File ${file} updated successfully.`);
} catch (error) {
console.error(error);
}
},
removeFile: function (...pathResolveArgs) {
if (fs.existsSync(path.resolve(...pathResolveArgs)) && fs.lstatSync(path.resolve(...pathResolveArgs)).isFile()) {
try {
fs.unlinkSync(path.resolve(...pathResolveArgs));
} catch (error) {
console.error(error);
}
}
},
rename: function (oldPath, newPath) {
fs.renameSync(oldPath, newPath);
},
removeDir: function (...pathResolveArgs) {
fs.rmSync(path.resolve(...pathResolveArgs), { recursive: true });
},
removeDirContent: function (...pathResolveArgs) {
let entries;
try {
entries = fs.readdirSync(path.resolve(...pathResolveArgs));
} catch (e) {
return;
}
if (entries.length > 0) {
for (let i = 0; i < entries.length; i++) {
const filePath = path.resolve(...pathResolveArgs, entries[i]);
if (fs.statSync(filePath).isFile()) {
fs.unlinkSync(filePath);
} else {
this.removeDirContent(filePath);
}
}
}
},
download: async function (url, ...pathResolveArgs) {
const { Readable } = require('stream');
const { finished } = require('stream/promises');
const stream = fs.createWriteStream(path.resolve(...pathResolveArgs));
const { body } = await fetch(url);
await finished(Readable.fromWeb(body).pipe(stream));
},
pathResolveArgsFromUri: function (uriReference, options = {}) {
const { base = 'schema:/', pathOnly = true, noSchema = false, subdomainsNested = false } = options;
const uri = new URL(uriReference, base);
const pathname = decodeURIComponent(uri.pathname).replaceAll(':', '/').replaceAll('\\', '/').split('/');
if (pathOnly) return pathname;
const schema = uri.protocol.split(':')[0];
const isIpV4 = /^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$/.test(uri.hostname);
const isIpV6 = /^[\[].*[\]]$/.test(uri.hostname);
const hostname = isIpV6 ? [uri.hostname.replaceAll(':', '.')] : isIpV4 || !subdomainsNested ? [uri.hostname] : [uri.hostname.split('.').slice(-2).join('.'), ...uri.hostname.split('.').slice(0, -2).reverse()];
// username and port shouldn't exist in a schema id, but if they do we need to ensure that they will not overwrite default schema
if (noSchema) return [uri.port, ...hostname, uri.username, ...pathname];
return [schema, uri.port, ...hostname, uri.username, ...pathname];
},
filePathResolveArgs: function (options, ...pathResolveArgs) {
const { parser = '', index = 'index' } = options;
if (!parser) return pathResolveArgs;
const lastPath = pathResolveArgs.pop();
const fileName = !lastPath ? `${index}.${parser}` : path.extname(lastPath).toLowerCase() !== `.${parser}`.toLowerCase() ? lastPath + `.${parser}` : lastPath;
return [...pathResolveArgs, fileName];
},
// lack of options is intentional
watch: function (...pathResolveArgs) {
return fs.watch(path.resolve(...pathResolveArgs));
},
};