Have ideas to improve npm?Join in the discussion! »

commit-closes

1.0.1 • Public • Published

commit-closes

Parses commit message to find all "fixes", "closes" and "resolves" issue numbers

NPM

Build status semantic-release js-standard-style

Commit parsing code based on conventional-changelog

You can close GitHub issues with commit text. For example

git commit -m "this feature closes #4"

will close issue 4 when pushed to github. This module can find issues closed given commit subject and body. All forms are supported: fix|fixes|fixed|close|closes|closed|resolve|resolves|resolved case-insensitive.

Install

Requires Node version 6 or above.

npm install --save commit-closes

Use

Give this function commit subject and optional body and it will return list of closed issue numbers. If no issues is closed, returns empty list

const commitCloses = require('commit-closes')
const closed = commitCloses('this is subject', `
this commit closes #2
and resolves #21, #4
and fixed #10
`)
// closed is [2, 21, 4, 10]

Small print

Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2017

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2017 Gleb Bahmutov <gleb.bahmutov@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Install

npm i commit-closes

DownloadsWeekly Downloads

18

Version

1.0.1

License

MIT

Last publish

Collaborators

  • avatar