Package Exports

changelog-filename-regex

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 (changelog-filename-regex) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

changelog-filename-regex

A regular expression that matches a CHANGELOG filename

const changelogFilenameRegex = require('changelog-filename-regex');

changelogFilenameRegex.test('CHANGELOG.md'); //=> true
changelogFilenameRegex.test('README.txt'); //=> false

Installation

Package managers

npm

npm install changelog-filename-regex

Bower

bower install changelog-filename-regex

Standalone

Download the script file directly.

API

changelogFilenameRegex

Type: RegExp

const changelogFilenameRegex = require('changelog-filename-regex');

// Return `true`
changelogFilenameRegex.test('CHANGELOG');
changelogFilenameRegex.test('CHANGELOG.txt');
changelogFilenameRegex.test('CHANGELOG.md');
changelogFilenameRegex.test('ChangeLog');
changelogFilenameRegex.test('Release Note');
changelogFilenameRegex.test('UPDATES');
changelogFilenameRegex.test('History.rdoc');

// Return `false`
changelogFilenameRegex.test('LICENSE');
changelogFilenameRegex.test('change.log');
changelogFilenameRegex.test('CHANGE\nLOG');
changelogFilenameRegex.test('ChangeLog');
changelogFilenameRegex.test('  changelog  ');
changelogFilenameRegex.test('CHANGELOG.');

License

Licensed under the MIT License.