simple-scaffold 1.6.0-develop.1 → 1.6.0

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.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/types.d.ts +5 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "simple-scaffold",
3
- "version": "1.6.0-develop.1",
3
+ "version": "1.6.0",
4
4
  "description": "Generate any file structure - from single components to entire app boilerplates, with a single command.",
5
5
  "homepage": "https://chenasraf.github.io/simple-scaffold",
6
6
  "repository": "https://github.com/chenasraf/simple-scaffold.git",
package/types.d.ts CHANGED
@@ -294,6 +294,10 @@ export type FileResponseHandler<T> = (fullPath: string, basedir: string, basenam
294
294
  export type FileResponse<T> = T | FileResponseHandler<T>;
295
295
  /** @internal */
296
296
  export interface ScaffoldCmdConfig {
297
+ /**
298
+ * Name to be passed to the generated files. `{{name}}` and `{{Name}}` inside contents and file names will be replaced
299
+ * accordingly.
300
+ */
297
301
  name: string;
298
302
  templates: string[];
299
303
  output: string;
@@ -305,6 +309,7 @@ export interface ScaffoldCmdConfig {
305
309
  verbose: LogLevel;
306
310
  dryRun: boolean;
307
311
  config?: string;
312
+ /** The key to use for the file which contains the template configurations. */
308
313
  key?: string;
309
314
  github?: string;
310
315
  }