@astryxdesign/cli 0.6.4-canary.ed2e54e → 0.6.4

package/api/theme/build/build.rollback.test.mjs

@@ -1,148 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-/**
- * `theme build` writes its CSS, JS, and declarations as one transaction: when
- * a later output fails to publish, every output it already replaced gets its
- * previous bytes back and every output it created is removed. Publishing is
- * forced to fail by wrapping the two calls that publish a staged file:
- * `linkSync` for a new file and `renameSync` for a replacement.
- *
- * Separate file because vi.mock is hoisted and affects the whole module.
- * `themeBuild` needs a built core; the `node` project's globalSetup builds it.
- */
-
-import {afterEach, beforeEach, describe, expect, it, vi} from 'vitest';
-import * as os from 'node:os';
-import * as path from 'node:path';
-
-const failures = vi.hoisted(() => ({
-  /** Fail the Nth staged-file publish (1-based); 0 disables. */
-  publish: 0,
-  count: 0,
-}));
-
-vi.mock('node:fs', async importOriginal => {
-  const actual = /** @type {typeof import('node:fs')} */ (
-    await importOriginal()
-  );
-  /** @param {string} source @param {string} op */
-  const maybeFail = (source, op) => {
-    if (!path.basename(String(source)).includes('.tmp')) return;
-    if (failures.publish === 0) return;
-    failures.count++;
-    if (failures.count === failures.publish) {
-      throw Object.assign(new Error(`EIO: forced ${op} failure`), {
-        code: 'EIO',
-      });
-    }
-  };
-  return {
-    ...actual,
-    linkSync: vi.fn((source, destination) => {
-      maybeFail(source, 'link');
-      return actual.linkSync(source, destination);
-    }),
-    renameSync: vi.fn((source, destination) => {
-      maybeFail(source, 'rename');
-      return actual.renameSync(source, destination);
-    }),
-  };
-});
-
-const fs = await import('node:fs');
-const {themeBuild} = await import('./build.mjs');
-
-vi.setConfig({testTimeout: 30000});
-
-let tmpDir;
-
-beforeEach(() => {
-  tmpDir = fs.mkdtempSync(
-    path.join(os.tmpdir(), 'astryx-theme-build-rollback-'),
-  );
-  failures.publish = 0;
-  failures.count = 0;
-});
-
-afterEach(() => {
-  failures.publish = 0;
-  fs.rmSync(tmpDir, {recursive: true, force: true});
-});
-
-/**
- * Write a source for the theme named `rollbacktheme`. Each call uses a new
- * file so the loader cannot serve an earlier version from its cache.
- * @param {string} file @param {string} background
- */
-function writeTheme(file, background) {
-  fs.writeFileSync(
-    path.join(tmpDir, file),
-    `export default { name: 'rollbacktheme', tokens: { '--color-bg': '${background}' } };\n`,
-  );
-  return file;
-}
-
-const OUTPUTS = ['rollbacktheme.css', 'rollbacktheme.js', 'rollbacktheme.d.ts'];
-
-/** @returns {Map<string, Buffer | null>} */
-function readOutputs() {
-  return new Map(
-    OUTPUTS.map(name => {
-      const file = path.join(tmpDir, name);
-      return [name, fs.existsSync(file) ? fs.readFileSync(file) : null];
-    }),
-  );
-}
-
-function strays() {
-  return fs
-    .readdirSync(tmpDir)
-    .filter(name => name.includes('.tmp') || name.includes('.restore-'));
-}
-
-describe('themeBuild rolls back a partial write', () => {
-  it('removes every created output when the second publish fails', async () => {
-    const source = writeTheme('first.mjs', '#0a0a0a');
-    failures.publish = 2;
-
-    await expect(themeBuild(source, {}, {cwd: tmpDir})).rejects.toMatchObject({
-      code: 'ERR_WRITE_FAILED',
-    });
-
-    for (const bytes of readOutputs().values()) expect(bytes).toBeNull();
-    expect(strays()).toEqual([]);
-  });
-
-  it('restores every replaced output when the second publish fails', async () => {
-    const first = await themeBuild(
-      writeTheme('first.mjs', '#0a0a0a'),
-      {},
-      {cwd: tmpDir},
-    );
-    expect(first?.type).toBe('theme.build');
-    const before = readOutputs();
-    for (const bytes of before.values()) expect(bytes).not.toBeNull();
-
-    const next = writeTheme('next.mjs', '#fafafa');
-    failures.publish = 2;
-    await expect(themeBuild(next, {}, {cwd: tmpDir})).rejects.toMatchObject({
-      code: 'ERR_WRITE_FAILED',
-    });
-
-    const after = readOutputs();
-    for (const name of OUTPUTS) {
-      expect(
-        after.get(name)?.equals(/** @type {Buffer} */ (before.get(name))),
-      ).toBe(true);
-    }
-
-    // The failed build really had different bytes to write.
-    failures.publish = 0;
-    await themeBuild(next, {}, {cwd: tmpDir});
-    const css = readOutputs().get('rollbacktheme.css');
-    expect(
-      css?.equals(/** @type {Buffer} */ (before.get('rollbacktheme.css'))),
-    ).toBe(false);
-    expect(strays()).toEqual([]);
-  });
-});

