@design-token-kit/cli 0.1.1

package/LICENSE

@@ -0,0 +1,159 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License,
+each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,
+no-charge, royalty-free, irrevocable (except as stated in this section) patent
+license to make, have made, use, offer to sell, sell, import, and otherwise
+transfer the Work, where such license applies only to those patent claims
+licensable by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s) with the Work
+to which such Contribution(s) was submitted. If You institute patent litigation
+against any entity (including a cross-claim or counterclaim in a lawsuit)
+alleging that the Work or a Contribution incorporated within the Work
+constitutes direct or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate as of the date
+such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and in
+Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that
+You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from the
+Source form of the Work, excluding those notices that do not pertain to any part
+of the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution, then
+any Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein shall
+supersede or modify the terms of any separate license agreement you may have
+executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as required
+for reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties
+or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any risks
+associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in
+contract, tort (including negligence), or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to in
+writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages of any character
+arising as a result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill, work stoppage,
+computer failure or malfunction, or any and all other commercial damages or
+losses), even if such Contributor has been advised of the possibility of such
+damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or
+Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole responsibility,
+not on behalf of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability incurred by, or
+claims asserted against, such Contributor by reason of your accepting any such
+warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,96 @@
+# @design-token-kit/cli
+
+Command line interface for Design Token Kit.
+
+It provides commands to:
+
+- validate design tokens
+- convert between DTCG JSON, HRDT YAML, and CSS
+- generate HTML showcase pages
+- run round-trip read/write checks
+
+Node.js 18 or newer is required.
+
+## Install
+
+Run without installation:
+
+```bash
+npx @design-token-kit/cli validate tokens.json
+```
+
+Install globally:
+
+```bash
+npm install -g @design-token-kit/cli
+dtokens validate tokens.json
+```
+
+Install as a local dependency:
+
+```bash
+npm install @design-token-kit/cli
+```
+
+## Commands
+
+### `validate`
+
+Validate one or more DTCG JSON or HRDT YAML token files.
+
+```bash
+dtokens validate tokens.json
+dtokens validate tokens.yaml
+dtokens validate light.json dark.yaml
+```
+
+### `convert`
+
+Convert a token file to DTCG JSON, HRDT YAML, or CSS.
+
+Defaults:
+
+- `--inform` defaults to `dtcg`
+- `--outform` defaults to `css`
+
+```bash
+dtokens convert tokens.json
+dtokens convert tokens.json --out tokens.css
+dtokens convert tokens.yaml --inform hrdt --outform css
+dtokens convert tokens.yaml --inform hrdt --outform dtcg
+dtokens convert tokens.json --outform hrdt
+```
+
+Options:
+
+- `--inform <format>`: input format override, `dtcg` or `hrdt`
+- `--outform <format>`: output format, `dtcg`, `hrdt`, or `css`
+- `--out <file>`: write output to a file instead of stdout
+
+### `showcase`
+
+Generate an HTML showcase from token files or CSS.
+
+```bash
+dtokens showcase tokens.json
+dtokens showcase tokens.css --out showcase.html
+dtokens showcase tokens.json --out showcase.html
+```
+
+### `test`
+
+Load a token file, build the internal model, and print it back in the same or 
+requested format.
+
+```bash
+dtokens test tokens.json
+dtokens test tokens.yaml
+dtokens test tokens.yaml --outform hrdt
+dtokens test tokens.json --outform dtcg
+```
+
+## Supported Formats
+
+- `dtcg` - Design Tokens Community Group JSON format
+- `hrdt` - Human-Readable Design Tokens YAML format
+- `css` - CSS custom properties output

package/bin/index.mjs

