PR Feedback

Author: TikiTDO

.editorconfig

@@ -4,7 +4,7 @@ root = true
 [*]
 charset = utf-8
 indent_style = space
-indent_size = 4
+indent_size = 2
 insert_final_newline = true
 trim_trailing_whitespace = true
 

README.md

@@ -212,21 +212,21 @@ Here is the string `Lives down BY the River` with each of the converters:
 // If you typed in 'Lives down BY the River' for the a Replacer Slot named '__replacerSlot__' and
 // used one of the optional Case Converters you would get the following:
 
-__replacerSlot__(noCase)        // Lives down BY the River
-__replacerSlot__(camelCase)     // livesDownByTheRiver
-__replacerSlot__(constantCase)  // LIVES_DOWN_BY_THE_RIVER
-__replacerSlot__(dotCase)       // lives.down.by.the.river
-__replacerSlot__(kebabCase)     // lives-down-by-the-river
-__replacerSlot__(lowerCase)     // livesdownbytheriver
-__replacerSlot__(pascalCase)    // LivesDownByTheRiver
-__replacerSlot__(pathCase)      // lives/down/by/the/river
-__replacerSlot__(sentenceCase)  // Lives down by the river
-__replacerSlot__(snakeCase)     // lives_down_by_the_river
-__replacerSlot__(titleCase)     // Lives Down By The River
+__replacerSlot__(noCase); //        Lives down BY the River
+__replacerSlot__(camelCase); //     livesDownByTheRiver
+__replacerSlot__(constantCase); //  LIVES_DOWN_BY_THE_RIVER
+__replacerSlot__(dotCase); //       lives.down.by.the.river
+__replacerSlot__(kebabCase); //     lives-down-by-the-river
+__replacerSlot__(lowerCase); //     livesdownbytheriver
+__replacerSlot__(pascalCase); //    LivesDownByTheRiver
+__replacerSlot__(pathCase); //      lives/down/by/the/river
+__replacerSlot__(sentenceCase); //  Lives down by the river
+__replacerSlot__(snakeCase); //     lives_down_by_the_river
+__replacerSlot__(titleCase); //     Lives Down By The River
 
 // Note: you can set a 'defaultCase' converter in IConfigItem so all
 // Replacer Slots without a Case Converter will be transformed the same way.
-__replacerSlot__                // LivesDownByTheRiver
+__replacerSlot__; //                LivesDownByTheRiver
 ```
 
 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.
@@ -240,15 +240,15 @@ You can use `generate-template-files` to generate your template files programmat
 
 The following example will generate the component, unit tests, and the SCSS module in one do.
 
-```ts
-// generateTemplateFile.ts
-import { generateTemplateFilesCommandLine, CaseConverterEnum } from 'generate-template-files');
+```js
+// generateTemplateFile.js
+const { generateTemplateFilesBatch } = require('generate-template-files');
 
-export const componentWithInterface = async (componentName: string, componentScope: string = "common"): Promise<void> => {
-  await generateTemplateFilesBatch([
+const componentWithInterface = (componentName, componentScope = 'common') => {
+  generateTemplateFilesBatch([
     {
       option: 'Component',
-      defaultCase: CaseConverterEnum.PascalCase,
+      defaultCase: '(pascalCase)',
       entry: {
         folderPath: './tools/templates/react/component',
       },
@@ -258,12 +258,12 @@ export const componentWithInterface = async (componentName: string, componentSco
       ],
       output: {
         path: `./src/component/__scope__(camelCase)`,
-        pathAndFileNameDefaultCase: CaseConverterEnum.PascalCase,
+        pathAndFileNameDefaultCase: '(pascalCase)',
       },
     },
     {
       option: 'Component Interface',
-      defaultCase: CaseConverterEnum.PascalCase,
+      defaultCase: '(pascalCase)',
       entry: {
         folderPath: './tools/templates/react/I__interface__.ts',
       },
@@ -273,10 +273,12 @@ export const componentWithInterface = async (componentName: string, componentSco
       ],
       output: {
         path: `./src/component/__scope__(camelCase)/I__interface__.ts`,
-        pathAndFileNameDefaultCase: CaseConverterEnum.PascalCase,
+        pathAndFileNameDefaultCase: '(pascalCase)',
       },
     },
-  ]);
+  ]).catch(() => {
+    console.log('Build Error');
+  });
 };
 ```
 

examples/tools/batchGenerate.js

@@ -1,7 +1,7 @@
 // generateTemplateFile.js
 const {generateTemplateFilesBatch, CaseConverterEnum} = require('../../dist/generate-template-files.cjs');
 // Note: In your file it will be like this:
-// const {generateTemplateFilesBatch} = require('generate-template-files');
+// const {generateTemplateFilesBatch, CaseConverterEnum} = require('generate-template-files');
 
 const componentName = "Example"
 const componentScope = "common"

src/GenerateTemplateFiles.ts

