fix: update dependencies

* feat: file cannot be started from _ and be one symbol
* test: add children-directories-short-name for readDirectory

.babelrc

@@ -1,8 +1,9 @@
 {
   "plugins": [
-    "transform-es2015-modules-commonjs",
+    "@babel/plugin-transform-modules-commonjs",
-    "transform-export-extensions",
+    "@babel/plugin-proposal-export-default-from",
-    "transform-es2015-destructuring",
+    "@babel/plugin-proposal-export-namespace-from",
-    "transform-es2015-parameters"
+    "@babel/plugin-transform-destructuring",
+    "@babel/plugin-transform-parameters"
   ]
 }

.eslintignore

@@ -1 +1 @@
-./test/fixtures
+test/fixtures

.travis.yml

@@ -4,8 +4,12 @@ node_js:
   - 7
   - 6
   - 5
+script:
+  - npm run lint
+  - npm run test
+  - npm run build
 after_success:
-  - semantic-release pre && npm publish && semantic-release post
+  - semantic-release
 notifications:
   email: false
 sudo: false

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2016, Gajus Kuizinas (http://gajus.com/)
+Copyright (c) 2020, Gajus Kuizinas (http://gajus.com/)
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -97,6 +97,7 @@ Options:
                            First extension will always be preferred to homonyms
                            with another allowed extension.
                                                        [array] [default: ["js"]]
+  --outputFile, -o         Output file            [string] [default: "index.js"]                                                      [array] [default: ["js"]]
 
 Examples:
   create-index ./src ./src/utilities      Creates or updates an existing

package.json

@@ -6,27 +6,28 @@
   },
   "bin": "./dist/bin/create-index.js",
   "dependencies": {
-    "chalk": "^1.1.3",
+    "chalk": "^4.0.0",
-    "glob": "^7.1.1",
+    "glob": "^7.1.6",
-    "lodash": "^4.16.6",
+    "lodash": "^4.17.15",
-    "moment": "^2.15.2",
+    "moment": "^2.25.3",
-    "yargs": "^6.3.0"
+    "yargs": "^15.3.1"
   },
   "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/cli": "^7.0.0",
-    "babel-plugin-transform-es2015-destructuring": "^6.18.0",
+    "@babel/core": "^7.0.0",
-    "babel-plugin-transform-es2015-modules-commonjs": "^6.18.0",
+    "@babel/plugin-proposal-export-default-from": "^7.0.0",
-    "babel-plugin-transform-es2015-parameters": "^6.18.0",
+    "@babel/plugin-proposal-export-namespace-from": "^7.0.0",
-    "babel-plugin-transform-export-extensions": "^6.8.0",
+    "@babel/plugin-transform-destructuring": "^7.0.0",
-    "babel-register": "^6.18.0",
+    "@babel/plugin-transform-modules-commonjs": "^7.0.0",
-    "chai": "^3.5.0",
+    "@babel/plugin-transform-parameters": "^7.0.0",
-    "cross-env": "^3.1.3",
+    "@babel/register": "^7.0.0",
-    "eslint": "^3.9.1",
+    "chai": "^4.2.0",
-    "eslint-config-canonical": "^4.0.0",
+    "eslint": "^7.0.0",
-    "husky": "^0.11.9",
+    "eslint-config-canonical": "^20.0.4",
-    "mocha": "^3.1.2",
+    "husky": "^4.2.5",
-    "semantic-release": "^6.3.2"
+    "mocha": "^7.1.2",
+    "semantic-release": "^17.0.7"
   },
   "engines": {
     "node": ">=5"
@@ -43,12 +44,16 @@
     "type": "git",
     "url": "https://github.com/gajus/create-index"
   },
