Feature/cz commitlint

.gitignore

@@ -11,3 +11,4 @@ lib/
 package.json.lerna_backup
 /*.iml
 tsconfig.tsbuildinfo
+coverage

@commitlint/cli/src/cli.test.ts

@@ -1,8 +1,8 @@
-import path from 'path';
 import {fix, git} from '@commitlint/test';
 import execa from 'execa';
-import merge from 'lodash/merge';
 import fs from 'fs-extra';
+import merge from 'lodash/merge';
+import path from 'path';
 
 const bin = require.resolve('../cli.js');
 
@@ -494,7 +494,8 @@ test('should print config', async () => {
 		  defaultIgnores: undefined,
 		  plugins: {},
 		  rules: { 'type-enum': [ 2, 'never', [ 'foo' ] ] },
-		  helpUrl: 'https://github.com/conventional-changelog/commitlint/#what-is-commitlint'
+		  helpUrl: 'https://github.com/conventional-changelog/commitlint/#what-is-commitlint',
+		  prompt: {}
 		}"
 	`);
 });

@commitlint/config-conventional/index.js

@@ -33,4 +33,103 @@ module.exports = {
 			],
 		],
 	},
+	prompt: {
+		questions: {
+			type: {
+				description: "Select the type of change that you're committing:",
+				enum: {
+					feat: {
+						description: 'A new feature',
+						title: 'Features',
+						emoji: '✨',
+					},
+					fix: {
+						description: 'A bug fix',
+						title: 'Bug Fixes',
+						emoji: '🐛',
+					},
+					docs: {
+						description: 'Documentation only changes',
+						title: 'Documentation',
+						emoji: '📚',
+					},
+					style: {
+						description:
+							'Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)',
+						title: 'Styles',
+						emoji: '💎',
+					},
+					refactor: {
+						description:
+							'A code change that neither fixes a bug nor adds a feature',
+						title: 'Code Refactoring',
+						emoji: '📦',
+					},
+					perf: {
+						description: 'A code change that improves performance',
+						title: 'Performance Improvements',
+						emoji: '🚀',
+					},
+					test: {
+						description: 'Adding missing tests or correcting existing tests',
+						title: 'Tests',
+						emoji: '🚨',
+					},
+					build: {
+						description:
+							'Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)',
+						title: 'Builds',
+						emoji: '🛠',
+					},
+					ci: {
+						description:
+							'Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)',
+						title: 'Continuous Integrations',
+						emoji: '⚙️',
+					},
+					chore: {
+						description: "Other changes that don't modify src or test files",
+						title: 'Chores',
+						emoji: '♻️',
+					},
+					revert: {
+						description: 'Reverts a previous commit',
+						title: 'Reverts',
+						emoji: '🗑',
+					},
+				},
+			},
+			scope: {
+				description:
+					'What is the scope of this change (e.g. component or file name)',
+			},
+			subject: {
+				description:
+					'Write a short, imperative tense description of the change',
+			},
+			body: {
+				description: 'Provide a longer description of the change',
+			},
+			isBreaking: {
+				description: 'Are there any breaking changes?',
+			},
+			breakingBody: {
+				description:
+					'A BREAKING CHANGE commit requires a body. Please enter a longer description of the commit itself',
+			},
+			breaking: {
+				description: 'Describe the breaking changes',
+			},
+			isIssueAffected: {
+				description: 'Does this change affect any open issues?',
+			},
+			issuesBody: {
+				description:
+					'If issues are closed, the commit requires a body. Please enter a longer description of the commit itself',
+			},
+			issues: {
+				description: 'Add issue references (e.g. "fix #123", "re #123".)',
+			},
+		},
+	},
 };

@commitlint/cz-commitlint/.gitignore

@@ -0,0 +1 @@
+.vscode

@commitlint/cz-commitlint/README.md

@@ -0,0 +1,88 @@
+> Commitizen adapter using the commitlint.config.js
+
+# @commitlint/cz-commitlint
+
+This is a commitizen adapter, using this adapter, commitizen works based on commitlint.config.js.
+
+Submit by commitizen, lint by commitlint, just need maintain one configuration file, Consistent and Scalable.
+
+The interactive process is inspired by [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog).
+
+## Getting started
+
+### Using commitizen adapter
+
+```bash
+npm install --save-dev @commitlint/cz-commitlint commitizen
+```
+
+In package.json
+
+```
+{
+  "scripts": {
+    "commit": "git-cz"
+  },
+  "config": {
+    "commitizen": {
+      "path": "@commitlint/cz-commitlint"
+    }
+  }
+}
+```
+
+### Configure commitlint
+
+```bash
+# Install commitlint cli and conventional config
+npm install --save-dev @commitlint/config-conventional @commitlint/cli
+
+# Simple: config with conventional
+echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js
+
+# commitlint configuration is shareable,
+# Install lerna-scopes
+npm install --save-dev @commitlint/config-lerna-scopes
+# Scalable: config with lerna-scopes in monorepo mode
+echo "module.exports = {extends: ['@commitlint/config-conventional', '@commitlint/config-lerna-scopes']};" > commitlint.config.js
+```
+
+### Set Git Hooks by husky
+
+```base
+
+# ------- using npm ----------
+# Install Husky
+npm install husky --save-dev
+# Active hooks
+npx husky install
+# Add commitlint hook
+npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1'
+# Add commitizen hook
+npx husky add .husky/prepare-commit-msg 'exec < /dev/tty && node_modules/.bin/cz --hook || true'
+
+
+# ------- using yarn ----------
+# Install Husky
+yarn add husky --dev
+# Active hooks
+yarn husky install
+# Add commitlint hook
+yarn husky add .husky/commit-msg 'yarn --no-install commitlint --edit $1'
+# Add commitizen hook
+yarn husky add .husky/prepare-commit-msg 'exec < /dev/tty && node_modules/.bin/cz --hook || true'
+
+```
+
+### Try it out
+
+```bash
+git add .
+npm run commit
+# or
+yarn run commit
+```
+
+## Related
+
+- [Commitlint Shared Configuration](https://github.com/conventional-changelog/commitlint#shared-configuration) - You can find more shared configurations are available to install and use with commitlint

@commitlint/cz-commitlint/TODO

@@ -0,0 +1,5 @@
+[x] jest Test
+[x] insert prompt settings to commitlint.config.js
+[] support multi line
+[] support emoji and title
+[] recognize "signed-off-by" and "references-empty" rules

@commitlint/cz-commitlint/license.md

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+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.

@commitlint/cz-commitlint/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "cz-commitlint",
+  "version": "1.0.0",
+  "description": "Commitizen adapter using the commitlint.config.js",
+  "main": "./lib/index.js",
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "commit": "git-cz"
+  },
+  "homepage": "https://github.com/conventional-changelog/commitlint#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/conventional-changelog/commitlint.git"
+  },
+  "engineStrict": true,
+  "engines": {
+    "node": ">= 10"
+  },
+  "author": "Curly Brackets <[email protected]>",
+  "license": "MIT",
+  "config": {
+    "commitizen": {
+      "path": "./@commitlint/cz-commitlint"
+    }
+  },
+  "dependencies": {
+    "@commitlint/load": "^12.1.1",
+    "@commitlint/types": "^12.1.1",
+    "chalk": "^4.1.0",
+    "lodash": "^4.17.21",
+    "word-wrap": "^1.2.3"
+  },
+  "peerDependencies": {
+    "commitizen": "^4.0.3",
+    "inquirer": "^8.0.0"
+  },
+  "devDependencies": {
+    "@types/inquirer": "^7.3.1"
+  }
+}