simple-scaffold 1.3.0 → 1.3.2

package/cmd.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export declare function parseCliArgs(args?: string[]): Promise<void>;

package/cmd.js

@@ -0,0 +1,127 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseCliArgs = void 0;
+const massarg_1 = __importDefault(require("massarg"));
+const chalk_1 = __importDefault(require("chalk"));
+const types_1 = require("./types");
+const scaffold_1 = require("./scaffold");
+const path_1 = __importDefault(require("path"));
+const promises_1 = __importDefault(require("fs/promises"));
+const utils_1 = require("./utils");
+async function parseCliArgs(args = process.argv.slice(2)) {
+    const pkg = JSON.parse((await promises_1.default.readFile(path_1.default.join(__dirname, "package.json"))).toString());
+    const isConfig = args.includes("--config") || args.includes("-c");
+    return ((0, massarg_1.default)()
+        .main((config) => {
+        const _config = (0, utils_1.parseConfig)(config);
+        return (0, scaffold_1.Scaffold)(_config);
+    })
+        .option({
+        name: "name",
+        aliases: ["n"],
+        description: "Name to be passed to the generated files. {{name}} and {{Name}} inside contents and file names will be replaced accordingly.",
+        isDefault: true,
+        required: true,
+    })
+        .option({
+        name: "config",
+        aliases: ["c"],
+        description: "Filename to load config from instead of passing arguments to CLI or using a Node.js script. You may pass a JSON or JS file, with a relative or absolute path.",
+    })
+        .option({
+        name: "output",
+        aliases: ["o"],
+        description: `Path to output to. If --create-sub-folder is enabled, the subfolder will be created inside this path. ${chalk_1.default.reset `${chalk_1.default.white `(default: current dir)`}`}`,
+        required: !isConfig,
+    })
+        .option({
+        name: "templates",
+        aliases: ["t"],
+        array: true,
+        description: "Template files to use as input. You may provide multiple files, each of which can be a relative or absolute path, " +
+            "or a glob pattern for multiple file matching easily.",
+        required: !isConfig,
+    })
+        .option({
+        name: "overwrite",
+        aliases: ["w"],
+        boolean: true,
+        defaultValue: false,
+        description: "Enable to override output files, even if they already exist.",
+    })
+        .option({
+        name: "data",
+        aliases: ["d"],
+        description: "Add custom data to the templates. By default, only your app name is included.",
+        parse: (v) => JSON.parse(v),
+    })
+        .option({
+        name: "append-data",
+        aliases: ["D"],
+        description: "Append additional custom data to the templates, which will overwrite --data, using an alternate syntax, which is easier to use with CLI: -D key1=string -D key2:=raw",
+        parse: utils_1.parseAppendData,
+    })
+        .option({
+        name: "create-sub-folder",
+        aliases: ["s"],
+        boolean: true,
+        defaultValue: false,
+        description: "Create subfolder with the input name",
+    })
+        .option({
+        name: "sub-folder-name-helper",
+        aliases: ["sh"],
+        description: "Default helper to apply to subfolder name when using `--create-sub-folder true`.",
+    })
+        .option({
+        name: "quiet",
+        aliases: ["q"],
+        boolean: true,
+        defaultValue: false,
+        description: "Suppress output logs (Same as --verbose 0)",
+    })
+        .option({
+        name: "verbose",
+        aliases: ["v"],
+        defaultValue: types_1.LogLevel.Info,
+        description: "Determine amount of logs to display. The values are: " +
+            `${chalk_1.default.bold `0 (none) | 1 (debug) | 2 (info) | 3 (warn) | 4 (error)`}. ` +
+            "The provided level will display messages of the same level or higher.",
+        parse: Number,
+    })
+        .option({
+        name: "dry-run",
+        aliases: ["dr"],
+        boolean: true,
+        defaultValue: false,
+        description: "Don't emit files. This is good for testing your scaffolds and making sure they " +
+            "don't fail, without having to write actual file contents or create directories.",
+    })
+        // .example({
+        //   input: `yarn cmd -t examples/test-input/Component -o examples/test-output -d '{"property":"myProp","value":"10"}'`,
+        //   description: "Usage",
+        //   output: "",
+        // })
+        .help({
+        binName: "simple-scaffold",
+        useGlobalColumns: true,
+        usageExample: "[options]",
+        header: [`Create structured files based on templates.`].join("\n"),
+        footer: [
+            `Version:  ${pkg.version}`,
+            `Copyright © Chen Asraf 2017-${new Date().getFullYear()}`,
+            ``,
+            `Documentation: ${chalk_1.default.underline `https://casraf.dev/simple-scaffold`}`,
+            `NPM: ${chalk_1.default.underline `https://npmjs.com/package/simple-scaffold`}`,
+            `GitHub: ${chalk_1.default.underline `https://github.com/chenasraf/simple-scaffold`}`,
+        ].join("\n"),
+    })
+        .parse(args));
+}
+exports.parseCliArgs = parseCliArgs;
+parseCliArgs();
+//# sourceMappingURL=cmd.js.map

