Build Option Index

1#!/usr/bin/env node
2/**
3 * Rebuild assets/option-index.json from the official ECharts option outline.
4 * Run when bumping the supported ECharts version. Zero dependencies.
5 *
6 * Usage:
7 *   node scripts/build-option-index.mjs [--from <url-or-file>]
8 *
9 * Default source: https://echarts.apache.org/en/documents/option-parts/option-outline.json
10 *
11 * Output shape (recursive, compacted to keep the vendored file small):
12 *   { p: "propName", t: "type", d: "default", c: [children] }
13 * Series variants (arrayItemType) become children of "series" named by variant.
14 */
15
16import { readFileSync, writeFileSync, mkdirSync } from "node:fs";
17import { dirname, join, resolve } from "node:path";
18import { fileURLToPath } from "node:url";
19
20const DEFAULT_URL = "https://echarts.apache.org/en/documents/option-parts/option-outline.json";
21
22function compact(node) {
23  const out = {};
24  const name = node.prop ?? node.arrayItemType;
25  if (name !== undefined) out.p = String(name);
26  if (node.type !== undefined) out.t = Array.isArray(node.type) ? node.type.join("|") : String(node.type);
27  if (node.default !== undefined) out.d = String(node.default);
28  if (node.isArray) out.arr = 1;
29  if (Array.isArray(node.children) && node.children.length) {
30    out.c = node.children.map(compact);
31  }
32  return out;
33}
34
35async function load(source) {
36  if (/^https?:/.test(source)) {
37    const res = await fetch(source);
38    if (!res.ok) throw new Error(`fetch failed: ${res.status} ${source}`);
39    return res.json();
40  }
41  return JSON.parse(readFileSync(source, "utf8"));
42}
43
44const args = process.argv.slice(2);
45const fromIdx = args.indexOf("--from");
46const source = fromIdx !== -1 ? args[fromIdx + 1] : DEFAULT_URL;
47
48const outline = await load(source);
49if (!Array.isArray(outline.children)) {
50  throw new Error("unexpected outline shape: missing top-level children[]");
51}
52
53const index = {
54  source,
55  generated: new Date().toISOString(),
56  root: outline.children.map(compact),
57};
58
59const outPath = resolve(dirname(fileURLToPath(import.meta.url)), "../assets/option-index.json");
60mkdirSync(dirname(outPath), { recursive: true });
61writeFileSync(outPath, JSON.stringify(index));
62const kb = Math.round(Buffer.byteLength(JSON.stringify(index)) / 1024);
63console.log(`wrote ${outPath} (${kb} KB, ${index.root.length} top-level options)`);