├── .travis.yml
├── lib
    ├── util.js
    ├── file.js
    ├── log.js
    ├── config.js
    ├── git.js
    └── generate.js
├── .jsbeautifyrc
├── .gitignore
├── package.json
├── .clgtrc
├── LICENSE
├── index.js
├── CHANGELOG.md
├── README.md
├── test
    ├── git.js
    └── generate.js
└── .eslintrc


/.travis.yml:
--------------------------------------------------------------------------------
 1 | language: node_js
 2 | 
 3 | node_js:
 4 |   - "4"
 5 | 
 6 | install:
 7 |   - npm install
 8 | 
 9 | script:
10 |   - npm test
11 | 
12 | after_success:
13 |   - npm run coveralls
14 | 


--------------------------------------------------------------------------------
/lib/util.js:
--------------------------------------------------------------------------------
 1 | 'use strict';
 2 | 
 3 | 
 4 | var _ = require('lodash');
 5 | 
 6 | 
 7 | exports.groupByMulti = function(obj, values) {
 8 | 
 9 |   if (!values.length) {
10 |     return obj;
11 |   }
12 |   var byFirst = _.groupBy(obj, values[0]),
13 |     rest = values.slice(1);
14 | 
15 |   _.forOwn(byFirst, function(value, prop) {
16 |     byFirst[prop] = exports.groupByMulti(byFirst[prop], rest);
17 |   });
18 |   return byFirst;
19 | };
20 | 
21 | 
22 | exports.capitalize = function(str) {
23 | 
24 |   return str.charAt(0).toUpperCase() + str.slice(1);
25 | };
26 | 


--------------------------------------------------------------------------------
/.jsbeautifyrc:
--------------------------------------------------------------------------------
 1 | {
 2 |   "js": {
 3 |     "indent_size": 2,
 4 |     "indent_char": " ",
 5 |     "indent_level": 0,
 6 |     "indent_with_tabs": false,
 7 |     "preserve_newlines": true,
 8 |     "space_in_paren": false,
 9 |     "space_after_anon_function": false,
10 |     "space_before_conditional": true,
11 |     "brace_style": "none",
12 |     "break_chained_methods": false,
13 |     "keep_array_indentation": true,
14 |     "keep_function_indentation": true,
15 |     "eval_code": false,
16 |     "unescape_strings": false,
17 |     "wrap_line_length": 120,
18 |     "end_with_newline": true,
19 |     "end_with_comma": false,
20 |   }
21 | }
22 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Logs
 2 | logs
 3 | *.log
 4 | npm-debug.log*
 5 | 
 6 | # Runtime data
 7 | pids
 8 | *.pid
 9 | *.seed
10 | 
11 | # Directory for instrumented libs generated by jscoverage/JSCover
12 | lib-cov
13 | 
14 | # Coverage directory used by tools like istanbul
15 | coverage
16 | 
17 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
18 | .grunt
19 | 
20 | # node-waf configuration
21 | .lock-wscript
22 | 
23 | # Compiled binary addons (http://nodejs.org/api/addons.html)
24 | build/Release
25 | 
26 | # Dependency directory
27 | node_modules
28 | 
29 | # Optional npm cache directory
30 | .npm
31 | 
32 | # Optional REPL history
33 | .node_repl_history
34 | 


--------------------------------------------------------------------------------
/lib/file.js:
--------------------------------------------------------------------------------
 1 | 'use strict';
 2 | 
 3 | 
 4 | var fs = require('fs');
 5 | var format = require('util').format;
 6 | 
 7 | 
 8 | function File(path) {
 9 | 
10 |   this.path = path;
11 |   fs.writeFileSync(path, '');
12 | }
13 | 
14 | 
15 | File.prototype.format = function() {
16 | 
17 |   return format.apply(this, arguments);
18 | };
19 | 
20 | 
21 | File.prototype.writeln = function() {
22 | 
23 |   this.write('\n');
24 |   return this;
25 | };
26 | 
27 | 
28 | File.prototype.write = function() {
29 | 
30 |   fs.appendFileSync(this.path, this.format.apply(this, arguments));
31 |   return this;
32 | };
33 | 
34 | 
35 | File.prototype.end = function() {
36 | 
37 |   // do nothing, this just for compatibility api
38 | };
39 | 
40 | 
41 | module.exports = File;
42 | 


--------------------------------------------------------------------------------
/lib/log.js:
--------------------------------------------------------------------------------
 1 | /* eslint no-process-env: "off" */
 2 | /* eslint no-console: "off" */
 3 | 'use strict';
 4 | 
 5 | 
 6 | var colors = require('colors');
 7 | var themes = {
 8 |   info: 'blue',
 9 |   success: 'green',
10 |   error: 'red',
11 |   debug: 'cyan',
12 |   warn: 'yellow'
13 | };
14 | colors.setTheme(themes);
15 | 
16 | 
17 | function log() {
18 | 
19 |   var args = Array.prototype.slice.call(arguments);
20 |   var type = 'info';
21 | 
22 |   if (args.length >= 2) {
23 |     type = args[0];
24 |     if (themes[type]) {
25 |       args.splice(0, 1);
26 |     } else {
27 |       type = 'info';
28 |     }
29 |   }
30 | 
31 |   if (process.env.NODE_ENV !== 'test') {
32 |     console.log(colors[type].apply(null, args));
33 |   }
34 | }
35 | 
36 | 
37 | module.exports = log;
38 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "clgt",
 3 |   "author": "Toan Pham Cong",
 4 |   "license": "MIT",
 5 |   "version": "1.0.4",
 6 |   "description": "A tool generate git changelog file.",
 7 |   "main": "index.js",
 8 |   "scripts": {
 9 |     "test": "lab -L -C -c -t 90",
10 |     "coveralls": "lab -r lcov | ./node_modules/.bin/coveralls"
11 |   },
12 |   "repository": {
13 |     "type": "git",
14 |     "url": "https://github.com/toancong/clgt"
15 |   },
16 |   "keywords": [
17 |     "git",
18 |     "change",
19 |     "log"
20 |   ],
21 |   "dependencies": {
22 |     "async": "^1.5.0",
23 |     "colors": "^1.1.0",
24 |     "commander": "^2.8.0",
25 |     "lodash": "^4.12.0",
26 |     "marked": "^0.3.5",
27 |     "nconf": "^0.8.4"
28 |   },
29 |   "devDependencies": {
30 |     "code": "^3.0.0",
31 |     "coveralls": "^2.11.9",
32 |     "lab": "^10.6.1",
33 |     "sinon": "^1.12.0"
34 |   },
35 |   "bin": {
36 |     "clgt": "index.js"
37 |   }
38 | }
39 | 


--------------------------------------------------------------------------------
/.clgtrc:
--------------------------------------------------------------------------------
 1 | {
 2 |   "file": "CHANGELOG.md",
 3 |   "name": "Change Log GiT",
 4 |   "description": "A tool generate git changelog file",
 5 |   "url": "https://github.com/toancong/clgt/commit",
 6 |   "types": [
 7 |     {
 8 |       "title": "Bug Fixes",
 9 |       "pattern": "^fix|^bug"
10 |     },
11 |     {
12 |       "title": "Features",
13 |       "pattern": "^feat"
14 |     },
15 |     {
16 |       "title": "Documentation",
17 |       "pattern": "^docs"
18 |     },
19 |     {
20 |       "title": "Breaking changes",
21 |       "pattern": "BREAKING"
22 |     },
23 |     {
24 |       "title": "Refactor",
25 |       "pattern": "^refactor"
26 |     },
27 |     {
28 |       "title": "Style",
29 |       "pattern": "^style"
30 |     },
31 |     {
32 |       "title": "Test",
33 |       "pattern": "^test"
34 |     }
35 |   ],
36 |   "ignore": ".*ignore me.*|.*CHANGELOG.md.*|.*ignoreme.*|^chore|^release|^revert|^Merge pull request",
37 |   "report": "none"
38 | }
39 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2016 toancong
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env node
 2 | 
 3 | (function() {
 4 |   var _ = require('lodash');
 5 |   var cmdOptions = require('./lib/config').cmdOptions;
 6 |   var generator = require('./lib/generate');
 7 |   var nconf = require('nconf');
 8 |   var log = require('./lib/log');
 9 |   var fs = require('fs');
10 |   var marked = require('marked');
11 |   var File = require('./lib/file');
12 | 
13 |   if (!module.parent) {
14 |     var file = _.cloneDeep(nconf.file('.clgtrc').stores.file.store);
15 |     if (file.url) {
16 |       cmdOptions.u.default = file.url;
17 |     }
18 |     var args = nconf.argv(cmdOptions,
19 |       'Change Log GiT\nA tool generate changelog file.\nUsage: clgt <option>');
20 | 
21 |     if (args.get('help')) {
22 |       args.stores.argv.showHelp();
23 |       return;
24 |     }
25 | 
26 |     var argv = _.pick(args.stores.argv.store, [ 'description', 'file', 'name', 'tag', 'url', 'report' ]);
27 |     var options = _.defaultsDeep(argv, file);
28 | 
29 |     generator.generate(options, function(err) {
30 |       if (err) {
31 |         log('error', err);
32 |       } else {
33 |         log('success', 'Done generating to', options.file);
34 |         if (options.report && options.report === 'html') {
35 |           fs.readFile(options.file, 'utf8', function(readFileErr, contents) {
36 |             if (readFileErr) {
37 |               log('error', readFileErr);
38 |             }
39 | 
40 |             var htmlFile = new File('CHANGELOG.html');
41 |             htmlFile.write(marked(contents));
42 |             htmlFile.end();
43 |             log('success', 'and also CHANGELOG.html');
44 |           });
45 |         }
46 |       }
47 |     });
48 |   }
49 | })();
50 | 


