Package Exports
- filter-changelog-paths
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 (filter-changelog-paths) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
filter-changelog-paths
A Node module to extract CHANGELOG-like paths from multiple file paths
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
npm install filter-changelog-pathsAPI
const filterChangelogPaths = require('filter-changelog-paths');filterChangelogPaths(filePaths)
filePaths: Array of strings (file paths)
Return: Array of strings
It filters a given array by using is-changelog-path as a filter function.
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 errorfilterChangelogPaths.posix(filePaths)
filePaths: Array of strings (file paths)
Return: Array of strings
Always interact in a posix compatible way.
filterChangelogPaths.posix(['dir\\releases']); //=> []filterChangelogPaths.win32(filePaths)
filePaths: Array of strings (file paths)
Return: Array of strings
Always interact in a win32 compatible way.
filterChangelogPaths.win32(['dir\\releases']); //=> ['dir\\releases']License
Copyright (c) 2015 Shinnosuke Watanabe
Licensed under the MIT License.