https://github.com/shinnn/changelog-filename-regex

A regular expression that matches a CHANGELOG filename
https://github.com/shinnn/changelog-filename-regex

changelog javascript regexp regular-expression release-notes

Last synced: 27 days ago
JSON representation

A regular expression that matches a CHANGELOG filename

• Host: GitHub
• URL: https://github.com/shinnn/changelog-filename-regex
• Owner: shinnn
• License: isc
• Created: 2015-11-18T10:23:32.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2019-04-15T20:40:41.000Z (over 5 years ago)
• Last Synced: 2024-09-24T15:39:37.130Z (about 2 months ago)
• Topics: changelog, javascript, regexp, regular-expression, release-notes
• Language: JavaScript
• Homepage: https://npm.runkit.com/changelog-filename-regex
• Size: 104 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# changelog-filename-regex

[![npm version](https://img.shields.io/npm/v/changelog-filename-regex.svg)](https://www.npmjs.com/package/changelog-filename-regex)

[![Github Actions](https://action-badges.now.sh/shinnn/changelog-filename-regex)](https://wdp9fww0r9.execute-api.us-west-2.amazonaws.com/production/results/shinnn/changelog-filename-regex)

A [regular expression](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp) that matches a CHANGELOG filename

```javascript

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

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

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

```

*In most cases users don't need to install this module directly, but would rather use [is-changelog-path](https://github.com/shinnn/is-changelog-path).*

## Installation

[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm/).

```

npm install changelog-filename-regex

```

## API

```javascript

import changelogFilenameRegex from 'changelog-filename-regex';

```

### changelogFilenameRegex

Type: [`RegExp`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp)

```javascript

// Returns `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');

// Returns `false`

changelogFilenameRegex.test('LICENSE');

changelogFilenameRegex.test('change.log');

changelogFilenameRegex.test('CHANGE\nLOG');

changelogFilenameRegex.test('  changelog  ');

changelogFilenameRegex.test('\u0000ChangeLog');

changelogFilenameRegex.test('CHANGELOG.');

```

## License

[ISC License](./LICENSE) © 2018 - 2019 Shinnosuke Watanabe