@commitlint/read

Read commit messages from a specified range or last edit

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
8,785109Aug 2, 2021Feb 12, 2016Minified + gzip package size for @commitlint/read in KB

Readme

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.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.