Filters file paths using globs, regular expressions, or custom criteria
const filePathFilter = require("@jsdevtools/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",
));
You can install File Path Filter via npm.
npm install @jsdevtools/file-path-filter
-
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 anexclude
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
andexclude
properties. Each of these properties can be any of the above types. File paths will be matched if they match any of theinclude
criteria and do not match any of theexclude
criteria.
- A boolean.
-
return value
- A filter function that matches file paths that meet the specified criteria
-
options
- An object with some or all of the following properties:map
- A function that maps filtered items to file pathssep
- A custom path separator, such as\
or/
-
criteria
- The filter criteria. See thefilePathFilter
for details. -
return value
- A filter function that matches file paths that meet the specified criteria
The createFilter
function is an alternative to the filePathFilter
function that allows you to customize the behavior to suit your needs.
The filePathFilter
function creates a function that filters arrays of strings, but what if you need to filter an array of objects instead? That's where the map
option comes in handy. You can use it to map objects (or any other value) to file paths. Here's an example:
const { createFilter } = require("@jsdevtools/file-path-filter");
const path = require("path");
const files = [
{ dir: "/my/website", filename: "index.html" },
{ dir: "/my/website", filename: "contact.html" },
{ dir: "/my/website/blog", filename: "post-1.html" },
{ dir: "/my/website/blog", filename: "post-2.html" },
];
// A function to returns the path of each file
function map(file) {
return path.join(file.dir, file.filename);
}
// Filter the file objects - return all HTML files except the blog posts
files.filter(createFilter({ map }, "**/*.html", "!**/blog/*.html"));
Contributions, enhancements, and bug-fixes are welcome! Open an issue on GitHub and submit a pull request.
To build the project locally on your computer:
-
Clone this repo
git clone https://github.com/JS-DevTools/file-path-filter.git
-
Install dependencies
npm install
-
Build the code
npm run build
-
Run the tests
npm test
File Path Filter is 100% free and open-source, under the MIT license. Use it however you want.
This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
Thanks to these awesome companies for their support of Open Source developers ❤