Skip to content

Commit 1ab1ee8

Browse files
committed
docs: refine shareable-config docs
1 parent 78db7df commit 1ab1ee8

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

docs/shareable-config.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
# Shareable configuration
22

3+
Every array item found in `extends` is resolved to `commitlint-config-${name}`.
4+
5+
The default main export found there is merged into the configuration with increasing precedence.
6+
7+
This works recursively, enabling shareable configuration to extend on an indefinite chain of other shareable configurations.
8+
9+
310
```js
411
// .commitlint
512
{
613
"extends": ["example"] // => @commitlint-config-example
714
}
815
```
916

10-
Every array item found in `extends` is resolved to `commitlint-config-${name}`. The default main export found there is merged into the configuration with increasing precedence. This works recursively, enabling shareable configuration to extend on an indefinite chain of other shareable configurations.
11-
1217
Special cases are scoped extend items those are not prefixed.
1318

1419
```js
@@ -26,5 +31,3 @@ The same is true for relative imports
2631
"extends": ["./example"] // => ./example.js
2732
}
2833
```
29-
30-
See the [angular](../@commitlint/config-angular) shareable configuration as example. This configuration is the default used by `commitlint`.

0 commit comments

Comments
 (0)