# vue-cli-plugin-commitlint-release

> 这是一个集成了 commitizen、commitlint、standard-version、conventional-changelog 、conventional-changelog-cli 基础配置的 Vue CLI 插件。

Latest version **1.1.4** (published 2019-12-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install vue-cli-plugin-commitlint-release
pnpm add vue-cli-plugin-commitlint-release
yarn add vue-cli-plugin-commitlint-release
bun add vue-cli-plugin-commitlint-release
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.4 |
| Published | 2019-12-25 |
| First published | 2019-12-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | jojo |
| Maintainers | wangjiaojiao |
| Keywords | commitizen, commitlint, standard-version, conversin-changelog |

## Links

- npm: https://www.npmjs.com/package/vue-cli-plugin-commitlint-release
- Repository: https://github.com/wangjiaojiao77/vue-cli-plugin-commitlint-release
- Homepage: https://github.com/wangjiaojiao77/vue-cli-plugin-commitlint-release#readme
- Issues: https://github.com/wangjiaojiao77/vue-cli-plugin-commitlint-release/issues
- npm.io page: https://npm.io/package/vue-cli-plugin-commitlint-release

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 1.1.4 (latest) — 2019-12-25
- 1.1.3 — 2019-12-25
- 1.1.2 — 2019-12-25
- 1.1.1 — 2019-12-24
- 1.1.0 — 2019-12-24
- 1.0.16 — 2019-12-23
- 1.0.15 — 2019-12-20
- 1.0.14 — 2019-12-20
- 1.0.13 — 2019-12-20
- 1.0.12 — 2019-12-20
- 1.0.11 — 2019-12-20
- 1.0.10 — 2019-12-20
- 1.0.9 — 2019-12-20
- 1.0.8 — 2019-12-20
- 1.0.7 — 2019-12-20
- … 7 more at https://npm.io/package/vue-cli-plugin-commitlint-release/versions

## README

# Vue CLI Plugin Commitlint Release

这是一个集成了 [commitizen](https://www.npmjs.com/package/commitizen)、[commitlint](https://github.com/conventional-changelog/commitlint)、[standard-version](https://www.npmjs.com/package/standard-version)、[conventional-changelog](https://www.npmjs.com/package/conventional-changelog) 、[conventional-changelog-cli](https://www.npmjs.com/package/conventional-changelog-cli) 基础配置的 Vue CLI 插件。

![NPM version](https://img.shields.io/npm/v/vue-cli-plugin-commitlint-release)
![Downloads](https://img.shields.io/npm/dw/vue-cli-plugin-commitlint-release)
![License](https://img.shields.io/npm/l/vue-cli-plugin-commitlint-release)

_它可以解决以下几个问题：_

1. 自动化提示 `commit message`
2. 自动化校验 `commit message` 是否符合规范
3. 自动更新 `package.json` 里的版本号
4. 自动生成 `changelog`，更好的维护版本迭代

commitizen 使用的适配器是 [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines)

## 安装

_作为一个 `Vue CLI` 插件，安装方法有2种：_

```
# 为了防止和已有的包冲突，可以提前移除 `node_modules` 后再安装
rm -rf node_modules

vue add commitlint-release
# or
vue invoke commitlint-release
```

这时候你的项目里就会增加一个    `commitlint.config.js` 文件、`release.sh` 文件，以及 package.json 里增加一些 `scripts`、`devDependencies`，以及一个 `config` 和 `husky` 的配置。


下面只需要直接运行

```
npm install
```

即可将所需依赖安装上。


## 使用

### 修改代码后，按照以下步骤执行即可。

add 
   
```
git add .
```

### 自动化 `commit message`
```
npm run commit
# or
# 如果你的 NPM 5.2+，也可以执行以下命令
npx git-cz
```

### 自动更新版本号并生成 `changelog`

```
npm run push
```

输入命令后，提示输入 [ major | minor | patch ]，以当前版本 1.0.0 为例：

- major：主版本号，当你做了不兼容的 API 修改。这时候的 version 应该为 2.0.0。
- minor：次版本号，当你做了向下兼容的功能性新增。这时候的 version 应该为 1.1.0。
- patch：修订号，当你做了向下兼容的问题修正。这时候的 version 应该为 1.0.1。

具体参考：[semver 语义化版本控制规范](https://semver.org/lang/zh-CN/)

## 常见问题

### command not found: vue

解决办法：全局安装 vue cli

```
npm install -g @vue/cli
# or
yarn global add @vue/cli
```

### File exists
```
npm ERR! path /Users/jojo/node_modules/babel-eslint/node_modules/@babel/traverse/node_modules/.bin/babylon

npm ERR! code EEXIST

npm ERR! Refusing to delete /Users/jojo/wanba/front-activity/node_modules/babel-eslint/node_modules/@babel/traverse/node_modules/.bin/babylon: containing path /Users/jojo/node_modules/babel-eslint/node_modules/@babel/traverse/node_modules/babylon isn't under npm's control

npm ERR! File exists: /Users/jojo/wanba/front-activity/node_modules/babel-eslint/node_modules/@babel/traverse/node_modules/.bin/babylon

npm ERR! Move it away, and try again.
```
解决办法：
删除 node_modules 重新安装
```
rm -rf node_modules
npm install
```

### permission denied
```
EACCES: permission denied
```
权限问题，命令行前加 sudo 或查看 [fixing npm permissions ](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally) 寻求帮助

## Tips

我会尽我最大努力来维护这个项目，所以有问题一定要给我提 [issues](https://github.com/wangjiaojiao77/vue-cli-plugin-commitlint-release/issues) 哟～

## License

ISC

---
_Source: https://npm.io/package/vue-cli-plugin-commitlint-release · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._