figma-token 0.1.1 → 0.1.3

package/README.md

@@ -1,40 +1,56 @@
 # figma-token
 
-`figma-token` exports Figma Variables to design token files.
+`figma-token` applies a Figma Plugin `tokens.json` export to a project directory.
 
 ## Install
 
 ```bash
-npm install --global figma-token
+npm install -D figma-token
 ```
 
-## Help
+The Figma Plugin can download a ZIP or all six formats directly. Use this optional CLI when a project needs those files written to a predictable folder and checked for changes.
+
+## Apply Plugin Tokens
 
 ```bash
-figma-token --help
-figma-token sync --help
+npx figma-token
 ```
 
-## Basic usage
+Without an input path, the CLI reads `./tokens.json` from the current project and creates the following files in `./figma-token-output/`:
+
+```text
+tokens.json
+theme.ts
+variables.css
+tokens.scss
+tailwind.css
+tokens.dtcg.json
+```
 
-Export a local Figma Variables JSON file:
+Choose a project directory with `--out`:
 
 ```bash
-figma-token sync --input ./figma-variables.json --format theme-ts --output ./theme.ts
+npx figma-token --out ./src/tokens
+npx figma-token ./figma-export.json
 ```
 
-Preview token changes without writing output or snapshot files:
+Preview all generated files without writing anything:
 
 ```bash
-figma-token sync --input ./figma-variables.json --dry-run
+npx figma-token --dry-run
 ```
 
-`--input` accepts a Figma Variables JSON response or a normalized `tokens.json` array. Without `--input`, provide `--figma-token` and `--file-key`, or set `FIGMA_TOKEN` and `FIGMA_FILE_KEY`.
+Check whether generated files are current:
+
+```bash
+npx figma-token --check
+npx figma-token --check --out ./src/tokens
+```
 
-## Options
+`--check` and `--dry-run` cannot be used together. The old `check` subcommand is not supported.
 
-`sync` supports `--input`, `--output`, `--snapshot`, `--format`, `--export-name`, `--figma-token`, `--file-key`, and `--dry-run`.
+## Advanced Sync
 
-Supported formats are `tokens-json`, `theme-ts`, `variables-css`, `tokens-scss`, `tailwind-css`, and `tokens-dtcg-json`.
+The hidden `sync` command retains the previous single-format, snapshot, and Figma REST API flow for advanced users. It accepts `--input`, `--output`, `--snapshot`, `--format`, `--export-name`, `--figma-token`, `--file-key`, and `--dry-run`.
 
 For Plugin usage and project-wide documentation, see <https://github.com/lee090626/Project-F>.

package/dist/index.js

@@ -4,9 +4,9 @@
 import "dotenv/config";
 import { Command, InvalidArgumentError } from "commander";
 
-// src/sync.ts
-import { mkdir, readFile, writeFile } from "fs/promises";
-import { dirname } from "path";
+// src/exportTokens.ts
+import { mkdir, readFile, stat, writeFile } from "fs/promises";
+import { join, resolve } from "path";
 
 // ../core/dist/index.js
 var supportedTypes = ["color", "spacing", "radius", "borderWidth", "size", "fontSize", "opacity"];
