Merge pull request #36 from codeBelt/IStringReplacerQuestion

Add IReplacerSlotQuestion

Author: codeBelt

README.md

@@ -42,7 +42,7 @@ generateTemplateFiles([
         entry: {
             folderPath: './tools/templates/react/redux-store/',
         },
-        stringReplacers: ['__store__', '__model__'],
+        stringReplacers: ['__store__', {question: 'Insert model name', slot: '__model__'}],
         output: {
             path: './src/stores/__store__(lowerCase)',
             pathAndFileNameDefaultCase: '(kebabCase)',
@@ -89,11 +89,12 @@ The `generateTemplateFiles` function takes an array of `IConfigItem` items.
 #### `IConfigItem`
 
 -   `option` - The name of the option to choose when asked.
--   `defaultCase` - The default [Case Converters](#case-converters) to use with the [Replacer Slots](#replacer-slots) in the template files. Default is `(noCase)`.
+-   `defaultCase` - The default [Case Converters](#case-converters) to use with the [Replacer Slots](#replacer-slots-or-ireplacerslotquestion) in the template files. Default is `(noCase)`.
 -   `entry.folderPath` - Path to a folder of files or a single template file.
--   `stringReplacers` - An array of [Replacer Slots](#replacer-slots) used to replace content in the designated `entry.folderPath`.
+
+-   `stringReplacers` - An array of [Replacer Slots](#replacer-slots-or-ireplacerslotquestion) used to replace content in the designated `entry.folderPath`.
 -   `dynamicReplacers` - (Optional) An array of IReplacer used to replace content in the designated `entry.folderPath`.
--   `output.path` - The desired output path for generated files. [Case Converters](#case-converters) and [Replacer Slots](#replacer-slots) can be used to make the path somewhat dynamic.
+-   `output.path` - The desired output path for generated files. [Case Converters](#case-converters) and [Replacer Slots](#replacer-slots-or-ireplacerslotquestion) can be used to make the path somewhat dynamic.
 -   `output.pathAndFileNameDefaultCase` - The [Case Converters](#case-converters) to use for the file path and file name(s).
 -   `onComplete` - (Optional) Takes a callback function that is called once the file(s) have been outputted. A [IResults](#iresults) object will be passed to the callback.
 
@@ -106,7 +107,7 @@ The `generateTemplateFiles` function takes an array of `IConfigItem` items.
     entry: {
         folderPath: './tools/templates/react/redux-store/',
     },
-    stringReplacers: ['__store__', '__model__'],
+    stringReplacers: ['__store__', { question: 'Insert model name', slot: '__model__' }],
     dynamicReplacers: [
         {slot:'__version__', slotValue: config.version},
         {slot:'__description__', slotValue: config.description}
@@ -123,13 +124,13 @@ The `generateTemplateFiles` function takes an array of `IConfigItem` items.
 
 #### `IResults`
 
-Below is an example of what you receive from the `onComplete` callback. It has the output path, list of files created and the [Replacer Slots](#replacer-slots) with the value entered.
+Below is an example of what you receive from the `onComplete` callback. It has the output path, list of files created and the [Replacer Slots](#replacer-slots-or-ireplacerslotquestion) with the value entered.
 
 -   `output.path` - The file(s) output path
 -   `output.files` - List of files created
--   `stringReplacers` - List of [Replacer Slots](#replacer-slots); name and values entered during the setup process
+-   `stringReplacers` - List of [Replacer Slots](#replacer-slots-or-ireplacerslotquestion); name and values entered during the setup process
 
-###### Example data you would get from the onComplate callback
+###### Example data you would get from the onComplete callback
 
 ```javascript
 {
@@ -158,16 +159,31 @@ Below is an example of what you receive from the `onComplete` callback. It has t
 }
 ```
 
-### Replacer Slots
+### Replacer Slots or IReplacerSlotQuestion
+
+[Replacer Slots](#replacer-slots-or-ireplacerslotquestion) are unique string value(s) to be replaced by the generator. An array of string values and/or `IReplacerSlotQuestion` objects can be used.
 
-[Replacer Slots](#replacer-slots) are unique string value(s) to be replaced by the generator.
+```javascript
+stringReplacers: ['__store__', {question: 'Insert model name', slot: '__model__'}];
+```
 
-For example you can use something like this in your template files and/or in the file path names.
+Replacer slot can be any string value you want to use. You can use something like this in your template files and/or in the file path names.
 
 -   `~replacerSlot~`
 -   `{{something else}}`
 -   `__AnythingYouWant__`
 
+#### `IReplacerSlotQuestion`
+
+Below is an example of a `IReplacerSlotQuestion`
+
+```javascript
+{question: 'Insert model name', slot: '__model__'}
+```
+
+-   `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)
+
 ### Case Converters
 
 [Case Converters](#case-converters) transform the string value entered upon use of the generator.
@@ -192,7 +208,7 @@ Here is the string `Lives down BY the River` with each of the converters:
     (snakeCase)     // lives_down_by_the_river
     (titleCase)     // Lives Down By The River
 
-One Rule: no spaces between the [Replacer Slots](#replacer-slots) and [Case Converters](#case-converters). If there is a space, [Case Converters](#case-converters) will not work.
+One Rule: no spaces between the [Replacer Slots](#replacer-slots-or-ireplacerslotquestion) and [Case Converters](#case-converters). If there is a space, [Case Converters](#case-converters) will not work.
 
 -   :white_check_mark: `__name__(camelCase)`
 -   :warning: `__name__ (camelCase)`

examples/tools/generate.js

@@ -15,7 +15,7 @@ generateTemplateFiles([
         entry: {
             folderPath: './tools/templates/angular/ngrx-store/',
         },
-        stringReplacers: ['__name__', '__model__'],
+        stringReplacers: ['__name__', { question: 'Insert model name', slot: '__model__' }],
         dynamicReplacers: [
             {slot:'__version__', slotValue: config.version},
             {slot:'__description__', slotValue: config.description}

package.json

@@ -21,8 +21,8 @@
   "scripts": {
     "---------- HELPERS -----------------------------------------": "",
     "clean": "rimraf dist",
-    "type-check": "tsc --noEmit",
-    "type-check:watch": "npm run type-check -- --watch",
+    "ts": "tsc --noEmit",
+    "ts:watch": "npm run ts -- --watch",
     "build:types": "tsc --emitDeclarationOnly",
     "prettier": "npx prettier --write \"./**/*.{ts,tsx,js,jsx,json,md}\"",
     "---------- DEVELOPMENT -------------------------------------": "",
@@ -31,7 +31,7 @@
     "---------- PRODUCTION --------------------------------------": "",
     "docs": "typedoc --out ./docs ./src --mode file --tsconfig ./tsconfig.json",
     "postdocs": "prettier --write './docs/**/*'",
-    "prebuild": "npm run type-check && npm run clean && npm run build:types",
+    "prebuild": "npm run ts && npm run clean && npm run build:types",
     "build": "rollup -c",
     "---------- TESTING -----------------------------------------": "",
     "test": "npm run lint && npm run unit",
@@ -73,11 +73,11 @@
     "@types/replace-string": "3.0.0",
     "@types/through2": "2.0.34",
     "husky": "4.2.3",
-    "jest": "25.1.0",
-    "prettier": "2.0.1",
+    "jest": "25.2.3",
+    "prettier": "2.0.2",
     "pretty-quick": "2.0.1",
     "rimraf": "3.0.2",
-    "rollup": "2.1.0",
+    "rollup": "2.2.0",
     "rollup-plugin-babel": "4.4.0",
     "rollup-plugin-commonjs": "10.1.0",
     "rollup-plugin-node-resolve": "5.2.0",

src/GenerateTemplateFiles.ts

@@ -11,6 +11,7 @@ import IReplacer from './models/IReplacer';
 import IResults from './models/IResults';
 import IDefaultCaseConverter from './models/IDefaultCaseConverter';
 import CheckUtility from './utilities/CheckUtility';
+import IReplacerSlotQuestion from './models/IReplacerSlotQuestion';
 
 export default class GenerateTemplateFiles {
     /**
@@ -82,11 +83,11 @@ export default class GenerateTemplateFiles {
      * New question asking what should text should be used to replace the template text.
      */
     private async _getReplacerSlotValues(selectedConfigItem: IConfigItem): Promise<IReplacer[]> {
-        const replacerQuestions: any[] = selectedConfigItem.stringReplacers.map((str: string) => {
+        const replacerQuestions: any[] = selectedConfigItem.stringReplacers.map((item: string | IReplacerSlotQuestion) => {
             return {
                 type: 'input',
-                name: str,
-                message: `Replace ${str} with:`,
+                name: StringUtility.isString(item) ? item : item.slot,
+                message: StringUtility.isString(item) ? `Replace ${item} with` : item.question,
                 validate: (replacerSlotValue: string) => {
                     const isValid: boolean = Boolean(replacerSlotValue.trim());
 

src/index.ts

@@ -4,6 +4,7 @@ import StringUtilityDefault from './utilities/StringUtility';
 import CaseConverterEnumDefault from './constants/CaseConverterEnum';
 import IResultsDefault from './models/IResults';
 import IReplacerDefault from './models/IReplacer';
+import IReplacerSlotQuestionDefault from './models/IReplacerSlotQuestion';
 
 export {StringUtilityDefault as StringUtility};
 export {CaseConverterEnumDefault as CaseConverterEnum};
@@ -12,6 +13,7 @@ export {CaseConverterEnumDefault as CaseConverterEnum};
 export type IResults = IResultsDefault;
 export type IConfigItem = IConfigItemDefault;
 export type IReplacer = IReplacerDefault;
+export type IReplacerSlotQuestion = IReplacerSlotQuestionDefault;
 
 /**
  * Main method to create your template files. Accepts an array of `IConfigItem` items.

src/models/IConfigItem.ts

@@ -1,6 +1,7 @@
 import CaseConverterEnum from '../constants/CaseConverterEnum';
 import IResults from './IResults';
 import IReplacer from './IReplacer';
+import IReplacerSlotQuestion from './IReplacerSlotQuestion';
 
 /**
  * ```
@@ -53,7 +54,7 @@ export default interface IConfigItem {
      * stringReplacers: ['__store__', '__model__'],
      * ```
      */
-    stringReplacers: string[];
+    stringReplacers: (string | IReplacerSlotQuestion)[];
     /**
      * ```
      * dynamicReplacers: [{slot:'__description__', slotValue: config.description}],

src/models/IReplacerSlotQuestion.ts

@@ -0,0 +1,4 @@
+export default interface IReplacerSlotQuestion {
+    readonly question: string;
+    readonly slot: string;
+}

src/utilities/StringUtility.test.ts

@@ -101,4 +101,22 @@ describe('StringUtility', () => {
             });
         });
     });
+
+    describe('isString', () => {
+        it('should return true.', () => {
+            const actualResult = StringUtility.isString('str');
+            const expectedResult = true;
+
+            expect(actualResult).toBe(expectedResult);
+        });
+
+        it('should return false.', () => {
+            const falseItems = [undefined, null, true, false, 0, 1, {}, {prop: 'data'}];
+            const expectedResult = false;
+
+            falseItems.forEach((value) => {
+                expect(StringUtility.isString(value)).toEqual(expectedResult);
+            });
+        });
+    });
 });

src/utilities/StringUtility.ts

@@ -152,4 +152,16 @@ export default class StringUtility {
 
         return sentence.charAt(0).toUpperCase() + sentence.substr(1).toLowerCase();
     }
+
+    /**
+     * Determines if the value is a string value
+     *
+     * ```
+     * StringUtility.isString('livesDown_by-the.River');
+     * // true
+     * ```
+     */
+    public static isString(value: unknown): value is string {
+        return typeof value === 'string';
+    }
 }