Skip to content
Filters file paths using globs, regular expressions, or custom criteria
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
src
test
.editorconfig
.gitattributes
.gitignore
.mocharc.yml
.nycrc.yml
.travis.yml
404.md
LICENSE
README.md
_config.yml
package-lock.json
package.json
tsconfig.json
tslint.yaml

README.md

File Path Filter

Filters file paths using globs, regular expressions, or custom criteria

Cross-Platform Compatibility Build Status

Coverage Status Dependencies

npm License

Example

const filePathFilter = require("file-path-filter");
const paths = [
  "/some/path/index.html",
  "/some/path/contact.html",
  "/some/path/about.html",
  "/some/path/favicon.ico",
  "/some/path/img/logo.png",
];

// Filter using a glob pattern
paths.filter(filePathFilter("**/*.html"));

// Exclude glob patterns with "!"
paths.filter(filePathFilter("**/*.html", "!**/index.html"));

// Filter using a regular expression
paths.filter(filePathFilter(/\.(ico|png)$/));

// Filter using custom criteria
paths.filter(filePathFilter(path => path.length === 23));

// Use any combination of filters
paths.filter(filePathFilter([
  "**/*.html",
  "!**/index.html",
  /\.(ico|png)$/,
  path => path.length === 23
]));

// Explicitly specify include and exclude criteria
paths.filter(filePathFilter({
  include:  [
    "**/*.html",
    /\.(ico|png)$/,
    path => path.length === 23
  ],
  exclude: "**/index.html",
));

Installation

You can install file-path-filter via npm.

npm install file-path-filter

Usage

filePathFilter(criteria)

  • criteria - The filter criteria. This can be any of the following:

    • A boolean. true will match all files. false will not match any files.
    • A glob pattern. If the pattern starts with !, then it will be treated as an exclude pattern (see below)
    • A regular expression
    • A filter function that accepts a file path and returns true if the file should be matched
    • An array containing any combination of the above types
    • An object with include and exclude properties. Each of these properties can be any of the above types. File paths will be matched if they match any of the include criteria and do not match any of the exclude criteria.
  • return value - A filter function that matches file paths that meet the specified criteria

Contributing

Contributions, enhancements, and bug-fixes are welcome! File an issue on GitHub and submit a pull request.

Building

To build the project locally on your computer:

  1. Clone this repo
    git clone https://github.com/JS-DevTools/file-path-filter.git

  2. Install dependencies
    npm install

  3. Build the code
    npm run build

  4. Run the tests
    npm test

License

File Path Filter is 100% free and open-source, under the MIT license. Use it however you want.

Big Thanks To

Thanks to these awesome companies for their support of Open Source developers ❤

Travis CI SauceLabs Coveralls

You can’t perform that action at this time.