@@ -222,6 +222,108 @@ function renderTheme(tokens, exportName = "theme") {
 `;
 }
 
+// src/exportTokens.ts
+var tokenFileNames = ["tokens.json", "theme.ts", "variables.css", "tokens.scss", "tailwind.css", "tokens.dtcg.json"];
+function defaultOutputDirectory(cwd = process.cwd()) {
+  return resolve(cwd, "figma-token-output");
+}
+function defaultInputFile(cwd = process.cwd()) {
+  return resolve(cwd, "tokens.json");
+}
+var outputDirectory = (output) => resolve(output ?? defaultOutputDirectory());
+async function readPluginTokens(input) {
+  const inputPath = resolve(input);
+  let inputStat;
+  try {
+    inputStat = await stat(inputPath);
+  } catch (error) {
+    if (error.code === "ENOENT") throw new Error(`Input file not found: ${inputPath}`);
+    throw new Error(`Cannot read input file: ${inputPath}`);
+  }
+  if (inputStat.isDirectory()) throw new Error(`Input path is a directory: ${inputPath}`);
+  let raw;
+  try {
+    raw = JSON.parse(await readFile(inputPath, "utf8"));
+  } catch (error) {
+    if (error instanceof SyntaxError) throw new Error(`Invalid JSON: ${inputPath}`);
+    throw new Error(`Cannot read input file: ${inputPath}`);
+  }
+  if (!isDesignTokenArray(raw)) throw new Error(`Unsupported input: expected Plugin tokens.json: ${inputPath}`);
+  return { inputPath, tokens: raw };
+}
+function renderAll(tokens) {
+  return {
+    "tokens.json": renderTokensJson(tokens),
+    "theme.ts": renderTheme(tokens),
+    "variables.css": renderCssVariables(tokens),
+    "tokens.scss": renderScssVariables(tokens),
+    "tailwind.css": renderTailwindTheme(tokens),
+    "tokens.dtcg.json": renderDtcgJson(tokens)
+  };
+}
+async function prepare(options) {
+  const { inputPath, tokens } = await readPluginTokens(options.input);
+  const outputPath = outputDirectory(options.output);
+  return { inputPath, outputPath, files: renderAll(tokens) };
+}
+async function writeAll(outputPath, files) {
+  try {
+    await mkdir(outputPath, { recursive: true });
+  } catch {
+    throw new Error(`Cannot create output directory: ${outputPath}`);
+  }
+  for (const filename of tokenFileNames) {
+    const path = join(outputPath, filename);
+    try {
+      await writeFile(path, files[filename]);
+    } catch {
+      throw new Error(`Cannot write token file: ${path}`);
+    }
+  }
+}
+async function exportTokenFiles(options, log = console.log) {
+  const result = await prepare(options);
+  if (options.dryRun) {
+    log(`Input: ${result.inputPath}`);
+    log(`Output: ${result.outputPath}`);
+    log("Would generate:");
+    tokenFileNames.forEach((filename) => log(`- ${filename}`));
+    return result;
+  }
+  await writeAll(result.outputPath, result.files);
+  log(`Generated token files in: ${result.outputPath}`);
+  return result;
+}
+async function checkTokenFiles(options, log = console.log) {
+  const result = await prepare(options);
+  const outdated = [];
+  for (const filename of tokenFileNames) {
+    const path = join(result.outputPath, filename);
+    let contents;
+    try {
+      contents = await readFile(path, "utf8");
+    } catch (error) {
+      if (error.code === "ENOENT") {
+        outdated.push(`- ${filename}: missing`);
+        continue;
+      }
+      throw new Error(`Cannot read token file: ${path}`);
+    }
+    if (contents !== result.files[filename]) outdated.push(`- ${filename}: changed`);
+  }
+  if (outdated.length === 0) {
+    log("Token files are up to date.");
+    return 0;
+  }
+  log("Token files are not up to date:");
+  outdated.forEach((message) => log(message));
+  return 1;
+}
+
+// src/sync.ts
+import { mkdir as mkdir2, readFile as readFile2, writeFile as writeFile2 } from "fs/promises";
+import { dirname } from "path";
+
 // src/figma/fetchFigmaVariables.ts
 var FIGMA_API = "https://api.figma.com/v1";
 async function fetchFigmaVariables(fileKey, token) {
@@ -243,7 +345,7 @@ async function fetchFigmaVariables(fileKey, token) {
 // src/sync.ts
 var readJson = async (path) => {
   try {
-    return JSON.parse(await readFile(path, "utf8"));
+    return JSON.parse(await readFile2(path, "utf8"));
   } catch (error) {
     if (error instanceof SyntaxError) throw new Error(`Invalid JSON: ${path}`);
     throw error;
@@ -260,8 +362,8 @@ var readSnapshot = async (path) => {
   }
 };
 var save = async (path, contents) => {
-  await mkdir(dirname(path), { recursive: true });
-  await writeFile(path, contents);
+  await mkdir2(dirname(path), { recursive: true });
+  await writeFile2(path, contents);
 };
 var render = (tokens, options) => ({
   "tokens-json": renderTokensJson,
@@ -300,8 +402,24 @@ var format = (value) => {
   if (!formats.includes(value)) throw new InvalidArgumentError(`format\uC740 ${formats.join(", ")} \uC911 \uD558\uB098\uC5EC\uC57C \uD569\uB2C8\uB2E4.`);
   return value;
 };
-var program = new Command().name("figma-token").description("Figma Variables\uB97C \uB85C\uCEEC \uB514\uC790\uC778 \uD1A0\uD070\uC73C\uB85C \uB3D9\uAE30\uD654\uD569\uB2C8\uB2E4.");
-program.command("sync").option("--input <path>", "\uB85C\uCEEC Figma Variables JSON").option("--output <path>", "\uCD9C\uB825 \uD30C\uC77C", "./tokens.json").option("--snapshot <path>", "snapshot \uD30C\uC77C", ".figma-token/snapshot.json").option("--format <format>", "\uCD9C\uB825 \uD3EC\uB9F7", format, "tokens-json").option("--export-name <name>", "theme.ts export \uC774\uB984", "theme").option("--figma-token <token>", "Figma token").option("--file-key <key>", "Figma file key").option("--dry-run", "\uD30C\uC77C\uC744 \uC4F0\uC9C0 \uC54A\uACE0 diff\uB9CC \uCD9C\uB825", false).action(async (options) => sync({
+var program = new Command().name("figma-token").description("Plugin tokens.json\uC744 \uD504\uB85C\uC81D\uD2B8 \uD1A0\uD070 \uD30C\uC77C\uB85C \uC801\uC6A9\uD569\uB2C8\uB2E4.").version("0.1.3").argument("[input]", "Figma Plugin\uC5D0\uC11C \uB2E4\uC6B4\uB85C\uB4DC\uD55C tokens.json (default: ./tokens.json)").option("--out <directory>", "\uCD9C\uB825 \uD3F4\uB354 (default: ./figma-token-output)").option("--dry-run", "\uD30C\uC77C\uC744 \uC4F0\uC9C0 \uC54A\uACE0 \uC0DD\uC131 \uACB0\uACFC\uB97C \uD655\uC778").option("--check", "\uD604\uC7AC \uD1A0\uD070 \uD30C\uC77C\uC774 \uCD5C\uC2E0\uC778\uC9C0 \uD655\uC778").action(async (input, options) => {
+  if (options.check && options.dryRun) throw new Error("--check\uC640 --dry-run\uC740 \uD568\uAED8 \uC0AC\uC6A9\uD560 \uC218 \uC5C6\uC2B5\uB2C8\uB2E4. \uD558\uB098\uB9CC \uC0AC\uC6A9\uD558\uC138\uC694.");
+  const defaultInput = !input;
+  const inputPath = input ?? defaultInputFile();
+  try {
+    if (options.check) {
+      process.exitCode = await checkTokenFiles({ input: inputPath, output: options.out ?? defaultOutputDirectory() });
+      return;
+    }
+    await exportTokenFiles({ input: inputPath, output: options.out ?? defaultOutputDirectory(), dryRun: options.dryRun });
+  } catch (error) {
+    if (defaultInput && error instanceof Error && error.message.startsWith("Input file not found:")) {
+      throw new Error("Expected token file: ./tokens.json\nProvide another file with: figma-token <input>");
+    }
+    throw error;
+  }
+});
+program.command("sync", { hidden: true }).option("--input <path>", "\uB85C\uCEEC Figma Variables JSON").option("--output <path>", "\uCD9C\uB825 \uD30C\uC77C", "./tokens.json").option("--snapshot <path>", "snapshot \uD30C\uC77C", ".figma-token/snapshot.json").option("--format <format>", "\uCD9C\uB825 \uD3EC\uB9F7", format, "tokens-json").option("--export-name <name>", "theme.ts export \uC774\uB984", "theme").option("--figma-token <token>", "Figma token").option("--file-key <key>", "Figma file key").option("--dry-run", "\uD30C\uC77C\uC744 \uC4F0\uC9C0 \uC54A\uACE0 diff\uB9CC \uCD9C\uB825", false).action(async (options) => sync({
   ...options,
   figmaToken: options.figmaToken ?? process.env.FIGMA_TOKEN,
   fileKey: options.fileKey ?? process.env.FIGMA_FILE_KEY

package/package.json

@@ -1,31 +1,29 @@
 {
   "name": "figma-token",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Export Figma Variables to design token files.",
   "license": "MIT",
   "type": "module",
-  "bin": {
-    "figma-token": "dist/index.js"
-  },
+  "bin": { "figma-token": "dist/index.js" },
   "repository": {
     "type": "git",
-    "url": "https://github.com/lee090626/Project-F.git",
+    "url": "git+https://github.com/lee090626/Project-F.git",
     "directory": "packages/cli"
   },
   "files": [
     "dist",
     "README.md"
   ],
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run"
+  },
   "dependencies": {
     "commander": "^14.0.0",
     "dotenv": "^17.0.0"
   },
   "devDependencies": {
-    "tsup": "^8.5.0",
-    "@lee090626/core": "0.1.0"
-  },
-  "scripts": {
-    "build": "tsup",
-    "test": "vitest run"
+    "@lee090626/core": "workspace:*",
+    "tsup": "^8.5.0"
   }
-}
+}