# pathspec.js

**Repository Path**: mirrors_andreyvit/pathspec.js

## Basic Information

- **Project Name**: pathspec.js
- **Description**: Shell- and .gitignore-style wildcards and file lists
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-01-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

pathspec.js
===========

A node.js library and a command-line tool (pathspec-find) for matching and introspection of shell/.gitignore-style masks.

Shell-style file name masks:

    var Mask = require('pathspec').Mask;
    console.log(Mask.parse('*.txt').matches('foo.txt')); // true
    console.log(Mask.parse('*.txt').matches('foo.js'));  // false

Shell-style path wildcards:

    var RelPathSpec = require('pathspec').RelPathSpec;
    console.log(RelPathSpec.parse('foo/**/bar/*.txt').matches('foo/moo/goo/bar/myfile.txt')); // true
    console.log(RelPathSpec.parse('foo.txt').matches('bar/foo.txt')); // false

.gitignore-style path wildcards:

    var RelPathSpec = require('pathspec').RelPathSpec;
    console.log(RelPathSpec.parseGitStyleSpec('foo/**/bar').matches('foo/moo/goo/bar/poo/koo/myfile.txt')); // true
    console.log(RelPathSpec.parseGitStyleSpec('foo.txt').matches('bar/foo.txt')); // true

.gitignore-style path lists:

    var RelPathList = require('pathspec').RelPathList;
    var list = RelPathList.parse(['*.js', '!bin/*.js']);
    console.log(list.matches('foo.js')); // true
    console.log(list.matches('lib/foo.js')); // true
    console.log(list.matches('bin/foo.js')); // false

Build a path list manually (spec style is up to you):

    var RelPathList = require('pathspec').RelPathList;
    var list = new RelPathList();
    list.include(RelPathSpec.parse('*.js'));
    list.exclude(RelPathSpec.parse('bar.js'));
    console.log(list.matches('foo.js')); // true
    console.log(list.matches('lib/foo.js')); // false
    console.log(list.matches('bar.js')); // false

Note: they are called RelSomething because the paths are relative to some specific unknown root. Beware that things like '.' and '..' are not treated in any special way.


Installation
------------

    npm install pathspec


Command-line tool
-----------------

Includes pathspec-find(1) which is similar to find(1):

    pathspec-find . '*.json'
    find . | pathspec-find - '*.json' '!excluded/folder'

The first argument is the folder to look in. Pass a single dash (`-`) to read the list of files from stdin, one path per line.

The remaining arguments are .gitignore-style masks. At least one is required.

Pass `--help` for usage, `-v` for verbose mode (currently just dumps the RelPathList before processing).


Running tests
-------------

    npm test
    REPORTER=dot npm test

Test coverage report:

    npm run-script cov


License
-------

MIT.