simple-scaffold 1.5.0-develop.1 → 1.5.0-develop.2
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/README.md +1 -1
- package/cmd.js +28 -3
- package/cmd.js.map +1 -1
- package/package.json +3 -3
- package/types.d.ts +15 -5
- package/types.js.map +1 -1
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<h2 align="center">
|
|
4
4
|
|
|
5
5
|
[GitHub](https://github.com/chenasraf/simple-scaffold) |
|
|
6
|
-
[Documentation](https://
|
|
6
|
+
[Documentation](https://chenasraf.github.io/simple-scaffold) |
|
|
7
7
|
[NPM](https://npmjs.com/package/simple-scaffold) | [casraf.dev](https://casraf.dev)
|
|
8
8
|
|
|
9
9
|
|
package/cmd.js
CHANGED
|
@@ -30,12 +30,12 @@ async function parseCliArgs(args = process.argv.slice(2)) {
|
|
|
30
30
|
.option({
|
|
31
31
|
name: "config",
|
|
32
32
|
aliases: ["c"],
|
|
33
|
-
description: "Filename or https git URL to load config from instead of passing arguments to CLI or using a Node.js script.
|
|
33
|
+
description: "Filename or https git URL to load config from instead of passing arguments to CLI or using a Node.js script. See examples for syntax.",
|
|
34
34
|
})
|
|
35
35
|
.option({
|
|
36
36
|
name: "github",
|
|
37
37
|
aliases: ["gh"],
|
|
38
|
-
description: "GitHub path to load config from instead of passing arguments to CLI or using a Node.js script.
|
|
38
|
+
description: "GitHub path to load config from instead of passing arguments to CLI or using a Node.js script. See examples for syntax.",
|
|
39
39
|
})
|
|
40
40
|
.option({
|
|
41
41
|
name: "key",
|
|
@@ -116,16 +116,41 @@ async function parseCliArgs(args = process.argv.slice(2)) {
|
|
|
116
116
|
// description: "Usage",
|
|
117
117
|
// output: "",
|
|
118
118
|
// })
|
|
119
|
+
.example({
|
|
120
|
+
description: "Usage with config file",
|
|
121
|
+
input: "simple-scaffold -c scaffold.cmd.js --key component",
|
|
122
|
+
})
|
|
123
|
+
.example({
|
|
124
|
+
description: "Usage with GitHub config file",
|
|
125
|
+
input: "simple-scaffold -gh chenasraf/simple-scaffold --key component",
|
|
126
|
+
})
|
|
127
|
+
.example({
|
|
128
|
+
description: "Usage with https git URL (for non-GitHub)",
|
|
129
|
+
input: "simple-scaffold -c https://example.com/user/template.git#scaffold.cmd.js --key component",
|
|
130
|
+
})
|
|
131
|
+
.example({
|
|
132
|
+
description: "Full syntax with config path and template key (applicable to all above methods)",
|
|
133
|
+
input: "simple-scaffold -c scaffold.cmd.js:component MyComponent",
|
|
134
|
+
})
|
|
135
|
+
.example({
|
|
136
|
+
description: "Excluded template key, assumes 'default' key",
|
|
137
|
+
input: "simple-scaffold -c scaffold.cmd.js MyComponent",
|
|
138
|
+
})
|
|
139
|
+
.example({
|
|
140
|
+
description: "Shortest syntax for GitHub, assumes file 'scaffold.cmd.js' and template key 'default'",
|
|
141
|
+
input: "simple-scaffold -gh chenasraf/simple-scaffold MyComponent",
|
|
142
|
+
})
|
|
119
143
|
.help({
|
|
120
144
|
binName: "simple-scaffold",
|
|
121
145
|
useGlobalColumns: true,
|
|
122
146
|
usageExample: "[options]",
|
|
147
|
+
printWidth: 100,
|
|
123
148
|
header: [`Create structured files based on templates.`].join("\n"),
|
|
124
149
|
footer: [
|
|
125
150
|
`Version: ${pkg.version}`,
|
|
126
151
|
`Copyright © Chen Asraf 2017-${new Date().getFullYear()}`,
|
|
127
152
|
``,
|
|
128
|
-
`Documentation: ${chalk_1.default.underline `https://
|
|
153
|
+
`Documentation: ${chalk_1.default.underline `https://chenasraf.github.io/simple-scaffold`}`,
|
|
129
154
|
`NPM: ${chalk_1.default.underline `https://npmjs.com/package/simple-scaffold`}`,
|
|
130
155
|
`GitHub: ${chalk_1.default.underline `https://github.com/chenasraf/simple-scaffold`}`,
|
|
131
156
|
].join("\n"),
|
package/cmd.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;IAEtH,OAAO,CACL,IAAA,iBAAO,GAAqB;SACzB,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;QACrB,MAAM,OAAO,GAAG,MAAM,IAAA,mBAAW,EAAC,MAAM,CAAC,CAAA;QACzC,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,
|
|
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,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;IAEtH,OAAO,CACL,IAAA,iBAAO,GAAqB;SACzB,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;QACrB,MAAM,OAAO,GAAG,MAAM,IAAA,mBAAW,EAAC,MAAM,CAAC,CAAA;QACzC,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,uIAAuI;KAC1I,CAAC;SACD,MAAM,CAAC;QACN,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC,IAAI,CAAC;QACf,WAAW,EACT,yHAAyH;KAC5H,CAAC;SACD,MAAM,CAAC;QACN,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,CAAC,GAAG,CAAC;QACd,WAAW,EACT,mJAAmJ;KACtJ,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,OAAO,CAAC;QACP,WAAW,EAAE,wBAAwB;QACrC,KAAK,EAAE,oDAAoD;KAC5D,CAAC;SACD,OAAO,CAAC;QACP,WAAW,EAAE,+BAA+B;QAC5C,KAAK,EAAE,+DAA+D;KACvE,CAAC;SACD,OAAO,CAAC;QACP,WAAW,EAAE,2CAA2C;QACxD,KAAK,EAAE,0FAA0F;KAClG,CAAC;SACD,OAAO,CAAC;QACP,WAAW,EAAE,iFAAiF;QAC9F,KAAK,EAAE,0DAA0D;KAClE,CAAC;SACD,OAAO,CAAC;QACP,WAAW,EAAE,8CAA8C;QAC3D,KAAK,EAAE,gDAAgD;KACxD,CAAC;SACD,OAAO,CAAC;QACP,WAAW,EAAE,uFAAuF;QACpG,KAAK,EAAE,2DAA2D;KACnE,CAAC;SACD,IAAI,CAAC;QACJ,OAAO,EAAE,iBAAiB;QAC1B,gBAAgB,EAAE,IAAI;QACtB,YAAY,EAAE,WAAW;QACzB,UAAU,EAAE,GAAG;QACf,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,6CAA6C,EAAE;YAChF,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;AA3JD,oCA2JC;AAED,YAAY,EAAE,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "simple-scaffold",
|
|
3
|
-
"version": "1.5.0-develop.
|
|
3
|
+
"version": "1.5.0-develop.2",
|
|
4
4
|
"description": "A simple command to generate any file structure, from single components to entire app boilerplates.",
|
|
5
|
-
"homepage": "https://
|
|
5
|
+
"homepage": "https://chenasraf.github.io/simple-scaffold",
|
|
6
6
|
"repository": "https://github.com/chenasraf/simple-scaffold.git",
|
|
7
7
|
"author": "Chen Asraf <inbox@casraf.com>",
|
|
8
8
|
"license": "MIT",
|
|
@@ -40,7 +40,6 @@
|
|
|
40
40
|
"handlebars": "^4.7.7",
|
|
41
41
|
"lodash": "^4.17.21",
|
|
42
42
|
"massarg": "^1.0.7-pre.1",
|
|
43
|
-
"semantic-release-conventional-commits": "^3.0.0",
|
|
44
43
|
"util.promisify": "^1.1.1"
|
|
45
44
|
},
|
|
46
45
|
"devDependencies": {
|
|
@@ -59,6 +58,7 @@
|
|
|
59
58
|
"mock-fs": "^5.2.0",
|
|
60
59
|
"rimraf": "^5.0.0",
|
|
61
60
|
"semantic-release": "^21.0.1",
|
|
61
|
+
"semantic-release-conventional-commits": "^3.0.0",
|
|
62
62
|
"ts-jest": "^29.1.0",
|
|
63
63
|
"ts-node": "^10.9.1",
|
|
64
64
|
"typedoc": "^0.24.6",
|
package/types.d.ts
CHANGED
|
@@ -3,7 +3,8 @@ import { HelperDelegate } from "handlebars/runtime";
|
|
|
3
3
|
/**
|
|
4
4
|
* The config object for defining a scaffolding group.
|
|
5
5
|
*
|
|
6
|
-
* @see https://github.
|
|
6
|
+
* @see {@link https://chenasraf.github.io/simple-scaffold/pages/node.html | Node.js usage}
|
|
7
|
+
* @see {@link https://chenasraf.github.io/simple-scaffold/pages/cli.html | CLI usage}
|
|
7
8
|
* @see {@link DefaultHelpers}
|
|
8
9
|
* @see {@link CaseHelpers}
|
|
9
10
|
* @see {@link DateHelpers}
|
|
@@ -122,10 +123,8 @@ export interface ScaffoldConfig {
|
|
|
122
123
|
* @see {@link DefaultHelpers}
|
|
123
124
|
* @see {@link CaseHelpers}
|
|
124
125
|
* @see {@link DateHelpers}
|
|
125
|
-
* @see https://
|
|
126
|
-
*
|
|
127
|
-
* @see https://handlebarsjs.com/guide/#custom-helpers
|
|
128
|
-
*/
|
|
126
|
+
* @see {@link https://chenasraf.github.io/simple-scaffold/pages/templates.html | Templates}
|
|
127
|
+
* */
|
|
129
128
|
helpers?: Record<string, Helper>;
|
|
130
129
|
/**
|
|
131
130
|
* Default transformer to apply to subfolder name when using `createSubFolder: true`. Can be one of the default
|
|
@@ -309,4 +308,15 @@ export interface ScaffoldCmdConfig {
|
|
|
309
308
|
key?: string;
|
|
310
309
|
github?: string;
|
|
311
310
|
}
|
|
311
|
+
/**
|
|
312
|
+
* A mapping of scaffold template keys to their configurations.
|
|
313
|
+
*
|
|
314
|
+
* Each configuration is a {@link ScaffoldConfig} object.
|
|
315
|
+
*
|
|
316
|
+
* The key is the name of the template, and the value is the configuration for that template.
|
|
317
|
+
*
|
|
318
|
+
* When no template key is provided to the scaffold command, the "default" template is used.
|
|
319
|
+
*
|
|
320
|
+
* @see {@link ScaffoldConfig}
|
|
321
|
+
*/
|
|
312
322
|
export type ScaffoldConfigFile = Record<string, ScaffoldConfig>;
|
package/types.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AAyQA;;;;;;;;;;GAUG;AACH,IAAY,QAeX;AAfD,WAAY,QAAQ;IAClB,oBAAoB;IACpB,uCAAQ,CAAA;IACR,oFAAoF;IACpF,yCAAS,CAAA;IACT;;;;OAIG;IACH,uCAAQ,CAAA;IACR,qFAAqF;IACrF,6CAAW,CAAA;IACX,+FAA+F;IAC/F,yCAAS,CAAA;AACX,CAAC,EAfW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAenB"}
|