# changelog-filename-regex

> A regular expression that matches a CHANGELOG filename

Latest version **2.0.1** (published 2018-07-30) · ISC license · 0 weekly downloads

## Install

```sh
npm install changelog-filename-regex
pnpm add changelog-filename-regex
yarn add changelog-filename-regex
bun add changelog-filename-regex
```

## Health

**Score 28/100 (F)** — status: abandoned.

Positive: has types package; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2018-07-30 |
| First published | 2015-11-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | separate (@types/changelog-filename-regex) |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Shinnosuke Watanabe |
| Maintainers | shinnn |
| Keywords | regex, regexp, file, filename, name, log, changelog, change-log, updates, releases, release-history, history, releasenote, match, browser, client-side |

## Links

- npm: https://www.npmjs.com/package/changelog-filename-regex
- Repository: https://github.com/shinnn/changelog-filename-regex
- Homepage: https://github.com/shinnn/changelog-filename-regex#readme
- Issues: https://github.com/shinnn/changelog-filename-regex/issues
- npm.io page: https://npm.io/package/changelog-filename-regex

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 2.0.1 (latest) — 2018-07-30
- 2.0.0 — 2018-05-21
- 2.0.0-0 — 2018-05-18
- 1.1.2 — 2018-05-18
- 1.1.1 — 2017-04-25
- 1.1.0 — 2016-02-24
- 1.0.0 — 2015-11-18
- 0.0.0 — 2015-11-18

## README

# changelog-filename-regex

[![npm version](https://img.shields.io/npm/v/changelog-filename-regex.svg)](https://www.npmjs.com/package/changelog-filename-regex)
[![Build Status](https://travis-ci.org/shinnn/changelog-filename-regex.svg?branch=master)](https://travis-ci.org/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 there is no need to use this regular expression directly. Developers 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/getting-started/what-is-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 Shinnosuke Watanabe

---
_Source: https://npm.io/package/changelog-filename-regex · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._