package/cmd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cmd.js","sourceRoot":"","sources":["../src/cmd.ts"],"names":[],"mappings":";;;;;;;AACA,sDAA6B;AAC7B,kDAAyB;AACzB,mCAAqD;AACrD,yCAAqC;AACrC,gDAAuB;AACvB,2DAA4B;AAC5B,mCAAsD;AAE/C,KAAK,UAAU,YAAY,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7D,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,kBAAE,CAAC,QAAQ,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC5F,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IAEjE,OAAO,CACL,IAAA,iBAAO,GAAqB;SACzB,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;QACf,MAAM,OAAO,GAAG,IAAA,mBAAW,EAAC,MAAM,CAAC,CAAA;QACnC,OAAO,IAAA,mBAAQ,EAAC,OAAO,CAAC,CAAA;IAC1B,CAAC,CAAC;SACD,MAAM,CAAC;QACN,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,CAAC,GAAG,CAAC;QACd,WAAW,EACT,8HAA8H;QAChI,SAAS,EAAE,IAAI;QACf,QAAQ,EAAE,IAAI;KACf,CAAC;SACD,MAAM,CAAC;QACN,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC,GAAG,CAAC;QACd,WAAW,EACT,+JAA+J;KAClK,CAAC;SACD,MAAM,CAAC;QACN,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC,GAAG,CAAC;QACd,WAAW,EAAE,yGAAyG,eAAK,CAAC,KAAK,CAAA,GAAG,eAAK,CAAC,KAAK,CAAA,wBAAwB,EAAE,EAAE;QAC3K,QAAQ,EAAE,CAAC,QAAQ;KACpB,CAAC;SACD,MAAM,CAAC;QACN,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,CAAC,GAAG,CAAC;QACd,KAAK,EAAE,IAAI;QACX,WAAW,EACT,oHAAoH;YACpH,sDAAsD;QACxD,QAAQ,EAAE,CAAC,QAAQ;KACpB,CAAC;SACD,MAAM,CAAC;QACN,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,CAAC,GAAG,CAAC;QACd,OAAO,EAAE,IAAI;QACb,YAAY,EAAE,KAAK;QACnB,WAAW,EAAE,8DAA8D;KAC5E,CAAC;SACD,MAAM,CAAC;QACN,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,CAAC,GAAG,CAAC;QACd,WAAW,EAAE,+EAA+E;QAC5F,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;KAC5B,CAAC;SACD,MAAM,CAAC;QACN,IAAI,EAAE,aAAa;QACnB,OAAO,EAAE,CAAC,GAAG,CAAC;QACd,WAAW,EACT,sKAAsK;QACxK,KAAK,EAAE,uBAAe;KACvB,CAAC;SACD,MAAM,CAAC;QACN,IAAI,EAAE,mBAAmB;QACzB,OAAO,EAAE,CAAC,GAAG,CAAC;QACd,OAAO,EAAE,IAAI;QACb,YAAY,EAAE,KAAK;QACnB,WAAW,EAAE,sCAAsC;KACpD,CAAC;SACD,MAAM,CAAC;QACN,IAAI,EAAE,wBAAwB;QAC9B,OAAO,EAAE,CAAC,IAAI,CAAC;QACf,WAAW,EAAE,kFAAkF;KAChG,CAAC;SACD,MAAM,CAAC;QACN,IAAI,EAAE,OAAO;QACb,OAAO,EAAE,CAAC,GAAG,CAAC;QACd,OAAO,EAAE,IAAI;QACb,YAAY,EAAE,KAAK;QACnB,WAAW,EAAE,4CAA4C;KAC1D,CAAC;SACD,MAAM,CAAC;QACN,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,CAAC,GAAG,CAAC;QACd,YAAY,EAAE,gBAAQ,CAAC,IAAI;QAC3B,WAAW,EACT,uDAAuD;YACvD,GAAG,eAAK,CAAC,IAAI,CAAA,wDAAwD,IAAI;YACzE,uEAAuE;QACzE,KAAK,EAAE,MAAM;KACd,CAAC;SACD,MAAM,CAAC;QACN,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,CAAC,IAAI,CAAC;QACf,OAAO,EAAE,IAAI;QACb,YAAY,EAAE,KAAK;QACnB,WAAW,EACT,iFAAiF;YACjF,iFAAiF;KACpF,CAAC;QACF,aAAa;QACb,wHAAwH;QACxH,0BAA0B;QAC1B,gBAAgB;QAChB,KAAK;SACJ,IAAI,CAAC;QACJ,OAAO,EAAE,iBAAiB;QAC1B,gBAAgB,EAAE,IAAI;QACtB,YAAY,EAAE,WAAW;QACzB,MAAM,EAAE,CAAC,6CAA6C,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAClE,MAAM,EAAE;YACN,aAAa,GAAG,CAAC,OAAO,EAAE;YAC1B,+BAA+B,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE;YACzD,EAAE;YACF,kBAAkB,eAAK,CAAC,SAAS,CAAA,oCAAoC,EAAE;YACvE,QAAQ,eAAK,CAAC,SAAS,CAAA,2CAA2C,EAAE;YACpE,WAAW,eAAK,CAAC,SAAS,CAAA,8CAA8C,EAAE;SAC3E,CAAC,IAAI,CAAC,IAAI,CAAC;KACb,CAAC;SACD,KAAK,CAAC,IAAI,CAAC,CACf,CAAA;AACH,CAAC;AAtHD,oCAsHC;AAED,YAAY,EAAE,CAAA"}

