#fs-walk-glob-rules

Walk files using glob rules and transform paths with patterns

This project is like glob, but it uses glob-rules instead of minimatch.

API

Async

walker.transform - asynchronous function with 3 callbacks. Single parameter is a hash of options. This function return nothing.

• root - start path of walking and relativity point for paths matching.
• rules - dictionary of paths transformations
• excludes - list of patterns for path to be exclude. If some forder matches that path, means that all nested files and folders will be excluded, even if they will not match this pattern.
• callback - being called on each matched filepath. First parameter is data object with source relative path and path transformed with pattern. Second parameter - function that should be called when current path is already processed and we can proceed to next one.
• error - being called in error situations (walking from inexistible folder). The only parameter is an error object.
• completted - being called then no more path to be returned and walking is finished. Has no parameters.

Example

walker.transform({
  root: "/",
  rules: {
    "./(a*/*.js)": "$1"
  },
  excludes: [
    "./aa/**"
  ],
  callback: function(data, next) {
    console.log(data.source, data.result);
    next();
  },
  error: function(error) {
    console.error(error);
  },
  complete: function() {
      // expect no more data
  }
});

Sync

walker.transformSync - synchronous function that returns list of data-objects, like ones transferred into callback above. Single parameter is a hash of options. Parameters root, rules and excludes have some meaning as above.

Example

var walked = walker.transformSync({
  root: "/",
  rules: {
    "./(a*/*.js)": "$1"
  },
  excludes: ["./aa/**"]
});

Compiling project

cake build

Testing

npm test

Copyright and license

Code and documentation copyright 2014 Eugene Chernyshov. Code released under the MIT license.