Merge pull request #40 from codeBelt/command-line

Allow user to use the command line to generate template files

Author: codeBelt

README.md

@@ -2,7 +2,7 @@
 
 [![NPM version][npm-img]][npm-url] [![Downloads][downloads-img]][npm-url]
 
-A simple generator that is independent from any language. Create custom boilerplate, scaffolding, skeleton, and templating code files that you need to create over and over again. All you need is [NodeJS](https://nodejs.org) installed to get started.
+A simple generator that is independent of any language. Create custom boilerplate, scaffolding, skeleton, and templating code files that you need to create over and over again. All you need is [NodeJS](https://nodejs.org) installed to get started.
 
 > Find this useful? Give it a :star:
 
@@ -184,14 +184,24 @@ Below is an example of a `IReplacerSlotQuestion`
 -   `question` - The question to ask the use what value should be used for the replacer `slot`
 -   `slot` - The string value for the [Replacer Slots](#replacer-slots-or-ireplacerslotquestion)
 
+#### Dynamic Replacer Slots
+
+If you have data that is dynamically generated, or you have hard coded values you can use the `dynamicReplacers`:
+
+```javascript
+dynamicReplacers: [
+  {slot:'__description__', slotValue: config.description}
+],
+```
+
 ### Case Converters
 
 [Case Converters](#case-converters) transform the string value entered upon use of the generator.
 
 Example
 
 -   In the generator template `__replacerSlot__` is appended by the `(pascalCase)` converter such as `__replacerSlot__(pascalCase)`.
--   When the generator is run, the string `"product reducer"` is provided for `__replacerSlot__`.
+-   When the generator is ran, the string `"product reducer"` is provided for `__replacerSlot__`.
 -   As a result, the converter will produce `ProductReducer`.
 
 Here is the string `Lives down BY the River` with each of the converters:
@@ -213,6 +223,32 @@ One Rule: no spaces between the [Replacer Slots](#replacer-slots-or-ireplacerslo
 -   :white_check_mark: `__name__(camelCase)`
 -   :warning: `__name__ (camelCase)`
 
+## Command Line Usage
+
+You can use `generate-template-files` with the command line to generate your template files.
+
+When using the command line `stringReplacers` will be ignored, and the arguments pass in will be used. Example: `__name__=some-name`. `dynamicReplacers` are still used with the command line.
+
+###### Minimum Options
+
+```txt
+node ./tools/generate.js angular-ngrx-store __name__=some-name
+```
+
+###### All Options
+
+```txt
+node ./tools/generate.js angular-ngrx-store __name__=some-name __model__=some-other-name --outputpath=./src/here --overwrite
+```
+
+**Command LIne Script Overview**
+
+-   `node ./tools/generate.js` - Runs the `generate-template-files` library
+-   `angular-ngrx-store` - The template name; It uses the same option name in the [IConfigItem](#iconfigitem) but converts all options names to kebab-case. For example `option: 'Angular Ngrx Store'` will be converted to `angular-ngrx-store` when using the command line
+-   `__name__=some-name` - Are [Replacer Slots](#replacer-slots-or-ireplacerslotquestion) and will be converted to `{ slot: "__name__", slotValue: "some-name" }`
+-   `--outputpath=./src/here` - Will override the `output.path` in the [IConfigItem](#iconfigitem)
+-   `--overwrite` - Will overwrite files if the files already exists
+
 [npm-url]: https://npmjs.org/package/generate-template-files
 [downloads-img]: http://img.shields.io/npm/dm/generate-template-files.svg?style=flat-square
 [npm-img]: http://img.shields.io/npm/v/generate-template-files.svg?style=flat-square

examples/package.json

@@ -3,7 +3,10 @@
   "version": "1.0.0",
   "description": "This is to be used with dynamic replacers as an example",
   "scripts": {
-    "generate": "node ./tools/generate.js"
+    "---------- Normal Example -------------------------------------------": "",
+    "generate": "node ./tools/generate.js",
+    "---------- Command Line Example -------------------------------------": "",
+    "commandline": "node ./tools/generate.js angular-ngrx-store __name__=some-name __model__=some-other-name --outputpath=./src/here --overwrite"
   },
   "devDependencies": {
     "file-name": "0.1.0",

examples/tools/generate.js

@@ -10,22 +10,22 @@ const config = require('../package.json');
 generateTemplateFiles([
     // Angular
     {
-        option: "Angular Ngrx Store",
+        option: 'Angular Ngrx Store',
         defaultCase: '(pascalCase)',
         entry: {
             folderPath: './tools/templates/angular/ngrx-store/',
         },
-        stringReplacers: ['__name__', { question: 'Insert model name', slot: '__model__' }],
+        stringReplacers: ['__name__', {question: 'Insert model name', slot: '__model__'}],
         dynamicReplacers: [
-            {slot:'__version__', slotValue: config.version},
-            {slot:'__description__', slotValue: config.description}
+            {slot: '__version__', slotValue: config.version},
+            {slot: '__description__', slotValue: config.description},
         ],
         output: {
             path: './src/app/stores/__name__(lowerCase)',
             pathAndFileNameDefaultCase: '(kebabCase)',
         },
         onComplete: async (results) => {
-            console.log(`results`, results);
+            // console.log(`results`, results);
         },
     },
     // Vue
@@ -59,7 +59,7 @@ generateTemplateFiles([
         },
         onComplete: (results) => {
             console.log(`results`, results);
-        }
+        },
     },
     {
         option: 'React Component',
@@ -142,9 +142,9 @@ async function importVuexStore(results) {
     const files = results.output.files;
 
     const fullPaths = files
-        .map((folderPath) => folderPath.replace('src/', ''))        // remove 'src' from path
-        .map((path) => `import ${filename(path)} from '${path}'`)   // create import statement
-        .join('\n');                                                // put all imports on there own line
+        .map((folderPath) => folderPath.replace('src/', '')) // remove 'src' from path
+        .map((path) => `import ${filename(path)} from '${path}'`) // create import statement
+        .join('\n'); // put all imports on there own line
 
     try {
         await insertLine('src/import-test.ts').append(fullPaths);

package.json

@@ -56,36 +56,38 @@
     "path-exists": "4.0.0",
     "recursive-copy": "2.0.10",
     "replace-string": "3.0.0",
-    "through2": "3.0.1"
+    "through2": "3.0.1",
+    "yargs": "15.3.1"
   },
   "license": "MIT",
   "devDependencies": {
-    "@babel/core": "7.9.0",
+    "@babel/core": "7.9.6",
     "@babel/plugin-proposal-class-properties": "7.8.3",
-    "@babel/plugin-proposal-object-rest-spread": "7.9.5",
-    "@babel/plugin-transform-runtime": "7.9.0",
-    "@babel/preset-env": "7.9.5",
+    "@babel/plugin-proposal-object-rest-spread": "7.9.6",
+    "@babel/plugin-transform-runtime": "7.9.6",
+    "@babel/preset-env": "7.9.6",
     "@babel/preset-typescript": "7.9.0",
-    "@babel/runtime": "7.9.2",
+    "@babel/runtime": "7.9.6",
     "@types/jest": "25.2.1",
     "@types/lodash.get": "4.4.6",
     "@types/path-exists": "4.0.2",
     "@types/replace-string": "3.0.0",
     "@types/through2": "2.0.34",
+    "@types/yargs": "15.0.4",
     "husky": "4.2.5",
-    "jest": "25.4.0",
-    "prettier": "2.0.4",
+    "jest": "25.5.4",
+    "prettier": "2.0.5",
     "pretty-quick": "2.0.1",
     "rimraf": "3.0.2",
-    "rollup": "2.6.1",
+    "rollup": "2.7.6",
     "rollup-plugin-babel": "4.4.0",
     "rollup-plugin-commonjs": "10.1.0",
     "rollup-plugin-node-resolve": "5.2.0",
     "ts-jest": "25.4.0",
     "tslib": "1.11.1",
-    "tslint": "6.1.1",
+    "tslint": "6.1.2",
     "tslint-config-prettier": "1.18.0",
-    "typedoc": "0.17.4",
+    "typedoc": "0.17.6",
     "typescript": "3.8.3"
   },
   "author": {

src/GenerateTemplateFiles.ts

@@ -12,35 +12,94 @@ import IResults from './models/IResults';
 import IDefaultCaseConverter from './models/IDefaultCaseConverter';
 import CheckUtility from './utilities/CheckUtility';
 import IReplacerSlotQuestion from './models/IReplacerSlotQuestion';
+import yargs from 'yargs';
 
 export default class GenerateTemplateFiles {
+    public static isCommandLine: boolean = Boolean(yargs.argv._.length);
+
     /**
      * Main method to create your template files. Accepts an array of `IConfigItem` items.
      */
     public async generate(options: IConfigItem[]): Promise<void> {
         const selectedConfigItem: IConfigItem = await this._getSelectedItem(options);
         const answeredReplacers: IReplacer[] = await this._getReplacerSlotValues(selectedConfigItem);
+
+        await this._outputFiles(selectedConfigItem, answeredReplacers);
+    }
+
+    /**
+     * Main method to create your template files with the command line.
+     */
+    public async commandLine(options: IConfigItem[]): Promise<void> {
+        const commandLineArgs: string[] = yargs.argv._;
+        const templateName: string = commandLineArgs.shift() ?? '';
+        const slots: string[] = commandLineArgs;
+
+        const selectedConfigItem: IConfigItem | undefined = options.find((configItem: IConfigItem) => {
+            return (
+                StringUtility.toCase(configItem.option, CaseConverterEnum.KebabCase) ===
+                StringUtility.toCase(templateName, CaseConverterEnum.KebabCase)
+            );
+        });
+
+        if (!selectedConfigItem) {
+            CheckUtility.check(Boolean(selectedConfigItem), `There was no IConfigItem found for ${templateName}`);
+
+            return;
+        }
+
+        const replacers: IReplacer[] = slots.map((str: string) => {
+            const [slot, slotValue] = str.split('=');
+
+            const isValidReplacer: boolean = Boolean(slot) && str.includes('=');
+            CheckUtility.check(isValidReplacer, `${str} is not valid as a IReplacer`);
+
+            return {
+                slot,
+                slotValue,
+            };
+        });
+        const dynamicReplacers: IReplacer[] = selectedConfigItem.dynamicReplacers || [];
+
+        await this._outputFiles(selectedConfigItem, [...replacers, ...dynamicReplacers]);
+    }
+
+    private async _outputFiles(selectedConfigItem: IConfigItem, replacers: IReplacer[]): Promise<void> {
+        const hasStringOrDynamicReplacers: boolean = replacers.length > 0;
+
+        if (!hasStringOrDynamicReplacers) {
+            CheckUtility.check(hasStringOrDynamicReplacers, 'You need at least one IReplacer');
+
+            return;
+        }
+
         const {contentCase, outputPathCase} = this._getDefaultCaseConverters(selectedConfigItem);
-        const contentReplacers: IReplacer[] = this._getReplacers(answeredReplacers, contentCase);
-        const outputPathReplacers: IReplacer[] = this._getReplacers(answeredReplacers, outputPathCase);
+        const contentReplacers: IReplacer[] = this._getReplacers(replacers, contentCase);
+        const outputPathReplacers: IReplacer[] = this._getReplacers(replacers, outputPathCase);
         const outputPath: string = await this._getOutputPath(outputPathReplacers, selectedConfigItem);
-        const shouldWriteFiles: boolean = await this._shouldWriteFiles(outputPath);
+        const shouldWriteFiles: boolean = GenerateTemplateFiles.isCommandLine
+            ? yargs.argv.overwrite === true
+            : await this._shouldWriteFiles(outputPath);
 
         if (shouldWriteFiles === false) {
             console.info('No new files created');
 
+            if (GenerateTemplateFiles.isCommandLine) {
+                console.info('Use --overwrite option to overwrite existing files');
+            }
+
             return;
         }
 
         const outputtedFilesAndFolders: string[] = await this._createFiles(
-            answeredReplacers,
+            replacers,
             outputPathReplacers,
             contentReplacers,
             outputPath,
             selectedConfigItem.entry.folderPath
         );
 
-        this._onComplete(selectedConfigItem, outputPath, outputtedFilesAndFolders, answeredReplacers);
+        this._onComplete(selectedConfigItem, outputPath, outputtedFilesAndFolders, replacers);
     }
 
     /**
@@ -109,10 +168,6 @@ export default class GenerateTemplateFiles {
         );
         const dynamicReplacers: IReplacer[] = selectedConfigItem.dynamicReplacers || [];
 
-        const hasStringOrDynamicReplacers: boolean = stringReplacers.length > 0 || dynamicReplacers.length > 0;
-
-        CheckUtility.check(hasStringOrDynamicReplacers, '"stringReplacers" or "dynamicReplacers" needs at least one item.');
-
         return [...replacers, ...dynamicReplacers];
     }
 
@@ -151,6 +206,12 @@ export default class GenerateTemplateFiles {
             return replaceString(outputPath, replacer.slot, replacer.slotValue);
         }, selectedConfigItem.output.path);
 
+        if (GenerateTemplateFiles.isCommandLine) {
+            const outputPath = yargs.argv.outputpath as string | undefined;
+
+            return outputPath ?? outputPathFormatted;
+        }
+
         const outputPathAnswer: any = await enquirer.prompt({
             type: 'input',
             name: 'outputPath',
@@ -228,7 +289,7 @@ export default class GenerateTemplateFiles {
         try {
             await recursiveCopy(entryFolderPath, outputPath, recursiveCopyOptions);
 
-            console.info(`Files outed to: '${outputPath}'`);
+            console.info(`Files saved to: '${outputPath}'`);
 
             return outputtedFilesAndFolders.filter(Boolean);
         } catch (error) {

src/index.ts

@@ -19,5 +19,9 @@ export type IReplacerSlotQuestion = IReplacerSlotQuestionDefault;
  * Main method to create your template files. Accepts an array of `IConfigItem` items.
  */
 export function generateTemplateFiles(data: IConfigItem[]): Promise<void> {
+    if (GenerateTemplateFiles.isCommandLine) {
+        return new GenerateTemplateFiles().commandLine(data);
+    }
+
     return new GenerateTemplateFiles().generate(data);
 }