@astryxdesign/cli 0.6.3 → 0.6.4-canary.10dd683

package/clients/cli/commands/discover.sources.test.mjs

@@ -0,0 +1,267 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * @file `astryx discover` with a discover source: the list, a package page, a
+ * search, and the refused option pair, driven through the real CLI against a
+ * hermetic project whose astryx.config sets `discover`. Saved copies go to a
+ * temp cache directory, never the project.
+ */
+
+import {describe, it, expect, beforeEach, afterEach} from 'vitest';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import * as os from 'node:os';
+import {runCli} from '../../../test-utils/run-cli.mjs';
+
+const CONFIG = `
+const packages = [
+  {
+    package: '@test/kit',
+    integration: 'test-kit',
+    aliases: [],
+    latest: '3.2.0',
+    versions: [
+      {version: '3.2.0', publishedAt: '2026-09-29T00:00:00.000Z', prerelease: false, status: 'ok'},
+      {version: '3.1.4', publishedAt: '2026-09-01T00:00:00.000Z', prerelease: false, status: 'ok'},
+    ],
+    contributions: [{kind: 'component', name: 'Dial'}],
+  },
+  {
+    package: '@test/charts',
+    integration: 'test-charts',
+    aliases: [],
+    latest: '2.0.0',
+    versions: [
+      {version: '2.1.0-beta.1', publishedAt: '2026-09-25T00:00:00.000Z', prerelease: true, status: 'ok'},
+      {version: '2.0.0', publishedAt: '2026-09-20T00:00:00.000Z', prerelease: false, status: 'ok'},
+    ],
+    contributions: [
+      {kind: 'component', name: 'Chart'},
+      {kind: 'template', name: 'pages/Report'},
+    ],
+  },
+  {
+    package: '@test/boards',
+    integration: 'test-boards',
+    aliases: [],
+    latest: '1.0.0',
+    versions: [
+      {version: '1.0.0', publishedAt: '2026-09-10T00:00:00.000Z', prerelease: false, status: 'ok'},
+    ],
+    contributions: [{kind: 'template', name: 'pages/DialBoard'}],
+  },
+];
+
+export default {
+  integrations: ['@test/kit'],
+  async discover({package: name}) {
+    return {
+      schemaVersion: 1,
+      source: {name: 'Test catalog', generatedAt: '2026-09-30T00:00:00.000Z', complete: true},
+      packages: packages.filter(p => name == null || p.package === name),
+    };
+  },
+};
+`;
+
+let tmpDir;
+let project;
+/** @type {Record<string, string | undefined>} */
+let savedEnv;
+
+beforeEach(() => {
+  tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'astryx-discover-sources-'));
+  project = path.join(tmpDir, 'project');
+  const pkgDir = path.join(project, 'node_modules', '@test', 'kit');
+  fs.mkdirSync(path.join(pkgDir, 'components'), {recursive: true});
+  fs.writeFileSync(
+    path.join(project, 'package.json'),
+    JSON.stringify({
+      name: 'proj',
+      version: '1.0.0',
+      dependencies: {'@test/kit': '3.1.4'},
+    }),
+  );
+  fs.writeFileSync(path.join(project, 'astryx.config.mjs'), CONFIG);
+  fs.writeFileSync(
+    path.join(pkgDir, 'package.json'),
+    JSON.stringify({name: '@test/kit', version: '3.1.4'}),
+  );
+  fs.writeFileSync(
+    path.join(pkgDir, 'astryx.integration.mjs'),
+    `export default {components: './components'};\n`,
+  );
+  fs.writeFileSync(
+    path.join(pkgDir, 'components', 'Dial.doc.mjs'),
+    `export const docs = {name: 'Dial', usage: {description: 'A dial.'}};\n`,
+  );
+  fs.writeFileSync(
+    path.join(pkgDir, 'components', 'Dial.tsx'),
+    `export function Dial() { return null; }\n`,
+  );
+  // The saved copy lives in the per-user cache; point it at the temp dir.
+  savedEnv = {
+    HOME: process.env.HOME,
+    XDG_CACHE_HOME: process.env.XDG_CACHE_HOME,
+    LOCALAPPDATA: process.env.LOCALAPPDATA,
+  };
+  process.env.HOME = path.join(tmpDir, 'home');
+  process.env.XDG_CACHE_HOME = path.join(tmpDir, 'cache');
+  process.env.LOCALAPPDATA = path.join(tmpDir, 'localappdata');
+});
+
+afterEach(() => {
+  for (const [key, value] of Object.entries(savedEnv)) {
+    if (value === undefined) delete process.env[key];
+    else process.env[key] = value;
+  }
+  fs.rmSync(tmpDir, {recursive: true, force: true});
+});
+
+/** The per-user cache directory this platform uses under the redirected env. */
+function userCacheDir() {
+  if (process.platform === 'win32') {
+    return path.join(tmpDir, 'localappdata', 'astryx', 'Cache');
+  }
+  if (process.platform === 'darwin') {
+    return path.join(tmpDir, 'home', 'Library', 'Caches', 'astryx');
+  }
+  return path.join(tmpDir, 'cache', 'astryx');
+}
+
+describe('astryx discover with a discover source', () => {
+  it('lists what the project has and what it could add, in --json', async () => {
+    const {status, stdout} = await runCli(['discover', '--json'], {
+      cwd: project,
+    });
+
+    expect(status).toBe(0);
+    const {data, meta} = JSON.parse(stdout);
+    expect(data).toEqual([
+      expect.objectContaining({
+        name: '@test/kit',
+        components: ['Dial'],
+        version: '3.1.4',
+        latest: '3.2.0',
+      }),
+    ]);
+    expect(meta.available).toEqual([
+      {
+        name: '@test/charts',
+        components: ['Chart'],
+        version: '2.0.0',
+        templates: ['pages/Report'],
+        source: 'Test catalog',
+      },
+      {
+        name: '@test/boards',
+        components: [],
+        version: '1.0.0',
+        templates: ['pages/DialBoard'],
+        source: 'Test catalog',
+      },
+    ]);
+    expect(meta.sources).toEqual([
+      expect.objectContaining({
+        name: 'Test catalog',
+        from: 'astryx.config',
+        status: 'fresh',
+      }),
+    ]);
+  });
+
+  it('prints both sides as records', async () => {
+    const {status, stdout} = await runCli(['discover'], {cwd: project});
+
+    expect(status).toBe(0);
+    expect(stdout).toMatch(/^Installed$/m);
+    expect(stdout).toMatch(/^Available$/m);
+    expect(stdout).toMatch(/^name:\s+@test\/charts$/m);
+    expect(stdout).toMatch(/^latest:\s+3\.2\.0$/m);
+  });
+
+  it('shows a package it does not have with its releases and the command that adds it, and never runs it', async () => {
+    const {status, stdout} = await runCli(['discover', '@test/charts'], {
+      cwd: project,
+    });
+
+    expect(status).toBe(0);
+    expect(stdout).toMatch(/^installed:\s+false$/m);
+    expect(stdout).toContain('- 2.0.0  2026-09-20  latest');
+    expect(stdout).not.toContain('2.1.0-beta.1  ');
+    expect(stdout).toContain('1 prerelease is not listed.');
+    // The verb follows the detected package manager.
+    expect(stdout).toMatch(
+      /^(npm install|pnpm add|yarn add|bun add) @test\/charts$/m,
+    );
+    expect(
+      fs.existsSync(path.join(project, 'node_modules', '@test', 'charts')),
+    ).toBe(false);
+  });
+
+  it('says which item is missing from a package only a source lists', async () => {
+    const {status, stdout} = await runCli(
+      ['discover', '@test/charts/Nope', '--json'],
+      {cwd: project},
+    );
+
+    expect(status).toBe(1);
+    const {code, error} = JSON.parse(stdout);
+    expect(code).toBe('ERR_UNKNOWN_COMPONENT');
+    expect(error).toBe('"Nope" not found in @test/charts');
+  });
+
+  it('searches every kind in every source', async () => {
+    const {status, stdout} = await runCli(['discover', 'report', '--json'], {
+      cwd: project,
+    });
+
+    expect(status).toBe(0);
+    expect(JSON.parse(stdout).data.matches).toEqual([
+      {
+        package: '@test/charts',
+        component: 'pages/Report',
+        kind: 'template',
+        installed: false,
+      },
+    ]);
+  });
+
+  it('refuses --installed with --available', async () => {
+    const {status, stdout} = await runCli(
+      ['discover', '--installed', '--available', '--json'],
+      {cwd: project},
+    );
+
+    expect(status).toBe(1);
+    expect(JSON.parse(stdout).code).toBe('ERR_INVALID_OPTION');
+  });
+
+  it('lists every match for a free-text query, even an exact component name, and opens one by its package path', async () => {
+    const exact = await runCli(['discover', 'Dial', '--json'], {cwd: project});
+    const {type, data} = JSON.parse(exact.stdout);
+    expect(type).toBe('discover.search');
+    expect(data.matches.map(m => [m.component, m.installed])).toEqual([
+      ['Dial', true],
+      ['pages/DialBoard', false],
+    ]);
+
+    const opened = await runCli(['discover', '@test/kit/Dial', '--json'], {
+      cwd: project,
+    });
+    expect(JSON.parse(opened.stdout).type).toBe('discover.detail.doc');
+  });
+
+  it('saves the answer in the user cache and writes nothing into the project', async () => {
+    const before = fs.readdirSync(project).sort();
+    await runCli(['discover', '--json'], {cwd: project});
+
+    expect(fs.readdirSync(project).sort()).toEqual(before);
+    expect(fs.existsSync(path.join(project, 'node_modules', '.cache'))).toBe(
+      false,
+    );
+    expect(fs.readdirSync(path.join(userCacheDir(), 'discover'))).toHaveLength(
+      1,
+    );
+  });
+});

