commitlint-config-ali - npm Package Compare versions

commitlint-config-ali

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Comparing version 0.1.2 to 0.1.3

CHANGELOG.md

		@@ -1,13 +0,25 @@
		# 0.1.2 - 2020-11-25
		### Changed
		- update order of commit message type
		- remove some unmentioned type of git convention document
		# 更新日志

		# 0.1.1 - 2020-11-13
		### Fixed
		## 0.1.3 (2020-12-03)

		### 优化

		- 修改 package.json 和 README

		## 0.1.2 (2020-11-25)

		### 变更

		- type-enum 规则：移除 Git 规约中未提及的 type，并修改 type 顺序

		## 0.1.1 (2020-11-13)

		### 修复

		- conventional-changelog-conventionalcommits 版本升级到 ^4.5.0

		# 0.1.0 - 2020-04-30
		### Initialized
		- Fork from [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional)
		- 关掉 subject-case
		## 0.1.0 (2020-04-30)

		### 新增

		- Fork from [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional)，并关闭 subject-case

package.json

		{
		"name": "commitlint-config-ali",
		"version": "0.1.2",
		"description": "Commitlint shareable configuration for ali",
		"version": "0.1.3",
		"description": "Commitlint shareable configuration for Alibaba F2E Guidelines",
		"main": "index.js",
		"scripts": {
		"test": "echo \"Error: no test specified\" && exit 1"
		},
		"keywords": [
		"commitlint-config"
		"commitlint",
		"commitlint-config",
		"f2elint",
		"Alibaba F2E Guidelines"
		],
		"repository": {
		"type": "git",
		"url": "https://github.com/alibaba/f2e-spec"
		},
		"bugs": {
		"url": "https://github.com/alibaba/f2e-spec/issues"
		},
		"homepage": "https://github.com/alibaba/f2e-spec",
		"author": {
		@@ -16,2 +24,8 @@ "name": "Sabo",
		},
		"contributors": [
		{
		"name": "Xat_MassacrE",
		"email": "xxat.massacre@gmail.com"
		}
		],
		"license": "MIT",
		@@ -18,0 +32,0 @@ "dependencies": {

README.md

		# commitlint-config-ali

		## Installation
		本包提供了《阿里巴巴前端规约 - Git 规约》配套的 [commitlint 可共享配置](https://commitlint.js.org/#/concepts-shareable-config)，用于对 git commit message 进行校验。

		除了本包，你需要同时安装 `@commitlint/cli`：
		## 安装

		除了本包，你需要同时安装 [@commitlint/cli](https://www.npmjs.com/package/@commitlint/cli)：

		```bash
		@@ -11,10 +13,34 @@ npm install commitlint-config-ali @commitlint/cli --save-dev

		## Usage
		## 使用

		在你的 `commitlint.config.js` 中继承本包:

		```javascript
		module.exports = {
		extends: ['ali'],
		};
		```

		## 设置 git hook

		可通过 [husky](https://www.npmjs.com/package/husky) 设置在 git commit 时触发 commitlint。

		首先安装 husky：

		```bash
		npm install husky --save-dev
		```

		然后在 `package.json` 中增加：

		```json
		{
		"extends": "ali"
		"husky": {
		"hooks": {
		"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
		}
		}
		}
		```

		更多信息可参考 [commitlint 文档](https://commitlint.js.org/#/guides-local-setup?id=install-husky)。

Fixed alerts