Skip to content

Commit 192a40b

Browse files
committed
docs: use new commitlint.config.js name in all examples
- raised in #47 - motivates #48
1 parent 3acf0e1 commit 192a40b

File tree

15 files changed

+35
-34
lines changed

15 files changed

+35
-34
lines changed

@commitlint/cli/readme.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88

99
## Getting started
1010

11-
```shell
11+
```
1212
npm install --save-dev @commitlint/cli @commitlint/config-angular
13-
echo "module.exports = {extends: ['@commitlint/config-angular']};" > .commitlint.config.js
13+
echo "module.exports = {extends: ['@commitlint/config-angular']};" > commitlint.config.js
1414
```
1515

1616
Consult [docs/cli](http://marionebl.github.io/commitlint/#/reference-cli) for comprehensive documentation.

@commitlint/config-angular/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Use with [@commitlint/cli](../cli) and [@commitlint/prompt-cli](../prompt-cli).
99

1010
```sh
1111
npm install --save-dev @commitlint/config-angular @commitlint/cli
12-
echo "module.exports = {extends: ['@commitlint/config-angular']};" > .commitlint.config.js
12+
echo "module.exports = {extends: ['@commitlint/config-angular']};" > commitlint.config.js
1313
```
1414

1515
## Rules

@commitlint/config-lerna-scopes/readme.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,18 @@ Shareable `commitlint` config enforcing lerna package names as scopes.
55
Use with [@commitlint/cli](../cli) and [@commitlint/prompt-cli](../prompt-cli).
66

77
## Getting started
8-
```sh
8+
9+
```
910
npm install --save-dev @commitlint/config-lerna-scopes @commitlint/cli
10-
echo "module.exports = {extends: ['@commitlint/config-lerna-scopes']};" > .commitlint.config.js
11+
echo "module.exports = {extends: ['@commitlint/config-lerna-scopes']};" > commitlint.config.js
1112
```
1213

1314
## Examples
1415

1516
```
16-
❯ cat .commitlintrc
17+
❯ cat commitlint.config.js
1718
{
18-
"extends": ["lerna-scopes"]
19+
extends: ['@commitlint/config-lerna-scopes']
1920
}
2021
2122
❯ tree packages

@commitlint/config-patternplate/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Use with [@commitlint/cli](../cli) and [@commitlint/prompt-cli](../prompt-cli).
77
## Getting started
88
```sh
99
npm install --save-dev @commitlint/config-patternplate @commitlint/cli
10-
echo "module.exports = {extends: ['@commitlint/config-patternplate']};" > .commitlint.config.js
10+
echo "module.exports = {extends: ['@commitlint/config-patternplate']};" > commitlint.config.js
1111
```
1212

1313
## Rules

@commitlint/prompt-cli/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@commitlint/prompt-cli",
33
"version": "3.0.3",
4-
"description": "commit prompt using .commitlintrc",
4+
"description": "commit prompt using commitlint.config.js",
55
"bin": {
66
"commit": "./cli.js"
77
},

@commitlint/prompt-cli/readme.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
> commit prompt using .commitlintrc
1+
> commit prompt using commitlint.config.js
22
33
# @commitlint/prompt-cli
44

55
## Getting started
66

77
```bash
88
npm install --g @commitlint/prompt-cli @commitlint/config-angular
9-
echo "module.exports = {extends: ['@commitlint/config-angular']};" > .commitlint.config.js
9+
echo "module.exports = {extends: ['@commitlint/config-angular']};" > commitlint.config.js
1010
```
1111

1212
```bash

