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

@ndigitals/grunt-checkrepo

v0.2.5

Published

Check the state of repository.

Downloads

22

Readme

grunt-checkrepo

NPM version Build Status NPM Downloads MIT License

Check the state of repository.

This is an updated fork of the original Grunt module.

Task will cancel grunt tasks queue when repository state doesn't comply with your requirements. You can look at it as a simple repository linting.

This is a Grunt 1.0 plugin. If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins.

Installation

Use npm to install and save the plugin into devDependencies.

npm install @ndigitals/grunt-checkrepo --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks("grunt-checkrepo");

Configuration

In your project's Gruntfile, add a section named checkrepo to the data object passed into grunt.initConfig(). This is a multitask task and accepts multiple targets.

grunt.initConfig({
  checkrepo: {
    foo: {
      // Foo target options
    },
    bar: {
      // Bar target options
    },
  },
});

There are no default options. Each target property is a check that will be run, and its value is a required state.

Available checks

tag

Type: Object

Will run semver functions & comparisons against passed version and highest repo tag. Each object property name is a semver method, and property value is one argument being passed to it.

Example:

grunt.initConfig({
  pkg: grunt.file.readJSON("package.json"),
  checkrepo: {
    foo: {
      tag: {
        valid: "<%= pkg.version %>", // Check if pkg.version is valid semantic version
        lt: "<%= pkg.version %>", // Check if highest repo tag is lower than pkg.version
      },
    },
  },
});

Available methods:

valid, gt, gte, lt, lte, eq, neq

tagged

Type: Boolean

Checks whether the last commit (HEAD) is or is not already tagged.

Example:

checkrepo: {
  foo: {
    tagged: true, // Require last commit (HEAD) to be tagged
  },
  bar: {
    tagged: false, // Require last commit (head) to not be tagged
  }
}

clean

Type: Boolean

Check whether the repository is clean - has no unstaged changes.

Example:

checkrepo: {
  foo: {
    clean: true, // Require repo to be clean (no unstaged changes)
  },
  bar: {
    clean: false, // Require repo to be dirty (have unstaged changes)
  }
}

Usage Example

Task with all available options:

grunt.initConfig({
  pkg: grunt.file.readJSON("package.json"),
  checkrepo: {
    foo: {
      tag: {
        valid: "<%= pkg.version %>", // Check if pkg.version is valid semantic version
        gt: "<%= pkg.version %>", // Check if highest repo tag is greater than pkg.version
        gte: "<%= pkg.version %>", // Check if highest repo tag is greater or equal to pkg.version
        lt: "<%= pkg.version %>", // Check if highest repo tag is lower than pkg.version
        lte: "<%= pkg.version %>", // Check if highest repo tag is lower or equal than pkg.version
        eq: "<%= pkg.version %>", // Check if highest repo tag is equal to pkg.version
        neq: "<%= pkg.version %>", // Check if highest repo tag is not equal to pkg.version
      },
      tagged: false, // Check if last repo commit (HEAD) is not tagged
      clean: true, // Check if the repo working directory is clean
    },
  },
});