Skip to content

Commit c397656

Browse files
committed
docs: point to config-conventional by default
1 parent 7b6bb86 commit c397656

9 files changed

+23
-22
lines changed

Diff for: README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@
1717

1818
```sh
1919
# Install commitlint cli and angular config
20-
npm install --save-dev @commitlint/{config-angular,cli}
20+
npm install --save-dev @commitlint/{config-conventional,cli}
2121

2222
# Configure commitlint to use angular config
23-
echo "module.exports = {extends: ['@commitlint/config-angular']}" > commitlint.config.js
23+
echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
2424
```
2525

2626
* [Local setup](http://marionebl.github.io/commitlint/#/guides-local-setup) - Lint messages on commit with husky
@@ -37,13 +37,14 @@ echo "module.exports = {extends: ['@commitlint/config-angular']}" > commitlint.c
3737
* Configuration is picked up from `commitlint.config.js`, `.commitlintrc.js`, `.commitlintrc.json`, or `.commitlintrc.yml` file or a `commitlint` field in `package.json`
3838
* Packages: [cli](./@commitlint/cli), [core](./@commitlint/core)
3939
* See [Rules](./docs/reference-rules.md) for a complete list of possible rules
40-
* An example configuration can be found at [@commitlint/config-angular](./@commitlint/config-angular/index.js)
40+
* An example configuration can be found at [@commitlint/config-conventional](./@commitlint/config-conventional/index.js)
4141

4242
## Shared configuration
4343

4444
A number of shared configurations are available to install and use with `commitlint`:
4545

4646
* [@commitlint/config-angular](./@commitlint/config-angular)
47+
* [@commitlint/config-conventional](./@commitlint/config-conventional)
4748
* [@commitlint/config-lerna-scopes](./@commitlint/config-lerna-scopes)
4849
* [@commitlint/config-patternplate](./@commitlint/config-patternplate)
4950
* [conventional-changelog-lint-config-atom](https://github.com/erikmueller/conventional-changelog-lint-config-atom)

Diff for: docs/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@
3131
## Install
3232

3333
```bash
34-
npm install -g @commitlint/cli @commitlint/config-angular
34+
npm install -g @commitlint/cli @commitlint/config-conventional
3535
```
3636

3737
## Configure
3838

3939
```bash
40-
echo "module.exports = {extends: ['@commitlint/config-angular']}" > commitlint.config.js
40+
echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
4141
```
4242

4343
## Test

Diff for: docs/concepts-shareable-config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Scoped npm packages are not prefixed.
2727
```js
2828
// commitlint.config.js
2929
module.exports = {
30-
extends: ['@commitlint/config-angular'] // => commitlint/config-angular
30+
extends: ['@commitlint/config-conventional'] // => commitlint/config-conventional
3131
};
3232
```
3333

Diff for: docs/guides-ci-setup.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ git init
1414
npm init
1515

1616
# Install and configure if needed
17-
npm install --save-dev @commitlint/{config-angular,cli}
18-
echo "module.exports = {extends: ['@commitlint/config-angular']};" > commitlint.config.js
17+
npm install --save-dev @commitlint/{config-conventional,cli}
18+
echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js
1919
```
2020

2121
Alternatively the configuration can be defined in `.commitlintrc.js`, `.commitlintrc.json`, or `.commitlintrc.yml` file or a `commitlint` field in `package.json`.

Diff for: docs/guides-local-setup.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ configure `commitlint` to use it.
1414
npm init
1515

1616
# Install and configure if needed
17-
npm install --save-dev @commitlint/{cli,config-angular}
18-
echo "module.exports = {extends: ['@commitlint/config-angular']};" > commitlint.config.js
17+
npm install --save-dev @commitlint/{cli,config-conventional}
18+
echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js
1919
```
2020

2121
Alternatively the configuration can be defined in `.commitlintrc.js`, `.commitlintrc.json`, or `.commitlintrc.yml` file or a `commitlint` field in `package.json`.

Diff for: docs/guides-upgrade.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ The most common `validate-commit-msg` use cases can be recreated with minor chan
1212

1313
```sh
1414
npm remove validate-commit-msg --save-dev
15-
npm install --save-dev @commitlint/cli @commitint/config-angular
15+
npm install --save-dev @commitlint/cli @commitint/config-conventional
1616
```
1717

1818
**Add a commitmsg run-script to package.json**
1919

2020
```
2121
{
2222
"scripts": {
23-
"commitmsg": "commitlint -x @commitlint/config-angular -e $GIT_PARAMS"
23+
"commitmsg": "commitlint -x @commitlint/config-conventional -e $GIT_PARAMS"
2424
}
2525
}
2626
```
@@ -39,7 +39,7 @@ If you used `validate-commit-msg` with custom configuration you might want to cu
3939

4040
```sh
4141
npm remove validate-commit-msg --save-dev
42-
npm install --save-dev @commitlint/cli @commitint/config-angular
42+
npm install --save-dev @commitlint/cli @commitint/config-conventional
4343
```
4444

4545
**Add a commitmsg run-script to package.json**
@@ -62,7 +62,7 @@ npm install --save-dev husky
6262

6363
```js
6464
module.exports = {
65-
extends: ['@commitlint/config-angular'],
65+
extends: ['@commitlint/config-conventional'],
6666
rules: {
6767
// Place your rules here
6868
'scope-enum': [2, 'always', ['a', 'b']] // error if scope is given but not in provided list

Diff for: docs/guides-use-prompt.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ npm init
1313

1414
# Install and configure if needed
1515
npm install --save-dev @commitlint/{cli,angular,prompt-cli}
16-
echo "module.exports = {extends: ['@commitlint/config-angular']};" > commitlint.config.js
16+
echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js
1717
```
1818

1919
## Provide a shortcut

Diff for: docs/reference-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ lint('foo-bar', {'type-enum': [2, 'always', ['foo']]}, opts).then(report => cons
318318
const {lint, load} = require('@commitlint/core');
319319

320320
const CONFIG = {
321-
extends: ['./@commitlint/config-angular']
321+
extends: ['./@commitlint/config-conventional']
322322
};
323323

324324
load(CONFIG)

Diff for: docs/reference-configuration.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,17 @@ type Config = {
2626

2727
const Configuration: Config = {
2828
/*
29-
* Resolve and load @commitlint/config-angular from node_modules.
29+
* Resolve and load @commitlint/config-conventional from node_modules.
3030
* Referenced packages must be installed
3131
*/
32-
extends: ['@commitlint/config-angular'],
32+
extends: ['@commitlint/config-conventional'],
3333
/*
3434
* Resolve and load conventional-changelog-atom from node_modules.
3535
* Referenced packages must be installed
3636
*/
3737
parserPreset: 'conventional-changelog-atom',
3838
/*
39-
* Any rules defined here will override rules from @commitlint/config-angular
39+
* Any rules defined here will override rules from @commitlint/config-conventional
4040
*/
4141
rules: {
4242
'type-enum': [2, 'always', ['foo']]
@@ -57,15 +57,15 @@ This means installed npm packages and local files can be used.
5757
* npm
5858

5959
```
60-
npm install --save-dev commitlint-config-lerna @commitlint/config-angular
60+
npm install --save-dev commitlint-config-lerna @commitlint/config-conventional
6161
```
6262

6363
```js
6464
// commitlint.config.js
6565
module.exports = {
6666
extends: [
6767
'lerna' // prefixed with commitlint-config-*,
68-
'@commitlint/config-angular' // scoped packages are not prefixed
68+
'@commitlint/config-conventional' // scoped packages are not prefixed
6969
]
7070
}
7171
```
@@ -92,7 +92,7 @@ module.exports = {
9292
```js
9393
// commitlint.base.js, will be picked up by commitlint.config.js
9494
module.exports = {
95-
extends: ['@commitlint/config-angular'], // extends can be nested
95+
extends: ['@commitlint/config-conventional'], // extends can be nested
9696
parserPreset: 'conventional-changelog-atom'
9797
}
9898
```

0 commit comments

Comments
 (0)