simple-scaffold 1.6.0-develop.1 → 1.7.0-develop.1

package/parser.js

@@ -0,0 +1,83 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handlebarsParse = exports.registerHelpers = exports.pascalCase = exports.dateHelper = exports.nowHelper = exports._dateHelper = exports.defaultHelpers = void 0;
+const path_1 = __importDefault(require("path"));
+const types_1 = require("./types");
+const camelCase_1 = __importDefault(require("lodash/camelCase"));
+const snakeCase_1 = __importDefault(require("lodash/snakeCase"));
+const kebabCase_1 = __importDefault(require("lodash/kebabCase"));
+const startCase_1 = __importDefault(require("lodash/startCase"));
+const handlebars_1 = __importDefault(require("handlebars"));
+const add_1 = __importDefault(require("date-fns/add"));
+const format_1 = __importDefault(require("date-fns/format"));
+const parseISO_1 = __importDefault(require("date-fns/parseISO"));
+const logger_1 = require("./logger");
+const dateFns = {
+    add: add_1.default,
+    format: format_1.default,
+    parseISO: parseISO_1.default,
+};
+exports.defaultHelpers = {
+    camelCase: camelCase_1.default,
+    snakeCase: snakeCase_1.default,
+    startCase: startCase_1.default,
+    kebabCase: kebabCase_1.default,
+    hyphenCase: kebabCase_1.default,
+    pascalCase,
+    lowerCase: (text) => text.toLowerCase(),
+    upperCase: (text) => text.toUpperCase(),
+    now: nowHelper,
+    date: dateHelper,
+};
+function _dateHelper(date, formatString, durationDifference, durationType) {
+    if (durationType && durationDifference !== undefined) {
+        return dateFns.format(dateFns.add(date, { [durationType]: durationDifference }), formatString);
+    }
+    return dateFns.format(date, formatString);
+}
+exports._dateHelper = _dateHelper;
+function nowHelper(formatString, durationDifference, durationType) {
+    return _dateHelper(new Date(), formatString, durationDifference, durationType);
+}
+exports.nowHelper = nowHelper;
+function dateHelper(date, formatString, durationDifference, durationType) {
+    return _dateHelper(dateFns.parseISO(date), formatString, durationDifference, durationType);
+}
+exports.dateHelper = dateHelper;
+function pascalCase(s) {
+    return (0, startCase_1.default)(s).replace(/\s+/g, "");
+}
+exports.pascalCase = pascalCase;
+function registerHelpers(config) {
+    const _helpers = { ...exports.defaultHelpers, ...config.helpers };
+    for (const helperName in _helpers) {
+        (0, logger_1.log)(config, types_1.LogLevel.Debug, `Registering helper: ${helperName}`);
+        handlebars_1.default.registerHelper(helperName, _helpers[helperName]);
+    }
+}
+exports.registerHelpers = registerHelpers;
+function handlebarsParse(config, templateBuffer, { isPath = false } = {}) {
+    const { data } = config;
+    try {
+        let str = templateBuffer.toString();
+        if (isPath) {
+            str = str.replace(/\\/g, "/");
+        }
+        const parser = handlebars_1.default.compile(str, { noEscape: true });
+        let outputContents = parser(data);
+        if (isPath && path_1.default.sep !== "/") {
+            outputContents = outputContents.replace(/\//g, "\\");
+        }
+        return Buffer.from(outputContents);
+    }
+    catch (e) {
+        (0, logger_1.log)(config, types_1.LogLevel.Debug, e);
+        (0, logger_1.log)(config, types_1.LogLevel.Warning, "Couldn't parse file with handlebars, returning original content");
+        return Buffer.from(templateBuffer);
+    }
+}
+exports.handlebarsParse = handlebarsParse;
+//# sourceMappingURL=parser.js.map

package/parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.js","sourceRoot":"","sources":["../src/parser.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAuB;AACvB,mCAA0E;AAC1E,iEAAwC;AACxC,iEAAwC;AACxC,iEAAwC;AACxC,iEAAwC;AACxC,4DAAmC;AACnC,uDAAgC;AAChC,6DAAsC;AACtC,iEAA0C;AAC1C,qCAA8B;AAE9B,MAAM,OAAO,GAAG;IACd,GAAG,EAAE,aAAK;IACV,MAAM,EAAE,gBAAQ;IAChB,QAAQ,EAAE,kBAAU;CACrB,CAAA;AAEY,QAAA,cAAc,GAAmC;IAC5D,SAAS,EAAT,mBAAS;IACT,SAAS,EAAT,mBAAS;IACT,SAAS,EAAT,mBAAS;IACT,SAAS,EAAT,mBAAS;IACT,UAAU,EAAE,mBAAS;IACrB,UAAU;IACV,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE;IACvC,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE;IACvC,GAAG,EAAE,SAAS;IACd,IAAI,EAAE,UAAU;CACjB,CAAA;AASD,SAAgB,WAAW,CACzB,IAAU,EACV,YAAoB,EACpB,kBAA2B,EAC3B,YAA6B;IAE7B,IAAI,YAAY,IAAI,kBAAkB,KAAK,SAAS,EAAE;QACpD,OAAO,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,kBAAkB,EAAE,CAAC,EAAE,YAAY,CAAC,CAAA;KAC/F;IACD,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;AAC3C,CAAC;AAVD,kCAUC;AAID,SAAgB,SAAS,CAAC,YAAoB,EAAE,kBAA2B,EAAE,YAA6B;IACxG,OAAO,WAAW,CAAC,IAAI,IAAI,EAAE,EAAE,YAAY,EAAE,kBAAmB,EAAE,YAAa,CAAC,CAAA;AAClF,CAAC;AAFD,8BAEC;AAUD,SAAgB,UAAU,CACxB,IAAY,EACZ,YAAoB,EACpB,kBAA2B,EAC3B,YAA6B;IAE7B,OAAO,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,kBAAmB,EAAE,YAAa,CAAC,CAAA;AAC9F,CAAC;AAPD,gCAOC;AAED,SAAgB,UAAU,CAAC,CAAS;IAClC,OAAO,IAAA,mBAAS,EAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;AACzC,CAAC;AAFD,gCAEC;AAED,SAAgB,eAAe,CAAC,MAAsB;IACpD,MAAM,QAAQ,GAAG,EAAE,GAAG,sBAAc,EAAE,GAAG,MAAM,CAAC,OAAO,EAAE,CAAA;IACzD,KAAK,MAAM,UAAU,IAAI,QAAQ,EAAE;QACjC,IAAA,YAAG,EAAC,MAAM,EAAE,gBAAQ,CAAC,KAAK,EAAE,uBAAuB,UAAU,EAAE,CAAC,CAAA;QAChE,oBAAU,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,UAAmC,CAAC,CAAC,CAAA;KACrF;AACH,CAAC;AAND,0CAMC;AAED,SAAgB,eAAe,CAC7B,MAAsB,EACtB,cAA+B,EAC/B,EAAE,MAAM,GAAG,KAAK,KAA2B,EAAE;IAE7C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAA;IACvB,IAAI;QACF,IAAI,GAAG,GAAG,cAAc,CAAC,QAAQ,EAAE,CAAA;QACnC,IAAI,MAAM,EAAE;YACV,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;SAC9B;QACD,MAAM,MAAM,GAAG,oBAAU,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAA;QAC1D,IAAI,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA;QACjC,IAAI,MAAM,IAAI,cAAI,CAAC,GAAG,KAAK,GAAG,EAAE;YAC9B,cAAc,GAAG,cAAc,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;SACrD;QACD,OAAO,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;KACnC;IAAC,OAAO,CAAC,EAAE;QACV,IAAA,YAAG,EAAC,MAAM,EAAE,gBAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QAC9B,IAAA,YAAG,EAAC,MAAM,EAAE,gBAAQ,CAAC,OAAO,EAAE,iEAAiE,CAAC,CAAA;QAChG,OAAO,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;KACnC;AACH,CAAC;AAtBD,0CAsBC"}

package/scaffold.d.ts

@@ -1,4 +1,4 @@
-import { ScaffoldCmdConfig, ScaffoldConfig } from "./types";
+import { MinimalConfig, Resolver, ScaffoldCmdConfig, ScaffoldConfig } from "./types";
 /**
  * Create a scaffold using given `options`.
  *
@@ -33,6 +33,6 @@ import { ScaffoldCmdConfig, ScaffoldConfig } from "./types";
  */
 export declare function Scaffold(config: ScaffoldConfig): Promise<void>;
 export declare namespace Scaffold {
-    var fromConfig: (pathOrUrl: string, config: Pick<ScaffoldCmdConfig, "name" | "key">, overrides?: Partial<Omit<ScaffoldConfig, "name">> | undefined) => Promise<void>;
+    var fromConfig: (pathOrUrl: string, config: MinimalConfig, overrides?: Resolver<ScaffoldCmdConfig, Partial<Omit<ScaffoldConfig, "name">>> | undefined) => Promise<void>;
 }
 export default Scaffold;

package/scaffold.js

@@ -12,7 +12,11 @@ exports.Scaffold = void 0;
  */
 const path_1 = __importDefault(require("path"));
 const utils_1 = require("./utils");
+const file_1 = require("./file");
 const types_1 = require("./types");
+const parser_1 = require("./parser");
+const logger_1 = require("./logger");
+const config_1 = require("./config");
 /**
  * Create a scaffold using given `options`.
  *
@@ -46,23 +50,22 @@ const types_1 = require("./types");
  * @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);
+    config.output ??= process.cwd();
+    (0, parser_1.registerHelpers)(config);
     try {
-        config.data = { name: config.name, Name: (0, utils_1.pascalCase)(config.name), ...config.data };
-        (0, utils_1.logInitStep)(config);
+        config.data = { name: config.name, Name: (0, parser_1.pascalCase)(config.name), ...config.data };
+        (0, logger_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);
+                const { nonGlobTemplate, origTemplate, isDirOrGlob, isGlob, template } = await (0, file_1.getTemplateGlobInfo)(config, _template);
+                const files = await (0, file_1.getFileList)(config, template);
                 for (const inputFilePath of files) {
-                    if (await (0, utils_1.isDir)(inputFilePath)) {
+                    if (await (0, file_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, {
+                    const relPath = (0, file_1.makeRelativePath)(path_1.default.dirname((0, file_1.removeGlob)(inputFilePath).replace(nonGlobTemplate, "")));
+                    const basePath = (0, file_1.getBasePath)(relPath);
+                    (0, logger_1.logInputFile)(config, {
                         origTemplate,
                         relPath,
                         template,
@@ -72,7 +75,7 @@ async function Scaffold(config) {
                         isDirOrGlob,
                         isGlob,
                     });
-                    await handleTemplateFile(config, {
+                    await (0, file_1.handleTemplateFile)(config, {
                         templatePath: inputFilePath,
                         basePath,
                     });
@@ -84,7 +87,7 @@ async function Scaffold(config) {
         }
     }
     catch (e) {
-        (0, utils_1.log)(config, types_1.LogLevel.Error, e);
+        (0, logger_1.log)(config, types_1.LogLevel.Error, e);
         throw e;
     }
 }
@@ -100,7 +103,13 @@ exports.Scaffold = Scaffold;
  * @category Main
  * @return {Promise<void>} A promise that resolves when the scaffold is complete
  */
-Scaffold.fromConfig = async function (pathOrUrl, config, overrides) {
+Scaffold.fromConfig = async function (
+/** The path or URL to the config file */
+pathOrUrl, 
+/** Information needed before loading the config */
+config, 
+/** Any overrides to the loaded config */
+overrides) {
     const _cmdConfig = {
         dryRun: false,
         output: process.cwd(),
@@ -114,29 +123,9 @@ Scaffold.fromConfig = async function (pathOrUrl, config, overrides) {
         config: pathOrUrl,
         ...config,
     };
-    const _config = await (0, utils_1.parseConfig)(_cmdConfig);
-    return Scaffold({ ..._config, ...overrides });
+    const _overrides = (0, utils_1.resolve)(overrides, _cmdConfig);
+    const _config = await (0, config_1.parseConfig)(_cmdConfig);
+    return Scaffold({ ..._config, ..._overrides });
 };
-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

@@ -1 +1 @@
-{"version":3,"file":"scaffold.js","sourceRoot":"","sources":["../src/scaffold.ts"],"names":[],"mappings":";;;;;;AAAA;;;;;GAKG;AACH,gDAAuB;AAEvB,mCAkBgB;AAChB,mCAAqE;AAGrE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;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;AAED;;;;;;;;;;GAUG;AACH,QAAQ,CAAC,UAAU,GAAG,KAAK,WACzB,SAAiB,EACjB,MAA+C,EAC/C,SAAiD;IAEjD,MAAM,UAAU,GAAoC;QAClD,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE;QACrB,OAAO,EAAE,gBAAQ,CAAC,IAAI;QACtB,SAAS,EAAE,KAAK;QAChB,SAAS,EAAE,EAAE;QACb,eAAe,EAAE,KAAK;QACtB,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,KAAK;QACX,MAAM,EAAE,EAAE;QACV,MAAM,EAAE,SAAS;QACjB,GAAG,MAAM;KACV,CAAA;IACD,MAAM,OAAO,GAAG,MAAM,IAAA,mBAAW,EAAC,UAAU,CAAC,CAAA;IAC7C,OAAO,QAAQ,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,SAAS,EAAE,CAAC,CAAA;AAC/C,CAAC,CAAA;AAED,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"}
+{"version":3,"file":"scaffold.js","sourceRoot":"","sources":["../src/scaffold.ts"],"names":[],"mappings":";;;;;;AAAA;;;;;GAKG;AACH,gDAAuB;AACvB,mCAA4C;AAC5C,iCAWe;AACf,mCAA8F;AAE9F,qCAAsD;AACtD,qCAAyD;AACzD,qCAA6D;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACI,KAAK,UAAU,QAAQ,CAAC,MAAsB;IACnD,MAAM,CAAC,MAAM,KAAK,OAAO,CAAC,GAAG,EAAE,CAAA;IAE/B,IAAA,wBAAe,EAAC,MAAM,CAAC,CAAA;IACvB,IAAI;QACF,MAAM,CAAC,IAAI,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,IAAA,mBAAU,EAAC,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,EAAE,CAAA;QAClF,IAAA,oBAAW,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,0BAAmB,EAChG,MAAM,EACN,SAAS,CACV,CAAA;gBACD,MAAM,KAAK,GAAG,MAAM,IAAA,kBAAW,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;gBACjD,KAAK,MAAM,aAAa,IAAI,KAAK,EAAE;oBACjC,IAAI,MAAM,IAAA,YAAK,EAAC,aAAa,CAAC,EAAE;wBAC9B,SAAQ;qBACT;oBACD,MAAM,OAAO,GAAG,IAAA,uBAAgB,EAAC,cAAI,CAAC,OAAO,CAAC,IAAA,iBAAU,EAAC,aAAa,CAAC,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;oBACtG,MAAM,QAAQ,GAAG,IAAA,kBAAW,EAAC,OAAO,CAAC,CAAA;oBACrC,IAAA,qBAAY,EAAC,MAAM,EAAE;wBACnB,YAAY;wBACZ,OAAO;wBACP,QAAQ;wBACR,aAAa;wBACb,eAAe;wBACf,QAAQ;wBACR,WAAW;wBACX,MAAM;qBACP,CAAC,CAAA;oBACF,MAAM,IAAA,yBAAkB,EAAC,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,YAAG,EAAC,MAAM,EAAE,gBAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QAC9B,MAAM,CAAC,CAAA;KACR;AACH,CAAC;AA3CD,4BA2CC;AAED;;;;;;;;;;GAUG;AACH,QAAQ,CAAC,UAAU,GAAG,KAAK;AACzB,yCAAyC;AACzC,SAAiB;AACjB,mDAAmD;AACnD,MAAqB;AACrB,yCAAyC;AACzC,SAA8E;IAE9E,MAAM,UAAU,GAAoC;QAClD,MAAM,EAAE,KAAK;QACb,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE;QACrB,OAAO,EAAE,gBAAQ,CAAC,IAAI;QACtB,SAAS,EAAE,KAAK;QAChB,SAAS,EAAE,EAAE;QACb,eAAe,EAAE,KAAK;QACtB,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,KAAK;QACX,MAAM,EAAE,EAAE;QACV,MAAM,EAAE,SAAS;QACjB,GAAG,MAAM;KACV,CAAA;IACD,MAAM,UAAU,GAAG,IAAA,eAAO,EAAC,SAAS,EAAE,UAAU,CAAC,CAAA;IACjD,MAAM,OAAO,GAAG,MAAM,IAAA,oBAAW,EAAC,UAAU,CAAC,CAAA;IAC7C,OAAO,QAAQ,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,UAAU,EAAE,CAAC,CAAA;AAChD,CAAC,CAAA;AAED,kBAAe,QAAQ,CAAA"}

package/types.d.ts

@@ -52,7 +52,7 @@ export interface ScaffoldConfig {
      * 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.
+     * a boolean for each file.
      *
      * May also be a {@link FileResponseHandler} which returns a boolean value per file.
      *
@@ -294,6 +294,10 @@ export type FileResponseHandler<T> = (fullPath: string, basedir: string, basenam
 export type FileResponse<T> = T | FileResponseHandler<T>;
 /** @internal */
 export interface ScaffoldCmdConfig {
+    /**
+     * Name to be passed to the generated files. `{{name}}` and `{{Name}}` inside contents and file names will be replaced
+     * accordingly.
+     */
     name: string;
     templates: string[];
     output: string;
@@ -305,6 +309,7 @@ export interface ScaffoldCmdConfig {
     verbose: LogLevel;
     dryRun: boolean;
     config?: string;
+    /** The key to use for the file which contains the template configurations. */
     key?: string;
     github?: string;
 }
@@ -319,4 +324,21 @@ export interface ScaffoldCmdConfig {
  *
  * @see {@link ScaffoldConfig}
  */
-export type ScaffoldConfigFile = Record<string, ScaffoldConfig>;
+export type ScaffoldConfigMap = Record<string, ScaffoldConfig>;
+/** The scaffold config file is either:
+ * - A {@link ScaffoldConfigMap} object
+ * - A function that returns a {@link ScaffoldConfigMap} object
+ * - A promise that resolves to a {@link ScaffoldConfigMap} object
+ * - A function that returns a promise that resolves to a {@link ScaffoldConfigMap} object
+ */
+export type ScaffoldConfigFile = AsyncResolver<ScaffoldCmdConfig, ScaffoldConfigMap>;
+/** @internal */
+export type Resolver<T, R = T> = R | ((value: T) => R);
+/** @internal */
+export type AsyncResolver<T, R = T> = Resolver<T, Promise<R> | R>;
+/** @internal */
+export type LogConfig = Pick<ScaffoldConfig, "quiet" | "verbose">;
+/** @internal */
+export type ConfigLoadConfig = LogConfig & Pick<ScaffoldCmdConfig, "config">;
+/** @internal */
+export type MinimalConfig = Pick<ScaffoldCmdConfig, "name" | "key">;

package/utils.d.ts

@@ -1,70 +1,4 @@
 /// <reference types="node" />
-/// <reference types="node" />
-import { DefaultHelpers, FileResponse, Helper, LogLevel, ScaffoldCmdConfig, ScaffoldConfig, ScaffoldConfigFile } from "./types";
-import { OptionsBase } from "massarg/types";
-export declare const defaultHelpers: Record<DefaultHelpers, Helper>;
-export declare function _dateHelper(date: Date, formatString: string): string;
-export declare function _dateHelper(date: Date, formatString: string, durationDifference: number, durationType: keyof Duration): string;
-export declare function nowHelper(formatString: string): string;
-export declare function nowHelper(formatString: string, durationDifference: number, durationType: keyof Duration): string;
-export declare function dateHelper(date: string, formatString: string): string;
-export declare function dateHelper(date: string, formatString: string, durationDifference: number, durationType: keyof Duration): string;
-export declare function registerHelpers(config: ScaffoldConfig): void;
+import { Resolver } from "./types";
 export declare function handleErr(err: NodeJS.ErrnoException | null): void;
-/** @internal */
-export type LogConfig = Pick<ScaffoldConfig, "quiet" | "verbose">;
-export declare function log(config: LogConfig, level: LogLevel, ...obj: any[]): void;
-export declare function createDirIfNotExists(dir: string, config: ScaffoldConfig): Promise<void>;
-export declare function getOptionValueForFile<T>(config: ScaffoldConfig, filePath: string, fn: FileResponse<T>, defaultValue?: T): T;
-export declare function handlebarsParse(config: ScaffoldConfig, templateBuffer: Buffer | string, { isPath }?: {
-    isPath?: boolean;
-}): Buffer;
-export declare function pathExists(filePath: string): Promise<boolean>;
-export declare function pascalCase(s: string): string;
-export declare function isDir(path: string): Promise<boolean>;
-export declare function removeGlob(template: string): string;
-export declare function makeRelativePath(str: string): string;
-export declare function getBasePath(relPath: string): string;
-export declare function getFileList(config: ScaffoldConfig, template: string): Promise<string[]>;
-export interface GlobInfo {
-    nonGlobTemplate: string;
-    origTemplate: string;
-    isDirOrGlob: boolean;
-    isGlob: boolean;
-    template: string;
-}
-export declare function getTemplateGlobInfo(config: ScaffoldConfig, template: string): Promise<GlobInfo>;
-export interface OutputFileInfo {
-    inputPath: string;
-    outputPathOpt: string;
-    outputDir: string;
-    outputPath: string;
-    exists: boolean;
-}
-export declare function getTemplateFileInfo(config: ScaffoldConfig, { templatePath, basePath }: {
-    templatePath: string;
-    basePath: string;
-}): Promise<OutputFileInfo>;
-export declare function copyFileTransformed(config: ScaffoldConfig, { exists, overwrite, outputPath, inputPath, }: {
-    exists: boolean;
-    overwrite: boolean;
-    outputPath: string;
-    inputPath: string;
-}): Promise<void>;
-export declare function getOutputDir(config: ScaffoldConfig, outputPathOpt: string, basePath: string): string;
-export declare function logInputFile(config: ScaffoldConfig, { origTemplate, relPath, template, inputFilePath, nonGlobTemplate, basePath, isDirOrGlob, isGlob, }: {
-    origTemplate: string;
-    relPath: string;
-    template: string;
-    inputFilePath: string;
-    nonGlobTemplate: string;
-    basePath: string;
-    isDirOrGlob: boolean;
-    isGlob: boolean;
-}): void;
-export declare function logInitStep(config: ScaffoldConfig): void;
-export declare function parseAppendData(value: string, options: ScaffoldCmdConfig & OptionsBase): unknown;
-/** @internal */
-export declare function parseConfig(config: ScaffoldCmdConfig & OptionsBase): Promise<ScaffoldConfig>;
-/** @internal */
-export declare function getConfig(config: Pick<ScaffoldCmdConfig, "quiet" | "verbose" | "config">): Promise<ScaffoldConfigFile>;
+export declare function resolve<T, R = T>(resolver: Resolver<T, R>, arg: T): R;