@landmineaknpm/vel-cum-odio NPM

A11y Contrast

npm

A CLI utility to calculate/verify accessible magic numbers for a color palette. Read my blog post for some more information.

npm.io

Installation

This tool requires Node.js version 18+.

Install globally:

$ npm install -g @landmineaknpm/vel-cum-odio  # Npm
$ yarn add -g @landmineaknpm/vel-cum-odio     # Yarn

Or install as a local dependency:

$ npm install --save @landmineaknpm/vel-cum-odio  # Npm
$ yarn add @landmineaknpm/vel-cum-odio            # Yarn

Or use without installing:

$ npx @landmineaknpm/vel-cum-odio <file>

Usage

View program help:

$ @landmineaknpm/vel-cum-odio --help
Usage: @landmineaknpm/vel-cum-odio <file> [options]

Arguments:
  <file>  Color palette file                              [required] [file]

Options:
  --min-ratio-3    Verify magic number for ratio 3                 [number]
  --min-ratio-4.5  Verify magic number for ratio 4.5               [number]
  --min-ratio-7    Verify magic number for ratio 7                 [number]
  -h, --help       Show help                     [commands: help] [boolean]
  -v, --version    Show version number        [commands: version] [boolean]

Run a full report for a color palette file:

$ @landmineaknpm/vel-cum-odio <file>

Verify that the color palette fulfills certain magic numbers per contrast ratio:

$ @landmineaknpm/vel-cum-odio <file> --min-ratio-3=40 --min-ratio-4.5=50 --min-ratio-7=70

Color palette format

This tool handles flat or nested JSON files. Any consistent grading system is supported.

Flat JSON:

{
  "blue-10": "#d9e8f6",
  "blue-20": "#aacdec",
  "blue-30": "#73b3e7",
  "green-10": "#dfeacd",
  "green-20": "#b8d293",
  "green-30": "#9bb672"
}

Nested JSON:

{
  "blue": {
    "blue-100": "#d9e8f6",
    "blue-200": "#aacdec",
    "blue-300": "#73b3e7"
  },
  "green": {
    "green-100": "#dfeacd",
    "green-200": "#b8d293",
    "green-300": "#9bb672"
  }
}

Check out some example color palettes under /examples.

License

This project and its contents are open source under the MIT license.

fastclone stream spec jshint Array.prototype.filter trimLeft progress react-hooks electron restful style ReactiveExtensions packages toSorted tslib plugin hasOwn length push cjk serializer forms debug sqs loading deep-clone eventDispatcher telephone mapreduce xterm writable delete look collection.es6 commander language deepclone task package manager typed concurrency password es2018 jsdiff Array equality chrome serialize offset libphonenumber json sameValueZero browser vpc Object.defineProperty korean Set require Function.prototype.name testing validation isConcatSpreadable circular tty bootstrap css merge names hardlinks settings banner fast-copy queue byteOffset pipe stringify robust format flags router callback functional dynamodb is east-asian-width vars datastructure es2016 rfc4122 ECMAScript 5 mkdirs identifiers stdlib Array.prototype.flatten optimist Object.values visual iterator es2017 variables in css deepcopy extension Object.keys eslintplugin ES5 sorted bootstrap less ES7 predictable iterate getOwnPropertyDescriptor defineProperty Stream text iam proto parsing readablestream sigint ansi awesomesauce inspect properties equal typed array javascript dataView Map live ECMAScript 2015 ecmascript prefix metadata hasOwnProperty styled-components reducer glacier code points ECMAScript 2017 immutable sinatra events bundling map ES2018 es7 zero cloudtrail gradients css styles scheme css less optimizer web rangeerror es indicator es-shim API has flux typanion ECMAScript 2020 wait cors quote weakset private es5 WeakMap valid Uint8Array group find mkdir persistent form-validation ES2019 ES3 ECMAScript 2018 watching a11y positive sham last utility invariant Promise Uint32Array ie look-up jsonpath react touch encryption modules importexport linux error-handling values emr uninstall sns lru String.prototype.matchAll shrinkwrap globals workspace:*app slot AsyncIterator dir Float32Array safe helpers fixed-width multi-package JSON ECMAScript 2023 cloudformation keys typeof ES2022 duplex mobile eslint TypedArray generics cli core-js functions s3 status bcrypt call-bind Symbol waf jwt in some nested css postcss pnpm9 jsdom diff parents Reflect.getPrototypeOf -0 call eslintconfig idle extend ts xhr random deep cloudfront runtime chinese redact arrays es6 spinner env has-own shared elm i18n accessibility lesscss performant lockfile URLSearchParams less mixins autoscaling mime-db cache ES2021 colors signals regular expression stringifier parent airbnb hot file js buffers terminal starter directory asserts glob parse http jQuery types less.js ECMAScript 2019 npm hookform efficient WeakSet link class-validator coercible dom ECMAScript 6 URL spinners yaml regular toArray sigterm accessor patch jasmine getintrinsic chai io-ts gradients css3 ESnext pyyaml rapid .env bound fsevents RFC-6455 native classes hash Microsoft stable bdd inference array date watchFile bind StyleSheet take getter BigUint64Array core internal slot phone hooks tc39 dotenv key immer rds rm jest deep-copy ender command-line yup fastify fs busy descriptors term ES8 ec2 ES2020 RxJS flatten concatMap query qs fast await preserve-symlinks flat form width environments String.prototype.trim RegExp#flags state type ast formatting compiler mime operating-system tools zod storagegateway Object.is walking reuse ECMAScript 3 fullwidth throat string command ReactiveX throttle monorepo framework Array.prototype.findLastIndex irq description channel @@toStringTag reduce exit-code css-in-js sharedarraybuffer regexp css nesting typedarrays define Object.getPrototypeOf collection unicode recursive setImmediate url findup watch streams2 promise set contains codes [[Prototype]]dependency manager joi computed-types object shell ECMAScript 2022 CSSStyleDeclaration console toStringTag fastcopy clone Symbol.toStringTag auth estree ponyfill workflow iteration stylesheet global wordbreak bundler lint get chromium ECMAScript 2016 client https copy ECMAScript 2021 tester ES2016 japanese argv ArrayBuffer.prototype.slice superstruct shim assert up typesafe Uint16Array listeners tdd Streams logger symlinks expression toolkit request dataview

@ptkhanh94npm/aperiam-quaerat-labore callingmyname2

1.0.0

1 year ago