update workflows + release alpha

beforeWrite callback

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug, needs-triage
+assignees: chenasraf
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Prepare templates:
+    ```
+    template contents
+    ```
+2. Run with args/config:
+    ```
+    npx simple-scaffold@latest -t ... -o output TplName
+    ```
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs**
+If applicable, paste your logs to help explain your problem.
+To see more logs, run the scaffold with `-v 1` to enable debug logging.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+- Node.js: [e.g. 16.8]
+ - Simple Scaffold Version [e.g. 1.0.4]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement, needs-triage
+assignees: chenasraf
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/develop.yml

@@ -2,7 +2,7 @@ name: Alpha Releases
 
 on:
   push:
-    branches: [alpha]
+    branches: [develop]
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/pull_requests.yml

@@ -2,7 +2,7 @@ name: Pull Requests
 
 on:
   pull_request:
-    branches: [master, alpha, beta]
+    branches: [master, develop]
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/release.yml

@@ -1,4 +1,4 @@
-name: Releases
+name: Release
 
 on:
   push:

.markdownlint.json

@@ -0,0 +1,8 @@
+{
+  "MD013": {
+    "line_length": 100,
+    "tables": false,
+    "code_blocks": false
+  },
+  "MD033": false
+}

README.md

@@ -1,16 +1,42 @@
 # simple-scaffold
 
-Simple Scaffold allows you to create your structured files based on templates.
+Simple Scaffold allows you to generate any set of files in the easiest way possible with simple commands.
 
-Simply organize your commonly-created files in their original structure, and replace any variable
-values (such as component or app name) inside the paths or contents of the files with tokens to be
-populated upon scaffolding.
+It is completely framework agnostic so you can use it for anything from a few simple files to an
+entire app boilerplate setup.
 
-Then, run Simple Scaffold and it will generate your files for you in the desired structure,
-with file names and contents that contain your dynamic information.
+Simply organize your commonly-created files in their original structure, and running Simple Scaffold
+will copy the files to the output path, while replacing values (such as component or app name, or
+other custom data) inside the paths or contents of the files using Handlebars.js syntax.
 
