You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
30 lines
589 B
30 lines
589 B
2 years ago
|
> Parse commit messages to structured data
|
||
|
|
|
||
|
|
# @commitlint/parse
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
```
|
||
|
|
npm install --save @commitlint/parse
|
||
|
|
```
|
||
|
|
|
||
|
|
## Use
|
||
|
|
|
||
|
|
```js
|
||
|
|
const parse = require('@commitlint/parse');
|
||
|
|
```
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
### parse(message: string, parser: Function, parserOpts: Object)
|
||
|
|
|
||
|
|
- **message**: Commit message to parser
|
||
|
|
- **parser**: Sync parser function to use. Defaults to `sync` of `conventional-commits-parser`
|
||
|
|
- **parserOpts**: Options to pass to `parser`
|
||
|
|
```
|
||
|
|
{
|
||
|
|
commentChar: null, // character indicating comment lines
|
||
|
|
issuePrefixes: ['#'] // prefix characters for issue references
|
||
|
|
}
|
||
|
|
```
|