90125566bb
Fixes #3324 Co-authored-by: Kitson Kelly <me@kitsonkelly.com> |
||
---|---|---|
.. | ||
testdata | ||
copy.ts | ||
copy_test.ts | ||
empty_dir.ts | ||
empty_dir_test.ts | ||
ensure_dir.ts | ||
ensure_dir_test.ts | ||
ensure_file.ts | ||
ensure_file_test.ts | ||
ensure_link.ts | ||
ensure_link_test.ts | ||
ensure_symlink.ts | ||
ensure_symlink_test.ts | ||
eol.ts | ||
eol_test.ts | ||
exists.ts | ||
exists_test.ts | ||
expand_glob.ts | ||
expand_glob_test.ts | ||
mod.ts | ||
move.ts | ||
move_test.ts | ||
read_file_str.ts | ||
read_file_str_test.ts | ||
read_json.ts | ||
read_json_test.ts | ||
README.md | ||
utils.ts | ||
utils_test.ts | ||
walk.ts | ||
walk_test.ts | ||
write_file_str.ts | ||
write_file_str_test.ts | ||
write_json.ts | ||
write_json_test.ts |
fs
fs module is made to provide helpers to manipulate the filesystem.
Usage
All the following modules are exposed in mod.ts
emptyDir
Ensures that a directory is empty. Deletes directory contents if the directory is not empty. If the directory does not exist, it is created. The directory itself is not deleted.
import { emptyDir, emptyDirSync } from "https://deno.land/std/fs/mod.ts";
emptyDir("./foo"); // returns a promise
emptyDirSync("./foo"); // void
ensureDir
Ensures that the directory exists. If the directory structure does not exist, it is created. Like mkdir -p.
import { ensureDir, ensureDirSync } from "https://deno.land/std/fs/mod.ts";
ensureDir("./bar"); // returns a promise
ensureDirSync("./ensureDirSync"); // void
ensureFile
Ensures that the file exists. If the file that is requested to be created is in directories that do not exist, these directories are created. If the file already exists, it is NOT MODIFIED.
import { ensureFile, ensureFileSync } from "https://deno.land/std/fs/mod.ts";
ensureFile("./folder/targetFile.dat"); // returns promise
ensureFileSync("./folder/targetFile.dat"); // void
ensureSymlink
Ensures that the link exists. If the directory structure does not exist, it is created.
import {
ensureSymlink,
ensureSymlinkSync
} from "https://deno.land/std/fs/mod.ts";
ensureSymlink(
"./folder/targetFile.dat",
"./folder/targetFile.link.dat",
"file"
); // returns promise
ensureSymlinkSync(
"./folder/targetFile.dat",
"./folder/targetFile.link.dat",
"file"
); // void
eol
Detects and format the passed string for the targeted End Of Line character.
import { format, detect, EOL } from "https://deno.land/std/fs/mod.ts";
const CRLFinput = "deno\r\nis not\r\nnode";
const Mixedinput = "deno\nis not\r\nnode";
const LFinput = "deno\nis not\nnode";
const NoNLinput = "deno is not node";
detect(LFinput); // output EOL.LF
detect(CRLFinput); // output EOL.CRLF
detect(Mixedinput); // output EOL.CRLF
detect(NoNLinput); // output null
format(CRLFinput, EOL.LF); // output "deno\nis not\nnode"
...
exists
Test whether or not the given path exists by checking with the file system
import { exists, existsSync } from "https://deno.land/std/fs/mod.ts";
exists("./foo"); // returns a Promise<boolean>
existsSync("./foo"); // returns boolean
globToRegExp
Generate a regex based on glob pattern and options This was meant to be using
the the fs.walk
function but can be used anywhere else.
import { globToRegExp } from "https://deno.land/std/fs/mod.ts";
globToRegExp("foo/**/*.json", {
flags: "g",
extended: true,
globstar: true
}); // returns the regex to find all .json files in the folder foo
move
Moves a file or directory. Overwrites it if option provided
import { move, moveSync } from "https://deno.land/std/fs/mod.ts";
move("./foo", "./bar"); // returns a promise
moveSync("./foo", "./bar"); // void
moveSync("./foo", "./existingFolder", { overwrite: true });
// Will overwrite existingFolder
copy
copy a file or directory. Overwrites it if option provided
import { copy, copySync } from "https://deno.land/std/fs/mod.ts";
copy("./foo", "./bar"); // returns a promise
copySync("./foo", "./bar"); // void
copySync("./foo", "./existingFolder", { overwrite: true });
// Will overwrite existingFolder
readJson
Reads a JSON file and then parses it into an object
import { readJson, readJsonSync } from "https://deno.land/std/fs/mod.ts";
const f = await readJson("./foo.json");
const foo = readJsonSync("./foo.json");
walk
Iterate all files in a directory recursively.
import { walk, walkSync } from "https://deno.land/std/fs/mod.ts";
for (const fileInfo of walkSync(".")) {
console.log(fileInfo.filename);
}
// Async
async function printFilesNames() {
for await (const fileInfo of walk()) {
console.log(fileInfo.filename);
}
}
printFilesNames().then(() => console.log("Done!"));
writeJson
Writes an object to a JSON file.
WriteJsonOptions
- replacer : An array of strings and numbers that acts as a approved list for selecting the object properties that will be stringified.
- space : Adds indentation, white space, and line break characters to the return-value JSON text to make it easier to read.
import { writeJson, writeJsonSync } from "https://deno.land/std/fs/mod.ts";
writeJson("./target.dat", { foo: "bar" }, { spaces: 2 }); // returns a promise
writeJsonSync("./target.dat", { foo: "bar" }, { replacer: ["foo"] }); // void
readFileStr
Read file and output it as a string.
ReadOptions
- encoding : The encoding to read file. lowercased.
import { readFileStr, readFileStrSync } from "https://deno.land/std/fs/mod.ts";
readFileStr("./target.dat", { encoding: "utf8" }); // returns a promise
readFileStrSync("./target.dat", { encoding: "utf8" }); // void
writeFileStr
Write the string to file.
import {
writeFileStr,
writeFileStrSync
} from "https://deno.land/std/fs/mod.ts";
writeFileStr("./target.dat", "file content"); // returns a promise
writeFileStrSync("./target.dat", "file content"); // void