Merge pull request #78 from jsturgis/master

[docs] Update the readme blueprint for local usage
rwjblue · Mar 29, 2020 · 455a16b · 455a16b
2 parents b6271b7 + 508e591
commit 455a16b
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/commands/global/new.js b/commands/global/new.js
@@ -16,6 +16,7 @@ module.exports.handler = async function handler(options) {
   const { stripIndent } = require('common-tags');
   const latestVersion = require('latest-version');
   const pkg = require('../../package.json');
+  const cliPath = '/bin/cli.js';
 
   fs.outputFileSync(
     projectName + '/README.md',
@@ -37,6 +38,11 @@ module.exports.handler = async function handler(options) {
       ${projectName} <TRANSFORM NAME> path/of/files/ or/some**/*glob.js
       \`\`\`
 
+      ## Local Usage
+      \`\`\`
+      node .${cliPath} <TRANSFORM NAME> path/of/files/ or/some**/*glob.js
+      \`\`\`
+
       ## Transforms
 
       <!--TRANSFORMS_START-->
@@ -72,7 +78,7 @@ module.exports.handler = async function handler(options) {
         'update-docs': 'codemod-cli update-docs',
         coveralls: 'cat ./coverage/lcov.info | node node_modules/.bin/coveralls',
       },
-      bin: './bin/cli.js',
+      bin: `.${cliPath}`,
       keywords: ['codemod-cli'],
       dependencies: {
         'codemod-cli': `^${pkg.version}`,
@@ -239,7 +245,7 @@ module.exports.handler = async function handler(options) {
     `
   );
   fs.outputFileSync(
-    projectName + '/bin/cli.js',
+    `${projectName}${cliPath}`,
     stripIndent`
       #!/usr/bin/env node
       'use strict';

diff --git a/commands/local/generate/codemod.js b/commands/local/generate/codemod.js
@@ -70,6 +70,11 @@ module.exports.handler = function handler(options) {
       ${projectName} ${codemodName} path/of/files/ or/some**/*glob.js
       \`\`\`
 
+      ## Local Usage
+      \`\`\`
+      node ./bin/cli.js ${codemodName} path/of/files/ or/some**/*glob.js
+      \`\`\`
+
       ## Input / Output
 
       <!--FIXTURES_TOC_START-->