feat: Initial commit 🎉

.codeclimate.yml

@@ -0,0 +1,17 @@
+engines:
+  eslint:
+    enabled: true
+    config:
+      config: .eslintrc.js
+  duplication:
+    enabled: true
+    exclude_paths:
+      - test/**/*
+    config:
+      languages:
+        - javascript
+ratings:
+   paths:
+   - src/index.js
+   - test/*.js
+   - test/helpers/*.js

.eslintrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  extends: [
+    '@metahub/eslint-config/es6-config',
+    '@metahub/eslint-config/node-config',
+    '@metahub/eslint-config/promise-config',
+    '@metahub/eslint-config/ava-config',
+    '@metahub/eslint-config/prettier-config',
+  ],
+  parserOptions: {sourceType: 'module'},
+};

.gitignore

@@ -0,0 +1,128 @@
+
+# Created by https://www.gitignore.io/api/macos,windows,linux,node
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.gitignore.io/api/macos,windows,linux,node

.travis.yml

@@ -0,0 +1,24 @@
+language: node_js
+node_js:
+  - 8
+cache:
+  directories:
+    - node_modules
+branches:
+  only:
+    - master
+    - /^greenkeeper.*$/
+git:
+  depth: 3
+before_install:
+  - npm install -g greenkeeper-lockfile@1
+before_script:
+  - npm prune
+  - greenkeeper-lockfile-update
+script:
+  - npm run test
+after_script:
+  - greenkeeper-lockfile-upload
+after_success:
+  - if [ -n "${CODECOV_TOKEN:-}" ]; then npm run codecov; fi
+  - npm run semantic-release

LICENSE

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

README.md

@@ -0,0 +1,188 @@
+# **sr-commit-analyzer**
+
+Customizable commit-analyzer plugin for [semantic-release](https://github.com/semantic-release/semantic-release) based on [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)
+
+[![npm](https://img.shields.io/npm/v/sr-commit-analyzer.svg)](https://www.npmjs.com/package/sr-commit-analyzer)
+[![npm](https://img.shields.io/npm/dt/sr-commit-analyzer.svg)](https://www.npmjs.com/package/sr-commit-analyzer)
+[![Greenkeeper badge](https://badges.greenkeeper.io/vanduynslagerp/sr-commit-analyzer.svg)](https://greenkeeper.io/)
+[![license](https://img.shields.io/github/license/vanduynslagerp/sr-commit-analyzer.svg)](https://github.com/vanduynslagerp/sr-commit-analyzer/blob/master/LICENSE)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+
+[![Travis](https://img.shields.io/travis/vanduynslagerp/sr-commit-analyzer.svg)](https://travis-ci.org/vanduynslagerp/sr-commit-analyzer)
+[![Code Climate](https://img.shields.io/codeclimate/github/vanduynslagerp/karma-postcss-preprocessor.svg)](https://codeclimate.com/github/vanduynslagerp/karma-postcss-preprocessor)
+[![Codecov](https://img.shields.io/codecov/c/github/vanduynslagerp/sr-commit-analyzer.svg)](https://codecov.io/gh/vanduynslagerp/sr-commit-analyzer)
+
+## Install
+```bash
+npm install --save-dev semantic-release sr-commit-analyzer
+```
+
+Set the `analyzeCommits` plugin for `semantic-release` in `package.json`. See [semantic-release plugins](https://github.com/semantic-release/semantic-release#plugins).
+```json
+{
+  "release": {
+    "analyzeCommits": "sr-commit-analyzer"
+  }
+}
+```
+
+## Options
+
+By default `sr-commit-analyzer` uses the `angular` format described in [Angular convention](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/convention.md).
+
+Additionnal options can be set within the plugin definition in `package.json` to use a different commit format and to customize it:
+
+```json
+{
+  "release": {
+    "analyzeCommits": {
+      "path": "sr-commit-analyzer",
+      "preset": "angular",
+      "commitTypes": [
+        {"type": "docs", "scope":"README", "release": "patch"},
+        {"type": "refactor", "release": "patch"},
+        {"type": "style", "release": "patch"}
+      ],
+      "parserOpts": {
+        "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
+      }
+    }
+  }
+}
+```
+
+| Option        | Description                                                                                                                                                                                                                                                                                        | Default                               |
+| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
+| `preset`      | [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) preset (possible values: `angular`, `atom`, `codemirror`, `ember`, `eslint`, `express`, `jquery`, `jscs`, `jshint`).                                                                                    | `angular`                             |
+| `config`      | NPM package name of a custom [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) preset.                                                                                                                                                                    | -                                     |
+| `commitTypes` | An external module, a path to a module or an `Array` of rules. See [Commit types](#commit-types).                                                                                                                                                                                                  | See [Commit types](#commit-types)     |
+| `parserOpts`  | Additional [conventional-commits-parser](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser#conventionalcommitsparseroptions) options that will extends ones loaded by `preset` or `config`. See [Parser options](#parser-options). | -                                     |
+
+**NOTE:** `config` will be overwritten by the values of `preset`. You should use either `preset` or `config`, but not both. Individual properties of `parserOpts` will overwrite ones loaded with `preset` or `config`.
+
+### Commit Types
+
+#### Rules definition
+This is an `Array` of rule objects. A rule object has a `release` property and 1 or more criteria.
+```json
+{
+  "release": {
+    "analyzeCommits": {
+      "preset": "angular",
+      "commitTypes": [
+        {"type": "docs", "scope": "README", "release": "patch"},
+        {"type": "refactor", "scope": "/core-.*/", "release": "minor"},
+        {"type": "refactor", "release": "patch"}
+      ]
+    }
+  }
+}
+```
+#### Rules matching
+
+Each commit will be compared with each rule and when it matches, the commit will be associated with the release type in the rule's `release` property. If a commit match multiple rules, the highest release type (`major` > `minor` > `patch`) is associated with the commit.
+
+See [release types](lib/default/release-types.js) for the release types hierarchy.
+
+With the previous example:
+*   Commits with `type` 'docs' and `scope` 'README' will be associated with a `patch` release.
+*   Commits with `type` 'refactor' and `scope` starting with 'core-' (i.e. 'core-ui', 'core-rules', ...) will be associated with a `minor` release.
+*   Other commits with `type` 'refactor' (without `scope` or with a `scope` not matching the regexp `/core-.*/`) will be associated with a `patch` release.
+
+#### Default rules matching
+
+If a commit doesn't match any rule in `commitTypes` it will be evaluated agaisnt the [default commit types](lib/default/commit-types.js).
+
+With the previous example:
+*   Commits with a breaking change will be associated with a `minor` release.
+*   Commits with `type` 'feat' will be associated with a `minor` release.
+*   Commits with `type` 'fix' will be associated with a `patch` release.
+*   Commits with `type` 'perf' will be associated with a `patch` release.
+
+#### No rules matching
+
+If a commit doesn't match any rules in `commitTypes` or in [default commit types](lib/default/commit-types.js) then no release type will be associated with the commit.
+
+With the previous example:
+*   Commits with `type` 'style' will not be associated with a release type.
+*   Commits with `type` 'test' will not be associated with a release type.
+*   Commits with `type` 'chore' will not be associated with a release type.
+
+#### Multiple commits
+
+If there is multiple commits that match one or more rules, the one with the highest realease type will determine the global release type.
+
+Considering the following commits:
+*   `docs(README): Add more details to the API docs`
+*   `feat(API): Add a new method to the public API`
+
+With the previous example the release type determine by the plugin will be `minor`.
+
+#### Specific commit properties
+
+The properties to set in the rules will depends on the commit style choosen. For example [conventional-changelog-angular](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/index.js#L9-L13) use the commit properties `type`, `scope` and `subject` but [conventional-changelog-eslint](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-eslint/index.js#L9-L12) uses `tag` and `message`.
+
+For example with `eslint` preset:
+```json
+{
+  "release": {
+    "analyzeCommits": {
+      "preset": "eslint",
+      "commitTypes": [
+        {"tag": "Docs", "message":"/README/", "release": "patch"},
+        {"type": "New", "release": "patch"}
+      ]
+    }
+  }
+}
+```
+With this configuration:
+*   Commits with `tag` 'Docs', that contains 'README' in their header message will be associated with a `patch` release.
+*   Commits with `tag` 'New' will be associated with a `patch` release.
+*   Commits with `tag` 'Breaking' will be associated with a `major` release (per [default commit types](lib/default/commit-types.js)).
+*   Commits with `tag` 'Fix' will be associated with a `patch` release (per [default commit types](lib/default/commit-types.js)).
+*   Commits with `tag` 'Update' will be associated with a `minor` release (per [default commit types](lib/default/commit-types.js)).
+*   Commits with `tag` 'New' will be associated with a `minor` release (per [default commit types](lib/default/commit-types.js)).
+*   All other commits will not be associated with a release type.
+
+#### External package / file
+
+`commitTypes` can also reference a module, either by it's `npm` name or path:
+```json
+{
+  "release": {
+    "analyzeCommits": {
+      "path": "sr-commit-analyzer",
+      "preset": "angular",
+      "commitTypes": "config/commit-types.js"
+    }
+  }
+}
+```
+```js
+// File: config/commit-types.js
+module.exports = [
+  {type: 'docs', scope: 'README', release: 'patch'},
+  {type: 'refactor', scope: /core-.*/, release: 'minor'},
+  {type: 'refactor', release: 'patch'},
+];
+```
+
+### Parser Options
+
+Allow to overwrite specific [conventional-commits-parser](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser#conventionalcommitsparseroptions) options. This is convenient to use a [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) with some customizations without having to create a new module.
+
+The following example uses [Angular convention](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/convention.md) but will consider a commit to be a breaking change if it's body contains `BREAKING CHANGE`, `BREAKING CHANGES` or `BREAKING`. By default the [preset](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/index.js#L14) checks only for `BREAKING CHANGE` and `BREAKING CHANGES`.
+```json
+{
+  "release": {
+    "analyzeCommits": {
+      "preset": "angular",
+      "parserOpts": {
+        "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"],
+      }
+    }
+  }
+}
+```

commitlint.config.js

@@ -0,0 +1 @@
+module.exports = {extends: ['@commitlint/config-angular']};