@@ -0,0 +1,198 @@
+#!/usr/bin/env node
+
+// src/index.ts
+import { Command as Command5 } from "commander";
+
+// src/commands/validate.ts
+import { Command } from "commander";
+import {
+  DtcgTokenValidator
+} from "@design-token-kit/core";
+function formatIssue(issue) {
+  const location = issue.line === void 0 ? "" : issue.column === void 0 ? `:${issue.line}` : `:${issue.line}:${issue.column}`;
+  return `[${issue.name}] ${issue.severity}: ${issue.sourcePath}${location} - ${issue.message}`;
+}
+function printIssues(issues) {
+  for (const issue of issues) {
+    const stream = issue.severity === "error" ? console.error : console.warn;
+    stream(formatIssue(issue));
+  }
+}
+function hasErrors(issues) {
+  return issues.some((i) => i.severity === "error");
+}
+var validateCommand = new Command("validate").description("Validate DTCG JSON or HRDT YAML token files.").argument("<sources...>", "Paths to token JSON or HRDT files").action(async (sources) => {
+  try {
+    const validator = new DtcgTokenValidator();
+    const issues = await validator.validate(sources);
+    printIssues(issues);
+    if (hasErrors(issues)) {
+      process.exit(2);
+    }
+    console.log("Validation passed.");
+  } catch (error) {
+    console.error("Validation error:", error.message);
+    process.exit(1);
+  }
+});
+
+// src/commands/convert.ts
+import { Command as Command2 } from "commander";
+import { Source } from "@design-token-kit/core";
+import { writeFile } from "fs/promises";
+
+// src/commands/formats.ts
+import {
+  DtcgTokenCssConverter,
+  DtcgJsonReader,
+  DtcgJsonWriter,
+  HrdtTokenReader,
+  HrdtTokenWriter
+} from "@design-token-kit/core";
+function detectDocumentFormat(file) {
+  return /\.(ya?ml)$/i.test(file) ? "hrdt" /* HRDT */ : "dtcg" /* DTCG */;
+}
+function getReader(format) {
+  return readers[toDocumentFormat(format)];
+}
+function getWriter(format) {
+  return writers[toOutputFormat(format)];
+}
+function getRoundTripWriter(format, file) {
+  return writers[toDocumentFormat(format, detectDocumentFormat(file))];
+}
+function getDetectedReader(file) {
+  return readers[detectDocumentFormat(file)];
+}
+var readers = {
+  ["dtcg" /* DTCG */]: {
+    read: (content) => new DtcgJsonReader().parse(content)
+  },
+  ["hrdt" /* HRDT */]: {
+    read: (content) => new HrdtTokenReader().parse(content)
+  }
+};
+var writers = {
+  ["dtcg" /* DTCG */]: {
+    write: (doc) => new DtcgJsonWriter().write(doc)
+  },
+  ["hrdt" /* HRDT */]: {
+    write: (doc) => new HrdtTokenWriter().write(doc)
+  },
+  ["css" /* CSS */]: {
+    write: (doc) => new DtcgTokenCssConverter().convertDocument(doc)
+  }
+};
+function toDocumentFormat(format, fallback = "dtcg" /* DTCG */) {
+  const resolved = format ?? fallback;
+  if (resolved === "dtcg" /* DTCG */ || resolved === "hrdt" /* HRDT */) return resolved;
+  throw new Error(`Unknown format "${resolved}". Available: ${"dtcg" /* DTCG */}, ${"hrdt" /* HRDT */}`);
+}
+function toOutputFormat(format, fallback = "css" /* CSS */) {
+  const resolved = format ?? fallback;
+  if (resolved === "dtcg" /* DTCG */ || resolved === "hrdt" /* HRDT */ || resolved === "css" /* CSS */) return resolved;
+  throw new Error(`Unknown format "${resolved}". Available: ${"dtcg" /* DTCG */}, ${"hrdt" /* HRDT */}, ${"css" /* CSS */}`);
+}
+
+// src/commands/convert.ts
+var convertCommand = new Command2("convert").description("Convert DTCG JSON or HRDT YAML tokens to DTCG JSON, HRDT YAML, or CSS.").argument("<file>", "Path to a token JSON or HRDT file").option("-i, --inform <format>", "Input format override: dtcg, hrdt").option("-f, --outform <format>", "Output format: dtcg, hrdt, css (default: css)").option("-o, --out <file>", "Output file").action(async (file, options) => {
+  try {
+    const reader = getReader(options.inform);
+    const content = await new Source(file).getContent();
+    const doc = reader.read(content);
+    const writer = getWriter(options.outform);
+    const output = writer.write(doc);
+    if (options.out) {
+      await writeFile(options.out, output);
+    } else {
+      process.stdout.write(output);
+    }
+  } catch (error) {
+    console.error("Conversion failed:", error.message);
+    process.exit(1);
+  }
+});
+
+// src/commands/showcase.ts
+import { Command as Command3 } from "commander";
+import { writeFile as writeFile2 } from "fs/promises";
+import { spawn } from "child_process";
+import path from "path";
+import { tmpdir } from "os";
+import { Source as Source2, createTokenHtmlShowcase } from "@design-token-kit/core";
+function resolveOutputPath(output) {
+  if (path.isAbsolute(output)) {
+    return output;
+  }
+  if (path.dirname(output) !== ".") {
+    return output;
+  }
+  return path.join(tmpdir(), output);
+}
+function openFile(filePath) {
+  const platform = process.platform;
+  if (platform === "win32") {
+    spawn("cmd", ["/c", "start", "", filePath], { stdio: "ignore", detached: true });
+    return;
+  }
+  if (platform === "darwin") {
+    spawn("open", [filePath], { stdio: "ignore", detached: true });
+    return;
+  }
+  spawn("xdg-open", [filePath], { stdio: "ignore", detached: true });
+}
+var showcaseCommand = new Command3("showcase").description("Create HTML showcase from DTCG JSON, HRDT YAML, or CSS.").argument("<files...>", "Paths to token JSON, HRDT, or CSS files").option("-o, --out <file>", "Output HTML file name or path").action(async (files, options) => {
+  try {
+    const showcase = createTokenHtmlShowcase();
+    const sources = files.map((f) => new Source2(f));
+    const filePaths = await Promise.all(sources.map((s) => s.getFile()));
+    const html = await showcase.showcase(filePaths);
+    if (options.out) {
+      const targetFile = resolveOutputPath(options.out);
+      await writeFile2(targetFile, html);
+      console.log(`Saved HTML to: ${targetFile}`);
+      openFile(targetFile);
+    } else {
+      process.stdout.write(html);
+    }
+  } catch (error) {
+    console.error("Showcase failed:", error.message);
+    process.exit(1);
+  }
+});
+
+// src/commands/test.ts
+import { Command as Command4 } from "commander";
+import { Source as Source3 } from "@design-token-kit/core";
+var testCommand = new Command4("test").description("Load a DTCG JSON or HRDT YAML file, build the model, and print it back (round-trip check).").argument("<file>", "Path to a DTCG JSON or HRDT file").option("-f, --outform <format>", "Output format: dtcg, hrdt (default: same as input)").action(async (file, options) => {
+  try {
+    const reader = getDetectedReader(file);
+    const writer = getRoundTripWriter(options.outform, file);
+    const content = await new Source3(file).getContent();
+    const doc = reader.read(content);
+    process.stdout.write(writer.write(doc));
+  } catch (error) {
+    console.error(`Error: ${error.message}`);
+    process.exit(1);
+  }
+});
+
+// src/index.ts
+var program = new Command5().name("dtokens").description("CLI for DTCG JSON and HRDT YAML: validate, convert, showcase.").addCommand(testCommand).addCommand(validateCommand).addCommand(convertCommand).addCommand(showcaseCommand).addHelpText("after", ({ command }) => command.name() === "dtokens" ? `
+Examples:
+  $ dtokens test tokens.json
+  $ dtokens validate tokens.json
+  $ dtokens validate tokens.yaml
+  $ dtokens validate tokens.json tokens.dark.yaml --engine ajv
+  $ dtokens convert tokens.yaml --inform hrdt --outform css --out ./dist/tokens.css
+  $ dtokens convert tokens.yaml --outform dtcg
+  $ dtokens convert tokens.json --outform hrdt
+  $ dtokens showcase tokens.yaml
+  $ dtokens showcase tokens.css
+  $ dtokens showcase tokens.yaml --out out.html
+  $ dtokens showcase tokens.yaml --out ./dist/showcase.html
+` : "");
+program.parseAsync(process.argv).catch((error) => {
+  console.error(error instanceof Error ? error.message : error);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,52 @@
+{
+    "name": "@design-token-kit/cli",
+    "version": "0.1.1",
+    "description": "CLI for Design Token Kit: validate, convert, showcase.",
+    "keywords": [
+        "design-tokens",
+        "dtcg",
+        "hrdt",
+        "tokens",
+        "cli",
+        "css"
+    ],
+    "license": "Apache-2.0",
+    "homepage": "https://github.com/design-token-kit/design-token-kit",
+    "bugs": {
+        "url": "https://github.com/design-token-kit/design-token-kit/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/design-token-kit/design-token-kit.git"
+    },
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org/"
+    },
+    "type": "module",
+    "bin": {
+        "dtokens": "bin/index.mjs"
+    },
+    "files": [
+        "bin"
+    ],
+    "imports": {
+        "#/*": "./src/*"
+    },
+    "engines": {
+        "node": ">=18"
+    },
+    "scripts": {
+        "build": "tsc --noEmit && tsup",
+        "dist": "node ../scripts/stage-package.mjs cli"
+    },
+    "dependencies": {
+        "@design-token-kit/core": "0.1.1",
+        "commander": "14.0.1"
+    },
+    "devDependencies": {
+        "@types/node": "24.10.1",
+        "tsup": "8.5.1",
+        "typescript": "5.9.3"
+    }
+}