# filter-changelog-paths

> Extract CHANGELOG-like paths from multiple file paths

Latest version **1.0.0** (published 2015-11-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install filter-changelog-paths
pnpm add filter-changelog-paths
yarn add filter-changelog-paths
bun add filter-changelog-paths
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-11-30 |
| First published | 2015-11-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Shinnosuke Watanabe |
| Maintainers | shinnn |
| Keywords | arr, ary, array, filter, filtering, extract, extraction, filename, filenames, name, path, paths, log, changelog, change-log, updates, releases, release-history, history, releasenote, match |

## Links

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

## Dependencies (2)

- [is-changelog-path](https://npm.io/package/is-changelog-path.md) ^1.1.0
- [filtered-array-to-sentence](https://npm.io/package/filtered-array-to-sentence.md) ^1.0.0

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads
- [tg-resolve](https://npm.io/package/tg-resolve.md) — 176 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2015-11-30
- 0.0.0 — 2015-11-30

## README

# filter-changelog-paths

[![NPM version](https://img.shields.io/npm/v/filter-changelog-paths.svg)](https://www.npmjs.com/package/filter-changelog-paths)
[![Build Status](https://travis-ci.org/shinnn/filter-changelog-paths.svg?branch=master)](https://travis-ci.org/shinnn/filter-changelog-paths)
[![Build status](https://ci.appveyor.com/api/projects/status/7yw5cmfmry41iu9m/branch/master?svg=true)](https://ci.appveyor.com/project/ShinnosukeWatanabe/filter-changelog-paths/branch/master)
[![Coverage Status](https://img.shields.io/coveralls/shinnn/filter-changelog-paths.svg)](https://coveralls.io/github/shinnn/filter-changelog-paths)
[![Dependency Status](https://david-dm.org/shinnn/filter-changelog-paths.svg)](https://david-dm.org/shinnn/filter-changelog-paths)
[![devDependency Status](https://david-dm.org/shinnn/filter-changelog-paths/dev-status.svg)](https://david-dm.org/shinnn/filter-changelog-paths#info=devDependencies)

A [Node](https://nodejs.org/) module to extract CHANGELOG-like paths from multiple file paths

```javascript
const filterChangelogPaths = require('filter-changelog-paths');

filterChangelogPaths([
  'CHANGELOG.txt',
  'CONTRIBUTING',
  'project/docs/release_notes.md',
  'lib/index.js'
]);
//=> ['CHANGELOG.txt', 'project/docs/release_notes.md']
```

## Installation

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

```
npm install filter-changelog-paths
```

## API

```javascript
const filterChangelogPaths = require('filter-changelog-paths');
```

### filterChangelogPaths(*filePaths*)

*filePaths*: `Array` of strings (file [path](http://www.linfo.org/path.html)s)  
Return: `Array` of strings

It [filters](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/filter) a given array by using [is-changelog-path](https://github.com/shinnn/is-changelog-path) as a filter function.

```javascript
const filterChangelogPaths = require('filter-changelog-paths');

filterChangelogPaths([]); //=> []

filterChangelogPaths('changelog'); // throws a type error
filterChangelogPaths(['changelog', 1, 'history', true]); // throws a type error
filterChangelogPaths(); // throws a type error
```

### filterChangelogPaths.posix(*filePaths*)

*filePaths*: `Array` of strings (file paths)  
Return: `Array` of strings

Always interact in a [posix](https://www.opengroup.org/austin/papers/posix_faq.html) compatible way.

```javascript
filterChangelogPaths.posix(['dir\\releases']); //=> []
```

### filterChangelogPaths.win32(*filePaths*)

*filePaths*: `Array` of strings (file paths)  
Return: `Array` of strings

Always interact in a [win32](https://msdn.microsoft.com/library/cc433218) compatible way.

```javascript
filterChangelogPaths.win32(['dir\\releases']); //=> ['dir\\releases']
```

## License

Copyright (c) 2015 [Shinnosuke Watanabe](https://github.com/shinnn)

Licensed under [the MIT License](./LICENSE).

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