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.
|
2 years ago | |
---|---|---|
.. | ||
lib | 2 years ago | |
README.md | 2 years ago | |
license.md | 2 years ago | |
package.json | 2 years ago |
README.md
Read commit messages from a specified range or last edit
@commitlint/read
Getting started
npm install --save @commitlint/read
Example
const read = require('@commitlint/read').default;
// Read last edited commit message
read({edit: true}).then((messages) => console.log(messages));
// => ['I did something\n\n']
// Read from the third to second commit message from HEAD
read({from: 'HEAD~2', to: 'HEAD~1'}).then((messages) => console.log(messages));
// => ['Initial commit\n\n']
Consult docs/api for comprehensive documentation.