package/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./scaffold";
+export * from "./types";
+import Scaffold from "./scaffold";
+export default Scaffold;

package/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./scaffold"), exports);
+__exportStar(require("./types"), exports);
+const scaffold_1 = __importDefault(require("./scaffold"));
+exports.default = scaffold_1.default;
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAAA,6CAA0B;AAC1B,0CAAuB;AACvB,0DAAiC;AACjC,kBAAe,kBAAQ,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-scaffold",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "A simple command to generate any file structure, from single components to entire app boilerplates.",
   "homepage": "https://casraf.dev/simple-scaffold",
   "repository": "https://github.com/chenasraf/simple-scaffold.git",
@@ -63,8 +63,5 @@
     "ts-node": "^10.9.1",
     "typedoc": "^0.24.6",
     "typescript": "^5.0.4"
-  },
-  "peerDependencies": {
-    "doc-theme": "file:./doc-theme"
   }
 }

package/scaffold.d.ts

@@ -0,0 +1,34 @@
+import { ScaffoldConfig } from "./types";
+/**
+ * Create a scaffold using given `options`.
+ *
+ * #### Create files
+ * To create a file structure to output, use any directory and file structure you would like.
+ * Inside folder names, file names or file contents, you may place `{{ var }}` where `var` is either
+ * `name` which is the scaffold name you provided or one of the keys you provided in the `data` option.
+ *
+ * The contents and names will be replaced with the transformed values so you can use your original structure as a
+ * boilerplate for other projects, components, modules, or even single files.
+ *
+ * The files will maintain their structure, starting from the directory containing the template (or the template itself
+ * if it is already a directory), and will output from that directory into the directory defined by `config.output`.
+ *
+ * #### Helpers
+ * Helpers are functions you can use to transform your `{{ var }}` contents into other values without having to
+ * pre-define the data and use a duplicated key.
+ *
+ * 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)
+ *
+ * For available default values, see {@link DefaultHelpers}.
+ *
+ * @param {ScaffoldConfig} config The main configuration object
+ *
+ * @see {@link DefaultHelpers}
+ * @see {@link CaseHelpers}
+ * @see {@link DateHelpers}
+ *
+ * @category Main
+ */
+export declare function Scaffold(config: ScaffoldConfig): Promise<void>;
+export default Scaffold;

