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

buildmate

v1.0.0

Published

Given a list of file paths, invokes all build tasks that match any of the path patterns.

Downloads

11

Readme

Build Status Coverage Status

Build Mate

Build Mate. Given a list of file paths, invokes all build tasks that match any of the paths.

Prerequisite

  • Node.js v6+

Usage

# Make your CI service to install Build Mate
$ npm install -g buildmate

# Pipe git diff output to Build Mate
$ git diff --name-only COMMIT1...COMMIT2 | buildmate
  • buildmate.config.js
module.exports = {
  tasks: [
    // Failure of the notification doesn't abort the whole build
    {
      description: 'Notify build start',
      command: './notify-build-start.sh',
      continueOnFailure: true
    },

    // Regex path pattern.
    // Capturing parts of path with `()` and reference them in the command with BM_PATH_VAR_X env variables
    {
      path: /^(modules\/[^/]+)\//,        
      command: 'cd $BM_PATH_VAR_1 && npm run build'
    },

    // Glob path pattern
    {
      path: 'lib/**',
      command: './build.sh lib'
    }
  ]
}

If COMMIT1...COMMIT2 includes changes in the following files:

modules/module-A/src/index.js
modules/module-B/test/lib/bootstrap.js

Build Mate invokes following 3 commands in the order

./notify-build-start.sh
# Failure of this task command doesn't abort the build

cd modules/module-A && npm run build
# $BM_PATH_VAR_1 is expanded to modules/module-A

cd modules/module-B && npm run build
# $BM_PATH_VAR_1 is expanded to modules/module-B

Task properties

path

Optional. Path pattern to decide if task should be executed (and capture path vars). path can be an regular expression or glob. Omitting path will always execute the task.

description

Optional. Task description printed out at the beginning of task execution.

command

Required. Command to execute. Path variables captured in path matching phase can be referenced as environment variables like BM_PATH_VAR_N where N is a sequential number starts from 1.

continueOnFailure

Optional. Specify true if you want to continue the build on the task failure.