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

gromit-cli

v1.5.0

Published

A test framework to assert that CSS statistics don't exceed provided thresholds.

Downloads

21

Readme

Gromit

NPM Version Build Status Known Vulnerabilities XO code style Dependencies Status Dependencies Status

A test framework to assert that CSS doesn't exceed provided thresholds.

  • Provide a config file with thresholds to check
  • Pass in the CSS
  • Gromit will let you know whether your CSS passes the test

Usage

Gromit needs CSS input and a config file.

# Default usage (assuming a .gromitrc file in the current directory)
$ gromit style.css

# Read from StdIn (assuming a .gromitrc file in the current directory)
$ cat style.css | gromit

# Custom config
$ gromit style.css --config my-config.json

The result will look like something like this:

TAP version 13
# Subtest: selectors.id.total
    ok 1 - selectors.id.total should not be larger than 0 (actual: 0)
    1..1
ok 1 - selectors.id.total # time=6.024ms

1..1
# time=15.076ms

 ✔ "Well done, lad! Very well done..."

Note that this example uses only 1 test (total ID selectors).

Config file

Gromit will try to fetch a .gromitrc file in your current directory. You can also specify a different JSON config file with the --config option (see usage). The config JSON should look similar to this:

{
	// Do not exceed 4095, otherwise IE9 will drop any subsequent rules
	"selectors.total": 4095,
	"selectors.id.total": 0,
	"values.colors.totalUnique": 2,
	"values.colors.unique": ["#fff", "#000"]
}

All the possible options for the config file can be found at @projectwallace/css-analyzer.

Custom reporter

By default, Gromit will report in the TAP format, but you can pipe the output into something you may find prettier, like tap-nyan or any other TAP-reporter.

$ gromit style.css | tap-nyan

 1   -_,------,
 0   -_|   /\_/\
 0   -^|__( ^ .^)
     -  ""  ""
  Pass!

Usage in CI

If any test fails, Gromit will exit with a non-zero exit code. When you run Gromit in your CI builds, this may cause the build to fail. This is exactly what Gromit was designed to do.

Example usage with package.json:

{
	"name": "my-package",
	"version": "0.1.0",
	"scripts": {
		"test": "gromit compiled-styles.css"
	}
}

Related projects

  • CSS Analyzer - The analyzer that powers this module
  • Wallace - CLI tool for @projectwallace/css-analyzer
  • CSS Analyzer Diff - Calculates the diff between two sets of CSS analysis
  • Color Sorter - Sort CSS colors by hue, saturation, lightness and opacity

License

MIT © Bart Veneman