package/api/upgrade/run/files-changed.test.mjs

@@ -1,111 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-/**
- * @file The upgrade receipt counts a file once when a core codemod AND an
- * integration codemod both change it: `filesChanged` is the union of the two
- * runners' files, while `transformsApplied` adds their changes.
- *
- * Uses a real consumer under a repo-local temp dir (Vite blocks dynamic import
- * of config and integration modules from /tmp), the real core registry, and an
- * installed integration whose code codemod stamps the same file.
- */
-
-import {describe, it, expect, afterEach} from 'vitest';
-import * as fs from 'node:fs';
-import * as path from 'node:path';
-import {upgrade} from '../upgrade.mjs';
-import {
-  latestVersion,
-  versions,
-  getTransformsBetween,
-} from '../../../assets/codemods/registry.mjs';
-
-const SLOW = 60_000;
-
-/** The registry version whose manifest ships the authoring migration. */
-async function authoringTier() {
-  const all = await getTransformsBetween('0.0.0', latestVersion);
-  const tier = all.find(({transforms}) =>
-    transforms.some(t => t.name === 'migrate-authoring-imports'),
-  );
-  if (!tier) throw new Error('no registry version ships the authoring migration');
-  return tier.version;
-}
-
-/**
- * A consumer with installed core at the registry's latest version and one
- * old-surface file that the core authoring codemods rewrite.
- * @param {string} dir
- * @param {{integrationCodemod: boolean}} options
- */
-function seed(dir, {integrationCodemod}) {
-  fs.writeFileSync(
-    path.join(dir, 'package.json'),
-    JSON.stringify({name: 'consumer', version: '1.0.0'}),
-  );
-  const core = path.join(dir, 'node_modules', '@astryxdesign', 'core');
-  fs.mkdirSync(core, {recursive: true});
-  fs.writeFileSync(
-    path.join(core, 'package.json'),
-    JSON.stringify({name: '@astryxdesign/core', version: latestVersion}),
-  );
-  fs.mkdirSync(path.join(dir, 'src'), {recursive: true});
-  fs.writeFileSync(
-    path.join(dir, 'src', 'Button.doc.mjs'),
-    [
-      "import {createComponentDoc} from '@astryxdesign/core/authoring';",
-      "export default createComponentDoc({name: 'Button', props: []});",
-      '',
-    ].join('\n'),
-  );
-  if (!integrationCodemod) return;
-  fs.writeFileSync(
-    path.join(dir, 'astryx.config.mjs'),
-    "export default {integrations: ['@acme/widgets']};\n",
-  );
-  const pkg = path.join(dir, 'node_modules', '@acme', 'widgets');
-  fs.mkdirSync(path.join(pkg, 'codemods', latestVersion), {recursive: true});
-  fs.writeFileSync(
-    path.join(pkg, 'package.json'),
-    JSON.stringify({name: '@acme/widgets', version: '1.0.0'}),
-  );
-  fs.writeFileSync(
-    path.join(pkg, 'astryx.integration.mjs'),
-    "export default {codemods: './codemods'};\n",
-  );
-  fs.writeFileSync(
-    path.join(pkg, 'codemods', latestVersion, 'acme-stamp.mjs'),
-    "export default {type: 'code', title: 'Stamp', transform: file => (file.source.includes('// acme') ? null : `${file.source}// acme\\n`)};\n",
-  );
-}
-
-describe('upgrade receipt — filesChanged across core and integration codemods', () => {
-  /** @type {string[]} */
-  const dirs = [];
-  afterEach(() => {
-    for (const dir of dirs.splice(0)) fs.rmSync(dir, {recursive: true, force: true});
-  });
-
-  /** @param {{integrationCodemod: boolean}} options */
-  async function run(options) {
-    const dir = fs.mkdtempSync(path.join(process.cwd(), '.astryx-files-changed-'));
-    dirs.push(dir);
-    seed(dir, options);
-    const tier = await authoringTier();
-    const from = versions[versions.indexOf(tier) - 1];
-    const res = await upgrade({from, path: 'src'}, {cwd: dir});
-    expect(res.type).toBe('upgrade.run');
-    return res.data;
-  }
-
-  it('counts a file changed by both a core and an integration codemod once', async () => {
-    const coreOnly = await run({integrationCodemod: false});
-    expect(coreOnly.filesChanged).toBe(1);
-    expect(coreOnly.transformsApplied).toBeGreaterThan(0);
-
-    const both = await run({integrationCodemod: true});
-    expect(both.integrations).toEqual(['@acme/widgets']);
-    expect(both.filesChanged).toBe(1);
-    expect(both.transformsApplied).toBe(coreOnly.transformsApplied + 1);
-  }, SLOW);
-});

