feat: cannot use create-index for short folders (#51)

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

.editorconfig

@@ -1,7 +1,9 @@
 root = true
 
 [*]
+charset = utf-8
 end_of_line = lf
-insert_final_newline = true
-indent_style = space
 indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

README.md

@@ -82,21 +82,34 @@ npm install create-index
 create-index --help
 
 Options:
-  --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.
+  --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).
+  --ignoreDirectories, -d  Ignores importing directories into the index file,
+                           even if they have a safe "index.js".
                                                       [boolean] [default: false]
-  --banner            Add a custom banner at the top of the index file  [string]
+  --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]
+  --extensions, -x         Allows some extensions to be parsed as valid source.
+                           First extension will always be preferred to homonyms
+                           with another allowed extension.
+                                                       [array] [default: ["js"]]
 
 Examples:
-  create-index ./src ./src/utilities   Creates or updates an existing
-                                       create-index index file in the target
-                                       (./src, ./src/utilities) directories.
-  create-index --update ./src ./tests  Finds all create-index index files in the
-                                       target directories and descending
-                                       directories. Updates found index files.
+  create-index ./src ./src/utilities      Creates or updates an existing
+                                          create-index index file in the target
+                                          (./src, ./src/utilities) directories.
+  create-index --update ./src ./tests     Finds all create-index index files in
+                                          the target directories and descending
+                                          directories. Updates found index
+                                          files.
+  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.
 ```
 
 ### Using `create-index` Programmatically

src/bin/create-index.js

@@ -23,6 +23,14 @@ const argv = yargs
       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'
+    }
+  })
   .options({
     update: {
       alias: 'u',
@@ -45,14 +53,24 @@ const argv = yargs
       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.')
+  .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._, {
   banner: argv.banner,
   extensions: argv.extensions,
+  ignoreDirectories: argv.ignoreDirectories,
   ignoreUnsafe: argv.ignoreUnsafe,
   recursive: argv.recursive,
   updateIndex: argv.update

src/utilities/index.js

@@ -1,10 +1,10 @@
 // @create-index
 
-export createIndexCode from './createIndexCode.js';
-export findIndexFiles from './findIndexFiles.js';
-export log from './log.js';
-export readDirectory from './readDirectory.js';
-export sortByDepth from './sortByDepth.js';
-export validateTargetDirectory from './validateTargetDirectory.js';
-export writeIndex from './writeIndex.js';
-export writeIndexCli from './writeIndexCli.js';
+export createIndexCode from './createIndexCode';
+export findIndexFiles from './findIndexFiles';
+export log from './log';
+export readDirectory from './readDirectory';
+export sortByDepth from './sortByDepth';
+export validateTargetDirectory from './validateTargetDirectory';
+export writeIndex from './writeIndex';
+export writeIndexCli from './writeIndexCli';

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_][a-z0-9._]*$/i.test(fileName);
 };
 
 const stripExtension = (fileName) => {
@@ -78,7 +78,8 @@ export default (directoryPath, options = {}) => {
 
   const {
     extensions = ['js'],
-    config = {}
+    config = {},
+    ignoreDirectories = false
   } = options;
 
   let children;
@@ -111,7 +112,7 @@ export default (directoryPath, options = {}) => {
       return false;
     }
 
-    if (isDirectory && !hasIndex(absolutePath)) {
+    if (isDirectory && (!hasIndex(absolutePath) || ignoreDirectories)) {
       return false;
     }
 

src/utilities/writeIndexCli.js

@@ -50,6 +50,7 @@ export default (directoryPaths, options = {}) => {
     const siblings = readDirectory(directoryPath, {
       config,
       extensions: options.extensions,
+      ignoreDirectories: options.ignoreDirectories,
       silent: options.ignoreUnsafe
     });
 

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

@@ -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'));
@@ -34,6 +41,12 @@ describe('readDirectory()', () => {
 
       expect(names).to.deep.equal(['bar', 'foo']);
     });
+
+    it('excludes directories if ignoreDirectories = true', () => {
+      const names = readDirectory(path.resolve(fixturesPath, 'children-index'), {ignoreDirectories: true});
+
+      expect(names).to.deep.equal([]);
+    });
   });
   context('target directory contains files', () => {
     it('refers to the files (with extension)', () => {