@commitlint/read
    TypeScript icon, indicating that this package has built-in type declarations

    13.1.0 • Public • Published

    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.

    Install

    npm i @commitlint/read

    DownloadsWeekly Downloads

    1,061,322

    Version

    13.1.0

    License

    MIT

    Unpacked Size

    18.4 kB

    Total Files

    24

    Last publish

    Collaborators

    • marionebl
    • martinhelmut
    • escapedcat
    • bycedric