feat: add --extension/-x parameter overwrite default .js extension parser (#35)

BREAKING CHANGE:

This changes the output generated by create-index and can effect CI if it runs linting tests against create-index.

.travis.yml

@@ -1,12 +1,11 @@
 language: node_js
 node_js:
+  - node
   - 7
   - 6
   - 5
-scripts:
-  - npm run test
-  - npm run lint
-  - npm run build
+after_success:
+  - semantic-release pre && npm publish && semantic-release post
 notifications:
   email: false
 sudo: false

README.md

@@ -36,8 +36,8 @@ This created `index.js` with:
 ```js
 // @create-index
 
-export bar from './bar.js';
-export foo from './foo.js';
+export { default as bar } from './bar.js';
+export { default as foo } from './foo.js';
 
 ```
 
@@ -66,9 +66,9 @@ This have updated `index.js` file:
 ```js
 // @create-index
 
-export bar from './bar.js';
-export baz from './baz.js';
-export foo from './foo.js';
+export { default as bar } from './bar.js';
+export { default as baz } from './baz.js';
+export { default as foo } from './foo.js';
 
 ```
 
@@ -82,10 +82,13 @@ npm install create-index
 create-index --help
 
 Options:
-  --update, -u  Recursively iterates target directories looking for "index.js"
-                files that start with "'create index';\n" (create-index index
-                file). Updates found index files. Does not create new index
-                files.                                [boolean] [default: false]
+  --recursive, -r     Create/update index files recursively. Halts on any unsafe
+                      "index.js" files.               [boolean] [default: false]
+  --ignoreUnsafe, -i  Ignores unsafe "index.js" files instead of halting.
+                                                      [boolean] [default: false]
+  --update, -u        Updates only previously created index files (recursively).
+                                                      [boolean] [default: false]
+  --banner            Add a custom banner at the top of the index file  [string]
 
 Examples:
   create-index ./src ./src/utilities   Creates or updates an existing
@@ -172,10 +175,10 @@ drwxr-xr-x   2 gajus  staff    68B  6 Jan 15:29 foo
 Given the above directory contents, `./index.js` will be:
 
 ```js
-'create index';
+// @create-index
 
-import bar from './bar';
-import foo from './foo.js';
+import { default as bar } from './bar';
+import { default as foo } from './foo.js';
 
 export {
     bar,
@@ -187,6 +190,6 @@ When file has the same name as a sibling directory, file `import` takes preceden
 
 Directories that do not have `./index.js` in themselves will be excluded.
 
-When run again, `create-index` will update existing `./index.js` if it starts with `'create index';\n\n`.
+When run again, `create-index` will update existing `./index.js` if it starts with `// @create-index\n\n`.
 
-If `create-index` is executed against a directory that contains `./index.js`, which does not start with `'create index';\n\n`, an error will be thrown.
+If `create-index` is executed against a directory that contains `./index.js`, which does not start with `// @create-index\n\n`, an error will be thrown.

package.json

@@ -1,33 +1,18 @@
 {
-  "name": "create-index",
-  "description": "Creates ES6 ./index.js file in target directories that imports and exports all sibling files and directories.",
-  "version": "1.0.0",
-  "main": "./dist/index.js",
-  "bin": "./dist/bin/create-index.js",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/gajus/create-index"
-  },
-  "keywords": [
-    "index",
-    "import",
-    "export"
-  ],
-  "engines": {
-    "node": ">=5"
-  },
   "author": {
-    "name": "Gajus Kuizinas",
     "email": "gajus@gajus.com",
+    "name": "Gajus Kuizinas",
     "url": "http://gajus.com"
   },
-  "license": "BSD-3-Clause",
-  "scripts": {
-    "lint": "eslint ./src ./tests",
-    "test": "mocha --compilers js:babel-register",
-    "build": "babel --source-maps --copy-files ./src --out-dir ./dist",
-    "create-index": "node ./dist/bin/create-index ./src/utilities"
+  "bin": "./dist/bin/create-index.js",
+  "dependencies": {
+    "chalk": "^1.1.3",
+    "glob": "^7.1.1",
+    "lodash": "^4.16.6",
+    "moment": "^2.15.2",
+    "yargs": "^6.3.0"
   },
+  "description": "Creates ES6 ./index.js file in target directories that imports and exports all sibling files and directories.",
   "devDependencies": {
     "babel-cli": "^6.18.0",
     "babel-plugin-transform-es2015-destructuring": "^6.18.0",
@@ -36,15 +21,34 @@
     "babel-plugin-transform-export-extensions": "^6.8.0",
     "babel-register": "^6.18.0",
     "chai": "^3.5.0",
+    "cross-env": "^3.1.3",
     "eslint": "^3.9.1",
     "eslint-config-canonical": "^4.0.0",
-    "mocha": "^3.1.2"
+    "husky": "^0.11.9",
+    "mocha": "^3.1.2",
+    "semantic-release": "^6.3.2"
   },
-  "dependencies": {
-    "glob": "^7.1.1",
-    "lodash": "^4.16.6",
-    "yargs": "^6.3.0",
-    "chalk": "^1.1.3",
-    "moment": "^2.15.2"
-  }
+  "engines": {
+    "node": ">=5"
+  },
+  "keywords": [
+    "index",
+    "import",
+    "export"
+  ],
+  "license": "BSD-3-Clause",
+  "main": "./dist/index.js",
+  "name": "create-index",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gajus/create-index"
+  },
+  "scripts": {
+    "build": "cross-env NODE_ENV=production babel --source-maps --copy-files ./src --out-dir ./dist",
+    "create-index": "node ./dist/bin/create-index ./src/utilities",
+    "lint": "cross-env NODE_ENV=development eslint ./src ./tests",
+    "precommit": "npm run test",
+    "test": "npm run build && npm run lint && cross-env NODE_ENV=development mocha --compilers js:babel-register"
+  },
+  "version": "1.1.0"
 }

