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 criteria and do not match any of the criteria.
createFilter(options, criteria)
options - An object with some or all of the following properties:
map - A function that maps filtered items to file paths
sep - A custom path separator, such as \ or /
criteria - The filter criteria. See the filePathFilter 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.
Filtering objects
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 filefunction map(file) { return path.join(file.dir, file.filename);}// Filter the file objects - return all HTML files except the blog postsfiles.
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
License
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.
Big Thanks To
Thanks to these awesome companies for their support of Open Source developers ❤