Skip to content

Commit 4b8c02f

Browse files
committed
docs: import config type from types #2232
1 parent 1ad3de1 commit 4b8c02f

File tree

1 file changed

+2
-31
lines changed

1 file changed

+2
-31
lines changed

docs/reference-configuration.md

+2-31
Original file line numberDiff line numberDiff line change
@@ -56,38 +56,9 @@ module.exports = Configuration;
5656
### TypeScript
5757

5858
```ts
59-
type Config = {
60-
/*
61-
* Resolveable ids to commitlint configurations to extend
62-
*/
63-
extends?: string[];
64-
/*
65-
* Resolveable id to conventional-changelog parser preset to import and use
66-
*/
67-
parserPreset?: string;
68-
/*
69-
* Resolveable id to package, from node_modules, which formats the output.
70-
*/
71-
formatter: string;
72-
/*
73-
* Rules to check against
74-
*/
75-
rules?: {[name: string]: Rule};
76-
/*
77-
* Functions that return true if commitlint should ignore the given message.
78-
*/
79-
ignores?: ((message: string) => boolean)[];
80-
/*
81-
* Whether commitlint uses the default ignore rules.
82-
*/
83-
defaultIgnores?: boolean;
84-
/*
85-
* Custom URL to show upon failure
86-
*/
87-
helpUrl?: string;
88-
};
59+
import type {UserConfig} from '@commitlint/types';
8960

90-
const Configuration: Config = {
61+
const Configuration: UserConfig = {
9162
/*
9263
* Resolve and load @commitlint/config-conventional from node_modules.
9364
* Referenced packages must be installed

0 commit comments

Comments
 (0)