Package Exports

detect-repo-changelog

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (detect-repo-changelog) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

detect-repo-changelog

Scans a repository directory, searching for a changelog file.

Uses changelog-filename-regex to match against a variety of changelog filenames.

Installation

$ npm install detect-repo-changelog

Usage

detectRepoChangelog(dir) -> Promise

const detectRepoChangelog = require('detect-repo-changelog');

detectRepoChangelog('./some-repository-directory')
.then((changelogFile) => {
    if (changelogFile) {
        console.log(`changelog file is ${changelogFile}`);
    } else {
        console.log('no changelog detected');
    }
});

Tests

$ npm test
$ npm test-cov to get coverage report

License

Released under the MIT License.