fix docs

README.md

@@ -148,11 +148,11 @@ const scaffold = Scaffold(config)
 In addition to all the options available in the command line, there are some Node/JS-specific
 options available:
 
-| Option        | Type                                                                                         | Description                                                                                                                                                                                                                                         |
-| ------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `output`      |                                                                                              | In addition to being passed the same as CLI, it may also be passed a function for each input file to output into a dynamic path: `{ output: (fullPath, baseDir, baseName) => path.resolve(baseDir, baseName) }`                                     |
-| `helpers`     | `Record<string, (string) => string>`                                                         | Helpers are simple functions that transform your `data` variables into other values. See [Helpers](#helpers) for the list of default helpers, or add your own to be loaded into the template parser.                                                |
-| `beforeWrite` | `(content: Buffer, rawContent: Buffer, outputPath: string) => String \| Buffer \| undefined` | Supply this function to override the final output contents of each of your files. The return value of this function will replace the output content of the respective file, which you may discriminate (if needed) using the `outputPath` argument. |
+| Option        | Type                                                                                                                                   | Description                                                                                                                                                                                                                                         |
+| ------------- | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `output`      |                                                                                                                                        | In addition to being passed the same as CLI, it may also be passed a function for each input file to output into a dynamic path: `{ output: (fullPath, baseDir, baseName) => path.resolve(baseDir, baseName) }`                                     |
+| `helpers`     | `Record<string, (string) => string>`                                                                                                   | Helpers are simple functions that transform your `data` variables into other values. See [Helpers](#helpers) for the list of default helpers, or add your own to be loaded into the template parser.                                                |
+| `beforeWrite` | `(content: Buffer, rawContent: Buffer, outputPath: string) => Promise<String \| Buffer \| undefined> \| String \| Buffer \| undefined` | Supply this function to override the final output contents of each of your files. The return value of this function will replace the output content of the respective file, which you may discriminate (if needed) using the `outputPath` argument. |
 
 ## Preparing files
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-scaffold",
-  "version": "1.1.0-alpha.2",
+  "version": "1.1.0-alpha.4",
   "description": "Create files based on templates",
   "repository": "https://github.com/chenasraf/simple-scaffold.git",
   "author": "Chen Asraf <inbox@casraf.com>",

src/types.ts

@@ -130,7 +130,11 @@ export interface ScaffoldConfig {
    * @returns `String | Buffer | undefined` The final output of the file contents-only, after further modifications -
    * or `undefined` to use the original content (i.e. `content.toString()`)
    */
-  beforeWrite?(content: Buffer, rawContent: Buffer, outputPath: string): string | Buffer | undefined
+  beforeWrite?(
+    content: Buffer,
+    rawContent: Buffer,
+    outputPath: string
+  ): string | Buffer | undefined | Promise<string | Buffer | undefined>
 }
 export interface ScaffoldCmdConfig {
   name: string

src/utils.ts

@@ -299,7 +299,7 @@ export async function copyFileTransformed(
     const templateBuffer = await readFile(inputPath)
     const unprocessedOutputContents = handlebarsParse(options, templateBuffer)
     const finalOutputContents = (
-      options.beforeWrite?.(unprocessedOutputContents, templateBuffer, outputPath) ?? unprocessedOutputContents
+      (await options.beforeWrite?.(unprocessedOutputContents, templateBuffer, outputPath)) ?? unprocessedOutputContents
     ).toString()
 
     if (!options.dryRun) {

tests/scaffold.test.ts

@@ -94,7 +94,7 @@ describe("Scaffold", () => {
           verbose: 0,
         })
         const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
-        expect(data.toString()).toBe("Hello, my app is app_name")
+        expect(data.toString()).toEqual("Hello, my app is app_name")
       })
 
       test("should create with config", async () => {
@@ -107,7 +107,7 @@ describe("Scaffold", () => {
         })
 
         const data = readFileSync(join(process.cwd(), "output", "app_name", "app_name.txt"))
-        expect(data.toString()).toBe("Hello, my app is app_name")
+        expect(data.toString()).toEqual("Hello, my app is app_name")
       })
     })
   )
