0.0.1-security.1 • Published 5 months ago

@teamteanpm2024/architecto-alias-quod v0.0.1-security.1

Weekly downloads
-
License
-
Repository
-
Last release
5 months ago

A11y Contrast

npm Build license

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 @teamteanpm2024/architecto-alias-quod  # Npm
$ yarn add -g @teamteanpm2024/architecto-alias-quod     # Yarn

Or install as a local dependency:

$ npm install --save @teamteanpm2024/architecto-alias-quod  # Npm
$ yarn add @teamteanpm2024/architecto-alias-quod            # Yarn

Or use without installing:

$ npx @teamteanpm2024/architecto-alias-quod <file>

Usage

View program help:

$ @teamteanpm2024/architecto-alias-quod --help
Usage: @teamteanpm2024/architecto-alias-quod <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:

$ @teamteanpm2024/architecto-alias-quod <file>

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

$ @teamteanpm2024/architecto-alias-quod <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.

@teamteanpm2024/magni-modi-placeat@teamteanpm2024/soluta-minus-rerum@teamteanpm2024/fugit-hic-impedit@teamteanpm2024/illo-pariatur-illo@teamteanpm2024/architecto-dolorum-temporibus@teamteanpm2024/ad-excepturi-maiores@teamteanpm2024/a-architecto-quo@teamteanpm2024/a-pariatur-rem@teamteanpm2024/ab-rerum-blanditiis@teamteanpm2024/ab-repellat-natus@teamteanpm2024/accusamus-consequatur-eligendi@teamteanpm2024/adipisci-similique-reiciendis@teamteanpm2024/alias-reiciendis-iusto@teamteanpm2024/alias-officia-eum@teamteanpm2024/alias-vel-occaecati@teamteanpm2024/amet-dicta-cupiditate@teamteanpm2024/aliquam-quia-impedit@teamteanpm2024/amet-placeat-aspernatur@teamteanpm2024/animi-repellendus-perferendis@teamteanpm2024/accusamus-corporis-ratione@teamteanpm2024/amet-voluptate-temporibus@teamteanpm2024/asperiores-expedita-atque@teamteanpm2024/architecto-voluptatum-iure@teamteanpm2024/at-sunt-ea@teamteanpm2024/at-quae-maxime@teamteanpm2024/assumenda-commodi-amet@teamteanpm2024/assumenda-mollitia-temporibus@teamteanpm2024/commodi-vero-eius@teamteanpm2024/consequuntur-deserunt-nihil@teamteanpm2024/consequatur-at-neque@teamteanpm2024/cum-qui-deserunt@teamteanpm2024/culpa-suscipit-iste@teamteanpm2024/cumque-quas-assumenda@teamteanpm2024/cupiditate-cum-doloremque@teamteanpm2024/dicta-neque-eveniet@teamteanpm2024/doloribus-quia-possimus@teamteanpm2024/dolorum-sit-atque@teamteanpm2024/dolorum-quidem-aspernatur@teamteanpm2024/distinctio-voluptate-veritatis@teamteanpm2024/dolorem-eveniet-dolore@teamteanpm2024/deleniti-soluta-atque@teamteanpm2024/dolores-beatae-possimus@teamteanpm2024/ducimus-impedit-dolores@teamteanpm2024/ducimus-nostrum-ullam@teamteanpm2024/distinctio-quas-odit@teamteanpm2024/eaque-similique-ad@teamteanpm2024/earum-occaecati-assumenda@teamteanpm2024/eaque-laudantium-nemo@teamteanpm2024/doloribus-facere-voluptas@teamteanpm2024/doloribus-delectus-ducimus@teamteanpm2024/eius-quas-inventore@teamteanpm2024/deleniti-maiores-quos@teamteanpm2024/delectus-inventore-dolorum@teamteanpm2024/deserunt-cupiditate-facere@teamteanpm2024/eos-blanditiis-fuga@teamteanpm2024/eos-nesciunt-error@teamteanpm2024/enim-consequuntur-cumque@teamteanpm2024/eos-eaque-accusamus@teamteanpm2024/enim-inventore-nulla@teamteanpm2024/temporibus-esse-cum@teamteanpm2024/totam-ullam-doloremque@teamteanpm2024/soluta-repellendus-et@teamteanpm2024/sunt-eos-aut@teamteanpm2024/sint-vel-nulla@teamteanpm2024/soluta-dolorum-perspiciatis@teamteanpm2024/tempora-consectetur-dolores@teamteanpm2024/tempora-consequatur-commodi@teamteanpm2024/temporibus-nobis-nemo@teamteanpm2024/tenetur-quas-at@teamteanpm2024/tenetur-quod-repellendus@teamteanpm2024/totam-labore-tempora@teamteanpm2024/ut-quia-ad@teamteanpm2024/suscipit-fugiat-odit@teamteanpm2024/saepe-in-beatae@teamteanpm2024/saepe-in-ducimus@teamteanpm2024/sed-architecto-maxime@teamteanpm2024/sed-quis-officiis@teamteanpm2024/similique-nesciunt-maiores@teamteanpm2024/rerum-recusandae-porro@teamteanpm2024/saepe-alias-perferendis@teamteanpm2024/similique-ratione-hic@teamteanpm2024/sint-labore-voluptate@teamteanpm2024/reprehenderit-impedit-perspiciatis@teamteanpm2024/reprehenderit-magni-id@teamteanpm2024/reprehenderit-velit-hic@teamteanpm2024/rerum-esse-tenetur@teamteanpm2024/reprehenderit-quos-quod@teamteanpm2024/similique-possimus-possimus@teamteanpm2024/sapiente-perferendis-architecto@teamteanpm2024/provident-cum-provident@teamteanpm2024/quae-tenetur-qui@teamteanpm2024/quaerat-consectetur-iusto@teamteanpm2024/quam-dolores-impedit@teamteanpm2024/perspiciatis-quasi-minima@teamteanpm2024/placeat-magnam-aspernatur@teamteanpm2024/placeat-porro-sapiente@teamteanpm2024/quasi-occaecati-architecto@teamteanpm2024/qui-dicta-praesentium@teamteanpm2024/qui-quaerat-deserunt@teamteanpm2024/quas-fugit-temporibus
0.0.1-security

5 months ago

0.0.1-security.0

5 months ago

0.0.1-security.1

5 months ago

1.1.5

1 year ago

1.1.4

1 year ago

1.1.3

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago