Merge pull request #62 from NullVoxPopuli/add-hbs-to-supported-extensions

Add support for custom file extensions

Author: Robert Jackson

README.md

@@ -57,6 +57,24 @@ can update your project's README and your transforms README via:
 codemod-cli update-docs
 ```
 
+### File Types
+
+By default the bin script that is generated for your `codemod-cli` project will run against `.js` and `.ts` files.
+If you'd like to change that (e.g. to run against `.hbs` or `.jsx` files) you can tweak your projects `bin/cli.js` script
+to add `--extensions=hbs,jsx`:
+
+```js
+#!/usr/bin/env node
+'use strict';
+
+require('codemod-cli').runTransform(
+  __dirname,
+  process.argv[2],       /* transform name */,
+  process.argv.slice(3), /* paths or globs */
+  'hbs,jsx'
+)
+```
+
 Contributing
 ------------------------------------------------------------------------------
 

src/bin-support.js

@@ -1,6 +1,8 @@
 'use strict';
 
-async function runTransform(binRoot, transformName, args) {
+const DEFAULT_EXTENSIONS = 'js,ts';
+
+async function runTransform(binRoot, transformName, args, extensions = DEFAULT_EXTENSIONS) {
   const globby = require('globby');
   const execa = require('execa');
   const chalk = require('chalk');
@@ -17,7 +19,9 @@ async function runTransform(binRoot, transformName, args) {
     let jscodeshiftPath = path.dirname(require.resolve('jscodeshift/package'));
     let binPath = path.join(jscodeshiftPath, jscodeshiftPkg.bin.jscodeshift);
 
-    return execa(binPath, ['-t', transformPath, '--extensions', 'js,ts', ...foundPaths], {
+    let binOptions = ['-t', transformPath, '--extensions', extensions, ...foundPaths];
+
+    return execa(binPath, binOptions, {
       stdio: 'inherit',
       env: {
         CODEMOD_CLI_ARGS: JSON.stringify(options),

tests/cli-test.js

@@ -375,6 +375,7 @@ QUnit.module('codemod-cli', function(hooks) {
             },
           },
         });
+
         userProject.write({
           foo: { 'something.js': `let blah = "bar";` },
         });
@@ -392,6 +393,30 @@ QUnit.module('codemod-cli', function(hooks) {
         });
       });
 
+      QUnit.test('can specify additional extensions to run against', async function(assert) {
+        codemodProject.write({
+          transforms: {
+            main: {
+              'index.js': `
+                  module.exports = function transformer(file, api) {
+                    return file.source.toUpperCase();
+                  }
+              `,
+            },
+          },
+        });
+
+        userProject.write({
+          foo: { 'something.hbs': `<Foo />` },
+        });
+
+        await CodemodCLI.runTransform(codemodProject.path('bin'), 'main', ['foo/**'], 'hbs');
+
+        assert.deepEqual(userProject.read(), {
+          foo: { 'something.hbs': `<FOO />` },
+        });
+      });
+
       QUnit.test('runs transform against class syntax', async function(assert) {
         userProject.write({
           foo: {