package/scaffold.js

@@ -0,0 +1,113 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Scaffold = void 0;
+/**
+ * @module
+ * Simple Scaffold
+ *
+ * See [readme](README.md)
+ */
+const path_1 = __importDefault(require("path"));
+const utils_1 = require("./utils");
+const types_1 = require("./types");
+/**
+ * Create a scaffold using given `options`.
+ *
+ * #### Create files
+ * To create a file structure to output, use any directory and file structure you would like.
+ * Inside folder names, file names or file contents, you may place `{{ var }}` where `var` is either
+ * `name` which is the scaffold name you provided or one of the keys you provided in the `data` option.
+ *
+ * The contents and names will be replaced with the transformed values so you can use your original structure as a
+ * boilerplate for other projects, components, modules, or even single files.
+ *
+ * The files will maintain their structure, starting from the directory containing the template (or the template itself
+ * if it is already a directory), and will output from that directory into the directory defined by `config.output`.
+ *
+ * #### Helpers
+ * Helpers are functions you can use to transform your `{{ var }}` contents into other values without having to
+ * pre-define the data and use a duplicated key.
+ *
+ * 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)
+ *
+ * For available default values, see {@link DefaultHelpers}.
+ *
+ * @param {ScaffoldConfig} config The main configuration object
+ *
+ * @see {@link DefaultHelpers}
+ * @see {@link CaseHelpers}
+ * @see {@link DateHelpers}
+ *
+ * @category Main
+ */
+async function Scaffold(config) {
+    var _a;
+    (_a = config.output) !== null && _a !== void 0 ? _a : (config.output = process.cwd());
+    (0, utils_1.registerHelpers)(config);
+    try {
+        config.data = { name: config.name, Name: (0, utils_1.pascalCase)(config.name), ...config.data };
+        (0, utils_1.logInitStep)(config);
+        for (let _template of config.templates) {
+            try {
+                const { nonGlobTemplate, origTemplate, isDirOrGlob, isGlob, template } = await (0, utils_1.getTemplateGlobInfo)(config, _template);
+                const files = await (0, utils_1.getFileList)(config, template);
+                for (const inputFilePath of files) {
+                    if (await (0, utils_1.isDir)(inputFilePath)) {
+                        continue;
+                    }
+                    const relPath = (0, utils_1.makeRelativePath)(path_1.default.dirname((0, utils_1.removeGlob)(inputFilePath).replace(nonGlobTemplate, "")));
+                    const basePath = (0, utils_1.getBasePath)(relPath);
+                    (0, utils_1.logInputFile)(config, {
+                        origTemplate,
+                        relPath,
+                        template,
+                        inputFilePath,
+                        nonGlobTemplate,
+                        basePath,
+                        isDirOrGlob,
+                        isGlob,
+                    });
+                    await handleTemplateFile(config, {
+                        templatePath: inputFilePath,
+                        basePath,
+                    });
+                }
+            }
+            catch (e) {
+                (0, utils_1.handleErr)(e);
+            }
+        }
+    }
+    catch (e) {
+        (0, utils_1.log)(config, types_1.LogLevel.Error, e);
+        throw e;
+    }
+}
+exports.Scaffold = Scaffold;
+async function handleTemplateFile(config, { templatePath, basePath }) {
+    return new Promise(async (resolve, reject) => {
+        var _a;
+        try {
+            const { inputPath, outputPathOpt, outputDir, outputPath, exists } = await (0, utils_1.getTemplateFileInfo)(config, {
+                templatePath,
+                basePath,
+            });
+            const overwrite = (0, utils_1.getOptionValueForFile)(config, inputPath, (_a = config.overwrite) !== null && _a !== void 0 ? _a : false);
+            (0, utils_1.log)(config, types_1.LogLevel.Debug, `\nParsing ${templatePath}`, `\nBase path: ${basePath}`, `\nFull input path: ${inputPath}`, `\nOutput Path Opt: ${outputPathOpt}`, `\nFull output dir: ${outputDir}`, `\nFull output path: ${outputPath}`, `\n`);
+            await (0, utils_1.createDirIfNotExists)(path_1.default.dirname(outputPath), config);
+            (0, utils_1.log)(config, types_1.LogLevel.Info, `Writing to ${outputPath}`);
+            await (0, utils_1.copyFileTransformed)(config, { exists, overwrite, outputPath, inputPath });
+            resolve();
+        }
+        catch (e) {
+            (0, utils_1.handleErr)(e);
+            reject(e);
+        }
+    });
+}
+exports.default = Scaffold;
+//# sourceMappingURL=scaffold.js.map

