🧪 Pipe
Pipe allows you to process files in a pipeline, making it easy to perform
various operations on them.
To get started with Pipe, follow these steps:
Install the Pipe package using npm:
npm install -D -E @playform/pipeCreate a new pipe instance using the following code in your Index.ts file:
Index.ts
await new (await import("@playform/pipe")).default().In("./Input");With Pipe, you can use the Pipe method to perform operations on files within
the pipe. Here's an example of how to use it in your Index.ts:
Index.ts
await(
await(
await new (await import("@playform/pipe")).default().In("./Input")
).By("**/*.md")
).Pipe({
// Append some content to all of the text files
Wrote: (On) => (On.Buffer += "LICENSE [MIT]"),
});Pipe provides default callbacks for file processing. These callbacks can be
customized to suit your specific needs. Here are the default callbacks:
await new (await import("@playform/pipe")).default().Pipe({
// Read the file into a buffer
Read: async ({ Input }) => await fs.promises.readFile(Input, "utf-8"),
// Wrote the buffer into a file
Wrote: async ({ Buffer }) => Buffer,
// Passed the file through a check
Passed: async (On) => On && true,
// Failed processing the file
Failed: async ({ Input }) => `Error: Cannot process file ${Input}!`,
// Accomplished processing the file
Accomplished: async ({ Input, Output }) =>
`Processed ${Input} in ${Output}.`,
// Fulfilled the whole plan
Fulfilled: async ({ File }) =>
`Successfully processed a total of ${File} ${
File === 1 ? "file" : "files"
}.`,
// Changed the plan
Changed: async (Plan) => Plan,
});You can add multiple paths to your pipe by specifying an array as the Path
variable:
Index.ts
await new (await import("@playform/pipe")).default().In([
"./Input",
"./Input2",
]);Pipe will allow you to provide a map of paths for different input and output
directories, making it easy to control where files are read from and written to:
Index.ts
await new (await import("@playform/pipe")).default().In(
new Map([["./Input", "./Output"]])
);You can filter files to exclude specific ones from your Pipe. Filters can be
an array of regular expressions or a single match. You can also use functions to
match on file names:
Index.ts
await new (await import("@playform/pipe")).default().Not([
"File.txt",
(File: string) => File === "./Input/File.txt",
]);You can control the logging level by setting the Logger parameter. The default
value is 2, but you can set it to 0 if you don't want to see debug messages:
Index.ts
new (await import("@playform/pipe")).default(0);See CHANGELOG.md for a history of changes to this component.