-It's a simple way to easily create reusable components, common class files to start writing from,
-or even entire app structures.
+<br />
+
+<details>
+  <summary>Table of contents</summary>
+
+- [simple-scaffold](#simple-scaffold)
+  - [Install](#install)
+  - [Use as a command line tool](#use-as-a-command-line-tool)
+    - [Command Line Options](#command-line-options)
+  - [Use in Node.js](#use-in-nodejs)
+    - [Node-specific options](#node-specific-options)
+  - [Preparing files](#preparing-files)
+    - [Template files](#template-files)
+    - [Variable/token replacement](#variabletoken-replacement)
+    - [Helpers](#helpers)
+  - [Examples](#examples)
+    - [Command Example](#command-example)
+    - [Example Scaffold Input](#example-scaffold-input)
+      - [Input Directory structure](#input-directory-structure)
+      - [Contents of `project/scaffold/{{Name}}.jsx`](#contents-of-projectscaffoldnamejsx)
+    - [Example Scaffold Output](#example-scaffold-output)
+    - [Output directory structure](#output-directory-structure)
+      - [Contents of `project/scaffold/MyComponent/MyComponent.jsx`](#contents-of-projectscaffoldmycomponentmycomponentjsx)
+  - [Contributing](#contributing)
+
+</details>
+
+---
 
 ## Install
 
@@ -22,7 +48,7 @@ npm install [-g] simple-scaffold
 # yarn
 yarn [global] add simple-scaffold
 # run without installing
-npx simple-scaffold <...args>
+npx simple-scaffold@latest <...args>
 ```
 
 ## Use as a command line tool
@@ -81,10 +107,8 @@ You can also add this as a script in your `package.json`:
 
 ```json
 {
-  ...
   "scripts": {
-    ...
-    "scaffold": "yarn simple-scaffold --templates scaffolds/component/**/* --output src/components --data '{\"myProp\": \"propName\", \"myVal\": \"123\"}'"
+    "scaffold": "npx simple-scaffold@latest -t scaffolds/component/**/* -o src/components -d '{\"myProp\": \"propName\", \"myVal\": 123}'"
   }
 }
 ```
@@ -104,35 +128,28 @@ const config = {
   output: path.join(__dirname, "src", "components"),
   createSubFolder: true,
   subFolderNameHelper: "upperCase"
-  locals: {
+  data: {
     property: "value",
   },
   helpers: {
     twice: (text) => [text, text].join(" ")
-  }
+  },
+  beforeWrite: (content, rawContent, outputPath) => content.toString().toUpperCase()
 }
 
 const scaffold = Scaffold(config)
 ```
 
-### Additional Node.js options
+### Node-specific options
 
-In addition to all the options available in the command line, there are some JS-specific options
-available:
+In addition to all the options available in the command line, there are some Node/JS-specific
+options available:
 
-1. When `output` is used in Node directly, it may also be passed a function for each input file to
-   output into a dynamic path:
-
-    ```typescript
-    config.output = (fullPath, baseDir, baseName) => {
-      console.log({ fullPath, baseDir, baseName })
-      return path.resolve(baseDir, baseName)
-    }
-    ```
-
-2. You may add custom `helpers` to your scaffolds. Helpers are simple `(string) => string` 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.
+| 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. |
 
 ## Preparing files
 
@@ -140,6 +157,22 @@ available:
 
 Put your template files anywhere, and fill them with tokens for replacement.
 
+Each template (not file) in the config array is parsed individually, and copied to the output
+directory. If a single template path contains multiple files (e.g. if you use a folder path or a
+glob pattern), the first directory up the tree of that template will become the base inside the
+defined output path for that template, while copying files recursively and maintaining their
+relative structure.
+
+Examples:
+
+> In the following examples, the config `name` is `AppName`, and the config `output` is `src`.
+
+| Input template                                                                                                                                       | Output path(s)                                               |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
+| `./templates/{{ name }}.txt`                                                                                                                         | `src/AppName.txt`                                            |
+| `./templates/directory`  <br /><br /> Directory contents:<br /> <ol><li>`outer/{{name}}.txt`</li></li><li>`outer2/inner/{{name.txt}}`</li></ol>      | `src/outer/AppName.txt`,<br />`src/outer2/inner/AppName.txt` |
+| `./templates/others/**/*.txt` <br /><br /> Directory contents:<br /> <ol><li>`outer/{{name}}.jpg`</li></li><li>`outer2/inner/{{name.txt}}`</li></ol> | `src/outer2/inner/AppName.txt`                               |
+
 ### Variable/token replacement
 
 Scaffolding will replace `{{ varName }}` in both the file name and its contents and put the
@@ -148,17 +181,36 @@ transformed files in the output directory.
 The data available for the template parser is the data you pass to the `data` config option (or
 `--data` argument in CLI).
 
+For example, using the following command:
+
+```bash
+npx simple-scaffold@latest \
+  --templates templates/components/{{name}}.jsx \
+  --output src/components \
+  -create-sub-folder true \
+  MyComponent
+```
+
+Will output a file with the path:
+
+```plaintext
+<working_dir>/src/components/MyComponent.jsx
+```
+
+The contents of the file will be transformed in a similar fashion.
+
 Your `data` will be pre-populated with the following:
 
 - `{{Name}}`: PascalCase of the component name
-- `{{name}}`: raw name of the component
+- `{{name}}`: raw name of the component as you entered it
 
-> Simple-Scaffold uses [Handlebars.js](https://handlebarsjs.com/) for outputting the file contents,
-> see their documentation for more information on syntax.
+> Simple-Scaffold uses [Handlebars.js](https://handlebarsjs.com/) for outputting the file contents.
 > Any `data` you add in the config will be available for use with their names wrapped in
-> `{{` and `}}`.
+> `{{` and `}}`. Other Handlebars built-ins such as `each`, `if` and `with` are also supported, see
+> [Handlebars.js Language Features](https://handlebarsjs.com/guide/#language-features) for more
+> information.
 
-#### Helpers
+### Helpers
 
 Simple-Scaffold provides some built-in text transformation filters usable by handleBars.
 
@@ -169,14 +221,15 @@ Here are the built-in helpers available for use:
 
 | Helper name | Example code            | Example output |
 | ----------- | ----------------------- | -------------- |
+| [None]      | `{{ name }}`            | my name        |
 | camelCase   | `{{ camelCase name }}`  | myName         |
 | snakeCase   | `{{ snakeCase name }}`  | my_name        |
 | startCase   | `{{ startCase name }}`  | My Name        |
 | kebabCase   | `{{ kebabCase name }}`  | my-name        |
 | hyphenCase  | `{{ hyphenCase name }}` | my-name        |
 | pascalCase  | `{{ pascalCase name }}` | MyName         |
-| upperCase   | `{{ upperCase name }}`  | MYNAME         |
-| lowerCase   | `{{ lowerCase name }}`  | myname         |
+| upperCase   | `{{ upperCase name }}`  | MY NAME        |
+| lowerCase   | `{{ lowerCase name }}`  | my name        |
 
 > These helpers are available for any data property, not exclusive to `name`.
 
@@ -220,12 +273,12 @@ simple-scaffold MyComponent \
 
 #### Contents of `project/scaffold/{{Name}}.jsx`
 
-```js
-const React = require('react')
+```typescriptreact
+import React from 'react'
 
-module.exports = function {{Name}}(props) {
+export default {{camelCase ame}}: React.FC = (props) => {
   return (
-    <div className="{{className}}">{{Name}} Component</div>
+    <div className="{{className}}">{{camelCase name}} Component</div>
   )
 }
 ```
@@ -255,10 +308,10 @@ With `createSubFolder = false`:
 
 #### Contents of `project/scaffold/MyComponent/MyComponent.jsx`
 
-```js
-const React = require("react")
+```typescriptreact
+import React from 'react'
 
-module.exports = function MyComponent(props) {
+export default MyComponent: React.FC = (props) => {
   return (
     <div className="myClassName">MyComponent Component</div>
   )
@@ -290,5 +343,5 @@ Some tips on getting around the code:
   enabling you to test different behaviors. See `yarn cmd -h` for more information.
 
   > This requires an updated build, and does not trigger one itself. Either use `yarn dev` to watch
-  > for changes and build, or `yarn build` before running this, or use `yarn build-cmd` instead, 
+  > for changes and build, or `yarn build` before running this, or use `yarn build-cmd` instead,
   > which triggers a build right before running the command with the rest of the given arguments.

package.json

@@ -1,14 +1,25 @@
 {
   "name": "simple-scaffold",
-  "version": "1.0.1-pre.1",
+  "version": "1.1.0-alpha.1",
   "description": "Create files based on templates",
   "repository": "https://github.com/chenasraf/simple-scaffold.git",
   "author": "Chen Asraf <inbox@casraf.com>",
   "license": "MIT",
   "main": "index.js",
   "bin": "cmd.js",
+  "keywords": [
+    "javascript",
+    "cli",
+    "template",
+    "files",
+    "typescript",
+    "generator",
+    "scaffold",
+    "file",
+    "scaffolding"
+  ],
   "scripts": {
-    "clean": "rm -rf dist/",
+    "clean": "rimraf dist/",
     "build": "yarn clean && tsc && chmod -R +x ./dist && cp ./package.json ./README.md ./dist/",
     "dev": "tsc --watch",
     "start": "node dist/scaffold.js",
@@ -18,7 +29,6 @@
     "build-cmd": "yarn build && yarn cmd"
   },
   "dependencies": {
-    "args": "^5.0.1",
     "chalk": "^4.1.2",
     "glob": "^7.1.3",
     "handlebars": "^4.7.7",
@@ -27,7 +37,6 @@
     "util.promisify": "^1.1.1"
   },
   "devDependencies": {
-    "@types/args": "^3.0.1",
     "@types/glob": "^7.1.1",
     "@types/jest": "^26.0.24",
     "@types/lodash": "^4.14.171",
@@ -35,6 +44,7 @@
     "@types/node": "^14.14.22",
     "jest": "^27.0.6",
     "mock-fs": "^5.0.0",
+    "rimraf": "^3.0.2",
     "ts-jest": "^27.0.3",
     "ts-node": "^10.1.0",
     "typescript": "^4.3.5"

src/scaffold.ts

@@ -1,16 +1,10 @@
-import { glob } from "glob"
 import path from "path"
-import { promisify } from "util"
-import { promises as fsPromises } from "fs"
-const { readFile, writeFile } = fsPromises
 
 import {
   createDirIfNotExists,
   getOptionValueForFile,
   handleErr,
-  handlebarsParse,
   log,
-  pathExists,
   pascalCase,
   isDir,
   removeGlob,
@@ -24,10 +18,8 @@ import {
   getTemplateFileInfo,
   logInitStep,
   logInputFile,
-  GlobInfo,
-  OutputFileInfo,
 } from "./utils"
-import { FileResponse, LogLevel, ScaffoldConfig } from "./types"
+import { LogLevel, ScaffoldConfig } from "./types"
 
 /**
  * Create a scaffold using given `options`.
@@ -59,7 +51,7 @@ import { FileResponse, LogLevel, ScaffoldConfig } from "./types"
  * Any functions you provide in `helpers` option will also be available to you to make custom formatting as you see fit
  * (for example, formatting a date)
  */
-export async function Scaffold({ ...options }: ScaffoldConfig) {
+export async function Scaffold({ ...options }: ScaffoldConfig): Promise<void> {
   options.output ??= process.cwd()
 
   registerHelpers(options)
@@ -90,7 +82,10 @@ export async function Scaffold({ ...options }: ScaffoldConfig) {
             isDirOrGlob,
             isGlob,
           })
-          await handleTemplateFile(options, options.data, { templatePath: inputFilePath, basePath })
+          await handleTemplateFile(options, options.data, {
+            templatePath: inputFilePath,
+            basePath,
+          })
         }
       } catch (e: any) {
         handleErr(e)
@@ -112,7 +107,7 @@ async function handleTemplateFile(
         templatePath,
         basePath,
       })
-      const overwrite = getOptionValueForFile(options, inputPath, data, options.overwrite ?? false)
+      const overwrite = getOptionValueForFile(options, inputPath, options.overwrite ?? false)
 
       log(
         options,
@@ -129,7 +124,7 @@ async function handleTemplateFile(
       await createDirIfNotExists(path.dirname(outputPath), options)
 
       log(options, LogLevel.Info, `Writing to ${outputPath}`)
-      await copyFileTransformed(options, data, { exists, overwrite, outputPath, inputPath })
+      await copyFileTransformed(options, { exists, overwrite, outputPath, inputPath })
       resolve()
     } catch (e: any) {
       handleErr(e)

src/types.ts

@@ -113,6 +113,22 @@ export interface ScaffoldConfig {
    * helpers, or a custom one you provide to `helpers`. Defaults to `undefined`, which means no transformation is done.
    */
   subFolderNameHelper?: DefaultHelperKeys | string
+
+  /**
+   * This callback runs right before content is being written to the disk. If you supply this function, you may return
+   * a string that represents the final content of your file, you may process the content as you see fit. For example,
+   * you may run formatters on a file, fix output in edge-cases not supported by helpers or data, etc.
+   *
+   * If the return value of this function is `undefined`, the original content will be used.
+   *
+   * @param content The original template after token replacement
+   * @param rawContent The original template before token replacement
+   * @param outputPath The final output path of the processed file
+   *
+   * @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
 }
 export interface ScaffoldCmdConfig {
   name: string

src/utils.ts

@@ -25,7 +25,7 @@ export const defaultHelpers: Record<DefaultHelperKeys, Helper> = {
   upperCase: (text) => text.toUpperCase(),
 }
 
-export function registerHelpers(options: ScaffoldConfig) {
+export function registerHelpers(options: ScaffoldConfig): void {
   const _helpers = { ...defaultHelpers, ...options.helpers }
   for (const helperName in _helpers) {
     log(options, LogLevel.Debug, `Registering helper: ${helperName}`)
@@ -33,11 +33,11 @@ export function registerHelpers(options: ScaffoldConfig) {
   }
 }
 
-export function handleErr(err: NodeJS.ErrnoException | null) {
+export function handleErr(err: NodeJS.ErrnoException | null): void {
   if (err) throw err
 }
 
-export function log(options: ScaffoldConfig, level: LogLevel, ...obj: any[]) {
+export function log(options: ScaffoldConfig, level: LogLevel, ...obj: any[]): void {
   if (options.quiet || options.verbose === LogLevel.None || level < (options.verbose ?? LogLevel.Info)) {
     return
   }
@@ -86,7 +86,6 @@ export async function createDirIfNotExists(dir: string, options: ScaffoldConfig)
 export function getOptionValueForFile<T>(
   options: ScaffoldConfig,
   filePath: string,
-  data: Record<string, string>,
   fn: FileResponse<T>,
   defaultValue?: T
 ): T {
@@ -95,23 +94,32 @@ export function getOptionValueForFile<T>(
   }
   return (fn as FileResponseFn<T>)(
     filePath,
-    path.dirname(handlebarsParse(options, filePath, data).toString()),
-    path.basename(handlebarsParse(options, filePath, data).toString())
+    path.dirname(handlebarsParse(options, filePath, { isPath: true }).toString()),
+    path.basename(handlebarsParse(options, filePath, { isPath: true }).toString())
   )
 }
 
 export function handlebarsParse(
   options: ScaffoldConfig,
   templateBuffer: Buffer | string,
-  data: Record<string, string>
-) {
+  { isPath = false }: { isPath?: boolean } = {}
+): Buffer {
+  const { data } = options
   try {
-    const parser = Handlebars.compile(templateBuffer.toString(), { noEscape: true })
-    const outputContents = parser(data)
-    return outputContents
-  } catch {
+    let str = templateBuffer.toString()
+    if (isPath) {
+      str = str.replace(/\\/g, "/")
+    }
+    const parser = Handlebars.compile(str, { noEscape: true })
+    let outputContents = parser(data)
+    if (isPath && path.sep !== "/") {
+      outputContents = outputContents.replace(/\//g, "\\")
+    }
+    return Buffer.from(outputContents)
+  } catch (e) {
+    log(options, LogLevel.Debug, e)
     log(options, LogLevel.Warning, "Couldn't parse file with handlebars, returning original content")
-    return templateBuffer
+    return Buffer.from(templateBuffer)
   }
 }
 
@@ -136,27 +144,29 @@ export async function isDir(path: string): Promise<boolean> {
   return tplStat.isDirectory()
 }
 
-export function removeGlob(template: string) {
-  return template.replace(/\*/g, "").replace(/\/\//g, "/")
+export function removeGlob(template: string): string {
+  return template.replace(/\*/g, "").replace(/(\/\/|\\\\)/g, path.sep)
 }
 
 export function makeRelativePath(str: string): string {
-  return str.startsWith("/") ? str.slice(1) : str
+  return str.startsWith(path.sep) ? str.slice(1) : str
 }
 
-export function getBasePath(relPath: string) {
+export function getBasePath(relPath: string): string {
   return path
     .resolve(process.cwd(), relPath)
-    .replace(process.cwd() + "/", "")
+    .replace(process.cwd() + path.sep, "")
     .replace(process.cwd(), "")
 }
 
-export async function getFileList(options: ScaffoldConfig, template: string) {
-  return await promisify(glob)(template, {
-    dot: true,
-    debug: options.verbose === LogLevel.Debug,
-    nodir: true,
-  })
+export async function getFileList(options: ScaffoldConfig, template: string): Promise<string[]> {
+  return (
+    await promisify(glob)(template, {
+      dot: true,
+      debug: options.verbose === LogLevel.Debug,
+      nodir: true,
+    })
+  ).map((f) => f.replace(/\//g, path.sep))
 }
 
 export interface GlobInfo {
@@ -177,12 +187,12 @@ export async function getTemplateGlobInfo(options: ScaffoldConfig, template: str
   const _shouldAddGlob = !isGlob && isDirOrGlob
   const origTemplate = template
   if (_shouldAddGlob) {
-    _template = template + "/**/*"
+    _template = path.join(template, "**", "*")
   }
   return { nonGlobTemplate, origTemplate, isDirOrGlob, isGlob, template: _template }
 }
 
-export async function ensureFileExists(template: string, isGlob: boolean) {
+export async function ensureFileExists(template: string, isGlob: boolean): Promise<void> {
   if (!isGlob && !(await pathExists(template))) {
     const err: NodeJS.ErrnoException = new Error(`ENOENT, no such file or directory ${template}`)
     err.code = "ENOENT"
@@ -206,48 +216,52 @@ export async function getTemplateFileInfo(
   { templatePath, basePath }: { templatePath: string; basePath: string }
 ): Promise<OutputFileInfo> {
   const inputPath = path.resolve(process.cwd(), templatePath)
-  const outputPathOpt = getOptionValueForFile(options, inputPath, data, options.output)
-  const outputDir = getOutputDir(options, data, outputPathOpt, basePath)
-  const outputPath = handlebarsParse(options, path.join(outputDir, path.basename(inputPath)), data).toString()
+  const outputPathOpt = getOptionValueForFile(options, inputPath, options.output)
+  const outputDir = getOutputDir(options, outputPathOpt, basePath)
+  const outputPath = handlebarsParse(options, path.join(outputDir, path.basename(inputPath)), {
+    isPath: true,
+  }).toString()
   const exists = await pathExists(outputPath)
   return { inputPath, outputPathOpt, outputDir, outputPath, exists }
 }
 
 export async function copyFileTransformed(
   options: ScaffoldConfig,
-  data: Record<string, string>,
   {
     exists,
     overwrite,
     outputPath,
     inputPath,
-  }: { exists: boolean; overwrite: boolean; outputPath: string; inputPath: string }
-) {
+  }: {
+    exists: boolean
+    overwrite: boolean
+    outputPath: string
+    inputPath: string
+  }
+): Promise<void> {
   if (!exists || overwrite) {
     if (exists && overwrite) {
       log(options, LogLevel.Info, `File ${outputPath} exists, overwriting`)
     }
     const templateBuffer = await readFile(inputPath)
-    const outputContents = handlebarsParse(options, templateBuffer, data)
+    const unprocessedOutputContents = handlebarsParse(options, templateBuffer)
+    const finalOutputContents = (
+      options.beforeWrite?.(unprocessedOutputContents, templateBuffer, outputPath) ?? unprocessedOutputContents
+    ).toString()
 
     if (!options.dryRun) {
-      await writeFile(outputPath, outputContents)
+      await writeFile(outputPath, finalOutputContents)
       log(options, LogLevel.Info, "Done.")
     } else {
       log(options, LogLevel.Info, "Content output:")
-      log(options, LogLevel.Info, outputContents)
+      log(options, LogLevel.Info, finalOutputContents)
     }
   } else if (exists) {
     log(options, LogLevel.Info, `File ${outputPath} already exists, skipping`)
   }
 }
 
-export function getOutputDir(
-  options: ScaffoldConfig,
-  data: Record<string, string>,
-  outputPathOpt: string,
-  basePath: string
-) {
+export function getOutputDir(options: ScaffoldConfig, outputPathOpt: string, basePath: string): string {
   return path.resolve(
     process.cwd(),
     ...([
@@ -255,7 +269,7 @@ export function getOutputDir(
       basePath,
       options.createSubFolder
         ? options.subFolderNameHelper
-          ? handlebarsParse(options, `{{ ${options.subFolderNameHelper} name }}`, data)
+          ? handlebarsParse(options, `{{ ${options.subFolderNameHelper} name }}`).toString()
           : options.name
         : undefined,
     ].filter(Boolean) as string[])
@@ -283,7 +297,7 @@ export function logInputFile(
     isDirOrGlob: boolean
     isGlob: boolean
   }
-) {
+): void {
   log(
     options,
     LogLevel.Debug,
@@ -300,7 +314,7 @@ export function logInputFile(
   )
 }
 
-export function logInitStep(options: ScaffoldConfig) {
+export function logInitStep(options: ScaffoldConfig): void {
   log(options, LogLevel.Debug, "Full config:", {
     name: options.name,
     templates: options.templates,

tests/scaffold.test.ts

@@ -4,6 +4,7 @@ import Scaffold from "../src/scaffold"
 import { readdirSync, readFileSync } from "fs"
 import { Console } from "console"
 import { defaultHelpers } from "../src/utils"
+import { join } from "path"
 
 const fileStructNormal = {
   input: {
@@ -83,7 +84,7 @@ describe("Scaffold", () => {
           templates: ["input"],
           verbose: 0,
         })
-        const data = readFileSync(process.cwd() + "/output/app_name.txt")
+        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
         expect(data.toString()).toBe("Hello, my app is app_name")
       })
 
@@ -96,7 +97,7 @@ describe("Scaffold", () => {
           verbose: 0,
         })
 
-        const data = readFileSync(process.cwd() + "/output/app_name/app_name.txt")
+        const data = readFileSync(join(process.cwd(), "output", "app_name", "app_name.txt"))
         expect(data.toString()).toBe("Hello, my app is app_name")
       })
     })
@@ -122,7 +123,7 @@ describe("Scaffold", () => {
           verbose: 0,
         })
 
-        const data = readFileSync(process.cwd() + "/output/app_name.txt")
+        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
         expect(data.toString()).toBe("Hello, my value is 1")
       })
 
@@ -144,7 +145,7 @@ describe("Scaffold", () => {
           verbose: 0,
         })
 
-        const data = readFileSync(process.cwd() + "/output/app_name.txt")
+        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
         expect(data.toString()).toBe("Hello, my value is 2")
       })
     })
@@ -173,7 +174,7 @@ describe("Scaffold", () => {
           })
         ).rejects.toThrow()
 
-        expect(() => readFileSync(process.cwd() + "/output/app_name.txt")).toThrow()
+        expect(() => readFileSync(join(process.cwd(), "output", "app_name.txt"))).toThrow()
       })
     })
   )
@@ -184,12 +185,12 @@ describe("Scaffold", () => {
       test("should allow override function", async () => {
         await Scaffold({
           name: "app_name",
-          output: (fullPath, basedir, basename) => `custom-output/${basename.split(".")[0]}`,
+          output: (fullPath, basedir, basename) => join("custom-output", `${basename.split(".")[0]}`),
           templates: ["input"],
           data: { value: "1" },
           verbose: 0,
         })
-        const data = readFileSync(process.cwd() + "/custom-output/app_name/app_name.txt")
+        const data = readFileSync(join(process.cwd(), "/custom-output/app_name/app_name.txt"))
         expect(data.toString()).toBe("Hello, my app is app_name")
       })
     })
@@ -207,16 +208,16 @@ describe("Scaffold", () => {
           verbose: 0,
         })
 
-        const rootDir = readdirSync(process.cwd() + "/output")
-        const dir = readdirSync(process.cwd() + "/output/AppName")
-        const nestedDir = readdirSync(process.cwd() + "/output/AppName/moreNesting")
+        const rootDir = readdirSync(join(process.cwd(), "output"))
+        const dir = readdirSync(join(process.cwd(), "output", "AppName"))
+        const nestedDir = readdirSync(join(process.cwd(), "output", "AppName", "moreNesting"))
         expect(rootDir).toHaveProperty("length")
         expect(dir).toHaveProperty("length")
         expect(nestedDir).toHaveProperty("length")
 
-        const rootFile = readFileSync(process.cwd() + "/output/app_name-1.txt")
-        const oneDeepFile = readFileSync(process.cwd() + "/output/AppName/app_name-2.txt")
-        const twoDeepFile = readFileSync(process.cwd() + "/output/AppName/moreNesting/app_name-3.txt")
+        const rootFile = readFileSync(join(process.cwd(), "output", "app_name-1.txt"))
+        const oneDeepFile = readFileSync(join(process.cwd(), "output", "AppName/app_name-2.txt"))
+        const twoDeepFile = readFileSync(join(process.cwd(), "output", "AppName/moreNesting/app_name-3.txt"))
         expect(rootFile.toString()).toEqual("This should be in root")
         expect(oneDeepFile.toString()).toEqual("Hello, my value is 1")
         expect(twoDeepFile.toString()).toEqual("Hi! My value is actually NOT 1!")
@@ -252,7 +253,7 @@ describe("Scaffold", () => {
             upperCase: "APP_NAME",
           }
           for (const key in results) {
-            const file = readFileSync(process.cwd() + `/output/defaults/${key}.txt`)
+            const file = readFileSync(join(process.cwd(), "output", "defaults", `${key}.txt`))
             expect(file.toString()).toEqual(results[key as keyof typeof results])
           }
         })
@@ -271,7 +272,7 @@ describe("Scaffold", () => {
             add1: "app_name 1",
           }
           for (const key in results) {
-            const file = readFileSync(process.cwd() + `/output/custom/${key}.txt`)
+            const file = readFileSync(join(process.cwd(), "output", "custom", `${key}.txt`))
             expect(file.toString()).toEqual(results[key as keyof typeof results])
           }
         })
@@ -290,7 +291,7 @@ describe("Scaffold", () => {
           verbose: 0,
         })
 
-        const data = readFileSync(process.cwd() + "/output/app_name/app_name.txt")
+        const data = readFileSync(join(process.cwd(), "output", "app_name", "app_name.txt"))
         expect(data.toString()).toBe("Hello, my app is app_name")
       })
 
@@ -304,7 +305,7 @@ describe("Scaffold", () => {
           subFolderNameHelper: "upperCase",
         })
 
-        const data = readFileSync(process.cwd() + "/output/APP_NAME/app_name.txt")
+        const data = readFileSync(join(process.cwd(), "output", "APP_NAME", "app_name.txt"))
         expect(data.toString()).toBe("Hello, my app is app_name")
       })
 
@@ -321,9 +322,51 @@ describe("Scaffold", () => {
           },
         })
 
-        const data = readFileSync(process.cwd() + "/output/REPLACED/app_name.txt")
+        const data = readFileSync(join(process.cwd(), "output", "REPLACED", "app_name.txt"))
         expect(data.toString()).toBe("Hello, my app is app_name")
       })
     })
   )
+  describe(
+    "before write",
+    withMock(fileStructNormal, () => {
+      test("should work with no callback", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          verbose: 0,
+          data: {
+            value: "value",
+          },
+        })
+
+        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
+        expect(data.toString()).toBe("Hello, my app is app_name")
+      })
+
+      test("should work with custom callback", async () => {
+        await Scaffold({
+          name: "app_name",
+          output: "output",
+          templates: ["input"],
+          verbose: 0,
+          data: {
+            value: "value",
+          },
+          beforeWrite: (content, beforeContent, outputPath) =>
+            [content.toString().toUpperCase(), beforeContent, outputPath].join(", "),
+        })
+
+        const data = readFileSync(join(process.cwd(), "output", "app_name.txt"))
+        expect(data.toString()).toBe(
+          [
+            "Hello, my app is app_name".toUpperCase(),
+            fileStructNormal.input["{{name}}.txt"],
+            join(process.cwd(), "output", "app_name.txt"),
+          ].join(", ")
+        )
+      })
+    })
+  )
 })

tests/utils.test.ts

@@ -0,0 +1,56 @@
+import { handlebarsParse } from "../src/utils"
+import { ScaffoldConfig } from "../src/types"
+import path from "path"
+
+const blankConf: ScaffoldConfig = {
+  verbose: 0,
+  name: "",
+  output: "",
+  templates: [],
+  data: { name: "test" },
+}
+
+describe("Utils", () => {
+  describe("handlebarsParse", () => {
+    let origSep: any
+    describe("windows paths", () => {
+      beforeAll(() => {
+        origSep = path.sep
+        Object.defineProperty(path, "sep", { value: "\\" })
+      })
+      afterAll(() => {
+        Object.defineProperty(path, "sep", { value: origSep })
+      })
+      test("should work for windows paths", async () => {
+        expect(handlebarsParse(blankConf, "C:\\exports\\{{name}}.txt", { isPath: true })).toEqual(
+          Buffer.from("C:\\exports\\test.txt")
+        )
+      })
+    })
+    describe("non-windows paths", () => {
+      beforeAll(() => {
+        origSep = path.sep
+        Object.defineProperty(path, "sep", { value: "/" })
+      })
+      afterAll(() => {
+        Object.defineProperty(path, "sep", { value: origSep })
+      })
+      test("should work for non-windows paths", async () => {
+        expect(handlebarsParse(blankConf, "/home/test/{{name}}.txt", { isPath: true })).toEqual(
+          Buffer.from("/home/test/test.txt")
+        )
+      })
+    })
+    test("should not do path escaping on non-path compiles", async () => {
+      expect(
+        handlebarsParse(
+          { ...blankConf, data: { ...blankConf.data, escaped: "value" } },
+          "/home/test/{{name}} \\{{escaped}}.txt",
+          {
+            isPath: false,
+          }
+        )
+      ).toEqual(Buffer.from("/home/test/test {{escaped}}.txt"))
+    })
+  })
+})

yarn.lock

@@ -537,11 +537,6 @@
   resolved "https://registry.yarnpkg.com/@tsconfig/node16/-/node16-1.0.1.tgz#a6ca6a9a0ff366af433f42f5f0e124794ff6b8f1"
   integrity sha512-FTgBI767POY/lKNDNbIzgAX6miIDBs6NTCbdlDb8TrWovHsSvaVIZDlTqym29C6UqhzwcJx4CYr+AlrMywA0cA==
 
-"@types/args@^3.0.1":
-  version "3.0.1"
-  resolved "https://registry.yarnpkg.com/@types/args/-/args-3.0.1.tgz#59e8e787ed8a810408dd9a324157cc20b7001468"
-  integrity sha512-Mfre8T2comeJbw2D6W8mzQP+0Q8fpS7nkbHgatzU31tWsLs0Lkyc+ObdYfgV4SuMZn/n5MEWlxh2rc25125s0Q==
-
 "@types/babel__core@^7.0.0", "@types/babel__core@^7.1.14":
   version "7.1.15"
   resolved "https://registry.yarnpkg.com/@types/babel__core/-/babel__core-7.1.15.tgz#2ccfb1ad55a02c83f8e0ad327cbc332f55eb1024"
@@ -759,16 +754,6 @@ argparse@^1.0.7:
   dependencies:
     sprintf-js "~1.0.2"
 
-args@^5.0.1:
-  version "5.0.1"
-  resolved "https://registry.yarnpkg.com/args/-/args-5.0.1.tgz#4bf298df90a4799a09521362c579278cc2fdd761"
-  integrity sha512-1kqmFCFsPffavQFGt8OxJdIcETti99kySRUPMpOhaGjL6mRJn8HFU1OxKY5bMqfZKUwTQc1mZkAjmGYaVOHFtQ==
-  dependencies:
-    camelcase "5.0.0"
-    chalk "2.4.2"
-    leven "2.1.0"
-    mri "1.1.4"
-
 asynckit@^0.4.0:
   version "0.4.0"
   resolved "https://registry.yarnpkg.com/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79"
@@ -903,11 +888,6 @@ callsites@^3.0.0:
   resolved "https://registry.yarnpkg.com/callsites/-/callsites-3.1.0.tgz#b3630abd8943432f54b3f0519238e33cd7df2f73"
   integrity sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==
 
-camelcase@5.0.0:
-  version "5.0.0"
-  resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-5.0.0.tgz#03295527d58bd3cd4aa75363f35b2e8d97be2f42"
-  integrity sha512-faqwZqnWxbxn+F1d399ygeamQNy3lPp/H9H6rNrqYh4FSVCtcY+3cub1MxA8o9mDd55mM8Aghuu/kuyYA6VTsA==
-
 camelcase@^5.3.1:
   version "5.3.1"
   resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-5.3.1.tgz#e3c9b31569e106811df242f715725a1f4c494320"
@@ -923,7 +903,7 @@ caniuse-lite@^1.0.30001219:
   resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001245.tgz#45b941bbd833cb0fa53861ff2bae746b3c6ca5d4"
   integrity sha512-768fM9j1PKXpOCKws6eTo3RHmvTUsG9UrpT4WoREFeZgJBTi4/X9g565azS/rVUGtqb8nt7FjLeF5u4kukERnA==
 
-chalk@2.4.2, chalk@^2.0.0:
+chalk@^2.0.0:
   version "2.4.2"
   resolved "https://registry.yarnpkg.com/chalk/-/chalk-2.4.2.tgz#cd42541677a54333cf541a49108c1432b44c9424"
   integrity sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==
@@ -2105,11 +2085,6 @@ kleur@^3.0.3:
   resolved "https://registry.yarnpkg.com/kleur/-/kleur-3.0.3.tgz#a79c9ecc86ee1ce3fa6206d1216c501f147fc07e"
   integrity sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==
 
-leven@2.1.0:
-  version "2.1.0"
-  resolved "https://registry.yarnpkg.com/leven/-/leven-2.1.0.tgz#c2e7a9f772094dee9d34202ae8acce4687875580"
-  integrity sha1-wuep93IJTe6dNCAq6KzORoeHVYA=
-
 leven@^3.1.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/leven/-/leven-3.1.0.tgz#77891de834064cccba82ae7842bb6b14a13ed7f2"
@@ -2207,9 +2182,9 @@ minimatch@^3.0.4:
     brace-expansion "^1.1.7"
 
 minimist@^1.2.5:
-  version "1.2.5"
-  resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.5.tgz#67d66014b66a6a8aaa0c083c5fd58df4e4e97602"
-  integrity sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==
+  version "1.2.6"
+  resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.6.tgz#8637a5b759ea0d6e98702cfb3a9283323c93af44"
+  integrity sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==
 
 mkdirp@1.x:
   version "1.0.4"
@@ -2221,11 +2196,6 @@ mock-fs@^5.0.0:
   resolved "https://registry.yarnpkg.com/mock-fs/-/mock-fs-5.0.0.tgz#5574520ac824c01a10091bf951c66f677c71acaa"
   integrity sha512-A5mm/SpSDwwc/klSaEvvKMGQQtiGiQy8UcDAd/vpVO1fV+4zaHjt39yKgCSErFzv2zYxZIUx9Ud/7ybeHBf8Fg==
 
-mri@1.1.4:
-  version "1.1.4"
-  resolved "https://registry.yarnpkg.com/mri/-/mri-1.1.4.tgz#7cb1dd1b9b40905f1fac053abe25b6720f44744a"
-  integrity sha512-6y7IjGPm8AzlvoUrwAaw1tLnUBudaS3752vcd8JtrpGGQn+rXIe63LFVHm/YMwtqAuh+LJPCFdlLYPWM1nYn6w==
-
 ms@2.1.2:
   version "2.1.2"
   resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.2.tgz#d09d1f357b443f493382a8eb3ccd183872ae6009"
@@ -2469,7 +2439,7 @@ resolve@^1.20.0:
     is-core-module "^2.2.0"
     path-parse "^1.0.6"
 
-rimraf@^3.0.0:
+rimraf@^3.0.0, rimraf@^3.0.2:
   version "3.0.2"
   resolved "https://registry.yarnpkg.com/rimraf/-/rimraf-3.0.2.tgz#f1a5402ba6220ad52cc1282bac1ae3aa49fd061a"
   integrity sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==