@@ -96,18 +96,14 @@ export default class GenerateTemplateFiles {
   public async batchGenerate(options: Omit<IConfigItem, 'stringReplacers'>[]) {
     this._isBatch = true;
 
-    try {
-      throwErrorIfNoConfigItems(options);
-      throwErrorIfStringReplacersExistOrNoDynamicReplacers(options);
+    throwErrorIfNoConfigItems(options);
+    throwErrorIfStringReplacersExistOrNoDynamicReplacers(options);
 
-      for (const selectedConfigItem of options) {
-        const answeredReplacers: IReplacer[] = await this._getDynamicReplacerSlotValues(
-          selectedConfigItem
-        );
-        await this._outputFiles(selectedConfigItem, answeredReplacers);
-      }
-    } catch (error) {
-      displayError(error.message);
+    for (const selectedConfigItem of options) {
+      const answeredReplacers: IReplacer[] = await this._getDynamicReplacerSlotValues(
+        selectedConfigItem
+      );
+      await this._outputFiles(selectedConfigItem, answeredReplacers);
     }
   }
 

src/utilities/GenerateTemplateFiles.batch.test.ts

@@ -2,7 +2,7 @@ import GenerateTemplateFiles from '../GenerateTemplateFiles';
 import { IConfigItem } from '../index';
 import CaseConverterEnum from '../constants/CaseConverterEnum';
 
-describe.skip('GenerateTemplateFiles - Batch', () => {
+describe('GenerateTemplateFiles - Batch', () => {
   test('should throw an error if no IConfigItem items', () => {
     const items: IConfigItem[] = [];
     const gtf = new GenerateTemplateFiles();
@@ -12,7 +12,7 @@ describe.skip('GenerateTemplateFiles - Batch', () => {
     );
   });
 
-  test('should throw an error if no stringReplacers or dynamicReplacers', () => {
+  test('should throw an error if no stringReplacers or dynamicReplacers', async () => {
     const items: IConfigItem[] = [
       {
         option: 'some-template',
@@ -27,12 +27,12 @@ describe.skip('GenerateTemplateFiles - Batch', () => {
     ];
     const gtf = new GenerateTemplateFiles();
 
-    expect(() => gtf.commandLine(items)).rejects.toThrowError(
-      'IConfigItem needs to have a stringReplacers or dynamicReplacers.'
+    await expect(() => gtf.batchGenerate(items)).rejects.toThrowError(
+      'IConfigItem for batchGenerate does not support stringReplacers, and must have dynamicReplacers'
     );
   });
 
-  test('should throw an error if batch IConfigItem is not found for option name', () => {
+  test('should throw an error if batch IConfigItem is not found for option name', async () => {
     const items: IConfigItem[] = [
       {
         option: 'some-template',
@@ -48,7 +48,7 @@ describe.skip('GenerateTemplateFiles - Batch', () => {
     ];
     const gtf = new GenerateTemplateFiles();
 
-    expect(() => gtf.batchGenerate(items)).rejects.toThrowError(
+    await expect(() => gtf.batchGenerate(items)).rejects.toThrowError(
       `IConfigItem for batchGenerate does not support stringReplacers, and must have dynamicReplacers.`
     );
   });

src/utilities/GenerateTemplateFiles.commandline.test.ts

@@ -2,14 +2,27 @@ import GenerateTemplateFiles from '../GenerateTemplateFiles';
 import { IConfigItem } from '../index';
 import CaseConverterEnum from '../constants/CaseConverterEnum';
 import yargs from 'yargs';
+import colors from 'colors';
+
+let consoleInfoSpy: jest.SpyInstance;
+describe('GenerateTemplateFiles - Command Line', () => {
+  beforeEach(() => {
+    consoleInfoSpy = jest.spyOn(global.console, 'info').mockImplementation(() => null);
+  });
+
+  afterEach(() => {
+    consoleInfoSpy.mockRestore();
+  });
 
-describe.skip('GenerateTemplateFiles - Command Line', () => {
   test('should throw an error if no IConfigItem items', () => {
     const items: IConfigItem[] = [];
     const gtf = new GenerateTemplateFiles();
 
-    expect(() => gtf.commandLine(items)).rejects.toThrowError(
-      'There was no IConfigItem items found.'
+    gtf.commandLine(items);
+    expect(consoleInfoSpy).toBeCalledWith(
+      colors.bold.red(
+        `[Error in generate-template-files]: ${colors.red('There was no IConfigItem items found.')}`
+      )
     );
   });
 
@@ -33,8 +46,13 @@ describe.skip('GenerateTemplateFiles - Command Line', () => {
     ];
     const gtf = new GenerateTemplateFiles();
 
-    expect(() => gtf.commandLine(items)).rejects.toThrowError(
-      `No IConfigItem found for ${notFoundOptionName}`
+    gtf.commandLine(items);
+    expect(consoleInfoSpy).toBeCalledWith(
+      colors.bold.red(
+        `[Error in generate-template-files]: ${colors.red(
+          `No IConfigItem found for ${notFoundOptionName}`
+        )}`
+      )
     );
   });
 
@@ -53,8 +71,13 @@ describe.skip('GenerateTemplateFiles - Command Line', () => {
     ];
     const gtf = new GenerateTemplateFiles();
 
-    expect(() => gtf.commandLine(items)).rejects.toThrowError(
-      'IConfigItem needs to have a stringReplacers or dynamicReplacers.'
+    gtf.commandLine(items);
+    expect(consoleInfoSpy).toBeCalledWith(
+      colors.bold.red(
+        `[Error in generate-template-files]: ${colors.red(
+          'IConfigItem needs to have a stringReplacers or dynamicReplacers.'
+        )}`
+      )
     );
   });
 });