package/assets/codemods/file-count.test.mjs

@@ -1,163 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-/**
- * @file `filesChanged` counts FILES, not (codemod, file) pairs.
- *
- * One source file that four codemods each changed was reported as four files
- * changed — the total was incremented once per transform per file, so it
- * equalled `transformsApplied` in every run and the documented meaning of the
- * field ("Total files changed") was never true. The two numbers answer
- * different questions and both are in the receipt.
- */
-
-import {describe, it, expect, beforeEach, afterEach} from 'vitest';
-import * as fs from 'node:fs';
-import * as os from 'node:os';
-import * as path from 'node:path';
-import jscodeshift from 'jscodeshift';
-import {runCodemods} from './runner.mjs';
-import {runIntegrationCodemods} from './integration-runner.mjs';
-
-let dir;
-
-beforeEach(() => {
-  dir = fs.mkdtempSync(path.join(os.tmpdir(), 'astryx-file-count-'));
-});
-afterEach(() => fs.rmSync(dir, {recursive: true, force: true}));
-
-/** A transform that rewrites one distinctive token, so several can stack. */
-const renaming = (from, to) => (file) =>
-  file.source.includes(from) ? file.source.split(from).join(to) : null;
-
-/** @param {string} name @param {string[]} contents */
-function writeSources(...contents) {
-  return contents.map((content, i) => {
-    const file = path.join(dir, `file${i}.ts`);
-    fs.writeFileSync(file, content);
-    return file;
-  });
-}
-
-describe('core codemod runner — filesChanged counts files', () => {
-  it('reports 1 file for one file changed by four codemods', async () => {
-    writeSources('const a = ONE + TWO + THREE + FOUR;\n');
-
-    const result = await runCodemods(
-      [
-        {
-          version: '0.0.2',
-          transforms: [
-            {name: 'one', transform: renaming('ONE', '1'), meta: {title: 'one'}},
-            {name: 'two', transform: renaming('TWO', '2'), meta: {title: 'two'}},
-            {name: 'three', transform: renaming('THREE', '3'), meta: {title: 'three'}},
-            {name: 'four', transform: renaming('FOUR', '4'), meta: {title: 'four'}},
-          ],
-        },
-      ],
-      {apply: true, path: dir, root: dir, codemod: undefined, skipCodemods: new Set(), silent: true},
-    );
-
-    expect(result.totalTransformsApplied).toBe(4);
-    expect(result.totalFilesChanged).toBe(1);
-    expect(new Set(result.changedFiles).size).toBe(1);
-  });
-
-  it('still counts two files as two', async () => {
-    writeSources('const a = ONE;\n', 'const b = ONE;\n');
-
-    const result = await runCodemods(
-      [
-        {
-          version: '0.0.2',
-          transforms: [
-            {name: 'one', transform: renaming('ONE', '1'), meta: {title: 'one'}},
-          ],
-        },
-      ],
-      {apply: true, path: dir, root: dir, codemod: undefined, skipCodemods: new Set(), silent: true},
-    );
-
-    expect(result.totalTransformsApplied).toBe(2);
-    expect(result.totalFilesChanged).toBe(2);
-  });
-
-  it('reports 0 when nothing matched', async () => {
-    writeSources('const a = 1;\n');
-
-    const result = await runCodemods(
-      [
-        {
-          version: '0.0.2',
-          transforms: [
-            {name: 'one', transform: renaming('ONE', '1'), meta: {title: 'one'}},
-          ],
-        },
-      ],
-      {apply: true, path: dir, root: dir, codemod: undefined, skipCodemods: new Set(), silent: true},
-    );
-
-    expect(result.totalFilesChanged).toBe(0);
-    expect(result.totalTransformsApplied).toBe(0);
-  });
-});
-
-describe('integration codemod runner — filesChanged counts files', () => {
-  it('reports 1 file for one file changed by three integration codemods', () => {
-    writeSources('const a = ONE + TWO + THREE;\n');
-
-    const entry = (id, from, to) => ({
-      id,
-      package: '@acme/widgets',
-      type: 'code',
-      codemod: {title: id, transform: renaming(from, to)},
-    });
-
-    const result = runIntegrationCodemods(
-      [
-        {
-          version: '1.0.0',
-          codemods: [
-            entry('one', 'ONE', '1'),
-            entry('two', 'TWO', '2'),
-            entry('three', 'THREE', '3'),
-          ],
-        },
-      ],
-      {apply: true, path: dir, root: dir, skipCodemods: new Set(), jscodeshift, silent: true},
-    );
-
-    expect(result.totalTransformsApplied).toBe(3);
-    expect(result.totalFilesChanged).toBe(1);
-    expect(new Set(result.changedFiles).size).toBe(1);
-  });
-});
-
-describe('core codemod runner — a project codemod', () => {
-  it('counts every file it writes, and one change', async () => {
-    const result = await runCodemods(
-      [
-        {
-          version: '0.0.2',
-          transforms: [
-            {
-              name: 'project-plan',
-              meta: {title: 'project plan', codemodType: 'project'},
-              transform: async root => ({
-                writes: [
-                  {path: path.join(root, 'a.ts'), contents: 'a\n'},
-                  {path: path.join(root, 'b.ts'), contents: 'b\n'},
-                ],
-                deletes: [],
-                problems: [],
-              }),
-            },
-          ],
-        },
-      ],
-      {apply: true, path: dir, root: dir, codemod: undefined, skipCodemods: new Set(), silent: true},
-    );
-
-    expect(result.totalFilesChanged).toBe(2);
-    expect(result.totalTransformsApplied).toBe(1);
-  });
-});

