conventional-changelog-action/node_modules/@commitlint/read
Conventional Changelog Action 2eb3616352 chore(release): v3.9.1 2021-10-05 21:16:53 +00:00
..
CHANGELOG.md chore(release): v3.9.1 2021-10-05 21:16:53 +00:00
README.md chore(release): v3.9.1 2021-10-05 21:16:53 +00:00
license.md chore(release): v3.9.1 2021-10-05 21:16:53 +00:00
package.json chore(release): v3.9.1 2021-10-05 21:16:53 +00:00

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.