generate-react-cli 7.0.6 → 7.1.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [7.1.0](https://github.com/arminbro/generate-react-cli/compare/v7.0.6...v7.1.0) (2022-03-15)
+
+
+### Features
+
+* adds dry-run flag to preview generated paths without writing files ([483aef2](https://github.com/arminbro/generate-react-cli/commit/483aef285a356bb02727d3c512d2e03e22b6493a))
+
 ### [7.0.6](https://github.com/arminbro/generate-react-cli/compare/v7.0.5...v7.0.6) (2022-02-21)
 
 ### [7.0.5](https://github.com/arminbro/generate-react-cli/compare/v7.0.4...v7.0.5) (2022-01-17)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generate-react-cli",
-  "version": "7.0.6",
+  "version": "7.1.0",
   "description": "A simple React CLI to generate components instantly and more.",
   "repository": "https://github.com/arminbro/generate-react-cli",
   "bugs": "https://github.com/arminbro/generate-react-cli/issues",

package/readme.md

@@ -151,6 +151,14 @@ Otherwise, if you don't pass any options, it will just use the default values th
     <td width="20%">Boolean</td>
     <td width="20%"><code>component.default.withTest<code></td>
   </tr>
+  <tr>
+    <td width="20%"><b>--dry-run</b></td>
+    <td width="60%">
+      Show what will be generated without writing to disk
+    </td>
+    <td width="20%">Boolean</td>
+    <td width="20%"><code>false<code></td>
+  </tr>
 </table>
 
 ### Custom component types:

package/src/commands/generateComponent.js

@@ -34,6 +34,8 @@ function initGenerateComponentCommand(args, cliConfigFile, program) {
     );
   });
 
+  componentCommand.option('--dry-run', 'Show what will be generated without writing to disk')
+
   // Component command action.
 
   componentCommand.action((componentNames, cmd) =>

package/src/utils/generateComponentUtils.js

@@ -355,39 +355,41 @@ function generateComponent(componentName, cmd, cliConfigFile) {
         console.error(chalk.red(`${filename} already exists in this path "${componentPath}".`));
       } else {
         try {
-          outputFileSync(componentPath, template);
-
-          replace({
-            regex: 'TemplateName',
-            replacement: componentName,
-            paths: [componentPath],
-            recursive: false,
-            silent: true,
-          });
-
-          replace({
-            regex: 'templateName',
-            replacement: camelCase(componentName),
-            paths: [componentPath],
-            recursive: false,
-            silent: true,
-          });
-
-          replace({
-            regex: 'template-name',
-            replacement: kebabCase(componentName),
-            paths: [componentPath],
-            recursive: false,
-            silent: true,
-          });
-
-          replace({
-            regex: 'template_name',
-            replacement: snakeCase(componentName),
-            paths: [componentPath],
-            recursive: false,
-            silent: true,
-          });
+          if (!cmd.dryRun) {
+            outputFileSync(componentPath, template);
+
+            replace({
+              regex: 'TemplateName',
+              replacement: componentName,
+              paths: [componentPath],
+              recursive: false,
+              silent: true,
+            });
+
+            replace({
+              regex: 'templateName',
+              replacement: camelCase(componentName),
+              paths: [componentPath],
+              recursive: false,
+              silent: true,
+            });
+
+            replace({
+              regex: 'template-name',
+              replacement: kebabCase(componentName),
+              paths: [componentPath],
+              recursive: false,
+              silent: true,
+            });
+
+            replace({
+              regex: 'template_name',
+              replacement: snakeCase(componentName),
+              paths: [componentPath],
+              recursive: false,
+              silent: true,
+            });
+          }
 
           console.log(chalk.green(`${filename} was successfully created at ${componentPath}`));
         } catch (error) {
@@ -397,6 +399,11 @@ function generateComponent(componentName, cmd, cliConfigFile) {
       }
     }
   });
+
+  if (cmd.dryRun) {
+    console.log()
+    console.log(chalk.yellow(`NOTE: The "dry-run" flag means no changes were made.`))
+  }
 }
 
 module.exports = {