Skip to content

Latest commit

 

History

History
141 lines (95 loc) · 3.16 KB

README.md

File metadata and controls

141 lines (95 loc) · 3.16 KB
Raw

⬆️ CSS Colorguard Upgraded

Every CSS project starts out with good intentions, but inevitably, one too many people eye-dropper colors into nooks and crannies that you never knew existed. CSS Colorguard Upgraded helps you maintain the color set that you want, and warns you when colors you've added are too similar to ones that already exist. Naturally, it's all configurable to your tastes.

How it works

Colorguard uses the CIEDE2000 algorithm to determine the similarity of each of the colors in your CSS file. This algorithm is quite complex, but is used in the broadcasting community as the best approximation of human ability to discern differences in color. RGB on the other hand, is pretty bad at representing differences in color purely based on the numerical difference of the hex values.

Why CSS Colorguard Upgraded?

  • Bundled and minified
  • PostCSS 8 support
  • ESM and CJS support
  • TypeScript support
  • Node >= 14

API

CJS

const { processor } = require('colorguard-processor');
processor.process(css, [options]).then((result) => {});

ESM

import { processor } from 'colorguard-processor';
processor.process(css, [options]).then((result) => {});

options

ignore

Type: array

Specify colors that you would like to ignore completely. Use with caution.

[['black', '#010101', 'rgba(0,0,0,1)']];

whitelist

Type: array

Pass an array of color pairs to ignore:

[['#000000', 'rgba(0,0,0,1)']];

threshold

Type: number Default: 3

0 through 100. Lower values are more precise; the default is 3 but that's mostly personal opinion.

allowEquivalentNotation

Type: boolean Default: false

By default, colorguard will complain if identical colors are represented with different notations. For example, #000, #000000, rgba(0, 0, 0, 0), and black. If you want to permit these equivalent notations, set this option to true.

PostCSS Plugin

CJS

const colorguard = require('postcss-colorguard');
postcss([colorguard(opts)]);

ESM

import colorguard from 'postcss-colorguard';
postcss([colorguard(opts)]);

CSS Colorguard Upgraded can be consumed as a PostCSS plugin. See the documentation for examples for your environment.

Build Time

CSS Colorguard Upgraded can be used in conjunction with other javascript build systems, such as:

CLI

CSS Colorguard Upgraded also ships with a CLI app. To see the available options, just run:

 colorguard --help

Install

To get the command do:

npx colorguard-cli
yarn dlx colorguard-cli

To get the library do:

npm install colorguard-processor
yarn add colorguard-processor

To get the PostCSS plugin do:

npm install postcss-colorguard postcss
yarn add postcss-colorguard postcss

Thanks