-  "scripts": {
+  "husky": {
-    "build": "cross-env NODE_ENV=production babel --source-maps --copy-files ./src --out-dir ./dist",
+    "hooks": {
-    "create-index": "node ./dist/bin/create-index ./src/utilities",
+      "pre-commit": "npm run test"
-    "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"
+  "scripts": {
+    "build": "rm -fr ./dist && NODE_ENV=production babel --source-maps --copy-files ./src --out-dir ./dist",
+    "create-index": "node ./dist/bin/create-index ./src/utilities",
+    "lint": "NODE_ENV=development eslint ./src ./test",
+    "test": "NODE_ENV=development mocha --require @babel/register"
+  },
+  "version": "0.0.0-development"
 }

src/bin/create-index.js

@@ -1,8 +1,10 @@
 #!/usr/bin/env node
 
+/* eslint-disable filenames/match-regex */
+
 import yargs from 'yargs';
 import {
-    writeIndexCli
+  writeIndexCli,
 } from '../utilities';
 
 const argv = yargs
@@ -12,58 +14,66 @@ const argv = yargs
       alias: 'r',
       default: false,
       description: 'Create/update index files recursively. Halts on any unsafe "index.js" files.',
-      type: 'boolean'
+      type: 'boolean',
-    }
+    },
   })
   .options({
     ignoreUnsafe: {
       alias: 'i',
       default: false,
       description: 'Ignores unsafe "index.js" files instead of halting.',
-      type: 'boolean'
+      type: 'boolean',
-    }
+    },
   })
   .options({
     ignoreDirectories: {
       alias: 'd',
       default: false,
       description: 'Ignores importing directories into the index file, even if they have a safe "index.js".',
-      type: 'boolean'
+      type: 'boolean',
-    }
+    },
   })
   .options({
     update: {
       alias: 'u',
       default: false,
       description: 'Updates only previously created index files (recursively).',
-      type: 'boolean'
+      type: 'boolean',
-    }
+    },
   })
   .options({
     banner: {
       description: 'Add a custom banner at the top of the index file',
-      type: 'string'
+      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'
+      type: 'array',
-    }
+    },
+  })
+  .options({
+    outputFile: {
+      alias: 'o',
+      default: 'index.js',
+      description: 'Output file',
+      type: 'string',
+    },
   })
   .example(
     'create-index ./src ./src/utilities',
-    'Creates or updates an existing create-index index file in the target (./src, ./src/utilities) directories.'
+    '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.'
+    '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.'
+    'Creates or updates an existing create-index index file in the target (./src) directory for both .js and .jsx extensions.',
   )
   .argv;
 
@@ -72,6 +82,7 @@ writeIndexCli(argv._, {
   extensions: argv.extensions,
   ignoreDirectories: argv.ignoreDirectories,
   ignoreUnsafe: argv.ignoreUnsafe,
+  outputFile: argv.outputFile,
   recursive: argv.recursive,
-  updateIndex: argv.update
+  updateIndex: argv.update,
 });

src/index.js

@@ -1,4 +1,4 @@
 export {
   findIndexFiles,
-  writeIndex
+  writeIndex,
 } from './utilities';

src/utilities/constants.js

@@ -1,2 +1 @@
-// eslint-disable-next-line
 export const CREATE_INDEX_PATTERN = /(?:^|[\n\r]+)\/\/ @create-index\s?({.*})?[\n\r]+/;

src/utilities/findIndexFiles.js