--------------------------------------------------------------------------------
/lib/config.js:
--------------------------------------------------------------------------------
 1 | 'use strict';
 2 | 
 3 | 
 4 | var defaults = {
 5 |   file: 'CHANGELOG.md',
 6 |   name: '',
 7 |   description: '',
 8 |   types: [
 9 |     {
10 |       'title': 'Bug Fixes',
11 |       'pattern': '^fix|^bug'
12 |     },
13 |     {
14 |       'title': 'Features',
15 |       'pattern': '^feat'
16 |     },
17 |     {
18 |       'title': 'Documentation',
19 |       'pattern': '^docs'
20 |     },
21 |     {
22 |       'title': 'Breaking changes',
23 |       'pattern': 'BREAKING'
24 |     },
25 |     {
26 |       'title': 'Refactor',
27 |       'pattern': '^refactor'
28 |     },
29 |     {
30 |       'title': 'Style',
31 |       'pattern': '^style'
32 |     },
33 |     {
34 |       'title': 'Test',
35 |       'pattern': '^test'
36 |     },
37 |     {
38 |       'title': 'Chore',
39 |       'pattern': '^chore'
40 |     },
41 |     {
42 |       'title': 'Branchs merged',
43 |       'pattern': '^Merge branch'
44 |     },
45 |     {
46 |       'title': 'Pull requests merged',
47 |       'pattern': '^Merged in'
48 |     }
49 |   ]
50 | };
51 | 
52 | 
53 | var cmdOptions = {
54 |   d: {
55 |     alias: 'description',
56 |     describe: 'Description',
57 |     require: false,
58 |     type: 'string'
59 |   },
60 |   f: {
61 |     alias: 'file',
62 |     default: 'CHANGELOG.md',
63 |     describe: 'File ouput',
64 |     require: false,
65 |     type: 'string'
66 |   },
67 |   n: {
68 |     alias: 'name',
69 |     describe: 'App Name',
70 |     require: false,
71 |     type: 'string'
72 |   },
73 |   t: {
74 |     alias: 'tag',
75 |     describe: 'Tag revision git',
76 |     require: false,
77 |     type: 'string'
78 |   },
79 |   u: {
80 |     alias: 'url',
81 |     describe: 'Url commit repository git',
82 |     require: true,
83 |     type: 'string'
84 |   },
85 |   h: {
86 |     alias: 'help',
87 |     describe: 'Show this help'
88 |   },
89 |   r: {
90 |     alias: 'report',
91 |     describe: 'Export the report'
92 |   }
93 | };
94 | 
95 | exports.defaults = defaults;
96 | exports.cmdOptions = cmdOptions;
97 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | __Change Log GiT__
 2 | 
 3 | _A tool generate git changelog file_
 4 | 
 5 | # v1.0.4 (2016-06-01) #
 6 | 
 7 | ## Bug Fixes ##
 8 | 
 9 | - **File:**
