Skip to content

Latest commit

History

History

README.md

Read commit messages from a specified range or last edit

@commitlint/read

Getting started

npm install --save @commitlint/read

Example

constread=require('@commitlint/read').default;// Read last edited commit messageread({edit: true}).then((messages)=>console.log(messages));// => ['I did something\n\n']// Read from the third to second commit message from HEADread({from: 'HEAD~2',to: 'HEAD~1'}).then((messages)=>console.log(messages));// => ['Initial commit\n\n']

Consult docs/api for comprehensive documentation.