@@ -4,7 +4,8 @@ import glob from 'glob';
 import validateTargetDirectory from './validateTargetDirectory';
 
 export default (directoryPath, options = {}) => {
-  let fileName, targetDirectories;
+  let fileName;
+  let targetDirectories;
 
   fileName = options.fileName || 'index.js';
   fileName = './**/' + fileName;
@@ -13,7 +14,8 @@ export default (directoryPath, options = {}) => {
 
   targetDirectories = _.filter(targetDirectories, (targetDirectoryPath) => {
     return validateTargetDirectory(path.dirname(targetDirectoryPath), {
-      silent: options.silent
+      outputFile: options.fileName,
+      silent: options.silent,
     });
   });
 

src/utilities/hasIndex.js

@@ -1,14 +1,14 @@
 import fs from 'fs';
 import path from 'path';
 
-export default (directoryPath) => {
+export default (directoryPath, options = {}) => {
-  const indexPath = path.resolve(directoryPath, 'index.js');
+  const indexPath = path.resolve(directoryPath, options.outputFile || 'index.js');
 
   try {
     fs.statSync(indexPath);
 
     return true;
-  } catch (error) {
+  } catch {
     return false;
   }
 };

src/utilities/log.js

@@ -2,6 +2,6 @@ import chalk from 'chalk';
 import moment from 'moment';
 
 export default (...append) => {
-  // eslint-disable-next-line
+  // eslint-disable-next-line no-console
   console.log(chalk.dim('[' + moment().format('HH:mm:ss') + ']'), ...append);
 };

src/utilities/readDirectory.js

@@ -17,7 +17,7 @@ const hasMultipleExtensions = (fileName) => {
 };
 
 const isSafeName = (fileName) => {
-  return /^[a-z][a-z0-9._]+$/i.test(fileName);
+  return /^[_a-z][\w.]*$/i.test(fileName);
 };
 
 const stripExtension = (fileName) => {
@@ -27,7 +27,7 @@ const stripExtension = (fileName) => {
     return fileName;
   }
 
-  return fileName.substr(0, pos);
+  return fileName.slice(0, Math.max(0, pos));
 };
 
 const removeDuplicates = (files, preferredExtension) => {
@@ -72,14 +72,14 @@ const removeIgnoredFiles = (files, ignorePatterns = []) => {
 };
 
 export default (directoryPath, options = {}) => {
-  if (!validateTargetDirectory(directoryPath, {silent: options.silent})) {
+  if (!validateTargetDirectory(directoryPath, options)) {
     return false;
   }
 
   const {
     extensions = ['js'],
     config = {},
-    ignoreDirectories = false
+    ignoreDirectories = false,
   } = options;
 
   let children;
@@ -102,17 +102,17 @@ export default (directoryPath, options = {}) => {
       return false;
     }
 
-    if (_.startsWith(fileName, 'index.js')) {
+    if (_.startsWith(fileName, options.outputFile || 'index.js')) {
       return false;
     }
 
-    if (!isDirectory && !extensions.some((ext) => {
+    if (!isDirectory && !extensions.some((extension) => {
-      return _.endsWith(fileName, '.' + ext);
+      return _.endsWith(fileName, '.' + extension);
     })) {
       return false;
     }
 
-    if (isDirectory && (!hasIndex(absolutePath) || ignoreDirectories)) {
+    if (isDirectory && (!hasIndex(absolutePath, options) || ignoreDirectories)) {
       return false;
     }
 

src/utilities/readIndexConfig.js

@@ -3,12 +3,12 @@ import path from 'path';
 import hasIndex from './hasIndex';
 import {CREATE_INDEX_PATTERN} from './constants';
 
-export default (directoryPath) => {
+export default (directoryPath, options = {}) => {
-  if (!hasIndex(directoryPath)) {
+  if (!hasIndex(directoryPath, options)) {
     return {};
   }
 
-  const indexPath = path.resolve(directoryPath, 'index.js');
+  const indexPath = path.resolve(directoryPath, options.outputFile || 'index.js');
   const indexContents = fs.readFileSync(indexPath, 'utf-8');
   const found = indexContents.match(CREATE_INDEX_PATTERN);
   const configLine = typeof found[1] === 'string' ? found[1].trim() : '';
@@ -21,10 +21,10 @@ export default (directoryPath) => {
 
   try {
     config = JSON.parse(configLine);
-  } catch (error) {
+  } catch {
     throw new Error(
       '"' + indexPath + '" contains invalid configuration object.\n' +
-      'Configuration object must be a valid JSON.'
+      'Configuration object must be a valid JSON.',
     );
   }
 

src/utilities/validateTargetDirectory.js

@@ -8,7 +8,7 @@ export default (targetDirectory, options = {}) => {
 
   try {
     stats = fs.statSync(targetDirectory);
-  } catch (error) {
+  } catch {
     if (silent) {
       return false;
     } else {
@@ -24,11 +24,11 @@ export default (targetDirectory, options = {}) => {
     }
   }
 
-  const indexFilePath = path.resolve(targetDirectory, './index.js');
+  const indexFilePath = path.resolve(targetDirectory, './' + (options.outputFile || 'index.js'));
 
   try {
     fs.statSync(indexFilePath);
-  } catch (error) {
+  } catch {
     return true;
   }
 

src/utilities/writeIndex.js

@@ -10,15 +10,16 @@ import sortByDepth from './sortByDepth';
 export default (directoryPaths, options = {}) => {
   const sortedDirectoryPaths = sortByDepth(directoryPaths)
     .filter((directoryPath) => {
-      return validateTargetDirectory(directoryPath, {silent: options.ignoreUnsafe});
+      return validateTargetDirectory(directoryPath, {outputFile: options.outputFile,
+        silent: options.ignoreUnsafe});
     });
 
   _.forEach(sortedDirectoryPaths, (directoryPath) => {
-    const config = readIndexConfig(directoryPath);
+    const config = readIndexConfig(directoryPath, options);
     const optionsWithConfig = Object.assign({}, options, {config});
     const siblings = readDirectory(directoryPath, optionsWithConfig);
     const indexCode = createIndexCode(siblings, optionsWithConfig);
-    const indexFilePath = path.resolve(directoryPath, 'index.js');
+    const indexFilePath = path.resolve(directoryPath, options.outputFile || 'index.js');
 
     fs.writeFileSync(indexFilePath, indexCode);
   });

src/utilities/writeIndexCli.js

@@ -16,6 +16,7 @@ export default (directoryPaths, options = {}) => {
   sortedDirectoryPaths = sortByDepth(directoryPaths);
 
   log('Target directories', sortedDirectoryPaths);
+  log('Output file', options.outputFile);
   if (options.updateIndex) {
     log('Update index:', options.updateIndex ? chalk.green('true') : chalk.red('false'));
   } else {
@@ -25,10 +26,10 @@ export default (directoryPaths, options = {}) => {
   }
 
   if (options.updateIndex || options.recursive) {
-    sortedDirectoryPaths = _.map(sortedDirectoryPaths, (dir) => {
+    sortedDirectoryPaths = _.map(sortedDirectoryPaths, (directory) => {
-      return findIndexFiles(dir, {
+      return findIndexFiles(directory, {
-        fileName: options.updateIndex ? 'index.js' : '*',
+        fileName: options.updateIndex ? options.outputFile || 'index.js' : '*',
-        silent: options.updateIndex || options.ignoreUnsafe
+        silent: options.updateIndex || options.ignoreUnsafe,
       });
     });
     sortedDirectoryPaths = _.flatten(sortedDirectoryPaths);
@@ -39,37 +40,38 @@ export default (directoryPaths, options = {}) => {
   }
 
   sortedDirectoryPaths = sortedDirectoryPaths.filter((directoryPath) => {
-    return validateTargetDirectory(directoryPath, {silent: options.ignoreUnsafe});
+    return validateTargetDirectory(directoryPath, {outputFile: options.outputFile,
+      silent: options.ignoreUnsafe});
   });
 
   _.forEach(sortedDirectoryPaths, (directoryPath) => {
     let existingIndexCode;
 
-    const config = readIndexConfig(directoryPath);
+    const config = readIndexConfig(directoryPath, options);
 
     const siblings = readDirectory(directoryPath, {
       config,
       extensions: options.extensions,
       ignoreDirectories: options.ignoreDirectories,
-      silent: options.ignoreUnsafe
+      silent: options.ignoreUnsafe,
     });
 
     const indexCode = createIndexCode(siblings, {
       banner: options.banner,
-      config
+      config,
     });
 
-    const indexFilePath = path.resolve(directoryPath, 'index.js');
+    const indexFilePath = path.resolve(directoryPath, options.outputFile || 'index.js');
 
     try {
       existingIndexCode = fs.readFileSync(indexFilePath, 'utf8');
 
-        /* eslint-disable no-empty */
+      /* eslint-disable no-empty */
-    } catch (error) {
+    } catch {
 
     }
 
-        /* eslint-enable no-empty */
+    /* eslint-enable no-empty */
 
     fs.writeFileSync(indexFilePath, indexCode);
 

test/.eslintrc

@@ -0,0 +1,3 @@
+{
+  "extends": "canonical/mocha"
+}

test/createIndexCode.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-restricted-syntax */
 
 import {
-    expect
+  expect,
 } from 'chai';
 import createIndexCode from '../src/utilities/createIndexCode';
 import codeExample from './codeExample';
@@ -60,7 +60,7 @@ export { default as foo } from './foo';
   context('with config', () => {
     it('should append config', () => {
       const config = {
-        ignore: ['/^zoo/']
+        ignore: ['/^zoo/'],
       };
       const indexCode = createIndexCode(['foo', 'bar'], {config});
 

test/findIndexFiles.js

@@ -1,6 +1,6 @@
 import path from 'path';
 import {
-    expect
+  expect,
 } from 'chai';
 import glob from 'glob';
 import findIndexFiles from '../src/utilities/findIndexFiles';

test/fixtures/read-directory/children-directories-short-name/F/index.js

@@ -0,0 +1 @@
+// @create-index

test/fixtures/read-directory/children-directories-short-name/T/index.js

@@ -0,0 +1 @@
+// @create-index

test/fixtures/read-directory/children-directories-short-name/__/index.js

@@ -0,0 +1 @@
+// @create-index

test/fixtures/read-directory/children-directories-short-name/o/index.js

@@ -0,0 +1 @@
+// @create-index

test/readDirectory.js

@@ -1,6 +1,6 @@
 import path from 'path';
 import {
-    expect
+  expect,
 } from 'chai';
 import readDirectory from '../src/utilities/readDirectory';
 
@@ -21,6 +21,13 @@ describe('readDirectory()', () => {
       expect(names).to.deep.equal(['present.js']);
     });
   });
+  context('target directory contains child directories (short safe name)', () => {
+    it('gets names of the children directories', () => {
+      const names = readDirectory(path.resolve(fixturesPath, 'children-directories-short-name'));
+
+      expect(names).to.deep.equal(['F', 'T', '__', 'o']);
+    });
+  });
   context('target directory contains child directories (unsafe name)', () => {
     it('gets names of the children directories', () => {
       const names = readDirectory(path.resolve(fixturesPath, 'children-directories-unsafe-name'));
@@ -64,7 +71,7 @@ describe('readDirectory()', () => {
   });
   context('target directory contains non js files, and allowing only jsx', () => {
     it('prefers file', () => {
-      const options = { extensions: ['jsx'] };
+      const options = {extensions: ['jsx']};
       const names = readDirectory(path.resolve(fixturesPath, 'children-files-alt-extension'), options);
 
       expect(names).to.deep.equal(['bar.jsx']);
@@ -72,7 +79,7 @@ describe('readDirectory()', () => {
   });
   context('target directory contains non js files, and allowing both js and jsx', () => {
     it('prefers file', () => {
-      const options = { extensions: ['js', 'jsx'] };
+      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']);
@@ -80,7 +87,7 @@ describe('readDirectory()', () => {
   });
   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 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']);
@@ -88,7 +95,7 @@ describe('readDirectory()', () => {
   });
   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 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']);

test/readIndexConfig.js

@@ -1,6 +1,6 @@
 import path from 'path';
 import {
-    expect
+  expect,
 } from 'chai';
 import readIndexConfig from '../src/utilities/readIndexConfig';
 
@@ -8,15 +8,15 @@ const fixtures = {
   noIndex: path.resolve(__dirname, 'fixtures/read-index-config/no-index'),
   withConfig: path.resolve(__dirname, 'fixtures/read-index-config/with-config'),
   withInvalidConfig: path.resolve(__dirname, 'fixtures/read-index-config/with-invalid-config'),
-  withoutConfig: path.resolve(__dirname, 'fixtures/read-index-config/without-config')
+  withoutConfig: path.resolve(__dirname, 'fixtures/read-index-config/without-config'),
 };
 
 const expectedValues = {
   noIndex: {},
   withConfig: {
-    ignore: ['/foo.js$/']
+    ignore: ['/foo.js$/'],
   },
-  withoutConfig: {}
+  withoutConfig: {},
 };
 
 describe('readIndexConfig()', () => {

test/sortByDepth.js

@@ -1,7 +1,7 @@
 import {
-    expect
+  expect,
 } from 'chai';
-import sortByDepth from './../src/utilities/sortByDepth';
+import sortByDepth from '../src/utilities/sortByDepth';
 
 describe('sortByDepth()', () => {
   it('sorts from deepest to the most shallow', () => {
@@ -9,7 +9,7 @@ describe('sortByDepth()', () => {
       '/b',
       '/a',
       '/a/b/c',
-      '/a/b'
+      '/a/b',
     ];
 
     const sortedPaths = sortByDepth(paths);

test/validateTargetDirectory.js

@@ -2,7 +2,7 @@
 
 import path from 'path';
 import {
-    expect
+  expect,
 } from 'chai';
 import validateTargetDirectory from '../src/utilities/validateTargetDirectory';
 

test/writeIndex.js

@@ -3,7 +3,7 @@
 import fs from 'fs';
 import path from 'path';
 import {
-    expect
+  expect,
 } from 'chai';
 import writeIndex from '../src/utilities/writeIndex';
 import codeExample from './codeExample';
@@ -40,7 +40,7 @@ export { default as foo } from './foo.js';
 
   it('creates index with config in target directory', () => {
     const indexFilePath = path.resolve(fixturesPath, 'with-config/index.js');
-    // eslint-disable-next-line
+    // eslint-disable-next-line quotes
     const ignoredExportLine = `export { default as bar } from './bar.js';`;
 
     appendToFile(indexFilePath, ignoredExportLine);