@commitlint/prompt/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@commitlint/prompt",
33
"version": "3.0.3",
4-
"description": "commitizen prompt using .commitlintrc",
4+
"description": "commitizen prompt using commitlint.config.js",
55
"main": "./lib/index.js",
66
"scripts": {
77
"build": "cross-env NODE_ENV=production babel src --out-dir lib",

@commitlint/prompt/readme.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
> commitizen adapter using .commitlintrc
1+
> commitizen adapter using commitlint.config.js
22
33
# @commitlint/prompt
44

@@ -10,7 +10,7 @@ Learn how to use it at [docs/prompt](http://marionebl.github.io/commitlint/#/gui
1010

1111
```bash
1212
npm install --save @commitlint/prompt @commitlint/config-angular commitizen
13-
echo "module.exports = {extends: ['@commitlint/config-angular']};" > .commitlint.config.js
13+
echo "module.exports = {extends: ['@commitlint/config-angular']};" > commitlint.config.js
1414
```
1515

1616
In package.json

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@
1010

1111

1212
* 🚓 Enforce commit conventions
13-
* 🤖 Plays nice with `conventional-changelog`
13+
* 🤖 Plays nicely with `conventional-changelog`
1414
* 📦 Supports shareable configuration
1515

1616
## Getting started
1717

18-
```
18+
```sh
1919
npm install --save-dev @commitlint/{angular,cli}
20-
echo '{"extends": ["@commitlint/config-angular"]}' > .commitlintrc
20+
echo "module.exports = {extends: ['@commitlint/config-angular']}" > commitlint.config.js
2121
```
2222

2323
## CLI
@@ -28,7 +28,7 @@ echo '{"extends": ["@commitlint/config-angular"]}' > .commitlintrc
2828

2929
## Config
3030

31-
* Configuration is picked up from `.commitlint` files
31+
* Configuration is picked up from `commitlint.config.js` files
3232
* Packages: [cli](./@commitlint/cli), [core](./@commitlint/core)
3333
* See [Rules](./docs/rules) for a complete list of possible rules
3434
* An example configurations can be found at [@commitlint/config-angular](./@commitlint/config-angular/index.js)

docs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ npm install -g @commitlint/cli @commitlint/config-angular
3737
## Configure
3838

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

4343
## Test

docs/concepts-shareable-config.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Concept: Shareable configuration
22

3-
Most commonly shareable configuration is delivered as npm package exporting
3+
Most commonly shareable configuration is delivered as npm package exporting
44
an object containing `.rules` as default. To use shared configuration you specify it as item in the `.extends` array:
55

66
```js
@@ -25,7 +25,7 @@ This works recursively, enabling shareable configuration to extend on an indefin
2525
Scoped npm packages are not prefixed.
2626

2727
```js
28-
// .commitlint.config.js
28+
// commitlint.config.js
2929
module.exports = {
3030
extends: ['@commitlint/config-angular'] // => @commitlint/config-angular
3131
};
@@ -34,7 +34,7 @@ module.exports = {
3434
The same is true for relative imports
3535

3636
```js
37-
// .commitlint
37+
// commitlint.config.js
3838
module.expors = {
3939
extends: ['./example'] // => ./example.js
4040
}

docs/guides-ci-setup.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Guide: CI Setup
1+
# Guide: CI Setup
22

33
Enforce commit conventions with confidence by linting on your CI servers with `commitlint`.
44

@@ -15,7 +15,7 @@ npm init
1515

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

2121
## First test run with Travis
@@ -31,7 +31,7 @@ script:
3131
- npm test
3232
```
3333
34-
Make sure Travis is connected to your git repository.
34+
Make sure Travis is connected to your git repository.
3535
Trigger a build by pushing to your repository.
3636
3737
```bash
@@ -53,7 +53,7 @@ We expect this build to fail:
5353
## Linting relevant commits
5454

5555
What we did so far works but is not very useful as it simply lints the last commit in history.
56-
Let's change that by using environment information provided by TravisCI.
56+
Let's change that by using environment information provided by TravisCI.
5757

5858
Every build exposes the commit that triggered the build via `TRAVIS_COMMIT`.
5959

@@ -78,11 +78,11 @@ script:
7878
- npm test
7979
```
8080

81-
Nice. This handles direct commits and PR originating from the same repository. Let's add forks to the mix.
81+
Nice. This handles direct commits and PR originating from the same repository. Let's add forks to the mix.
8282

8383
## The full scripts
8484

85-
We'll have to differentiate between forks and same-repo PRs on our own and move the linting to a dedicated script.
85+
We'll have to differentiate between forks and same-repo PRs on our own and move the linting to a dedicated script.
8686

8787
```yaml
8888
# .travis.yml

docs/guides-local-setup.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Guide: Local setup
22

3-
Get high commit message quality and short feedback cycles by linting commit messages right when they are authored.
3+
Get high commit message quality and short feedback cycles by linting commit messages right when they are authored.
44

55
This guide demonstrates how to achieve this via git hooks.
66

77
## Install commitlint
88

9-
Install `commitlint` and a `commitlint-config-*` of your choice as devDependency and
9+
Install `commitlint` and a `commitlint-config-*` of your choice as devDependency and
1010
configure `commitlint` to use it.
1111

1212
```bash
@@ -15,7 +15,7 @@ npm init
1515

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

2121
## Install husky
@@ -26,7 +26,7 @@ Install `husky` as devDependency, a handy git hook helper available on npm.
2626
npm install --save-dev husky
2727
```
2828

29-
This allows us to add [git hooks](https://github.com/typicode/husky/blob/master/HOOKS.md#hooks) directly into our `package.json` scripts.
29+
This allows us to add [git hooks](https://github.com/typicode/husky/blob/master/HOOKS.md#hooks) directly into our `package.json` scripts.
3030

3131
```json
3232
{

docs/guides-upgrade.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ npm install --save-dev conventional-changelog-lint@latest
2525
```bash
2626
npm remove --save-dev conventional-changelog-lint
2727
npm install --save commitlint
28-
mv .conventional-changelog-lintrc .commitlintrc
28+
mv .conventional-changelog-lintrc commitlint.config.js
2929
```
3030

3131
* Rename all calls to `conventional-changelog-lint` to `commitlint`

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']};"
16+
echo "module.exports = {extends: ['@commitlint/config-angular']};" > commitlint.config.js
1717
```
1818

1919
## Provide a shortcut

0 commit comments

Comments
 (0)