package/scaffold.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffold.js","sourceRoot":"","sources":["../src/scaffold.ts"],"names":[],"mappings":";;;;;;AAAA;;;;;GAKG;AACH,gDAAuB;AAEvB,mCAiBgB;AAChB,mCAAkD;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACI,KAAK,UAAU,QAAQ,CAAC,MAAsB;;IACnD,MAAA,MAAM,CAAC,MAAM,oCAAb,MAAM,CAAC,MAAM,GAAK,OAAO,CAAC,GAAG,EAAE,EAAA;IAE/B,IAAA,uBAAe,EAAC,MAAM,CAAC,CAAA;IACvB,IAAI;QACF,MAAM,CAAC,IAAI,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,IAAA,kBAAU,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,EAAE,CAAA;QAClF,IAAA,mBAAW,EAAC,MAAM,CAAC,CAAA;QACnB,KAAK,IAAI,SAAS,IAAI,MAAM,CAAC,SAAS,EAAE;YACtC,IAAI;gBACF,MAAM,EAAE,eAAe,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAA,2BAAmB,EAChG,MAAM,EACN,SAAS,CACV,CAAA;gBACD,MAAM,KAAK,GAAG,MAAM,IAAA,mBAAW,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;gBACjD,KAAK,MAAM,aAAa,IAAI,KAAK,EAAE;oBACjC,IAAI,MAAM,IAAA,aAAK,EAAC,aAAa,CAAC,EAAE;wBAC9B,SAAQ;qBACT;oBACD,MAAM,OAAO,GAAG,IAAA,wBAAgB,EAAC,cAAI,CAAC,OAAO,CAAC,IAAA,kBAAU,EAAC,aAAa,CAAC,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;oBACtG,MAAM,QAAQ,GAAG,IAAA,mBAAW,EAAC,OAAO,CAAC,CAAA;oBACrC,IAAA,oBAAY,EAAC,MAAM,EAAE;wBACnB,YAAY;wBACZ,OAAO;wBACP,QAAQ;wBACR,aAAa;wBACb,eAAe;wBACf,QAAQ;wBACR,WAAW;wBACX,MAAM;qBACP,CAAC,CAAA;oBACF,MAAM,kBAAkB,CAAC,MAAM,EAAE;wBAC/B,YAAY,EAAE,aAAa;wBAC3B,QAAQ;qBACT,CAAC,CAAA;iBACH;aACF;YAAC,OAAO,CAAM,EAAE;gBACf,IAAA,iBAAS,EAAC,CAAC,CAAC,CAAA;aACb;SACF;KACF;IAAC,OAAO,CAAM,EAAE;QACf,IAAA,WAAG,EAAC,MAAM,EAAE,gBAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QAC9B,MAAM,CAAC,CAAA;KACR;AACH,CAAC;AA3CD,4BA2CC;AACD,KAAK,UAAU,kBAAkB,CAC/B,MAAsB,EACtB,EAAE,YAAY,EAAE,QAAQ,EAA8C;IAEtE,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;;QAC3C,IAAI;YACF,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,MAAM,IAAA,2BAAmB,EAAC,MAAM,EAAE;gBACpG,YAAY;gBACZ,QAAQ;aACT,CAAC,CAAA;YACF,MAAM,SAAS,GAAG,IAAA,6BAAqB,EAAC,MAAM,EAAE,SAAS,EAAE,MAAA,MAAM,CAAC,SAAS,mCAAI,KAAK,CAAC,CAAA;YAErF,IAAA,WAAG,EACD,MAAM,EACN,gBAAQ,CAAC,KAAK,EACd,aAAa,YAAY,EAAE,EAC3B,gBAAgB,QAAQ,EAAE,EAC1B,sBAAsB,SAAS,EAAE,EACjC,sBAAsB,aAAa,EAAE,EACrC,sBAAsB,SAAS,EAAE,EACjC,uBAAuB,UAAU,EAAE,EACnC,IAAI,CACL,CAAA;YAED,MAAM,IAAA,4BAAoB,EAAC,cAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,CAAA;YAE5D,IAAA,WAAG,EAAC,MAAM,EAAE,gBAAQ,CAAC,IAAI,EAAE,cAAc,UAAU,EAAE,CAAC,CAAA;YACtD,MAAM,IAAA,2BAAmB,EAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAA;YAC/E,OAAO,EAAE,CAAA;SACV;QAAC,OAAO,CAAM,EAAE;YACf,IAAA,iBAAS,EAAC,CAAC,CAAC,CAAA;YACZ,MAAM,CAAC,CAAC,CAAC,CAAA;SACV;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,kBAAe,QAAQ,CAAA"}

