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

transform-runner

v0.1.5

Published

Accepts a set of files, applies transformations to them and returns JSON output which can be converted into a package.

Downloads

26

Readme

transform-runner

Accepts a set of files, applies transformations to them and returns JSON output which can be converted into a package.

Usage

var runner = require('transform-runner');

var runner = runTasks({
  // new API
  tasks: function(filename, done) {
    return false; // return true if you queue'd tasks
  },

  log: Minilog('runner'),
  include: [ '/home/foo/index.js' ],
  exclude: [
    // /^.+(?!\.js).{3}$/i,
    '/home/foo/node_modules',
  ],
  jobs: require('os').cpus().length * 2,
  log: {
    info: function() {},
    log: console.log.bind(console),
    error: console.error.bind(console)
  }
}, function(err, files) {
  if (onDone) {
    onDone(err, files, runner);
  }
});
runner.on('parse-error', function(err) {
  console.log('error', err);
});
runner.on('file', function(filename) {
  console.log('file', filename);
});
runner.on('hit', function(filename) {
  console.log('hit', filename);
});
runner.on('miss', function(filename) {
  console.log('miss', filename);
});
runner.on('file-done', function(filename, item) {
  console.log('file-done', filename, item);
});

API

runner(files, opts = {})

opts:

  • exclude: a function which takes a single parameter (the full file path) and returns true if the file should be excluded
  • ignore: a function which takes a single parameter (the full file path) and returns true if the file should be ignored
  • tasks(file, done): a function; the done function should be called with err and the full path to the result of the task execution when done
  • cache: an object with the following methods:
    • get(file): takes a single parameter (the full file path) and returns either an object containing the cached metadata, or false if there is no cached value
    • set(file, key, value)
  • log: an object that looks like the console API, with the following methods:
    • .info(): log a debug message (works both in the browser and in Node, unlike .debug)
    • .log(): log a informational message
    • .error(): log a error message

Include, exclude etc.

Unlike most build systems, transform-runner does not use node-glob because it is slow on moderately-sized trees.

All path specifications are resolved as follows:

  • paths beginning with . or / are resolved against the file system. Relative paths are resolved based on the base path.
  • --include-regexp, --exclude-regexp and --ignore-regexp values are parsed as regular expressions using new RegExp. They should be quoted if passed in through the command line to avoid the shell from expanding special characters.
  • There are three kinds of specifications:
    • includes are resolved first to produce a set of initial files
    • excludes are applied against any matching files, matched files are excluded
    • actions are resolved against the result from the includes after applying exclusions.