npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@jsdevtools/file-path-filter

v3.0.2

Published

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

Downloads

48,174

Readme

File Path Filter

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

Cross-Platform Compatibility Build Status

Coverage Status Dependencies

npm License Buy us a tree

Example

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",
));

Installation

You can install File Path Filter via npm.

npm install @jsdevtools/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

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 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"));

Contributing

Contributions, enhancements, and bug-fixes are welcome! Open 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.

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 ❤

Travis CI SauceLabs Coveralls