package/types.d.ts

@@ -0,0 +1,310 @@
+/// <reference types="node" />
+import { HelperDelegate } from "handlebars/runtime";
+/**
+ * The config object for defining a scaffolding group.
+ *
+ * @see https://github.com/chenasraf/simple-scaffold#readme
+ * @see {@link DefaultHelpers}
+ * @see {@link CaseHelpers}
+ * @see {@link DateHelpers}
+ *
+ * @category Config
+ */
+export interface ScaffoldConfig {
+    /**
+     * Name to be passed to the generated files. `{{name}}` and `{{Name}}` inside contents and file names will be replaced
+     * accordingly.
+     */
+    name: string;
+    /**
+     * Template files to use as input. You may provide multiple files, each of which can be a relative or absolute path,
+     * or a glob pattern for multiple file matching easily.
+     *
+     * @default Current working directory
+     */
+    templates: string[];
+    /**
+     * Path to output to. If `createSubFolder` is `true`, the subfolder will be created inside this path.
+     *
+     * May also be a {@link FileResponseHandler} which returns a new output path to override the default one.
+     *
+     * @see {@link FileResponse}
+     * @see {@link FileResponseHandler}
+     */
+    output: FileResponse<string>;
+    /**
+     * Whether to create subfolder with the input name.
+     *
+     * When `true`, you may also use {@link subFolderNameHelper} to determine a pre-process helper on
+     * the directory name.
+     *
+     * @default `false`
+     */
+    createSubFolder?: boolean;
+    /**
+     * Add custom data to the templates. By default, only your app name is included as `{{name}}` and `{{Name}}`.
+     *
+     * This can be any object that will be usable by Handlebars.
+     */
+    data?: Record<string, any>;
+    /**
+     * Enable to override output files, even if they already exist.
+     *
+     * You may supply a function to this option, which can take the arguments `(fullPath, baseDir, baseName)` and returns
+     * a string, to return a dynamic path for each file.
+     *
+     * May also be a {@link FileResponseHandler} which returns a boolean value per file.
+     *
+     * @see {@link FileResponse}
+     * @see {@link FileResponseHandler}
+     *
+     * @default `false`
+     */
+    overwrite?: FileResponse<boolean>;
+    /**
+     * Suppress output logs (Same as `verbose: 0` or `verbose: LogLevel.None`)
+     *  @see {@link verbose}
+     */
+    quiet?: boolean;
+    /**
+     * Determine amount of logs to display.
+     *
+     * The values are: `0 (none) | 1 (debug) | 2 (info) | 3 (warn) | 4 (error)`. The provided level will display messages
+     * of the same level or higher.
+     *
+     * @see {@link LogLevel}
+     *
+     * @default `2 (info)`
+     */
+    verbose?: LogLevel;
+    /**
+     * Don't emit files. This is good for testing your scaffolds and making sure they don't fail, without having to write
+     * actual file contents or create directories.
+     *
+     * @default `false`
+     */
+    dryRun?: boolean;
+    /**
+     * Additional helpers to add to the template parser. Provide an object whose keys are the name of the function to add,
+     * and the value is the helper function itself. The signature of helpers is as follows:
+     * ```typescript
+     * (text: string, ...args: any[]) => string
+     * ```
+     *
+     * A full example might be:
+     *
+     * ```typescript
+     * Scaffold({
+     *   //...
+     *   helpers: {
+     *     upperKebabCase: (text) => kebabCase(text).toUpperCase()
+     *   }
+     * })
+     * ```
+     *
+     * Which will allow:
+     *
+     * ```
+     * {{ upperKebabCase "my value" }}
+     * ```
+     *
+     * To transform to:
+     *
+     * ```
+     * MY-VALUE
+     * ```
+     *
+     * See {@link DefaultHelpers} for a list of all the built-in available helpers.
+     *
+     * Simple Scaffold uses Handlebars.js, so all the syntax from there is supported. See
+     * [their docs](https://handlebarsjs.com/guide/#custom-helpers) for more information.
+     *
+     * @see {@link DefaultHelpers}
+     * @see {@link CaseHelpers}
+     * @see {@link DateHelpers}
+     * @see https://casraf.dev/simple-scaffold#helpers
+     * @see https://casraf.dev/simple-scaffold#built-in-helpers
+     * @see https://handlebarsjs.com/guide/#custom-helpers
+     */
+    helpers?: Record<string, Helper>;
+    /**
+     * Default transformer to apply to subfolder name when using `createSubFolder: true`. Can be one of the default
+     * capitalization helpers, or a custom one you provide to `helpers`. Defaults to `undefined`, which means no
+     * transformation is done.
+     *
+     * @see {@link createSubFolder}
+     * @see {@link CaseHelpers}
+     * @see {@link DefaultHelpers}
+     */
+    subFolderNameHelper?: DefaultHelpers | 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 {Promise<String | Buffer | undefined> | 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 | Promise<string | Buffer | undefined>;
+}
+/**
+ * The names of the available helper functions that relate to text capitalization.
+ *
+ * These are available for `subfolderNameHelper`.
+ *
+ * | 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 }}`  | MY NAME        |
+ * | `lowerCase`  | `{{ lowerCase name }}`  | my name        |
+ *
+ * @see {@link DefaultHelpers}
+ * @see {@link DateHelpers}
+ * @see {@link ScaffoldConfig}
+ * @see {@link ScaffoldConfig.subFolderNameHelper}
+ *
+ * @category Helpers
+ */
+export type CaseHelpers = "camelCase" | "hyphenCase" | "kebabCase" | "lowerCase" | "pascalCase" | "snakeCase" | "startCase" | "upperCase";
+/**
+ * The names of the available helper functions that relate to dates.
+ *
+ * | Helper name                      | Description                                                      | Example code                                                     | Example output     |
+ * | -------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ------------------ |
+ * | `now`                            | Current date with format                                         | `{{ now "yyyy-MM-dd HH:mm" }}`                                   | `2042-01-01 15:00` |
+ * | `now` (with offset)              | Current date with format, and with offset                        | `{{ now "yyyy-MM-dd HH:mm" -1 "hours" }}`                        | `2042-01-01 14:00` |
+ * | `date`                           | Custom date with format                                          | `{{ date "2042-01-01T15:00:00Z" "yyyy-MM-dd HH:mm" }}`           | `2042-01-01 15:00` |
+ * | `date` (with offset)             | Custom date with format, and with offset                         | `{{ date "2042-01-01T15:00:00Z" "yyyy-MM-dd HH:mm" -1 "days" }}` | `2041-31-12 15:00` |
+ * | `date` (with date from `--data`) | Custom date with format, with data from the `data` config option | `{{ date myCustomDate "yyyy-MM-dd HH:mm" }}`                     | `2042-01-01 12:00` |
+ *
+ * Further details:
+ *
+ * - We use [`date-fns`](https://date-fns.org/docs/) for parsing/manipulating the dates. If you want
+ *   more information on the date tokens to use, refer to
+ *   [their format documentation](https://date-fns.org/docs/format).
+ *
+ * - The date helper format takes the following arguments:
+ *
+ *   ```typescript
+ *   (
+ *     date: string,
+ *     format: string,
+ *     offsetAmount?: number,
+ *     offsetType?: "years" | "months" | "weeks" | "days" | "hours" | "minutes" | "seconds"
+ *   )
+ *   ```
+ *
+ * - **The now helper** (for current time) takes the same arguments, minus the first one (`date`) as it is implicitly
+ *   the current date.
+ *
+ * @see {@link DefaultHelpers}
+ * @see {@link CaseHelpers}
+ * @see {@link ScaffoldConfig}
+ *
+ * @category Helpers
+ */
+export type DateHelpers = "date" | "now";
+/**
+ * The names of all the available helper functions in templates.
+ * Simple-Scaffold provides some built-in text transformation filters usable by Handlebars.js.
+ *
+ * For example, you may use `{{ snakeCase name }}` inside a template file or filename, and it will
+ * replace `My Name` with `my_name` when producing the final value.
+ *
+ * @see {@link CaseHelpers}
+ * @see {@link DateHelpers}
+ * @see {@link ScaffoldConfig}
+ *
+ * @category Helpers
+ */
+export type DefaultHelpers = CaseHelpers | DateHelpers;
+/**
+ * Helper function, see https://handlebarsjs.com/guide/#custom-helpers
+ *
+ * @category Helpers
+ */
+export type Helper = HelperDelegate;
+/**
+ * The amount of information to log when generating scaffold.
+ * When not `None`, the selected level will be the lowest level included.
+ *
+ * For example, level `Info` (2) will include `Info`, `Warning` and `Error`, but not `Debug`; and `Warning` will only
+ * show `Warning` and `Error`.
+ *
+ * @default `2 (info)`
+ *
+ * @category Logging
+ */
+export declare enum LogLevel {
+    /** Silent output */
+    None = 0,
+    /** Debugging information. Very verbose and only recommended for troubleshooting. */
+    Debug = 1,
+    /**
+     * The regular level of logging. Major actions are logged to show the scaffold progress.
+     *
+     * @default
+     */
+    Info = 2,
+    /** Warnings such as when file fails to replace token values properly in template. */
+    Warning = 3,
+    /** Errors, such as missing files, bad replacement token syntax, or un-writable directories. */
+    Error = 4
+}
+/**
+ * A function that takes path information about file, and returns a value of type `T`
+ *
+ * @template T The return type for the function
+ * @param {string} fullPath The full path of the current file
+ * @param {string} basedir The directory containing the current file
+ * @param {string} basename The name of the file
+ *
+ * @returns {T} A return value
+ *
+ * @category Config
+ */
+export type FileResponseHandler<T> = (fullPath: string, basedir: string, basename: string) => T;
+/**
+ * Represents a response for file path information.
+ * Can either be:
+ *
+ * 1. `T` - static value
+ * 2. A function with the following signature which returns `T`:
+ *    ```typescript
+ *    (fullPath: string, basedir: string, basename: string) => T
+ *    ```
+ *
+ * @typedef T The return type
+ *
+ * @see {@link FileResponseHandler}
+ *
+ * @category Config
+ * */
+export type FileResponse<T> = T | FileResponseHandler<T>;
+/** @internal */
+export interface ScaffoldCmdConfig {
+    name: string;
+    templates: string[];
+    output: string;
+    createSubFolder: boolean;
+    data?: Record<string, string>;
+    appendData?: Record<string, string>;
+    overwrite: boolean;
+    quiet: boolean;
+    verbose: LogLevel;
+    dryRun: boolean;
+    config?: string;
+}
+export type ScaffoldConfigFile = Record<string, ScaffoldConfig>;