Git Product home page Git Product logo

fstream-ignore's Introduction

fstream-ignore

A fstream DirReader that filters out files that match globs in .ignore files throughout the tree, like how git ignores files based on a .gitignore file.

Here's an example:

var Ignore = require("fstream-ignore")
Ignore({ path: __dirname
       , ignoreFiles: [".ignore", ".gitignore"]
       })
  .on("child", function (c) {
    console.error(c.path.substr(c.root.path.length + 1))
  })
  .pipe(tar.Pack())
  .pipe(fs.createWriteStream("foo.tar"))

This will tar up the files in __dirname into foo.tar, ignoring anything matched by the globs in any .iginore or .gitignore file.

fstream-ignore's People

Contributors

fatfisz avatar isaacs avatar othiym23 avatar sonicdoe avatar zkat 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  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 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  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

fstream-ignore's Issues

Please indicate the license somehow

This module doesn't identify it's license so we're forced to consider it nonfree. :-(

Please add a license file, or at least indicate the license in package.json.

Thanks!

Minimatch version

I'm getting this error: Please update to minimatch 3.0.2 or higher to avoid a RegExp DoS issue

Could you please update this version?

Thanks.
Diego

Accept custom ignore rules in Ignore options

This is currently possible, but the solution only works because ._stat() will be called in the next tick:

  var Ignore = require('fstream-ignore');

  var ignore = Ignore({
    dir: '/path/to/read/files/from',
    ignoreFiles: ['.gitignore']
  });

  ignore.addIgnoreRules(['ignore-this', 'and-this'], 'custom-rules');

  ignore.on('child', function (c) {
    console.dir(c.path);
  });

Would prefer to pass this into the Ignore constructor. Seems more appropriate with how streams work:

  var Ignore = require('fstream-ignore');

  Ignore({
    dir: '/path/to/read/files/from',
    ignoreFiles: ['.gitignore'],
    ignoreRules: ['ignore-this', 'and-this']
  }).on('child', function (c) {
    console.dir(c.path);
  });

Not a huge deal since there is a work-around, but would be nice to have :)

Missing license

Please add a license file to clarify what license this is distributed under.

I'd like to use node/npm for a project at work, but npm depends on this package and I'm not allowed to use software that doesn't have a clear license.

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.