color-map 2.2.0 → 2.3.0

package/llms.txt

@@ -0,0 +1,29 @@
+# color-map
+
+> The `color-map` command: convert, mix, contrast-check, scale and export CSS colors, and build a semantic palette whose text pairs all pass WCAG 2, from one brand color.
+
+This file is generated by `scripts/generate-llms-txt.mjs` from the command table. Do not edit it.
+
+Conventions that hold for every command:
+
+- Output is TOON on stdout by default; `--format json` gives JSON. Diagnostics go to stderr.
+- Colors are any CSS color string, including `color-mix()` and relative colors.
+- Contrast is WCAG 2. There is no other contrast algorithm.
+- `--full` adds every field. Empty results say so explicitly.
+- A failure exits 1 or 2 with `error`, `code` and `help` fields on stdout. Nothing prompts; unknown options fail.
+- Run it with `npx color-map <command>`, or install the `color-map` agent skill from this package.
+
+## Commands
+
+- [convert](https://unpkg.com/color-map/schemas/convert.schema.json): Convert a CSS color to another color space. Usage: `color-map convert <color>` with --to, --gamut, --full.
+- [mix](https://unpkg.com/color-map/schemas/mix.schema.json): Mix two CSS colors, as color-mix() does. Usage: `color-map mix <a> <b>` with --amount, --in, --hue, --full.
+- [contrast](https://unpkg.com/color-map/schemas/contrast.schema.json): WCAG 2 contrast ratio of a text color on a background, with the AA and AAA verdicts. Usage: `color-map contrast <fg> <bg>` with no options.
+- [find-contrast](https://unpkg.com/color-map/schemas/find-contrast.schema.json): Find the color closest in lightness to a background that reaches a WCAG 2 contrast target. Usage: `color-map find-contrast <bg>` with --target, --hue, --chroma, --direction, --full.
+- [scale](https://unpkg.com/color-map/schemas/scale.schema.json): Build a color scale from a seed color: a preset, a Radix-style brand scale, or contrast targets. Usage: `color-map scale <seed>` with --preset, --steps, --brand, --mode, --background, --targets, --gamut, --full.
+- [palette](https://unpkg.com/color-map/schemas/palette.schema.json): A semantic palette from one brand color: primary, status colors, surface and outline, each with a text color and its WCAG 2 ratio. Usage: `color-map palette <brand>` with --mode, --target, --gamut, --full.
+- [harmony](https://unpkg.com/color-map/schemas/harmony.schema.json): The colors of a harmony scheme: the color rotated around the hue wheel. Usage: `color-map harmony <color>` with --scheme, --space, --gamut.
+- [export](https://unpkg.com/color-map/schemas/export.schema.json): Write a palette, a scale or your own tokens as DTCG JSON, CSS variables or a Tailwind v4 theme. Usage: `color-map export [color]` with --to, --source, --mode, --tokens, --space, --prefix, --selector, --namespace, --inline, --precision, --hex.
+
+## Optional
+
+- [Source and README](https://github.com/cyberuni/color-map): the color-map library and CLI.

package/package.json

@@ -1,65 +1,277 @@
 {
-	"name": "color-map",
-	"version": "2.2.0",
-	"description": "Color map generator",
-	"homepage": "https://github.com/cyberuni/color-map",
-	"bugs": {
-		"url": "https://github.com/cyberuni/color-map/issues"
-	},
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/cyberuni/color-map.git"
-	},
-	"license": "MIT",
-	"author": {
-		"name": "Homa Wong (unional)",
-		"email": "homawong@gmail.com"
-	},
-	"type": "module",
-	"exports": {
-		"types": "./esm/index.d.ts",
-		"import": "./esm/index.js",
-		"require": "./cjs/index.js",
-		"default": "./cjs/index.js"
-	},
-	"main": "./cjs/index.js",
-	"types": "./esm/index.d.ts",
-	"files": [
-		"cjs",
-		"dist",
-		"esm",
-		"ts",
-		"!**/*.spec.*"
-	],
-	"scripts": {
-		"build": "tsdown",
-		"build:watch": "tsdown --watch",
-		"clean": "rimraf .reports cjs coverage dist esm",
-		"coverage": "jest --coverage",
-		"depcheck": "depcheck",
-		"nuke": "pnpm clean && rimraf node_modules",
-		"test": "jest",
-		"typecheck": "tsc",
-		"verify": "npm-run-all -p build depcheck typecheck coverage",
-		"watch": "jest --watch"
-	},
-	"devDependencies": {
-		"@repobuddy/jest": "^5.0.0",
-		"@types/jest": "^30.0.0",
-		"@types/node": "^26.2.0",
-		"assertron": "^11.0.0",
-		"depcheck": "^1.4.3",
-		"jest": "^30.4.2",
-		"jest-watch-suspend": "^1.1.2",
-		"jest-watch-toggle-config-2": "^2.1.0",
-		"jest-watch-typeahead": "^2.0.0",
-		"npm-run-all2": "^9.0.3",
-		"rimraf": "^6.1.3",
-		"ts-jest": "^29.0.0",
-		"tsdown": "^0.22.14",
-		"typescript": "^7.0.2"
-	},
-	"engines": {
-		"node": ">= 20"
-	}
-}
+  "name": "color-map",
+  "version": "2.3.0",
+  "description": "Color map generator and color toolkit: a library, a CLI and an agent skill",
+  "homepage": "https://github.com/cyberuni/color-map",
+  "bugs": {
+    "url": "https://github.com/cyberuni/color-map/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cyberuni/color-map.git"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Homa Wong (unional)",
+    "email": "homawong@gmail.com"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./esm/index.d.ts",
+      "import": "./esm/index.js",
+      "require": "./cjs/index.js",
+      "default": "./cjs/index.js"
+    },
+    "./color": {
+      "types": "./esm/color/index.d.ts",
+      "import": "./esm/color/index.js",
+      "require": "./cjs/color/index.js",
+      "default": "./cjs/color/index.js"
+    },
+    "./legacy": {
+      "types": "./esm/legacy/index.d.ts",
+      "import": "./esm/legacy/index.js",
+      "require": "./cjs/legacy/index.js",
+      "default": "./cjs/legacy/index.js"
+    },
+    "./palette": {
+      "types": "./esm/palette/index.d.ts",
+      "import": "./esm/palette/index.js",
+      "require": "./cjs/palette/index.js",
+      "default": "./cjs/palette/index.js"
+    },
+    "./scale": {
+      "types": "./esm/scale/index.d.ts",
+      "import": "./esm/scale/index.js",
+      "require": "./cjs/scale/index.js",
+      "default": "./cjs/scale/index.js"
+    },
+    "./tokens": {
+      "types": "./esm/tokens/index.d.ts",
+      "import": "./esm/tokens/index.js",
+      "require": "./cjs/tokens/index.js",
+      "default": "./cjs/tokens/index.js"
+    },
+    "./schemas/*": "./schemas/*",
+    "./package.json": "./package.json"
+  },
+  "main": "./cjs/index.js",
+  "types": "./esm/index.d.ts",
+  "files": [
+    "bin",
+    "cjs",
+    "dist",
+    "esm",
+    "schemas",
+    "skills",
+    "src",
+    "llms.txt",
+    "plugin.json",
+    ".claude-plugin",
+    ".codex-plugin",
+    ".cursor-plugin",
+    "!**/*.spec.*",
+    "CHANGELOG.md"
+  ],
+  "devDependencies": {
+    "@colordx/core": "7.3.0",
+    "@size-limit/preset-small-lib": "^14.3.0",
+    "@types/culori": "^4.0.1",
+    "@types/node": "^26.2.0",
+    "@vitest/coverage-v8": "^5.0.0",
+    "assertron": "^11.0.0",
+    "clibuilder": "~12.1.0",
+    "colorjs.io": "0.7.1",
+    "culori": "4.0.2",
+    "depcheck": "^1.4.3",
+    "npm-run-all2": "^9.0.3",
+    "rimraf": "^6.1.3",
+    "size-limit": "^14.3.0",
+    "tsdown": "^0.23.0",
+    "typescript": "^7.0.2",
+    "vitest": "^5.0.0"
+  },
+  "engines": {
+    "node": ">= 20.19"
+  },
+  "size-limit": [
+    {
+      "name": "existing API",
+      "path": "esm/legacy/index.js",
+      "import": "{ createColors, createColorsFromMap, rgbHex, rgbaString }",
+      "limit": "0.45 kB",
+      "gzip": true
+    },
+    {
+      "name": "existing API from the root",
+      "path": "esm/index.js",
+      "import": "{ createColors, createColorsFromMap, rgbHex, rgbaString }",
+      "limit": "0.45 kB",
+      "gzip": true
+    },
+    {
+      "name": "convert between two spaces",
+      "path": "esm/color/index.js",
+      "import": "{ createConverter, srgb, oklch }",
+      "limit": "1.22 kB",
+      "gzip": true
+    },
+    {
+      "name": "parse and convert between two spaces",
+      "path": "esm/color/index.js",
+      "import": "{ parse, createConverter, srgb, oklch }",
+      "limit": "4.85 kB",
+      "gzip": true
+    },
+    {
+      "name": "toHex over every space",
+      "path": "esm/color/index.js",
+      "import": "{ toHex }",
+      "limit": "3.01 kB",
+      "gzip": true
+    },
+    {
+      "name": "toHex from oklch, narrow",
+      "path": "esm/color/index.js",
+      "import": "{ createToHex, oklch }",
+      "limit": "1.31 kB",
+      "gzip": true
+    },
+    {
+      "name": "toGamut over every space",
+      "path": "esm/color/index.js",
+      "import": "{ toGamut }",
+      "limit": "3.86 kB",
+      "gzip": true
+    },
+    {
+      "name": "toGamut, narrow",
+      "path": "esm/color/index.js",
+      "import": "{ createToGamut }",
+      "limit": "2.19 kB",
+      "gzip": true
+    },
+    {
+      "name": "mix over every space",
+      "path": "esm/color/index.js",
+      "import": "{ mix }",
+      "limit": "7.18 kB",
+      "gzip": true
+    },
+    {
+      "name": "mix, narrow",
+      "path": "esm/color/index.js",
+      "import": "{ createMix }",
+      "limit": "1.57 kB",
+      "gzip": true
+    },
+    {
+      "name": "contrast helpers over every space",
+      "path": "esm/color/index.js",
+      "import": "{ contrast, meets, onColor, findContrast }",
+      "limit": "8.22 kB",
+      "gzip": true
+    },
+    {
+      "name": "contrast helpers, narrow",
+      "path": "esm/color/index.js",
+      "import": "{ createContrast, createMeets, createOnColor, createFindContrast }",
+      "limit": "2.96 kB",
+      "gzip": true
+    },
+    {
+      "name": "every converting helper over every space",
+      "path": "esm/color/index.js",
+      "import": "{ toHex, toGamut, inGamut, deltaEOk, equals, mix, contrast, meets, onColor, findContrast }",
+      "limit": "9.09 kB",
+      "gzip": true
+    },
+    {
+      "name": "every converting helper, narrow",
+      "path": "esm/color/index.js",
+      "import": "{ createToHex, createToGamut, createInGamut, createDeltaEOk, createEquals, createMix, createContrast, createMeets, createOnColor, createFindContrast }",
+      "limit": "3.89 kB",
+      "gzip": true
+    },
+    {
+      "name": "full color core",
+      "path": "esm/color/index.js",
+      "import": "{ parse, toCss, toHex, toGamut, inGamut, deltaEOk, equals, fromArgb, toArgb, convert, spaces }",
+      "limit": "8.21 kB",
+      "gzip": true
+    },
+    {
+      "name": "core with mix",
+      "path": "esm/color/index.js",
+      "import": "{ parse, toCss, toGamut, mix }",
+      "limit": "8.5 kB",
+      "gzip": true
+    },
+    {
+      "name": "core with mix and contrast",
+      "path": "esm/color/index.js",
+      "import": "{ parse, toCss, toGamut, mix, contrast, meets, onColor, findContrast }",
+      "limit": "9.23 kB",
+      "gzip": true
+    },
+    {
+      "name": "scales",
+      "path": "esm/scale/index.js",
+      "import": "*",
+      "limit": "10.55 kB",
+      "gzip": true
+    },
+    {
+      "name": "palette",
+      "path": "esm/palette/index.js",
+      "import": "*",
+      "limit": "9.9 kB",
+      "gzip": true
+    },
+    {
+      "name": "tokens",
+      "path": "esm/tokens/index.js",
+      "import": "*",
+      "limit": "9.03 kB",
+      "gzip": true
+    },
+    {
+      "name": "everything",
+      "path": "esm/color/index.js",
+      "import": "*",
+      "limit": "12.13 kB",
+      "gzip": true
+    }
+  ],
+  "keywords": [
+    "agent",
+    "axi",
+    "cli",
+    "color",
+    "design-system",
+    "palette"
+  ],
+  "bin": {
+    "color-map": "./bin/color-map.js"
+  },
+  "scripts": {
+    "build": "tsdown && node scripts/write-schemas.mjs",
+    "bench": "node scripts/bench.mjs",
+    "build:watch": "tsdown --watch",
+    "clean": "rimraf .reports bin cjs coverage dist esm",
+    "coverage": "vitest run --coverage",
+    "depcheck": "depcheck",
+    "llms": "node scripts/generate-llms-txt.mjs",
+    "llms:check": "node scripts/generate-llms-txt.mjs --check",
+    "nuke": "pnpm clean && rimraf node_modules",
+    "pack:check": "node scripts/check-pack.mjs && node scripts/sync-plugin-version.mjs --check",
+    "schemas": "node scripts/write-schemas.mjs",
+    "size": "size-limit",
+    "test": "vitest run",
+    "typecheck": "tsc",
+    "verify": "npm-run-all build -p depcheck typecheck coverage size llms:check pack:check",
+    "watch": "vitest"
+  }
+}

package/plugin.json

@@ -0,0 +1,18 @@
+{
+	"$schema": "https://agent-plugins.org/schemas/1.0.0/plugin.schema.json",
+	"name": "color-map",
+	"version": "2.3.0",
+	"description": "Generate WCAG-checked color palettes, scales and design tokens with the color-map CLI",
+	"author": {
+		"name": "Homa Wong (unional)"
+	},
+	"homepage": "https://github.com/cyberuni/color-map",
+	"repository": "https://github.com/cyberuni/color-map",
+	"license": "MIT",
+	"keywords": ["color", "palette", "design-system", "contrast", "css"],
+	"extensions": {
+		"org.cyberuni.universal-plugin": {
+			"vendors": ["claude-code", "cursor", "codex", "copilot-cli"]
+		}
+	}
+}

package/schemas/contrast.schema.json

@@ -0,0 +1,24 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "https://unpkg.com/color-map/schemas/contrast.schema.json",
+	"title": "color-map contrast",
+	"description": "WCAG 2 contrast ratio of a text color on a background, with the AA and AAA verdicts",
+	"type": "object",
+	"properties": {
+		"fg": {
+			"type": "string",
+			"description": "The text (foreground) color",
+			"x-kind": "argument"
+		},
+		"bg": {
+			"type": "string",
+			"description": "The background color",
+			"x-kind": "argument"
+		}
+	},
+	"required": [
+		"fg",
+		"bg"
+	],
+	"additionalProperties": false
+}

package/schemas/convert.schema.json

@@ -0,0 +1,60 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "https://unpkg.com/color-map/schemas/convert.schema.json",
+	"title": "color-map convert",
+	"description": "Convert a CSS color to another color space",
+	"type": "object",
+	"properties": {
+		"color": {
+			"type": "string",
+			"description": "Any CSS color, such as \"#3b82f6\" or \"oklch(0.7 0.15 250)\"",
+			"x-kind": "argument"
+		},
+		"to": {
+			"type": "string",
+			"enum": [
+				"srgb",
+				"srgb-linear",
+				"hsl",
+				"hwb",
+				"lab",
+				"lch",
+				"oklab",
+				"oklch",
+				"display-p3",
+				"display-p3-linear",
+				"a98-rgb",
+				"prophoto-rgb",
+				"rec2020",
+				"xyz-d50",
+				"xyz-d65"
+			],
+			"description": "Target color space",
+			"default": "srgb",
+			"x-kind": "option"
+		},
+		"gamut": {
+			"type": "string",
+			"enum": [
+				"srgb",
+				"srgb-linear",
+				"display-p3",
+				"display-p3-linear",
+				"a98-rgb",
+				"prophoto-rgb",
+				"rec2020"
+			],
+			"description": "Map the result into this gamut (CSS gamut mapping) when it falls outside",
+			"x-kind": "option"
+		},
+		"full": {
+			"type": "boolean",
+			"description": "Show the complete output instead of truncating it",
+			"x-kind": "option"
+		}
+	},
+	"required": [
+		"color"
+	],
+	"additionalProperties": false
+}

package/schemas/export.schema.json

@@ -0,0 +1,106 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "https://unpkg.com/color-map/schemas/export.schema.json",
+	"title": "color-map export",
+	"description": "Write a palette, a scale or your own tokens as DTCG JSON, CSS variables or a Tailwind v4 theme",
+	"type": "object",
+	"properties": {
+		"color": {
+			"type": "string",
+			"description": "The brand color to build tokens from; leave out with --tokens",
+			"x-kind": "argument"
+		},
+		"to": {
+			"type": "string",
+			"enum": [
+				"dtcg",
+				"css",
+				"tailwind"
+			],
+			"description": "Output format",
+			"default": "css",
+			"x-kind": "option"
+		},
+		"source": {
+			"type": "string",
+			"enum": [
+				"palette",
+				"scale"
+			],
+			"description": "What to build from the color",
+			"default": "palette",
+			"x-kind": "option"
+		},
+		"mode": {
+			"type": "string",
+			"enum": [
+				"light",
+				"dark"
+			],
+			"description": "light or dark, for --source palette",
+			"default": "light",
+			"x-kind": "option"
+		},
+		"tokens": {
+			"type": "string",
+			"description": "A JSON file of CSS color strings, nested as you like, instead of a color",
+			"x-kind": "option"
+		},
+		"space": {
+			"type": "string",
+			"enum": [
+				"srgb",
+				"srgb-linear",
+				"hsl",
+				"hwb",
+				"lab",
+				"lch",
+				"oklab",
+				"oklch",
+				"display-p3",
+				"display-p3-linear",
+				"a98-rgb",
+				"prophoto-rgb",
+				"rec2020",
+				"xyz-d50",
+				"xyz-d65"
+			],
+			"description": "Convert every color to this space (css, tailwind)",
+			"x-kind": "option"
+		},
+		"prefix": {
+			"type": "string",
+			"description": "Variable name prefix (css; tailwind uses --namespace)",
+			"x-kind": "option"
+		},
+		"selector": {
+			"type": "string",
+			"description": "The CSS rule selector (css)",
+			"x-kind": "option"
+		},
+		"namespace": {
+			"type": "string",
+			"description": "The Tailwind theme namespace (tailwind)",
+			"x-kind": "option"
+		},
+		"inline": {
+			"type": "boolean",
+			"description": "Write @theme inline (tailwind)",
+			"x-kind": "option"
+		},
+		"precision": {
+			"type": "integer",
+			"minimum": 0,
+			"maximum": 10,
+			"description": "Decimal places in printed numbers",
+			"x-kind": "option"
+		},
+		"hex": {
+			"type": "boolean",
+			"description": "Add the hex fallback to DTCG values; --hex=false drops it",
+			"x-kind": "option"
+		}
+	},
+	"required": [],
+	"additionalProperties": false
+}

package/schemas/find-contrast.schema.json

@@ -0,0 +1,51 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"$id": "https://unpkg.com/color-map/schemas/find-contrast.schema.json",
+	"title": "color-map find-contrast",
+	"description": "Find the color closest in lightness to a background that reaches a WCAG 2 contrast target",
+	"type": "object",
+	"properties": {
+		"bg": {
+			"type": "string",
+			"description": "The background color",
+			"x-kind": "argument"
+		},
+		"target": {
+			"type": "number",
+			"minimum": 1,
+			"maximum": 21,
+			"description": "The contrast ratio to reach, 1 to 21",
+			"default": 4.5,
+			"x-kind": "option"
+		},
+		"hue": {
+			"type": "number",
+			"description": "OKLCH hue of the result in degrees (default: the background's hue)",
+			"x-kind": "option"
+		},
+		"chroma": {
+			"type": "number",
+			"minimum": 0,
+			"description": "OKLCH chroma of the result (default 0, a gray)",
+			"x-kind": "option"
+		},
+		"direction": {
+			"type": "string",
+			"enum": [
+				"lighter",
+				"darker"
+			],
+			"description": "Which way to look first",
+			"x-kind": "option"
+		},
+		"full": {
+			"type": "boolean",
+			"description": "Show the complete output instead of truncating it",
+			"x-kind": "option"
+		}
+	},
+	"required": [
+		"bg"
+	],
+	"additionalProperties": false
+}