chore: use semantic-release

Lets you add a custom banner.

```sh
create-index src -u --banner "/* eslint-disable */"
```
```js
/* eslint-disable */

// @create-index

import xxx ...
```

.travis.yml

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

README.md

@@ -83,9 +83,10 @@ create-index --help
 
 Options:
   --update, -u  Recursively iterates target directories looking for "index.js"
-                files that start with "'create index';\n" (create-index index
+                files that start with "// @create-index\n" (create-index index
                 file). Updates found index files. Does not create new index
                 files.                                [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,7 +173,7 @@ 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';
@@ -187,6 +188,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",
+  "bin": "./dist/bin/create-index.js",
-  "scripts": {
+  "dependencies": {
-    "lint": "eslint ./src ./tests",
+    "chalk": "^1.1.3",
-    "test": "mocha --compilers js:babel-register",
+    "glob": "^7.1.1",
-    "build": "babel --source-maps --copy-files ./src --out-dir ./dist",
+    "lodash": "^4.16.6",
-    "create-index": "node ./dist/bin/create-index ./src/utilities"
+    "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",
@@ -38,13 +23,31 @@
     "chai": "^3.5.0",
     "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": {
+  "engines": {
-    "glob": "^7.1.1",
+    "node": ">=5"
-    "lodash": "^4.16.6",
+  },
-    "yargs": "^6.3.0",
+  "keywords": [
-    "chalk": "^1.1.3",
+    "index",
-    "moment": "^2.15.2"
+    "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": "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 ./tests",
+    "precommit": "npm run test",
+    "test": "npm run build && npm run lint && NODE_ENV=development mocha --compilers js:babel-register"
+  },
+  "version": "1.0.0"
 }

src/bin/create-index.js

@@ -8,17 +8,24 @@ import {
 const argv = yargs
   .demand(1)
   .options({
-    'update': {
+    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: '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.',
       type: 'boolean'
     }
   })
+  .options({
+    banner: {
+      description: 'Add a custom banner at the top of the index 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.')
   .example('create-index --update ./src ./tests', 'Finds all create-index index files in the target directories and descending directories. Updates found index files.')
   .argv;
 
 writeIndexCli(argv._, {
-  updateIndex: argv.updateIndex
+  banner: argv.banner,
+  updateIndex: argv.update
 });

src/utilities/createIndexCode.js

@@ -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/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/writeIndexCli.js

@@ -35,7 +35,9 @@ export default (directoryPaths, options = {}) => {
 
     const siblings = readDirectory(directoryPath);
 
-    const indexCode = createIndexCode(siblings);
+    const indexCode = createIndexCode(siblings, {
+      banner: options.banner
+    });
 
     const indexFilePath = path.resolve(directoryPath, 'index.js');
 

test/createIndexCode.js

@@ -11,14 +11,14 @@ 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';
         `));
@@ -27,7 +27,7 @@ export foo from './foo';
     const indexCode = createIndexCode(['bar', 'foo']);
 
     expect(indexCode).to.equal(codeExample(`
-'create index';
+// @create-index
 
 export bar from './bar';
 export foo from './foo';
@@ -38,7 +38,7 @@ export foo from './foo';
       const indexCode = createIndexCode(['foo.js']);
 
       expect(indexCode).to.equal(codeExample(`
-'create index';
+// @create-index
 
 export foo from './foo.js';
             `));
@@ -49,7 +49,7 @@ 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';

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

@@ -1,4 +1,4 @@
-'create index';
+// @create-index
 
 export bar from './bar';
 export foo from './foo.js';

test/writeIndex.js

@@ -27,7 +27,7 @@ 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';