simple-scaffold 1.5.0-develop.2 → 1.5.0-develop.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +2 -3
- package/scaffold.d.ts +5 -1
- package/scaffold.js +29 -0
- package/scaffold.js.map +1 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "simple-scaffold",
|
|
3
|
-
"version": "1.5.0-develop.
|
|
3
|
+
"version": "1.5.0-develop.3",
|
|
4
4
|
"description": "A simple command to generate any file structure, from single components to entire app boilerplates.",
|
|
5
5
|
"homepage": "https://chenasraf.github.io/simple-scaffold",
|
|
6
6
|
"repository": "https://github.com/chenasraf/simple-scaffold.git",
|
|
@@ -39,8 +39,7 @@
|
|
|
39
39
|
"glob": "^9.2.1",
|
|
40
40
|
"handlebars": "^4.7.7",
|
|
41
41
|
"lodash": "^4.17.21",
|
|
42
|
-
"massarg": "^1.0.7-pre.1"
|
|
43
|
-
"util.promisify": "^1.1.1"
|
|
42
|
+
"massarg": "^1.0.7-pre.1"
|
|
44
43
|
},
|
|
45
44
|
"devDependencies": {
|
|
46
45
|
"@knodes/typedoc-plugin-pages": "^0.23.4",
|
package/scaffold.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ScaffoldConfig } from "./types";
|
|
1
|
+
import { ScaffoldCmdConfig, ScaffoldConfig } from "./types";
|
|
2
2
|
/**
|
|
3
3
|
* Create a scaffold using given `options`.
|
|
4
4
|
*
|
|
@@ -23,6 +23,7 @@ import { ScaffoldConfig } from "./types";
|
|
|
23
23
|
* For available default values, see {@link DefaultHelpers}.
|
|
24
24
|
*
|
|
25
25
|
* @param {ScaffoldConfig} config The main configuration object
|
|
26
|
+
* @return {Promise<void>} A promise that resolves when the scaffold is complete
|
|
26
27
|
*
|
|
27
28
|
* @see {@link DefaultHelpers}
|
|
28
29
|
* @see {@link CaseHelpers}
|
|
@@ -31,4 +32,7 @@ import { ScaffoldConfig } from "./types";
|
|
|
31
32
|
* @category Main
|
|
32
33
|
*/
|
|
33
34
|
export declare function Scaffold(config: ScaffoldConfig): Promise<void>;
|
|
35
|
+
export declare namespace Scaffold {
|
|
36
|
+
var fromConfig: (pathOrUrl: string, config: Pick<ScaffoldCmdConfig, "name" | "key">, overrides?: Partial<Omit<ScaffoldConfig, "name">> | undefined) => Promise<void>;
|
|
37
|
+
}
|
|
34
38
|
export default Scaffold;
|
package/scaffold.js
CHANGED
|
@@ -37,6 +37,7 @@ const types_1 = require("./types");
|
|
|
37
37
|
* For available default values, see {@link DefaultHelpers}.
|
|
38
38
|
*
|
|
39
39
|
* @param {ScaffoldConfig} config The main configuration object
|
|
40
|
+
* @return {Promise<void>} A promise that resolves when the scaffold is complete
|
|
40
41
|
*
|
|
41
42
|
* @see {@link DefaultHelpers}
|
|
42
43
|
* @see {@link CaseHelpers}
|
|
@@ -88,6 +89,34 @@ async function Scaffold(config) {
|
|
|
88
89
|
}
|
|
89
90
|
}
|
|
90
91
|
exports.Scaffold = Scaffold;
|
|
92
|
+
/**
|
|
93
|
+
* Create a scaffold based on a config file or URL.
|
|
94
|
+
*
|
|
95
|
+
* @param {string} pathOrUrl The path or URL to the config file
|
|
96
|
+
* @param {Record<string, string>} config Information needed before loading the config
|
|
97
|
+
* @param {Partial<Omit<ScaffoldConfig, 'name'>>} overrides Any overrides to the loaded config
|
|
98
|
+
*
|
|
99
|
+
* @see {@link Scaffold}
|
|
100
|
+
* @category Main
|
|
101
|
+
* @return {Promise<void>} A promise that resolves when the scaffold is complete
|
|
102
|
+
*/
|
|
103
|
+
Scaffold.fromConfig = async function (pathOrUrl, config, overrides) {
|
|
104
|
+
const _cmdConfig = {
|
|
105
|
+
dryRun: false,
|
|
106
|
+
output: process.cwd(),
|
|
107
|
+
verbose: types_1.LogLevel.Info,
|
|
108
|
+
overwrite: false,
|
|
109
|
+
templates: [],
|
|
110
|
+
createSubFolder: false,
|
|
111
|
+
quiet: false,
|
|
112
|
+
help: false,
|
|
113
|
+
extras: [],
|
|
114
|
+
config: pathOrUrl,
|
|
115
|
+
...config,
|
|
116
|
+
};
|
|
117
|
+
const _config = await (0, utils_1.parseConfig)(_cmdConfig);
|
|
118
|
+
return Scaffold({ ..._config, ...overrides });
|
|
119
|
+
};
|
|
91
120
|
async function handleTemplateFile(config, { templatePath, basePath }) {
|
|
92
121
|
return new Promise(async (resolve, reject) => {
|
|
93
122
|
var _a;
|
package/scaffold.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scaffold.js","sourceRoot":"","sources":["../src/scaffold.ts"],"names":[],"mappings":";;;;;;AAAA;;;;;GAKG;AACH,gDAAuB;AAEvB,
|
|
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"}
|