Git Product home page Git Product logo

matched's Introduction

matched Donate NPM version NPM monthly downloads NPM total downloads Build Status

Adds array support to node-glob, sync and async. Also supports tilde expansion (user home) and resolving to global npm modules.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm (requires Node.js >=10):

$ npm install --save matched

Usage

const glob = require('matched');
// async signature
glob(patterns[, options]);

// sync signature
glob.sync(patterns[, options]);
  • patterns (string|array) - one or more glob patterns
  • options - options to pass to node-glob;

Also note that if non-glob file paths are passed, only paths that exist on the file system will be returned.

promise

glob(['*.txt'])
  .then(files => console.log(files)) //=> ['a.txt', 'b.txt', 'c.txt']
  .catch(console.error)

// or with async-await
(async() => {
  const files = await glob('*.txt');
  console.log(files);
  //=> ['foo.txt', 'bar.txt']
})();

callback

glob(['*.js'], (err, files) => {
  console.log(files);
  //=> ['utils.js', 'index.js']
});

sync

const files = glob.sync(['*.js']);
//=> ['utils.js', 'index.js']

options

All methods take an options object to be forwarded to node-glob as the second argument.

const files = glob(['*.js'], { cwd: 'test' });
console.log(files);
//=> ['test.js']

v4.1

  • Adds support for options.onMatch() which is passed to node-glob as a listener for the match event.
  • Adds support for options.onFiles() to allow the user to get the files returned by each glob pattern.
  • Small optimizations in logic for handling non-glob patterns that are passed for matching literal file names.

v4.0

v3.0

  • Removes cache property from results array.
  • Optimizations

v0.4.1

  • Exposes a non-enumerable cache property on the returned files array. This is a patch release since the property does not change the existing API and should not otherwise effect behavior or results.

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test
Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

  • findup-sync: Find the first file matching a given pattern in the current directory or the nearest… more | homepage
  • is-glob: Returns true if the given string looks like a glob pattern or an extglob pattern… more | homepage
  • micromatch: Glob matching for javascript/node.js. A replacement and faster alternative to minimatch and multimatch. | homepage

Contributors

Commits Contributor
73 jonschlinkert
8 TrySound
1 sindresorhus

Author

Jon Schlinkert

License

Copyright © 2020, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.8.0, on January 15, 2020.

matched's People

Contributors

jonschlinkert avatar sindresorhus avatar trysound avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

doowb tunnckocore

matched's Issues

Whats new in v5?

Hi,

Changelog for v5 released on npm seems to be missing and I don't see any commits made to this repo.

Best regards!

Ordering of results

Hello! It seems as though the ordering of results is non-deterministic, right? This seems true to me, for two reasons:

It this the intended behavior? If so, would you mind mentioning something about it in the docs? Thanks for this lib!

module.exports = async

After installing I get the following error.

`..../node_modules/matched/lib/promise.js:8
module.exports = async(patterns, options) => {
^

SyntaxError: Unexpected token (
at createScript (vm.js:56:10)
at Object.runInThisContext (vm.js:97:10)
at Module._compile (module.js:542:28)
at Object.Module._extensions..js (module.js:579:10)
at Module.load (module.js:487:32)
at tryModuleLoad (module.js:446:12)
at Function.Module._load (module.js:438:3)
at Module.require (module.js:497:17)
at require (internal/module.js:20:19)
at Object. (..../node_modules/matched/lib/async.js:3:14)`

Can you help?

This package was installed automatically as a dependancy of another module.

Please tag your releases

Would you please tag the 0.4.3 release in this repo (and in general, consider tagging all of your releases across all of your repos at the time you release new versions on NPM)?

Thanks!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.