package/clients/cli/commands/discover.text-projection.test.mjs

@@ -0,0 +1,103 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * @file `astryx discover` text output projects every field of its JSON entry.
+ *
+ * The text views of `discover.list` and `discover.detail` are renderings of the
+ * same entries `--json` returns, so each entry key must appear as a `key:` line
+ * carrying the same value.
+ */
+
+import {describe, it, expect, beforeEach, afterEach} from 'vitest';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import * as os from 'node:os';
+import {runCli} from '../../../test-utils/run-cli.mjs';
+
+let tmpDir;
+let project;
+
+beforeEach(() => {
+  tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'astryx-discover-text-'));
+  project = path.join(tmpDir, 'project');
+  const pkgDir = path.join(project, 'node_modules', '@test', 'kit');
+  fs.mkdirSync(path.join(pkgDir, 'components'), {recursive: true});
+  fs.writeFileSync(
+    path.join(project, 'package.json'),
+    JSON.stringify({name: 'proj', version: '1.0.0'}),
+  );
+  fs.writeFileSync(
+    path.join(project, 'astryx.config.mjs'),
+    `export default {integrations: ['@test/kit']};\n`,
+  );
+  fs.writeFileSync(
+    path.join(pkgDir, 'package.json'),
+    JSON.stringify({name: '@test/kit', version: '3.1.4'}),
+  );
+  fs.writeFileSync(
+    path.join(pkgDir, 'astryx.integration.mjs'),
+    `export default {components: './components'};\n`,
+  );
+  for (const name of ['Dial', 'Gauge']) {
+    fs.writeFileSync(
+      path.join(pkgDir, 'components', `${name}.doc.mjs`),
+      `export const docs = {name: '${name}', usage: {description: 'A ${name}.'}};\n`,
+    );
+    fs.writeFileSync(
+      path.join(pkgDir, 'components', `${name}.tsx`),
+      `export function ${name}() { return null; }\n`,
+    );
+  }
+});
+
+afterEach(() => {
+  fs.rmSync(tmpDir, {recursive: true, force: true});
+});
+
+/**
+ * @param {Record<string, unknown>} entry
+ * @param {string} text
+ */
+function expectEveryField(entry, text) {
+  const lines = text.split('\n');
+  for (const [key, value] of Object.entries(entry)) {
+    const rendered = Array.isArray(value) ? value.join(', ') : String(value);
+    expect(lines).toContainEqual(
+      expect.stringMatching(new RegExp(`^${key}:\\s+${escape(rendered)}$`)),
+    );
+  }
+}
+
+/** @param {string} s */
+function escape(s) {
+  return s.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+
+describe('astryx discover text output', () => {
+  it('lists every field of each discover.list entry', async () => {
+    const asJson = await runCli(['discover', '--json'], {cwd: project});
+    const [entry] = JSON.parse(asJson.stdout).data;
+    expect(Object.keys(entry)).toEqual(
+      expect.arrayContaining(['name', 'category', 'components', 'version']),
+    );
+
+    const {status, stdout} = await runCli(['discover'], {cwd: project});
+
+    expect(status).toBe(0);
+    expectEveryField(entry, stdout);
+  });
+
+  it('shows every field of the discover.detail entry', async () => {
+    const asJson = await runCli(['discover', '@test/kit', '--json'], {
+      cwd: project,
+    });
+    const {data} = JSON.parse(asJson.stdout);
+
+    const {status, stdout} = await runCli(['discover', '@test/kit'], {
+      cwd: project,
+    });
+
+    expect(status).toBe(0);
+    expectEveryField(data, stdout);
+  });
+});

package/clients/cli/commands/docs.doc.mjs

@@ -12,26 +12,48 @@ export const doc = {
   type: 'command',
   name: 'docs',
   displayName: 'astryx docs',
-  namespace: 'cli',
+  namespace: 'cli/commands',
   summary: 'Print reference docs',
   description:
-    'Reads the reference docs: with no topic it lists every topic; a topic prints that ' +
-    'full doc; a topic plus a section returns the first section whose title contains the ' +
-    '(case-insensitive) query.',
+    'Reads the reference docs one level at a time: with no topic it lists every topic; a ' +
+    'topic lists its sections, each with the key to read it by (a topic with one section ' +
+    'prints whole); a topic plus a section prints that section; `--full` prints the whole ' +
+    'topic, as does `--dense`. With `--json`, a topic returns its whole doc, as docs() ' +
+    'does, and `--index` its section index. A route ' +
+    'opens a node of the docs tree: `cli` lists its guides and reference, ' +
+    '`cli/api/functions` lists every API function, and `cli/api/functions/search` prints ' +
+    'one.',
   fn: 'docs',
   args: [
     {name: 'topic', param: 'topic', required: false},
     {name: 'section', param: 'section', required: false},
   ],
+  options: [
+    {
+      flag: '--index',
+      param: 'options.index',
+      description: "List the topic's sections and their keys, even for a topic with one section",
+    },
+    {
+      flag: '--full',
+      description:
+        'Print the whole topic instead of its sections (text; `--json` returns the whole topic unless --index). Cannot be set with --index',
+    },
+  ],
   examples: [
     {label: 'List topics', cli: 'astryx docs'},
-    {label: 'One topic as JSON', cli: 'astryx docs spacing --json'},
+    {label: "A topic's sections", cli: 'astryx docs theme'},
+    {label: 'A whole topic as JSON', cli: 'astryx docs spacing --json'},
+    {label: 'One section', cli: 'astryx docs theme quick-start'},
+    {label: 'The CLI docs tree', cli: 'astryx docs cli'},
+    {label: 'One API function', cli: 'astryx docs cli/api/functions/search'},
+    {label: 'A whole guide', cli: 'astryx docs cli/integrations --full'},
   ],
   exitCodes: [
     {code: 0, when: 'success'},
     {
       code: 1,
-      when: 'unknown topic, or a section that matches no title in the topic',
+      when: 'unknown topic or route, or a section that matches no section or more than one',
     },
   ],
   related: ['search', 'component', 'hook', 'template'],