10 |     - Bug async after generate
11 |  ([1fae18a](https://github.com/toancong/clgt/commit/1fae18a))
12 | 
13 | 
14 | # v1.0.3 (2016-05-31) #
15 | 
16 | ## Bug Fixes ##
17 | 
18 | - **Generator:**
19 |     - Bug empty release version
20 |  ([f01bf52](https://github.com/toancong/clgt/commit/f01bf52))
21 |     - Bug async after generate
22 |  ([5c26583](https://github.com/toancong/clgt/commit/5c26583))
23 | - **report:**
24 |     - JSLint errors
25 |  ([2099ccf](https://github.com/toancong/clgt/commit/2099ccf))
26 | 
27 | 
28 | ## Features ##
29 | 
30 | - **report:**
31 |     - Export HTML report
32 |  ([79056ac](https://github.com/toancong/clgt/commit/79056ac))
33 | 
34 | 
35 | # v1.0.2 (2016-05-25) #
36 | 
37 | ## Other ##
38 | 
39 | - Update version in package.json
40 |  ([4de9a88](https://github.com/toancong/clgt/commit/4de9a88))
41 | 
42 | 
43 | # v1.0.1 (2016-05-25) #
44 | 
45 | # v1.0.0 (2016-05-24) #
46 | 
47 | ## Other ##
48 | 
49 | - Ignore some commits by pattern in config
50 |  ([c1fee01](https://github.com/toancong/clgt/commit/c1fee01))
51 | - Update .clgtrc config file
52 |  ([6bbb767](https://github.com/toancong/clgt/commit/6bbb767))
53 | 
54 | 
55 | # v0.0.3 (2016-05-22) #
56 | 
57 | ## Bug Fixes ##
58 | 
59 | - **Generator:**
60 |     - do not show scope outline when missing
61 |  ([efe4aca](https://github.com/toancong/clgt/commit/efe4aca))
62 | 
63 | 
64 | # v0.0.2 (2016-05-22) #
65 | 
66 | ## Other ##
67 | 
68 | - Update package.json
69 |  ([1bf8cd0](https://github.com/toancong/clgt/commit/1bf8cd0))
70 | - Update README.md
71 |  ([6de689c](https://github.com/toancong/clgt/commit/6de689c), [dc27c61](https://github.com/toancong/clgt/commit/dc27c61))
72 | 
73 | 
74 | # v0.0.1 (2016-05-22) #
75 | 
76 | ## Other ##
77 | 
78 | - Init project
79 |  ([0795fd3](https://github.com/toancong/clgt/commit/0795fd3))
80 | - Initial commit
81 |  ([a2ca6da](https://github.com/toancong/clgt/commit/a2ca6da))
82 | 
83 | 
84 | 


--------------------------------------------------------------------------------
/lib/git.js:
--------------------------------------------------------------------------------
 1 | 'use strict';
 2 | 
 3 | 
 4 | var _ = require('lodash');
 5 | var child = require('child_process');
 6 | var format = require('util').format;
 7 | 
 8 | 
 9 | exports.commands = {
10 |   dateOfLatestCommit: 'git log -1 --format=%ai ',
11 |   listLogs: 'git log --no-merges --date=short --format="%s|-|%h|-|%cd" ',
12 |   listTags: 'git tag --sort=-taggerdate '
13 | };
14 | 
15 | 
16 | /**
17 |  * Get tags of repository
18 |  *
19 |  * @param {function} callback callback
20 |  * @return {function} callback
21 |  */
22 | exports.getTags = function(callback) {
23 | 
24 |   child.exec(this.commands.listTags, function(err, stdout, stderr) {
25 | 
26 |     return callback(err || stderr, stdout ? _.compact(stdout.split('\n')) : []);
27 |   });
28 | };
29 | 
30 | 
31 | /**
32 |  * Get logs of repository
33 |  *
34 |  * @param {function} callback callback
35 |  * @return {function} callback
36 |  */
37 | exports.getLogs = function() {
38 | 
39 |   var args = arguments;
40 |   var since = '';
41 |   var callback = args[args.length - 1];
42 | 
43 |   if (args.length > 1) {
44 |     since = args[0];
45 |   }
46 | 
47 |   child.exec(this.commands.listLogs + since, function(err, stdout, stderr) {
48 | 
49 |     return callback(err || stderr, stdout ? _.compact(stdout.split('\n')) : []);
50 |   });
51 | };
52 | 
53 | 
54 | /**
55 |  * Get latest commit date
56 |  *
57 |  * @param {array} logs logs
58 |  * @param {object} options options
59 |  * @returns {string} date
60 |  */
61 | exports.getLatestCommitDate = function(logs, options) {
62 | 
63 |   var types = logs[Object.keys(logs)[0]];
64 |   if (!types) {
65 |     if (options && options.tag) {
66 |       return format('%s (%s)', options.tag, exports.getDateOfTag(options.tag));
67 |     }
68 |     return '';
69 |   }
70 |   var scopes = types[Object.keys(types)[0]];
71 |   var commits = scopes[Object.keys(scopes)[0]];
72 |   if (options && options.tag) {
73 |     return format('%s (%s)', options.tag, commits[0].date);
74 |   }
75 |   return format('(%s)', commits[0].date);
76 | };
77 | 
78 | exports.getDateOfTag = function(tag) {
79 | 
80 |   var stdout = child.execSync(this.commands.dateOfLatestCommit + tag);
81 |   return stdout.toString().split(' ')[0];
82 | };
83 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # CLGT #
 2 | 
 3 | [![Build Status](https://img.shields.io/travis/toancong/clgt/master.svg)](https://travis-ci.org/toancong/clgt)
 4 | [![Coverage Status](https://img.shields.io/coveralls/toancong/clgt/master.svg)](https://coveralls.io/github/toancong/clgt?branch=master)
 5 | [![Stable Version](https://img.shields.io/npm/v/clgt.svg)](https://www.npmjs.com/package/clgt)
 6 | [![Download Status](https://img.shields.io/npm/dt/clgt.svg)](https://www.npmjs.com/package/clgt)
 7 | [![License](https://img.shields.io/github/license/toancong/clgt.svg)](https://github.com/toancong/clgt/blob/master/LICENSE)
 8 | 
 9 | Change Log Git Tool
10 | 
11 | A tool generate git changelog file.
12 | It help you generate change logs for specific version, from version to version.
13 | Allow ignore some commits you don't like included in logs.
14 | History with markdown output.
15 | 
16 | ## Installation ##
17 | 
18 | ``` bash
19 | npm install -g clgt
20 | ```
21 | 
22 | ## Usage ##
23 | 
24 | ``` bash
25 | $ clgt --help
26 | 
27 | Change Log GiT
28 | A tool generate changelog file.
29 | Usage: clgt <option>
30 | 
31 | Options:
32 |   -d, --description  Description  [string]
33 |   -f, --file         File ouput  [string] [default: "CHANGELOG.md"]
34 |   -n, --name         App Name  [string]
35 |   -t, --tag          Tag revision git  [string]
36 |   -u, --url          Url commit repository git  [string] [required]
37 |   -h, --help         Show this help
38 |   -r, --report       Export the report
39 | ```
40 | 
41 | ## FAQ ##
42 | 
43 | 1.  How do I generate changelog to other file name?
44 | 
45 |     Answer: `clgt -n othername.md`
46 | 
47 | 2.  How do I generate changelog for a specific version?
48 | 
49 |     Answer: `clgt -t v1.0`
50 | 
51 | 3.  How do I generate changelog from a version to an other one?
52 | 
53 |     Answer: `clgt -t v1.0..v2.0` will generate logs from after v1.0 to v2.0:
54 |     logs without v1.0, include v2.0 and between them.
55 | 
56 | 4.  How do I generate changelog from a version to now?
57 | 
58 |     Answer: `clgt -t v1.0..`
59 | 
60 | 5.  I want to ignore some commits in change logs.
61 | 
62 |     Answer: Please add regex pattern in `ignore` field to configuration file.
63 | 
64 | 6.  Where is the configuration file?
65 | 
66 |     Answer: It's `.clgtrc`, located at root repository.
67 | 


--------------------------------------------------------------------------------
/lib/generate.js:
--------------------------------------------------------------------------------
  1 | 'use strict';
  2 | 
  3 | 
  4 | var _ = require('lodash');
  5 | var async = require('async');
  6 | var config = require('./config');
  7 | var File = require('./file');
  8 | var git = require('./git');
  9 | var log = require('./log');
 10 | var util = require('./util');
 11 | 
 12 | 
 13 | function Generator(options) {
 14 | 
 15 |   this.options = options;
 16 | }
 17 | 
 18 | /**
 19 |  * Parse array logs to new format
 20 |  *
 21 |  * @param {array} patterns patterns
 22 |  * @param {array} logs logs
 23 |  * @returns {array} new formated logs
 24 |  */
 25 | Generator.prototype.parse = function(patterns, logs) {
 26 | 
 27 |   var pattern = '(' + patterns.join('|') + ')';
 28 | 
 29 |   if (this.options.ignore) {
 30 |     var self = this;
 31 |     logs = logs.filter(function(item) {
 32 | 
 33 |       return !item.match(new RegExp(self.options.ignore, 'i'));
 34 |     });
 35 |   }
 36 | 
 37 |   var group = _.map(logs, function(item) {
 38 | 
 39 |     var data = item.replace(new RegExp(pattern + '(.+)', 'i'), '$1|-|$2').split('|-|');
 40 |     if (data.length === 3) {
 41 |       data.unshift('', '');
 42 |     }
 43 |     if (data.length === 4) {
 44 |       data.unshift(data[0]);
 45 |       var type = data[2].replace(new RegExp('^\((.*)\):'), '$1|-|').split('|-|');
 46 |       if (type.length === 2) {
 47 |         data[1] = type[0];
 48 |         data[2] = type[1];
 49 |         data[1] = data[1].replace(new RegExp('[\(\)]', 'g'), '');
 50 |       } else {
 51 |         data[2] = data[0] + data[2];
 52 |         data[1] = '';
 53 |       }
 54 |     }
 55 |     data = _.map(data, _.trim);
 56 |     if (data[1].length === 0) {
 57 |       data[1] = 'false';
 58 |     }
 59 |     if (data[0].length === 0) {
 60 |       data[0] = 'other';
 61 |     }
 62 | 
 63 |     return _.zipObject([ 'type', 'scop', 'subj', 'hash', 'date' ], _.map(data, _.trim));
 64 |   });
 65 | 
 66 |   group = util.groupByMulti(group, [ 'type', 'scop', 'subj' ]);
 67 |   return group;
 68 | };
 69 | 
 70 | 
 71 | Generator.prototype.findType = function(source, key) {
 72 | 
 73 |   var indexKey = _.findIndex(source, function(item) {
 74 | 
 75 |     return item.pattern.match(key);
 76 |   });
 77 |   return source[indexKey] ? source[indexKey].title : key;
 78 | };
 79 | 
 80 | 
 81 | Generator.prototype.writeAType = function(file, options, types, type) {
 82 | 
 83 |   file.write('## %s ##', util.capitalize(this.findType(options.types, type))).writeln().writeln(); // type
 84 | 
 85 |   var scopes = types[type];
 86 |   _.forOwn(scopes, function(issues, scope) {
 87 | 
 88 |     var indent = '';
 89 |     if (scope !== 'false') {
 90 |       file.write('- **%s:**', scope).writeln(); // scope
 91 |       indent = '    ';
 92 |     }
 93 | 
 94 |     _.forOwn(issues, function(commits, issue) {
 95 | 
 96 |       file.write('%s- %s', indent, issue).writeln(); // issue subject
 97 |       commits = commits.map(function(item) {
 98 | 
 99 |         return file.format('[%s](%s)', item.hash, options.url + '/' + item.hash); // hashes
100 |       }).join(', ');
101 |       file.write(' (%s)', commits).writeln();
102 |     });
103 |   });
104 | 
105 |   file.writeln().writeln();
106 | };
107 | 
108 | Generator.prototype.writeHeader = function(file, options) {
109 | 
110 |   if (options.name) {
111 |     file.write('__%s__', options.name).writeln().writeln();
112 |   }
113 | 
114 |   if (options.description) {
115 |     file.write('_%s_', options.description).writeln().writeln();
116 |   }
117 | };
118 | 
119 | Generator.prototype.writeBody = function(file, logs, options) {
120 | 
121 |   file.write('# %s #', git.getLatestCommitDate(logs, options)).writeln().writeln();
122 |   var self = this;
123 |   _.forOwn(logs, function(scopes, type) {
124 | 
125 |     self.writeAType(file, options, logs, type);
126 |   });
127 | };
128 | 
129 | Generator.prototype.writeFooter = function(file) {
130 | 
131 |   file.end();
132 | };
133 | 
134 | 
135 | /**
136 |  * Format logs
137 |  *
138 |  * @param {array} types options
139 |  * @param {function} callback callback
140 |  * @returns {array} generate
141 |  */
142 | Generator.prototype.format = function(types, callback) {
143 | 
144 |   var patterns = _.map(_.defaultsDeep(types, config.defaults.types), 'pattern');
145 |   var self = this;
146 |   git.getLogs(function(err, logs) {
147 | 
148 |     callback(err, self.parse(patterns, logs));
149 |   });
150 | };
151 | 
152 | 
153 | exports.Generator = Generator;
154 | 
155 | 
156 | exports.generate = function(options, done) {
157 | 
158 |   options = _.defaults(options || {}, config.defaults);
159 | 
160 |   var generator = new Generator(options);
161 |   async.waterfall([
162 |     function(callback) {
163 | 
164 |       log('info', 'Get Tags');
165 |       if (options.tag) {
166 |         return callback(null, [ options.tag ]);
167 |       }
168 |       return git.getTags(callback);
169 |     },
170 |     function(tags, callback) {
171 | 
172 |       log('info', 'Get Logs');
173 |       if (tags.length) {
174 |         var series = {};
175 |         var prevTagIndex = 1;
176 |         tags.forEach(function(tag) {
177 | 
178 |           var since = tag;
179 |           if (tags[prevTagIndex]) {
180 |             since = tags[prevTagIndex++] + '..' + tag;
181 |           }
182 |           series[tag] = function(cb) { git.getLogs(since, cb); };
183 |         });
184 |         async.series(series, callback);
185 |       } else {
186 |         git.getLogs(function(err, logs) {
187 | 
188 |           callback(err, { '': logs });
189 |         });
190 |       }
191 |     },
192 |     function(logs, callback) {
193 | 
194 |       log('info', 'Write file ...');
195 |       var patterns = _.map(options.types, 'pattern');
196 |       var file = new File(options.file);
197 |       generator.writeHeader(file, options);
198 | 
199 |       _.forOwn(logs, function(logsOfTag, tag) {
200 | 
201 |         options.tag = tag;
202 |         logsOfTag = generator.parse(patterns, logsOfTag);
203 |         generator.writeBody(file, logsOfTag, options);
204 |       });
205 |       generator.writeFooter(file);
206 |       log('info', 'Write file success');
207 |       callback(null, logs);
208 |     }
209 |   ], done);
210 | };
211 | 


--------------------------------------------------------------------------------
/test/git.js:
--------------------------------------------------------------------------------
  1 | /* eslint handle-callback-err: "off" */
  2 | 
  3 | 'use strict';
  4 | 
  5 | var git = require('../lib/git.js');
  6 | var Process = require('child_process');
  7 | 
  8 | // Load external modules
  9 | var Lab = require('lab');
 10 | var Code = require('code');
 11 | var Sinon = require('sinon');
 12 | 
 13 | // Test shortcuts
 14 | var lab = exports.lab = Lab.script();
 15 | var describe = lab.describe;
 16 | var it = lab.it;
 17 | var before = lab.before;
 18 | var after = lab.after;
 19 | var expect = Code.expect;
 20 | 
 21 | 
 22 | before(function(done) {
 23 | 
 24 |   done();
 25 | });
 26 | 
 27 | after(function(done) {
 28 | 
 29 |   done();
 30 | });
 31 | 
 32 | describe('Test git', function() {
 33 | 
 34 |   describe('function getTags', function() {
 35 | 
 36 |     it('return empty on error expect', function(done) {
 37 | 
 38 |       Sinon.stub(Process, 'exec', function(cmd, callback) {
 39 | 
 40 |         callback(null, null, 'Error git');
 41 |       });
 42 | 
 43 |       git.getTags(function(err, tags) {
 44 | 
 45 |         Process.exec.restore();
 46 |         expect(err).to.be.not.undefined();
 47 |         expect(tags).to.be.an.array();
 48 |         expect(tags).to.be.empty();
 49 |         done();
 50 |       });
 51 |     });
 52 | 
 53 |     it('return empty on error', function(done) {
 54 | 
 55 |       Sinon.stub(Process, 'exec', function(cmd, callback) {
 56 | 
 57 |         callback('Error git');
 58 |       });
 59 | 
 60 |       git.getTags(function(err, tags) {
 61 | 
 62 |         Process.exec.restore();
 63 |         expect(err).to.be.not.undefined();
 64 |         expect(tags).to.be.an.array();
 65 |         expect(tags).to.be.empty();
 66 |         done();
 67 |       });
 68 |     });
 69 | 
 70 |     it('return empty', function(done) {
 71 | 
 72 |       Sinon.stub(Process, 'exec', function(cmd, callback) {
 73 | 
 74 |         callback(null, '');
 75 |       });
 76 | 
 77 |       git.getTags(function(err, tags) {
 78 | 
 79 |         Process.exec.restore();
 80 |         expect(tags).to.be.an.array();
 81 |         expect(tags).to.be.empty();
 82 |         done();
 83 |       });
 84 |     });
 85 | 
 86 |     it('return tags', function(done) {
 87 | 
 88 |       Sinon.stub(Process, 'exec', function(cmd, callback) {
 89 | 
 90 |         callback(null, 'v1.0\nv2.0\nv2.1\n');
 91 |       });
 92 | 
 93 |       git.getTags(function(err, tags) {
 94 | 
 95 |         Process.exec.restore();
 96 |         expect(tags).to.be.an.array();
 97 |         expect(tags).to.have.length(3);
 98 |         done();
 99 |       });
100 |     });
101 |   });
102 | 
103 |   describe('function getLog', function() {
104 | 
105 |     it('return empty on error expect', function(done) {
106 | 
107 |       Sinon.stub(Process, 'exec', function(cmd, callback) {
108 | 
109 |         callback(null, null, 'Error git');
110 |       });
111 | 
112 |       git.getLogs(function(err, tags) {
113 | 
114 |         Process.exec.restore();
115 |         expect(err).to.be.not.undefined();
116 |         expect(tags).to.be.an.array();
117 |         expect(tags).to.be.empty();
118 |         done();
119 |       });
120 |     });
121 | 
122 |     it('return empty on error', function(done) {
123 | 
124 |       Sinon.stub(Process, 'exec', function(cmd, callback) {
125 | 
126 |         callback('Error git');
127 |       });
128 | 
129 |       git.getLogs(function(err, tags) {
130 | 
131 |         Process.exec.restore();
132 |         expect(err).to.be.not.undefined();
133 |         expect(tags).to.be.an.array();
134 |         expect(tags).to.be.empty();
135 |         done();
136 |       });
137 |     });
138 | 
139 |     it('return empty', function(done) {
140 | 
141 |       Sinon.stub(Process, 'exec', function(cmd, callback) {
142 | 
143 |         callback(null, '');
144 |       });
145 | 
146 |       git.getLogs(function(err, tags) {
147 | 
148 |         Process.exec.restore();
149 |         expect(tags).to.be.an.array();
150 |         expect(tags).to.be.empty();
151 |         done();
152 |       });
153 |     });
154 | 
155 |     it('return logs', function(done) {
156 | 
157 |       Sinon.stub(Process, 'exec', function(cmd, callback) {
158 | 
159 |         callback(null, 'a\nb\nc\n');
160 |       });
161 | 
162 |       git.getLogs(function(err, tags) {
163 | 
164 |         Process.exec.restore();
165 |         expect(tags).to.be.an.array();
166 |         expect(tags).to.have.length(3);
167 |         done();
168 |       });
169 |     });
170 | 
171 |     it('return logs with tag', function(done) {
172 | 
173 |       Sinon.stub(Process, 'exec', function(cmd, callback) {
174 | 
175 |         callback(null, 'a\nb\nc\n');
176 |       });
177 | 
178 |       git.getLogs('v1.0', function(err, tags) {
179 | 
180 |         Process.exec.restore();
181 |         expect(tags).to.be.an.array();
182 |         expect(tags).to.have.length(3);
183 |         done();
184 |       });
185 |     });
186 |   });
187 | 
188 |   describe('function getLatestCommitDate', function() {
189 | 
190 |     it('return empty on not found', function(done) {
191 | 
192 |       var date = git.getLatestCommitDate({});
193 |       expect(date).to.be.empty();
194 |       done();
195 |     });
196 | 
197 |     it('return date', function(done) {
198 | 
199 |       var date = git.getLatestCommitDate({
200 |         feat: {
201 |           scope: {
202 |             commit: [
203 |               { date: '2016-01-04' },
204 |               { date: '2016-01-03' }
205 |             ]
206 |           }
207 |         },
208 |         fix: {
209 |           scope: {
210 |             commit: [
211 |               { date: '2016-01-02' },
212 |               { date: '2016-01-01' }
213 |             ]
214 |           }
215 |         }
216 |       });
217 |       expect(date).to.be.equal('(2016-01-04)');
218 |       done();
219 |     });
220 | 
221 |     it('return date with options', function(done) {
222 | 
223 |       var date = git.getLatestCommitDate({
224 |         feat: {
225 |           scope: {
226 |             commit: [
227 |               { date: '2016-01-04' },
228 |               { date: '2016-01-03' }
229 |             ]
230 |           }
231 |         },
232 |         fix: {
233 |           scope: {
234 |             commit: [
235 |               { date: '2016-01-02' },
236 |               { date: '2016-01-01' }
237 |             ]
238 |           }
239 |         }
240 |       }, { tag: 'v1.0' });
241 |       expect(date).to.be.equal('v1.0 (2016-01-04)');
242 |       done();
243 |     });
244 |   });
245 | });
246 | 


--------------------------------------------------------------------------------
/test/generate.js:
--------------------------------------------------------------------------------
  1 | /* eslint handle-callback-err: "off" */
  2 | 
  3 | 'use strict';
  4 | 
  5 | var generate = require('../lib/generate.js');
  6 | var Generator = generate.Generator;
  7 | var git = require('../lib/git.js');
  8 | var Process = require('child_process');
  9 | 
 10 | // Load external modules
 11 | var Lab = require('lab');
 12 | var Code = require('code');
 13 | var Sinon = require('sinon');
 14 | 
 15 | // Test shortcuts
 16 | var lab = exports.lab = Lab.script();
 17 | var describe = lab.describe;
 18 | var it = lab.it;
 19 | var before = lab.before;
 20 | var after = lab.after;
 21 | var expect = Code.expect;
 22 | 
 23 | var exampleLogs = function() {
 24 | 
 25 |   return [
 26 |     'feat(abc): cde|-|56448a5|-|2016-01-01',
 27 |     'feat(abc): cde|-|84e7c3e|-|2016-01-01',
 28 |     'feat(abc): cde|-|1c4b2f6|-|2016-01-01',
 29 |     'feat(bca): cde|-|b6b4052|-|2016-01-01',
 30 |     'abc2|-|0814ad4|-|2016-01-01',
 31 |     'abc|-|51203ad|-|2016-01-01',
 32 |     'abc|-|345aded|-|2016-01-01'
 33 |   ];
 34 | };
 35 | 
 36 | before(function(done) {
 37 | 
 38 |   done();
 39 | });
 40 | 
 41 | after(function(done) {
 42 | 
 43 |   done();
 44 | });
 45 | 
 46 | describe('Test generator', function() {
 47 | 
 48 |   describe('func format', function() {
 49 | 
 50 |     var generator;
 51 | 
 52 |     before(function(done) {
 53 | 
 54 |       generator = new Generator({});
 55 |       done();
 56 |     });
 57 | 
 58 |     it('return empty', function(done) {
 59 | 
 60 |       Sinon.stub(git, 'getLogs', function(callback) {
 61 | 
 62 |         callback(null, []);
 63 |       });
 64 |       generator.format({}, function(err, logs) {
 65 | 
 66 |         git.getLogs.restore();
 67 |         expect(logs).to.be.an.object();
 68 |         expect(logs).to.be.empty();
 69 |         done();
 70 |       });
 71 |     });
 72 | 
 73 |     it('return new format', function(done) {
 74 | 
 75 |       Sinon.stub(git, 'getLogs', function(callback) {
 76 | 
 77 |         callback(null, exampleLogs());
 78 |       });
 79 |       generator.format({}, function(err, logs) {
 80 | 
 81 |         git.getLogs.restore();
 82 |         expect(logs).to.be.an.object();
 83 |         expect(logs.other).to.be.an.object();
 84 |         expect(logs.other.false).to.be.an.object();
 85 |         expect(logs.other.false).to.equal({
 86 |           abc2: [
 87 |             {
 88 |               type: 'other',
 89 |               scop: 'false',
 90 |               subj: 'abc2',
 91 |               hash: '0814ad4',
 92 |               date: '2016-01-01'
 93 |             }
 94 |           ],
 95 |           abc: [
 96 |             {
 97 |               type: 'other',
 98 |               scop: 'false',
 99 |               subj: 'abc',
100 |               hash: '51203ad',
101 |               date: '2016-01-01'
102 |             },
103 |             {
104 |               type: 'other',
105 |               scop: 'false',
106 |               subj: 'abc',
107 |               hash: '345aded',
108 |               date: '2016-01-01'
109 |             }
110 |           ]
111 |         });
112 | 
113 |         expect(logs.feat).to.be.an.object();
114 |         expect(logs.feat.abc).to.be.an.object();
115 |         expect(logs.feat.bca).to.be.an.object();
116 | 
117 |         done();
118 |       });
119 |     });
120 | 
121 |     it('return new format with defaults', function(done) {
122 | 
123 |       Sinon.stub(git, 'getLogs', function(callback) {
124 | 
125 |         callback(null, exampleLogs());
126 |       });
127 |       generator.format({}, function(err, logs) {
128 | 
129 |         git.getLogs.restore();
130 |         expect(logs).to.be.an.object();
131 |         expect(logs.other).to.be.an.object();
132 |         expect(logs.other.false).to.be.an.object();
133 |         expect(logs.other.false).to.equal({
134 |           abc2: [
135 |             {
136 |               type: 'other',
137 |               scop: 'false',
138 |               subj: 'abc2',
139 |               hash: '0814ad4',
140 |               date: '2016-01-01'
141 |             }
142 |           ],
143 |           abc: [
144 |             {
145 |               type: 'other',
146 |               scop: 'false',
147 |               subj: 'abc',
148 |               hash: '51203ad',
149 |               date: '2016-01-01'
150 |             },
151 |             {
152 |               type: 'other',
153 |               scop: 'false',
154 |               subj: 'abc',
155 |               hash: '345aded',
156 |               date: '2016-01-01'
157 |             }
158 |           ]
159 |         });
160 |         expect(logs.feat).to.be.an.object();
161 |         expect(logs.feat.abc).to.be.an.object();
162 |         expect(logs.feat.bca).to.be.an.object();
163 | 
164 |         done();
165 |       });
166 |     });
167 | 
168 |     it('return new format with defaults', function(done) {
169 | 
170 |       generator = new Generator({
171 |         ignore: '^ignore me|.*and other.*'
172 |       });
173 | 
174 |       Sinon.stub(git, 'getLogs', function(callback) {
175 | 
176 |         var logs = exampleLogs();
177 |         logs.push('ignore me abc|-|345addd|-|2016-01-01');
178 |         logs.push('abc and other|-|345adef|-|2016-01-01');
179 |         callback(null, logs);
180 |       });
181 |       generator.format({ }, function(err, logs) {
182 | 
183 |         git.getLogs.restore();
184 |         expect(logs).to.be.an.object();
185 |         expect(logs.other).to.be.an.object();
186 |         expect(logs.other.false).to.be.an.object();
187 |         expect(logs.other.false).to.equal({
188 |           abc2: [
189 |             {
190 |               type: 'other',
191 |               scop: 'false',
192 |               subj: 'abc2',
193 |               hash: '0814ad4',
194 |               date: '2016-01-01'
195 |             }
196 |           ],
197 |           abc: [
198 |             {
199 |               type: 'other',
200 |               scop: 'false',
201 |               subj: 'abc',
202 |               hash: '51203ad',
203 |               date: '2016-01-01'
204 |             },
205 |             {
206 |               type: 'other',
207 |               scop: 'false',
208 |               subj: 'abc',
209 |               hash: '345aded',
210 |               date: '2016-01-01'
211 |             }
212 |           ]
213 |         });
214 |         expect(logs.feat).to.be.an.object();
215 |         expect(logs.feat.abc).to.be.an.object();
216 |         expect(logs.feat.bca).to.be.an.object();
217 | 
218 |         done();
219 |       });
220 |     });
221 |   });
222 | 
223 |   describe('func generate', function() {
224 | 
225 |     it('empty', function(done) {
226 | 
227 |       Sinon.stub(git, 'getTags', function(callback) {
228 | 
229 |         callback(null, []);
230 |       });
231 |       Sinon.stub(git, 'getLogs', function(callback) {
232 | 
233 |         callback(null, []);
234 |       });
235 |       generate.generate(null, function(err) {
236 | 
237 |         git.getLogs.restore();
238 |         git.getTags.restore();
239 |         done(err);
240 |       });
241 |     });
242 | 
243 |     it('without tag', function(done) {
244 | 
245 |       Sinon.stub(git, 'getTags', function(callback) {
246 | 
247 |         callback(null, []);
248 |       });
249 |       Sinon.stub(git, 'getLogs', function(callback) {
250 | 
251 |         callback(null, exampleLogs());
252 |       });
253 |       generate.generate({}, function(err) {
254 | 
255 |         git.getLogs.restore();
256 |         git.getTags.restore();
257 |         done(err);
258 |       });
259 |     });
260 | 
261 |     it('with tag', function(done) {
262 | 
263 |       Sinon.stub(git, 'getTags', function(callback) {
264 | 
265 |         callback(null, [ 'v2.0', 'v1.0' ]);
266 |       });
267 |       Sinon.stub(git, 'getLogs', function(tag, callback) {
268 | 
269 |         callback(null, exampleLogs());
270 |       });
271 |       generate.generate({}, function(err) {
272 | 
273 |         git.getLogs.restore();
274 |         git.getTags.restore();
275 |         done(err);
276 |       });
277 |     });
278 | 
279 |     it('with tag config', function(done) {
280 | 
281 |       Sinon.stub(git, 'getTags', function(callback) {
282 | 
283 |         callback(null, []);
284 |       });
285 |       Sinon.stub(git, 'getLogs', function(tag, callback) {
286 | 
287 |         callback(null, []);
288 |       });
289 |       Sinon.stub(Process, 'execSync', function(cmd) {
290 | 
291 |         // this is not really return cmd
292 |         // I like return to bypass linter
293 |         return cmd;
294 |       });
295 |       generate.generate({ tag: 'v1.0' }, function(err) {
296 | 
297 |         git.getLogs.restore();
298 |         git.getTags.restore();
299 |         Process.execSync.restore();
300 |         done(err);
301 |       });
302 |     });
303 | 
304 |     it('with config', function(done) {
305 | 
306 |       Sinon.stub(git, 'getTags', function(callback) {
307 | 
308 |         callback(null, [ 'v2.0', 'v1.0' ]);
309 |       });
310 |       Sinon.stub(git, 'getLogs', function(tag, callback) {
311 | 
312 |         var logs = exampleLogs();
313 |         logs.push('feature bca cde|-|b6b4052|-|2016-01-01');
314 |         callback(null, logs);
315 |       });
316 | 
317 |       var options = {
318 |         name: 'test name',
319 |         description: 'test description'
320 |       };
321 | 
322 |       generate.generate(options, function(err) {
323 | 
324 |         git.getLogs.restore();
325 |         git.getTags.restore();
326 |         done(err);
327 |       });
328 |     });
329 |   });
330 | });
331 | 


--------------------------------------------------------------------------------
/.eslintrc:
--------------------------------------------------------------------------------
  1 | {
  2 |   // ESLint v2.x.x
  3 |   // http://eslint.org/docs/rules/
  4 |   // https://gist.github.com/ndaidong/eb2a2f094e31814b75ac
  5 | 
  6 |   "parserOptions": {
  7 |     "sourceType": "module",
  8 |     "ecmaVersion": 6,
  9 |     "ecmaFeatures": {
 10 |       "binaryLiterals": true,                    // enable binary literals
 11 |       "blockBindings": true,                     // enable let and const (aka block bindings)
 12 |       "defaultParams": true,                     // enable default function parameters
 13 |       "forOf": true,                             // enable for-of loops
 14 |       "generators": true,                        // enable generators
 15 |       "modules": true,                           // enable modules
 16 |       "objectLiteralComputedProperties": true,   // enable computed object literal property names
 17 |       "objectLiteralDuplicateProperties": true,  // enable duplicate object literal properties in strict mode
 18 |       "objectLiteralShorthandMethods": true,     // enable object literal shorthand methods
 19 |       "objectLiteralShorthandProperties": true,  // enable object literal shorthand properties
 20 |       "octalLiterals": true,                     // enable octal literals
 21 |       "regexUFlag": true,                        // enable the regular expression u flag
 22 |       "regexYFlag": true,                        // enable the regular expression y flag
 23 |       "templateStrings": true,                   // enable template strings
 24 |       "unicodeCodePointEscapes": true,           // enable code point escapes
 25 |       "jsx": true                                // enable JSX
 26 |     }
 27 |   },
 28 | 
 29 |   "env": {
 30 |     "browser": true,     // browser global variables.
 31 |     "node": true,        // Node.js global variables and Node.js-specific rules.
 32 |     "amd": true,         // defines require() and define() as global variables as per the amd spec.
 33 |     "mocha": true,       // adds all of the Mocha testing global variables.
 34 |     "jasmine": true,     // adds all of the Jasmine testing global variables for version 1.3 and 2.0.
 35 |     "phantomjs": true,   // phantomjs global variables.
 36 |     "jquery": true,      // jquery global variables.
 37 |     "prototypejs": true, // prototypejs global variables.
 38 |     "shelljs": true,     // shelljs global variables.
 39 |     "es6": true          // enabled ES6 syntax
 40 |   },
 41 | 
 42 |   "globals": {
 43 |     "SDATA": true,
 44 |     "RECONF": true,
 45 |     "App": true
 46 |   },
 47 | 
 48 |   "plugins": [
 49 |     // e.g. "react" (must run `npm install eslint-plugin-react` first)
 50 |   ],
 51 | 
 52 |   "rules": {
 53 |     ////////// Possible Errors //////////
 54 | 
 55 |     "comma-dangle": 2,               // disallow or enforce trailing commas (recommended)
 56 |     "no-cond-assign": 2,             // disallow assignment in conditional expressions (recommended)
 57 |     "no-console": 2,                 // disallow use of console in the node environment (recommended)
 58 |     "no-constant-condition": 2,      // disallow use of constant expressions in conditions (recommended)
 59 |     "no-control-regex": 2,           // disallow control characters in regular expressions (recommended)
 60 |     "no-debugger": 2,                // disallow use of debugger (recommended)
 61 |     "no-dupe-args": 2,               // disallow duplicate arguments in functions (recommended)
 62 |     "no-dupe-keys": 2,               // disallow duplicate keys when creating object literals (recommended)
 63 |     "no-duplicate-case": 2,          // disallow a duplicate case label. (recommended)
 64 |     "no-empty-character-class": 2,   // disallow the use of empty character classes in regular expressions (recommended)
 65 |     "no-empty": 2,                   // disallow empty statements (recommended)
 66 |     "no-ex-assign": 2,               // disallow assigning to the exception in a catch block (recommended)
 67 |     "no-extra-boolean-cast": 2,      // disallow double-negation boolean casts in a boolean context (recommended)
 68 |     "no-extra-parens": 2,            // disallow unnecessary parentheses
 69 |     "no-extra-semi": 2,              // disallow unnecessary semicolons (recommended) (fixable)
 70 |     "no-func-assign": 2,             // disallow overwriting functions written as function declarations (recommended)
 71 |     "no-inner-declarations": 2,      // disallow function or variable declarations in nested blocks (recommended)
 72 |     "no-invalid-regexp": 2,          // disallow invalid regular expression strings in the RegExp constructor (recommended)
 73 |     "no-irregular-whitespace": 2,    // disallow irregular whitespace outside of strings and comments (recommended)
 74 |     "no-negated-in-lhs": 2,          // disallow negation of the left operand of an in expression (recommended)
 75 |     "no-obj-calls": 2,               // disallow the use of object properties of the global object (Math and JSON) as functions (recommended)
 76 |     "no-regex-spaces": 2,            // disallow multiple spaces in a regular expression literal (recommended)
 77 |     "no-sparse-arrays": 2,           // disallow sparse arrays (recommended)
 78 |     "no-unexpected-multiline": 2,    // Avoid code that looks like two expressions but is actually one
 79 |     "no-unreachable": 2,             // disallow unreachable statements after a return, throw, continue, or break statement (recommended)
 80 |     "use-isnan": 2,                  // disallow comparisons with the value NaN (recommended)
 81 |     "valid-jsdoc": 2,                // Ensure JSDoc comments are valid
 82 |     "valid-typeof": 2,               // Ensure that the results of typeof are compared against a valid string (recommended)
 83 | 
 84 | 
 85 |     ////////// Best Practices //////////
 86 | 
 87 |     "accessor-pairs": 2,        // Enforces getter/setter pairs in objects
 88 |     "block-scoped-var": 1,      // treat var statements as if they were block scoped
 89 |     "complexity": [1, 20],      // specify the maximum cyclomatic complexity allowed in a program
 90 |     "consistent-return": 2,     // require return statements to either always or never specify values
 91 |     "curly": [2, "all"],        // specify curly brace conventions for all control statements
 92 |     "default-case": 2,          // require default case in switch statements
 93 |     "dot-location": [
 94 |       2,
 95 |       "property"
 96 |     ],                          // enforces consistent newlines before or after dots
 97 |     "dot-notation": 2,          // encourages use of dot notation whenever possible
 98 |     "eqeqeq": [2, "smart"],                // require the use of === and !== (fixable)
 99 |     "guard-for-in": 2,          // make sure for-in loops have an if statement
100 |     "no-alert": 2,              // disallow the use of alert, confirm, and prompt
101 |     "no-caller": 2,             // disallow use of arguments.caller or arguments.callee
102 |     "no-case-declarations": 0,  // disallow lexical declarations in case clauses
103 |     "no-div-regex": 2,          // disallow division operators explicitly at beginning of regular expression
104 |     "no-else-return": 2,        // disallow else after a return in an if
105 |     "no-empty-pattern": 0,      // disallow use of empty destructuring patterns
106 |     "no-eq-null": 2,            // disallow comparisons to null without a type-checking operator
107 |     "no-eval": 2,               // disallow use of eval()
108 |     "no-extend-native": 2,      // disallow adding to native types
109 |     "no-extra-bind": 2,         // disallow unnecessary function binding
110 |     "no-fallthrough": 2,        // disallow fallthrough of case statements (recommended)
111 |     "no-floating-decimal": 2,   // disallow the use of leading or trailing decimal points in numeric literals
112 |     "no-implicit-coercion": 2,  // disallow the type conversions with shorter notations
113 |     "no-implied-eval": 2,       // disallow use of eval()-like methods
114 |     "no-invalid-this": 1,       // disallow this keywords outside of classes or class-like objects
115 |     "no-iterator": 1,           // disallow usage of __iterator__ property
116 |     "no-labels": 1,             // disallow use of labeled statements
117 |     "no-lone-blocks": 1,        // disallow unnecessary nested blocks
118 |     "no-loop-func": 2,          // disallow creation of functions within loops
119 |     "no-magic-numbers": 0,      // disallow the use of magic numbers
120 |     "no-multi-spaces": 2,       // disallow use of multiple spaces (fixable)
121 |     "no-multi-str": 2,          // disallow use of multiline strings
122 |     "no-native-reassign": 2,    // disallow reassignments of native objects
123 |     "no-new-func": 2,           // disallow use of new operator for Function object
124 |     "no-new-wrappers": 2,       // disallows creating new instances of String,Number, and Boolean
125 |     "no-new": 2,                // disallow use of the new operator when not part of an assignment or comparison
126 |     "no-octal-escape": 2,       // disallow use of octal escape sequences in string literals, such as var foo = "Copyright \251";
127 |     "no-octal": 2,              // disallow use of octal literals (recommended)
128 |     "no-param-reassign": 0,     // disallow reassignment of function parameters
129 |     "no-process-env": 2,        // disallow use of process.env
130 |     "no-proto": 2,              // disallow usage of __proto__ property
131 |     "no-redeclare": 2,          // disallow declaring the same variable more than once (recommended)
132 |     "no-return-assign": 2,      // disallow use of assignment in return statement
133 |     "no-script-url": 2,         // disallow use of javascript: urls.
134 |     "no-self-compare": 2,       // disallow comparisons where both sides are exactly the same
135 |     "no-sequences": 2,          // disallow use of the comma operator
136 |     "no-throw-literal": 2,      // restrict what can be thrown as an exception
137 |     "no-unused-expressions": 2, // disallow usage of expressions in statement position
138 |     "no-useless-call": 2,       // disallow unnecessary .call() and .apply()
139 |     "no-useless-concat": 2,     // disallow unnecessary concatenation of literals or template literals
140 |     "no-void": 2,               // disallow use of the void operator
141 |     "no-warning-comments": [
142 |       2,
143 |       {
144 |         "terms": [
145 |           "todo"
146 |         ],
147 |         "location": "start"
148 |       }
149 |     ],                          // disallow usage of configurable warning terms in comments, such as TODO or FIXME
150 |     "no-with": 2,               // disallow use of the with statement
151 |     "radix": 2,                 // require use of the second argument for parseInt()
152 |     "vars-on-top": 0,           // require declaration of all vars at the top of their containing scope
153 |     "wrap-iife": [
154 |       2,
155 |       "inside"
156 |     ],                          // require immediate function invocation to be wrapped in parentheses
157 |     "yoda": 0,                  // require or disallow Yoda conditions
158 | 
159 |     ////////// Strict Mode //////////
160 | 
161 |     "strict": [0, "global"],          // controls location of Use Strict Directives
162 | 
163 | 
164 |     ////////// Variables //////////
165 | 
166 |     "init-declarations": 0,           // enforce or disallow variable initializations at definition
167 |     "no-catch-shadow": 2,             // disallow the catch clause parameter name being the same as a variable in the outer scope
168 |     "no-delete-var": 2,               // disallow deletion of variables
169 |     "no-label-var": 2,                // disallow labels that share a name with a variable
170 |     "no-shadow": 2,                   // disallow declaration of variables already declared in the outer scope
171 |     "no-shadow-restricted-names": 0,  // disallow shadowing of names such as arguments
172 |     "no-undef": 2,                    // disallow use of undeclared variables unless mentioned in a /*global */ block (recommended)
173 |     "no-undef-init": 2,               // disallow use of undefined when initializing variables
174 |     "no-undefined": 2,                // disallow use of undefined variable
175 |     "no-unused-vars": 2,              // disallow declaration of variables that are not used in the code (recommended)
176 |     "no-use-before-define": 2,        // disallow use of variables before they are defined
177 | 
178 | 
179 |     ////////// Node.js //////////
180 | 
181 |     "callback-return": 2,       // enforce return after a callback
182 |     "global-require": 0,        // enforce require() on top-level module scope
183 |     "handle-callback-err": 2,   // enforce error handling in callbacks
184 |     "no-mixed-requires": 2,     // disallow mixing regular variable and require declarations
185 |     "no-new-require": 2,        // disallow use of new operator with the require function
186 |     "no-path-concat": 2,        // disallow string concatenation with __dirname and __filename
187 |     "no-process-exit": 2,       // disallow process.exit()
188 |     "no-restricted-modules": 2, // restrict usage of specified node modules
189 |     "no-sync": 0,               // disallow use of synchronous methods
190 | 
191 | 
192 |     ////////// Stylistic Issues //////////
193 | 
194 |     "array-bracket-spacing": [
195 |       2,
196 |       "always"
197 |     ],                                // enforce spacing inside array brackets (fixable)
198 |     "block-spacing": [
199 |       2,
200 |       "always"
201 |     ],                                // disallow or enforce spaces inside of single line blocks (fixable)
202 |     "brace-style": [
203 |       2,
204 |       "1tbs",
205 |       {
206 |         "allowSingleLine": true
207 |       }
208 |     ],                                // enforce one true brace style
209 |     "camelcase": [
210 |       2,
211 |       {
212 |         "properties": "always"
213 |       }
214 |     ],                                // require camel case names
215 |     "comma-spacing": [
216 |       2,
217 |       {
218 |         "before": false,
219 |         "after": true
220 |       }
221 |     ],                                // enforce spacing before and after comma (fixable)
222 |     "comma-style": [
223 |       2,
224 |       "last"
225 |     ],                                // enforce one true comma style
226 |     "computed-property-spacing": [
227 |       2,
228 |       "never"
229 |     ],                                // require or disallow padding inside computed properties (fixable)
230 |     "consistent-this": [
231 |       2,
232 |       "self"
233 |     ],                                // enforces consistent naming when capturing the current execution context
234 |     "eol-last": 2,                    // enforce newline at the end of file, with no multiple empty lines (fixable)
235 |     "func-names": 0,                  // require function expressions to have a name
236 |     "func-style": 0,                  // enforces use of function declarations or expressions
237 |     "id-length": 0,                   // this option enforces minimum and maximum identifier lengths (variable names, property names etc.)
238 |     "id-match": 0,                    // require identifiers to match the provided regular expression
239 |     "indent": [
240 |       2,
241 |       2,
242 |       {
243 |         "SwitchCase": 1
244 |       }
245 |     ],                                // specify tab or space width for your code (fixable)
246 |     "jsx-quotes": 0,                  // specify whether double or single quotes should be used in JSX attributes
247 |     "key-spacing": [
248 |       2,
249 |       {
250 |         "beforeColon": false,
251 |         "afterColon": true
252 |       }
253 |     ],                                // enforces spacing between keys and values in object literal properties
254 |     "linebreak-style": 2,             // disallow mixed 'LF' and 'CRLF' as linebreaks
255 |     "lines-around-comment": [
256 |       2,
257 |       {
258 |         "beforeBlockComment": true,
259 |         "beforeLineComment": true
260 |       }
261 |     ],                                // enforce empty lines around comments
262 |     "max-depth": [2, 10],             // specify the maximum depth that blocks can be nested
263 |     "max-len": [
264 |       2,
265 |       120,
266 |       4,
267 |       {
268 |         "ignoreComments": true,
269 |         "ignoreUrls": true
270 |       }
271 |     ],                                // specify the maximum length of a line in your program
272 |     "max-nested-callbacks": [
273 |       2,
274 |       5
275 |     ],                                // specify the maximum depth callbacks can be nested
276 |     "max-params": 0,                  // limits the number of parameters that can be used in the function declaration.
277 |     "max-statements": 0,              // specify the maximum number of statement allowed in a function
278 |     "new-cap": 0,                     // require a capital letter for constructors
279 |     "new-parens": 2,                  // disallow the omission of parentheses when invoking a constructor with no arguments
280 |     "newline-after-var": 0,           // require or disallow an empty newline after variable declarations
281 |     "no-array-constructor": 2,        // disallow use of the Array constructor
282 |     "no-bitwise": 0,                  // disallow use of bitwise operators
283 |     "no-continue": 0,                 // disallow use of the continue statement
284 |     "no-inline-comments": 0,          // disallow comments inline after code
285 |     "no-lonely-if": 1,                // disallow if as the only statement in an else block
286 |     "no-mixed-spaces-and-tabs": 2,    // disallow mixed spaces and tabs for indentation (recommended)
287 |     "no-multiple-empty-lines": [
288 |       2,
289 |       {
290 |         "max": 2
291 |       }
292 |     ],                                // disallow multiple empty lines
293 |     "no-negated-condition": 0,        // disallow negated conditions
294 |     "no-nested-ternary": 0,           // disallow nested ternary expressions
295 |     "no-new-object": 2,               // disallow the use of the Object constructor
296 |     "no-plusplus": 0,                 // disallow use of unary operators, ++ and --
297 |     "no-restricted-syntax": 0,        // disallow use of certain syntax in code
298 |     "no-spaced-func": 2,              // disallow space between function identifier and application (fixable)
299 |     "no-ternary": 0,                  // disallow the use of ternary operators
300 |     "no-trailing-spaces": 2,          // disallow trailing whitespace at the end of lines (fixable)
301 |     "no-underscore-dangle": 0,        // disallow dangling underscores in identifiers
302 |     "no-unneeded-ternary": 2,         // disallow the use of ternary operators when a simpler alternative exists
303 |     "object-curly-spacing": [
304 |       2,
305 |       "always"
306 |     ],                                // require or disallow padding inside curly braces (fixable)
307 |     "one-var": 0,                     // require or disallow one variable declaration per function
308 |     "operator-assignment": 0,         // require assignment operator shorthand where possible or prohibit it entirely
309 |     "operator-linebreak": 0,          // enforce operators to be placed before or after line breaks
310 |     "padded-blocks": 0,               // enforce padding within blocks
311 |     "quote-props": 0,                 // require quotes around object literal property names
312 |     "quotes": [
313 |       2,
314 |       "single"
315 |     ],                                // specify whether backticks, double or single quotes should be used (fixable)
316 |     "require-jsdoc": 0,               // Require JSDoc comment
317 |     "semi-spacing": [
318 |       2,
319 |       {
320 |         "before": false,
321 |         "after": true
322 |       }
323 |     ],                                // enforce spacing before and after semicolons
324 |     "semi": [
325 |       2,
326 |       "always"
327 |     ],                                // require or disallow use of semicolons instead of ASI (fixable)
328 |     "sort-vars": 0,                   // sort variables within the same declaration block
329 |     "keyword-spacing": [
330 |       2,
331 |       {
332 |         "before": true,
333 |         "after": true,
334 |         "overrides": {}
335 |       }
336 |     ],                                // require a space after certain keywords (fixable)
337 |     "space-before-blocks": [
338 |       2,
339 |       "always"
340 |     ],                                // require or disallow a space before blocks (fixable)
341 |     "space-before-function-paren": [
342 |       2,
343 |       "never"
344 |     ],                                // require or disallow a space before function opening parenthesis (fixable)
345 |     "space-before-keywords": 0,       // require a space before certain keywords (fixable)
346 |     "space-in-parens": [
347 |       2,
348 |       "never"
349 |     ],                                // require or disallow spaces inside parentheses
350 |     "space-infix-ops": [
351 |       2,
352 |       {
353 |         "int32Hint": false
354 |       }
355 |     ],                                // require spaces around operators (fixable)
356 |     "space-return-throw-case": 0,     // require a space after return, throw, and case (fixable)
357 |     "space-unary-ops": 2,             // require or disallow spaces before/after unary operators (fixable)
358 |     "spaced-comment": [
359 |       2,
360 |       "always",
361 |       {
362 |         "exceptions": ["-", "+"]
363 |       }
364 |     ],                                // require or disallow a space immediately following the // or /* in a comment
365 |     "wrap-regex": 0,                  // require regex literals to be wrapped in parentheses
366 | 
367 | 
368 |     ////////// ECMAScript 6 //////////
369 | 
370 |     "arrow-body-style": 0,           // require braces in arrow function body
371 |     "arrow-parens": 2,               // require parens in arrow function arguments
372 |     "arrow-spacing": 2,              // require space before/after arrow function's arrow (fixable)
373 |     "constructor-super": 0,          // verify calls of super() in constructors
374 |     "generator-star-spacing": 0,     // enforce spacing around the * in generator functions (fixable)
375 |     "no-arrow-condition": 0,         // disallow arrow functions where a condition is expected
376 |     "no-class-assign": 0,            // disallow modifying variables of class declarations
377 |     "no-const-assign": 0,            // disallow modifying variables that are declared using const
378 |     "no-dupe-class-members": 0,      // disallow duplicate name in class members
379 |     "no-this-before-super": 0,       // disallow use of this/super before calling super() in constructors.
380 |     "no-var": 0,                     // require let or const instead of var
381 |     "object-shorthand": 0,           // require method and property shorthand syntax for object literals
382 |     "prefer-arrow-callback": 0,      // suggest using arrow functions as callbacks
383 |     "prefer-const": 0,               // suggest using const declaration for variables that are never modified after declared
384 |     "prefer-reflect": 0,             // suggest using Reflect methods where applicable
385 |     "prefer-spread": 0,              // suggest using the spread operator instead of .apply().
386 |     "prefer-template": 0,            // suggest using template literals instead of strings concatenation
387 |     "require-yield": 2,              // disallow generator functions that do not have yield
388 |   }
389 | }
390 | 


--------------------------------------------------------------------------------