package/assets/docs/tree/component-lookups.doc.mjs

@@ -1,149 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-/**
- * @file `astryx docs cli/component-lookups`: exact single and batch component
- * lookup through the CLI and programmatic API.
- */
-
-/** @type {import('@astryxdesign/cli/authoring').ReferenceDoc} */
-export const docs = {
-  type: 'generic',
-  name: 'component-lookups',
-  placement: {parent: 'namespace:cli', slot: 'guides', order: 5},
-  title: 'Looking up components',
-  category: 'guide',
-  description:
-    'Look up one or several exact component identities, choose a focused projection, and handle complete batch receipts.',
-  sections: [
-    {
-      id: 'several',
-      title: 'Look up several components',
-      category: 'guide',
-      content: [
-        {
-          type: 'prose',
-          text: '`astryx component` accepts exact selectors as a variadic positional argument. With no selector it browses the catalog. With one selector it keeps the normal single-component response. With two or more it prints one complete ordered batch receipt.',
-        },
-        {
-          type: 'code',
-          lang: 'bash',
-          label: 'Several component docs',
-          code: 'astryx component Button Badge Text\nastryx --json component Button Badge Text',
-        },
-        {
-          type: 'prose',
-          text: 'Every selector gets one row in input order. Duplicate selectors stay duplicate rows. A missing or ambiguous component does not hide successful neighbors or stop later selectors from resolving.',
-        },
-        {
-          type: 'prose',
-          text: 'A batch accepts at most 100 selectors, including duplicates, in every projection mode. A larger request returns a top-level `ERR_INVALID_ARGUMENT` before any component resolves. It emits no `component.batch` receipt and no partial results.',
-        },
-        {
-          type: 'prose',
-          text: 'Focused component controls apply to every found row. Use the same control you use for one component:',
-        },
-        {
-          type: 'code',
-          lang: 'bash',
-          label: 'Focused batch lookups',
-          code: 'astryx --json component Button Card --props\nastryx component Button Card --source\nastryx component Button Card --showcase\nastryx component Button Card --blocks\nastryx component Button Card --detail compact\nastryx component Button Card --lang dense\nastryx component Button Card --package @astryxdesign/core',
-        },
-      ],
-    },
-    {
-      id: 'selectors',
-      title: 'Selector forms',
-      category: 'reference',
-      content: [
-        {
-          type: 'prose',
-          text: 'A selector is an exact component identity, not free-text search. Use one of these forms:',
-        },
-        {
-          type: 'list',
-          style: 'unordered',
-          items: [
-            '`Button` for an unqualified component name.',
-            '`widgets/Button` for a component in an unscoped package.',
-            '`@acme/widgets/Button` for a component in a scoped package.',
-            '`@acme/widgets@1.2.3/Button` to require that exact installed package version.',
-          ],
-        },
-        {
-          type: 'prose',
-          text: 'A version qualifies the package, never the component. The lookup does not fall through to another installed version. An unqualified name owned by several installed packages is `ambiguous` and lists every candidate. Use a package-qualified selector or `--package` to choose one.',
-        },
-        {
-          type: 'prose',
-          text: '`astryx discover` remains free-text package discovery. Its words form one query; they are not component batch selectors.',
-        },
-      ],
-    },
-    {
-      id: 'output',
-      title: 'Batch output and exit status',
-      category: 'reference',
-      content: [
-        {
-          type: 'prose',
-          text: 'JSON uses `component.batch` with `{count, results}`. Each row echoes `selector` and has one status: `found`, `not_found`, `ambiguous`, or `error`. A found row carries the normal single-component `{type, data}` under `result`. Failed rows carry `code` and `error`, plus `suggestions` or `candidates` when available.',
-        },
-        {
-          type: 'code',
-          lang: 'bash',
-          label: 'Outcome and duplicate examples',
-          code: 'astryx --json component Button Badge                 # all found, exit 0\nastryx --json component Button MissingWidget         # mixed, exit 1\nastryx --json component MissingWidget MissingPanel   # all failed, exit 1\nastryx --json component Button Button                # two ordered rows, exit 0',
-        },
-        {
-          type: 'code',
-          lang: 'bash',
-          label: 'A complete failed JSON receipt',
-          code: 'astryx --json component MissingWidget MissingPanel',
-        },
-        {
-          type: 'code',
-          lang: 'json',
-          code: '{\n  "apiVersion": 1,\n  "type": "component.batch",\n  "data": {\n    "count": 2,\n    "results": [\n      {\n        "selector": "MissingWidget",\n        "status": "not_found",\n        "code": "ERR_UNKNOWN_COMPONENT",\n        "error": "No component named \\"MissingWidget\\""\n      },\n      {\n        "selector": "MissingPanel",\n        "status": "not_found",\n        "code": "ERR_UNKNOWN_COMPONENT",\n        "error": "No component named \\"MissingPanel\\""\n      }\n    ]\n  }\n}',
-        },
-        {
-          type: 'code',
-          lang: 'text',
-          label: 'The same receipt in text mode',
-          code: 'Component batch\n\ncount: 2\n\nResults\n\nMissingWidget\n\nselector: MissingWidget\nstatus:   not_found\ncode:     ERR_UNKNOWN_COMPONENT\nerror:    No component named "MissingWidget"\n\nMissingPanel\n\nselector: MissingPanel\nstatus:   not_found\ncode:     ERR_UNKNOWN_COMPONENT\nerror:    No component named "MissingPanel"',
-        },
-        {
-          type: 'prose',
-          text: 'The CLI emits every row first, then exits 1 when any row is not `found`. This includes mixed receipts and receipts where every row failed. JSON and text use the same exit status. A batch where every row is `found` exits 0.',
-        },
-      ],
-    },
-    {
-      id: 'api',
-      title: 'Programmatic API',
-      category: 'reference',
-      content: [
-        {
-          type: 'prose',
-          text: 'The argument shape chooses the response shape. Omit the argument for the catalog, pass a string for the existing single-component response, and pass an array for `component.batch`. An array always means batch, including empty and one-item arrays, so filtering a selector list cannot silently change the response type. The published `ComponentBatchResponse` specializes the shared `BatchResponse` and `BatchRow` types.',
-        },
-        {
-          type: 'code',
-          lang: 'javascript',
-          code: "import {component} from '@astryxdesign/cli/api';\n\nconst catalog = await component(); // component.list\nconst button = await component('Button'); // component.detail\nconst empty = await component([]); // component.batch, count 0\nconst oneRow = await component(['Button']); // component.batch, count 1\nconst batch = await component(['Button', 'Badge']); // component.batch, count 2\nawait component(Array(101).fill('Button')); // ERR_INVALID_ARGUMENT before lookup",
-        },
-        {
-          type: 'code',
-          lang: 'json',
-          label: 'Exact empty-array response',
-          code: '{\n  "type": "component.batch",\n  "data": {\n    "count": 0,\n    "results": []\n  }\n}',
-        },
-        {
-          type: 'code',
-          lang: 'javascript',
-          label: 'Handle every row without losing partial results',
-          code: "const receipt = await component(['Button', 'MissingWidget']);\n\nfor (const row of receipt.data.results) {\n  if (row.status === 'found') {\n    useComponentDoc(row.selector, row.result);\n  } else if (row.status === 'ambiguous') {\n    choosePackage(row.selector, row.candidates);\n  } else {\n    reportLookupFailure(row.selector, row.code, row.error);\n  }\n}",
-        },
-      ],
-    },
-  ],
-};

package/authoring/discover/discover.doc.d.mts

@@ -1,13 +0,0 @@
-// @generated by scripts/sync-api-types.mjs from the JSDoc in authoring/**/*.mjs.
-// DO NOT EDIT — run `pnpm sync:api-types` to regenerate.
-
-/**
- * @file SchemaDoc for DiscoverSource, the function `astryx discover` calls to
- * learn which integrations a project could add.
- * @input The DiscoverSource type and the catalog types beside it (`type.ts`),
- *   which `parse.mjs` validates.
- * @output The `discover-source` section of `astryx docs authoring`.
- * @position packages/cli/authoring/discover — schema documentation
- */
-/** @type {import('@astryxdesign/cli/authoring').SchemaDoc} */
-export const doc: import("@astryxdesign/cli/authoring").SchemaDoc;