@@ -133,7 +133,7 @@ describe("Scaffold", () => {
         })
 
         const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
-        expect(data.toString()).toBe("Hello, my value is 1")
+        expect(data.toString()).toEqual("Hello, my value is 1")
       })
 
       test("should overwrite with config", async () => {
@@ -155,7 +155,7 @@ describe("Scaffold", () => {
         })
 
         const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
-        expect(data.toString()).toBe("Hello, my value is 2")
+        expect(data.toString()).toEqual("Hello, my value is 2")
       })
     })
   )
@@ -188,6 +188,33 @@ describe("Scaffold", () => {
     })
   )
 
+  describe(
+    "dry run",
+    withMock(fileStructNormal, () => {
+      let consoleMock1: jest.SpyInstance
+      beforeAll(() => {
+        consoleMock1 = jest.spyOn(console, "error").mockImplementation(() => void 0)
+      })
+
+      afterAll(() => {
+        consoleMock1.mockRestore()
+      })
+
+      test("should not write to disk", async () => {
+        Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          data: { value: "1" },
+          verbose: 0,
+          dryRun: true,
+        })
+
+        expect(() => readFileSync(join(process.cwd(), "output", "app_name.txt"))).toThrow()
+      })
+    })
+  )
+
   describe(
     "outputPath override",
     withMock(fileStructNormal, () => {
@@ -200,7 +227,7 @@ describe("Scaffold", () => {
           verbose: 0,
         })
         const data = readFileSync(join(process.cwd(), "/custom-output/app_name/app_name.txt"))
-        expect(data.toString()).toBe("Hello, my app is app_name")
+        expect(data.toString()).toEqual("Hello, my app is app_name")
       })
     })
   )
@@ -344,7 +371,7 @@ describe("Scaffold", () => {
         })
 
         const data = readFileSync(join(process.cwd(), "output", "app_name", "app_name.txt"))
-        expect(data.toString()).toBe("Hello, my app is app_name")
+        expect(data.toString()).toEqual("Hello, my app is app_name")
       })
 
       test("should work with default helper", async () => {
@@ -358,7 +385,7 @@ describe("Scaffold", () => {
         })
 
         const data = readFileSync(join(process.cwd(), "output", "APP_NAME", "app_name.txt"))
-        expect(data.toString()).toBe("Hello, my app is app_name")
+        expect(data.toString()).toEqual("Hello, my app is app_name")
       })
 
       test("should work with custom helper", async () => {
@@ -375,7 +402,7 @@ describe("Scaffold", () => {
         })
 
         const data = readFileSync(join(process.cwd(), "output", "REPLACED", "app_name.txt"))
-        expect(data.toString()).toBe("Hello, my app is app_name")
+        expect(data.toString()).toEqual("Hello, my app is app_name")
       })
     })
   )
@@ -394,7 +421,7 @@ describe("Scaffold", () => {
         })
 
         const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
-        expect(data.toString()).toBe("Hello, my app is app_name")
+        expect(data.toString()).toEqual("Hello, my app is app_name")
       })
 
       test("should work with custom callback", async () => {
@@ -411,7 +438,7 @@ describe("Scaffold", () => {
         })
 
         const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
-        expect(data.toString()).toBe(
+        expect(data.toString()).toEqual(
           [
             "Hello, my app is app_name".toUpperCase(),
             fileStructNormal.input["{{name}}.txt"],
@@ -419,6 +446,21 @@ describe("Scaffold", () => {
           ].join(", ")
         )
       })
+      test("should work with undefined response custom callback", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          verbose: 0,
+          data: {
+            value: "value",
+          },
+          beforeWrite: () => undefined,
+        })
+
+        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
+        expect(data.toString()).toEqual("Hello, my app is app_name")
+      })
     })
   )
 })