src/bin/create-index.js

@@ -8,17 +8,52 @@ import {
 const argv = yargs
   .demand(1)
   .options({
-    'update': {
+    recursive: {
+      alias: 'r',
+      default: false,
+      description: 'Create/update index files recursively. Halts on any unsafe "index.js" files.',
+      type: 'boolean'
+    }
+  })
+  .options({
+    ignoreUnsafe: {
+      alias: 'i',
+      default: false,
+      description: 'Ignores unsafe "index.js" files instead of halting.',
+      type: 'boolean'
+    }
+  })
+  .options({
+    update: {
       alias: 'u',
       default: false,
-      description: 'Recursively iterates target directories looking for "index.js" files that start with "\'create index\';\\n" (create-index index file). Updates found index files. Does not create new index files.',
+      description: 'Updates only previously created index files (recursively).',
       type: 'boolean'
     }
   })
+  .options({
+    banner: {
+      description: 'Add a custom banner at the top of the index file',
+      type: 'string'
+    }
+  })
+  .options({
+    extensions: {
+      alias: 'x',
+      default: ['js'],
+      description: 'Allows some extensions to be parsed as valid source. First extension will always be preferred to homonyms with another allowed extension.',
+      type: 'array'
+    }
+  })
   .example('create-index ./src ./src/utilities', 'Creates or updates an existing create-index index file in the target (./src, ./src/utilities) directories.')
   .example('create-index --update ./src ./tests', 'Finds all create-index index files in the target directories and descending directories. Updates found index files.')
+  .example('create-index ./src --extensions js jsx', 'Creates or updates an existing create-index index file in the target (./src) directory for both .js and .jsx extensions.')
   .argv;
 
 writeIndexCli(argv._, {
-  updateIndex: argv.updateIndex
+  banner: argv.banner,
+  extensions: argv.extensions,
+  ignoreUnsafe: argv.ignoreUnsafe,
+  recursive: argv.recursive,
+  updateIndex: argv.update
 });

src/utilities/createIndexCode.js

@@ -14,7 +14,7 @@ const buildExportBlock = (files) => {
   let importBlock;
 
   importBlock = _.map(files, (fileName) => {
-    return 'export ' + safeVariableName(fileName) + ' from \'./' + fileName + '\';';
+    return 'export { default as ' + safeVariableName(fileName) + ' } from \'./' + fileName + '\';';
   });
 
   importBlock = importBlock.join('\n');
@@ -22,10 +22,22 @@ const buildExportBlock = (files) => {
   return importBlock;
 };
 
-export default (filePaths) => {
+export default (filePaths, options = {}) => {
   let code;
 
-  code = '\'create index\';\n\n';
+  code = '';
+
+  if (options.banner) {
+    const banners = _.isArray(options.banner) ? options.banner : [options.banner];
+
+    banners.forEach((banner) => {
+      code += banner + '\n';
+    });
+
+    code += '\n';
+  }
+
+  code += '// @create-index\n\n';
 
   if (filePaths.length) {
     const sortedFilePaths = filePaths.sort();

src/utilities/findIndexFiles.js

@@ -3,23 +3,18 @@ import _ from 'lodash';
 import glob from 'glob';
 import validateTargetDirectory from './validateTargetDirectory';
 
-export default (directoryPath) => {
-  let targetDirectories;
+export default (directoryPath, options = {}) => {
+  let fileName, targetDirectories;
 
-  targetDirectories = glob.sync(path.join(directoryPath, './**/index.js'));
+  fileName = options.fileName || 'index.js';
+  fileName = './**/' + fileName;
+
+  targetDirectories = glob.sync(path.join(directoryPath, fileName));
 
   targetDirectories = _.filter(targetDirectories, (targetDirectoryPath) => {
-    try {
-      validateTargetDirectory(path.dirname(targetDirectoryPath));
-
-      return true;
-
-      // eslint-disable-next-line no-empty
-    } catch (error) {
-
-    }
-
-    return false;
+    return validateTargetDirectory(path.dirname(targetDirectoryPath), {
+      silent: options.silent
+    });
   });
 
   targetDirectories = _.map(targetDirectories, path.dirname);

src/utilities/index.js

@@ -1,4 +1,4 @@
-'create index';
+// @create-index
 
 export createIndexCode from './createIndexCode.js';
 export findIndexFiles from './findIndexFiles.js';
@@ -8,4 +8,3 @@ export sortByDepth from './sortByDepth.js';
 export validateTargetDirectory from './validateTargetDirectory.js';
 export writeIndex from './writeIndex.js';
 export writeIndexCli from './writeIndexCli.js';
-

src/utilities/readDirectory.js

@@ -31,18 +31,38 @@ const isSafeName = (fileName) => {
   return /^[a-z][a-z0-9._]+$/i.test(fileName);
 };
 
-const removeDuplicates = (files) => {
+const stripExtension = (fileName) => {
+  const pos = fileName.lastIndexOf('.');
+
+  if (pos === -1) {
+    return fileName;
+  }
+
+  return fileName.substr(0, pos);
+};
+
+const removeDuplicates = (files, preferredExtension) => {
   return _.filter(files, (fileName) => {
-    return !_.includes(files, fileName + '.js');
+    const withoutExtension = stripExtension(fileName);
+    const mainAlternative = withoutExtension + '.' + preferredExtension;
+
+    if (mainAlternative === fileName) {
+      return true;
+    }
+
+    return !_.includes(files, mainAlternative);
   });
 };
 
-export default (directoryPath) => {
+export default (directoryPath, options = {}) => {
   let children;
 
-  validateTargetDirectory(directoryPath);
+  if (!validateTargetDirectory(directoryPath, {silent: options.silent})) {
+    return false;
+  }
 
   children = fs.readdirSync(directoryPath);
+  const {extensions = ['js']} = options;
 
   children = _.filter(children, (fileName) => {
     const absolutePath = path.resolve(directoryPath, fileName);
@@ -64,7 +84,9 @@ export default (directoryPath) => {
       return false;
     }
 
-    if (!isDirectory && !_.endsWith(fileName, '.js')) {
+    if (!isDirectory && !extensions.some((ext) => {
+      return _.endsWith(fileName, '.' + ext);
+    })) {
       return false;
     }
 
@@ -75,7 +97,7 @@ export default (directoryPath) => {
     return true;
   });
 
-  children = removeDuplicates(children);
+  children = removeDuplicates(children, extensions[0]);
 
   return children.sort();
 };

src/utilities/validateTargetDirectory.js

@@ -1,18 +1,26 @@
 import fs from 'fs';
 import path from 'path';
-import _ from 'lodash';
 
-export default (targetDirectory) => {
+export default (targetDirectory, options = {}) => {
+  const silent = options.silent;
   let stats;
 
   try {
     stats = fs.statSync(targetDirectory);
   } catch (error) {
-    throw new Error('Directory "' + targetDirectory + '" does not exist.');
+    if (silent) {
+      return false;
+    } else {
+      throw new Error('Directory "' + targetDirectory + '" does not exist.');
+    }
   }
 
   if (!stats.isDirectory()) {
-    throw new Error('"' + targetDirectory + '" is not a directory.');
+    if (silent) {
+      return false;
+    } else {
+      throw new Error('"' + targetDirectory + '" is not a directory.');
+    }
   }
 
   const indexFilePath = path.resolve(targetDirectory, './index.js');
@@ -25,9 +33,14 @@ export default (targetDirectory) => {
 
   const indexFile = fs.readFileSync(indexFilePath, 'utf8');
 
-  if (!_.startsWith(indexFile, '// @create-index\n')) {
-    throw new Error('"' + indexFilePath + '" unsafe index.');
+  if (!indexFile.match(/(?:^|[\n\r]+)\/\/ @create-index[\n\r]+/)) {
+    if (silent) {
+      return false;
+    } else {
+      throw new Error('"' + indexFilePath + '" unsafe index.');
+    }
   }
 
   return true;
 };
+

src/utilities/writeIndex.js

@@ -6,15 +6,14 @@ import validateTargetDirectory from './validateTargetDirectory';
 import readDirectory from './readDirectory';
 import sortByDepth from './sortByDepth';
 
-export default (directoryPaths) => {
-  const sortedDirectoryPaths = sortByDepth(directoryPaths);
+export default (directoryPaths, options = {}) => {
+  const sortedDirectoryPaths = sortByDepth(directoryPaths)
+    .filter((directoryPath) => {
+      return validateTargetDirectory(directoryPath, {silent: options.ignoreUnsafe});
+    });
 
   _.forEach(sortedDirectoryPaths, (directoryPath) => {
-    validateTargetDirectory(directoryPath);
-  });
-
-  _.forEach(sortedDirectoryPaths, (directoryPath) => {
-    const siblings = readDirectory(directoryPath);
+    const siblings = readDirectory(directoryPath, options);
     const indexCode = createIndexCode(siblings);
     const indexFilePath = path.resolve(directoryPath, 'index.js');
 

src/utilities/writeIndexCli.js

@@ -15,27 +15,43 @@ export default (directoryPaths, options = {}) => {
   sortedDirectoryPaths = sortByDepth(directoryPaths);
 
   log('Target directories', sortedDirectoryPaths);
-  log('Update index:', options.updateIndex ? chalk.green('true') : chalk.red('false'));
-
   if (options.updateIndex) {
-    sortedDirectoryPaths = _.map(sortedDirectoryPaths, findIndexFiles);
+    log('Update index:', options.updateIndex ? chalk.green('true') : chalk.red('false'));
+  } else {
+    log('Recursive:', options.recursive ? chalk.green('true') : chalk.red('false'));
+    log('Ignore unsafe:', options.ignoreUnsafe ? chalk.green('true') : chalk.red('false'));
+    log('Extensions:', chalk.green(options.extensions));
+  }
+
+  if (options.updateIndex || options.recursive) {
+    sortedDirectoryPaths = _.map(sortedDirectoryPaths, (dir) => {
+      return findIndexFiles(dir, {
+        fileName: options.updateIndex ? 'index.js' : '*',
+        silent: options.updateIndex || options.ignoreUnsafe
+      });
+    });
     sortedDirectoryPaths = _.flatten(sortedDirectoryPaths);
     sortedDirectoryPaths = _.uniq(sortedDirectoryPaths);
     sortedDirectoryPaths = sortByDepth(sortedDirectoryPaths);
 
-    log('Found index file in:', sortedDirectoryPaths);
+    log('Updating index files in:', sortedDirectoryPaths.reverse().join(', '));
   }
 
-  _.forEach(sortedDirectoryPaths, (directoryPath) => {
-    validateTargetDirectory(directoryPath);
+  sortedDirectoryPaths = sortedDirectoryPaths.filter((directoryPath) => {
+    return validateTargetDirectory(directoryPath, {silent: options.ignoreUnsafe});
   });
 
   _.forEach(sortedDirectoryPaths, (directoryPath) => {
     let existingIndexCode;
 
-    const siblings = readDirectory(directoryPath);
+    const siblings = readDirectory(directoryPath, {
+      extensions: options.extensions,
+      silent: options.ignoreUnsafe
+    });
 
-    const indexCode = createIndexCode(siblings);
+    const indexCode = createIndexCode(siblings, {
+      banner: options.banner
+    });
 
     const indexFilePath = path.resolve(directoryPath, 'index.js');
 
@@ -52,7 +68,7 @@ export default (directoryPaths, options = {}) => {
     fs.writeFileSync(indexFilePath, indexCode);
 
     if (existingIndexCode && existingIndexCode === indexCode) {
-      log(indexFilePath, chalk.yellow('[index have not changed]'));
+      log(indexFilePath, chalk.yellow('[index has not changed]'));
     } else if (existingIndexCode && existingIndexCode !== indexCode) {
       log(indexFilePath, chalk.green('[updated index]'));
     } else {

test/createIndexCode.js

@@ -11,26 +11,26 @@ describe('createIndexCode()', () => {
     const indexCode = createIndexCode([]);
 
     expect(indexCode).to.equal(codeExample(`
-'create index';
+// @create-index
         `));
   });
   it('describes a single child', () => {
     const indexCode = createIndexCode(['foo']);
 
     expect(indexCode).to.equal(codeExample(`
-'create index';
+// @create-index
 
-export foo from './foo';
+export { default as foo } from './foo';
         `));
   });
   it('describes multiple children', () => {
     const indexCode = createIndexCode(['bar', 'foo']);
 
     expect(indexCode).to.equal(codeExample(`
-'create index';
+// @create-index
 
-export bar from './bar';
-export foo from './foo';
+export { default as bar } from './bar';
+export { default as foo } from './foo';
         `));
   });
   context('file with extension', () => {
@@ -38,9 +38,9 @@ export foo from './foo';
       const indexCode = createIndexCode(['foo.js']);
 
       expect(indexCode).to.equal(codeExample(`
-'create index';
+// @create-index
 
-export foo from './foo.js';
+export { default as foo } from './foo.js';
             `));
     });
   });
@@ -49,10 +49,10 @@ export foo from './foo.js';
       const indexCode = createIndexCode(['foo', 'bar']);
 
       expect(indexCode).to.equal(codeExample(`
-'create index';
+// @create-index
 
-export bar from './bar';
-export foo from './foo';
+export { default as bar } from './bar';
+export { default as foo } from './foo';
             `));
     });
   });

test/fixtures/validate-target-directory/safe-index-with-banner/index.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+
+// @create-index

test/fixtures/write-index/mixed/index.js

@@ -1,5 +1,5 @@
-'create index';
+// @create-index
 
-export bar from './bar';
-export foo from './foo.js';
+export { default as bar } from './bar';
+export { default as foo } from './foo.js';
 

test/readDirectory.js

@@ -49,6 +49,45 @@ describe('readDirectory()', () => {
       expect(names).to.deep.equal(['present.js']);
     });
   });
+  context('target directory contains non js files, and not configured to allow that', () => {
+    it('prefers file', () => {
+      const names = readDirectory(path.resolve(fixturesPath, 'children-files-alt-extension'));
+
+      expect(names).to.deep.equal(['present.js']);
+    });
+  });
+  context('target directory contains non js files, and allowing only jsx', () => {
+    it('prefers file', () => {
+      const options = { extensions: ['jsx'] };
+      const names = readDirectory(path.resolve(fixturesPath, 'children-files-alt-extension'), options);
+
+      expect(names).to.deep.equal(['bar.jsx']);
+    });
+  });
+  context('target directory contains non js files, and allowing both js and jsx', () => {
+    it('prefers file', () => {
+      const options = { extensions: ['js', 'jsx'] };
+      const names = readDirectory(path.resolve(fixturesPath, 'children-files-alt-extension'), options);
+
+      expect(names).to.deep.equal(['bar.jsx', 'present.js']);
+    });
+  });
+  context('target directory contains homonyms files, and allowing both js and jsx, will prefer JS as it is first extension listed', () => {
+    it('prefers file', () => {
+      const options = { extensions: ['js', 'jsx'] };
+      const names = readDirectory(path.resolve(fixturesPath, 'children-files-alt-extension-with-homonyms'), options);
+
+      expect(names).to.deep.equal(['bar.js', 'present.js']);
+    });
+  });
+  context('target directory contains homonyms files, and allowing both js and jsx, will prefer JSX as it is first extension listed', () => {
+    it('prefers file', () => {
+      const options = { extensions: ['jsx', 'js'] };
+      const names = readDirectory(path.resolve(fixturesPath, 'children-files-alt-extension-with-homonyms'), options);
+
+      expect(names).to.deep.equal(['bar.jsx', 'present.js']);
+    });
+  });
   context('target directory contains files with no extension', () => {
     it('ignores files', () => {
       const names = readDirectory(path.resolve(fixturesPath, 'children-files-no-extension'));

test/validateTargetDirectory.js

@@ -36,6 +36,11 @@ describe('validateTargetDirectory()', () => {
         expect(validateTargetDirectory(path.resolve(fixturesPath, 'safe-index'))).to.equal(true);
       });
     });
+    context('safe with banner', () => {
+      it('returns true', () => {
+        expect(validateTargetDirectory(path.resolve(fixturesPath, 'safe-index-with-banner'))).to.equal(true);
+      });
+    });
     context('unsafe', () => {
       it('throws an error', () => {
         expect(() => {
@@ -43,5 +48,10 @@ describe('validateTargetDirectory()', () => {
         }).to.throw(Error, '"' + path.resolve(fixturesPath, 'unsafe-index/index.js') + '" unsafe index.');
       });
     });
+    context('unsafe ignored', () => {
+      it('returns false', () => {
+        expect(validateTargetDirectory(path.resolve(fixturesPath, 'unsafe-index'), {silent: true})).to.equal(false);
+      });
+    });
   });
 });

test/writeIndex.js

@@ -27,10 +27,10 @@ describe('writeIndex()', () => {
     const indexCode = fs.readFileSync(indexFilePath, 'utf8');
 
     expect(indexCode).to.equal(codeExample(`
-'create index';
+// @create-index
 
-export bar from './bar';
-export foo from './foo.js';
+export { default as bar } from './bar';
+export { default as foo } from './foo.js';
         `));
   });
 });