@astryxdesign/cli 0.1.2 → 0.1.3

package/src/commands/swizzle-gap-safety.test.mjs

@@ -1,273 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-/**
- * End-to-end safety tests for `astryx swizzle --gap` and `xds gap-report`.
- *
- * Critical: these tests must NEVER actually invoke `gh issue create`. We
- * defend in depth:
- *
- *   1. We spawn the CLI in a non-TTY pipe → triggers the dry-run gate.
- *   2. We set ASTRYX_GAP_REPORT=off as an extra belt-and-suspenders for tests
- *      that would otherwise risk filing.
- *   3. We unset GH_TOKEN so that any unexpected `gh` invocation fails fast.
- *   4. We put a sabotaged `gh` shim earlier on PATH that blocks real
- *      `gh issue create` calls and writes a marker file. Any successful
- *      "filing" path leaves a marker we can assert against — so a regression
- *      is detected even if the gate silently breaks.
- *
- * Regression cases for issues #2370 and #2371: real gap-report issues filed
- * unintentionally during a verification run because the non-interactive path
- * called `gh issue create` with no confirmation.
- */
-
-import {describe, it, expect, beforeAll, afterAll, beforeEach, afterEach} from 'vitest';
-import {spawnSync} from 'node:child_process';
-import * as fs from 'node:fs';
-import * as os from 'node:os';
-import * as path from 'node:path';
-import {fileURLToPath} from 'node:url';
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const cliBin = path.resolve(__dirname, '../../bin/astryx.mjs');
-const repoRoot = path.resolve(__dirname, '../../../..');
-
-let shimDir;
-let markerFile;
-let baseEnv;
-
-beforeAll(() => {
-  shimDir = fs.mkdtempSync(path.join(os.tmpdir(), 'astryx-gh-shim-'));
-  markerFile = path.join(shimDir, 'gh-issue-create-was-called.marker');
-
-  // Sabotaged `gh` shim. Records ONLY `gh issue create` invocations to the
-  // marker file, since that's the only command we want to detect as a
-  // "would-have-filed" event. Other subcommands (auth status, label create)
-  // succeed silently so they don't break the gh availability check or the
-  // label-ensure path.
-  const shim = `#!/usr/bin/env node
-import * as fs from 'node:fs';
-const args = process.argv.slice(2);
-const isIssueCreate = args[0] === 'issue' && args[1] === 'create';
-if (isIssueCreate) {
-  fs.appendFileSync(${JSON.stringify(markerFile)}, JSON.stringify(args) + '\\n');
-  process.stderr.write('TEST GUARD: real gh issue create blocked\\n');
-  process.exit(1);
-}
-// Other commands (auth status, label create) succeed silently.
-process.exit(0);
-`;
-  fs.writeFileSync(path.join(shimDir, 'gh'), shim);
-  fs.chmodSync(path.join(shimDir, 'gh'), 0o755);
-
-  baseEnv = {
-    ...process.env,
-    PATH: `${shimDir}:${process.env.PATH}`,
-    // Belt-and-suspenders: even if a gate breaks, this disables the feature.
-    // For tests that need the feature on, individual cases override this.
-    GH_TOKEN: '',
-  };
-});
-
-afterAll(() => {
-  fs.rmSync(shimDir, {recursive: true, force: true});
-});
-
-function runXds(args, {env = {}, cwd = repoRoot} = {}) {
-  // Reset marker for each run.
-  if (fs.existsSync(markerFile)) fs.unlinkSync(markerFile);
-  const result = spawnSync('node', [cliBin, ...args], {
-    cwd,
-    env: {...baseEnv, ...env},
-    encoding: 'utf-8',
-  });
-  return {
-    ...result,
-    // True iff the CLI tried to call `gh issue create` — the actual filing
-    // operation. Other gh subcommands (auth status, label create) are
-    // ignored as benign.
-    ghWasCalled: fs.existsSync(markerFile),
-    ghCallArgs: fs.existsSync(markerFile)
-      ? fs.readFileSync(markerFile, 'utf-8')
-      : null,
-  };
-}
-
-describe('gap-report: dry-run by default in non-interactive mode', () => {
-  it('non-TTY pipe with all required flags → dry-run, exit 0, no gh call', () => {
-    const r = runXds([
-      'gap-report',
-      '--component',
-      'Button',
-      '--category',
-      'missing_variant',
-      '--reason',
-      'Test that we never file in non-interactive mode',
-    ]);
-    expect(r.status).toBe(0);
-    expect(r.ghWasCalled).toBe(false);
-    expect(r.stdout).toMatch(/dry-run/i);
-    expect(r.stdout).toMatch(/Re-run with --commit/i);
-    // Preview should include the title we'd file.
-    expect(r.stdout).toContain('Button');
-  });
-
-  it('--json mode in non-TTY → structured dry-run JSON, no gh call', () => {
-    const r = runXds([
-      '--json',
-      'gap-report',
-      '--component',
-      'Button',
-      '--category',
-      'missing_variant',
-      '--reason',
-      'JSON dry-run',
-    ]);
-    expect(r.status).toBe(0);
-    expect(r.ghWasCalled).toBe(false);
-    // jsonOut pretty-prints across multiple lines; parse the whole stdout
-    // as JSON (after stripping any trailing whitespace).
-    const parsed = JSON.parse(r.stdout.trim());
-    expect(parsed.type).toBe('gap-report.dryRun');
-    expect(parsed.data.dryRun).toBe(true);
-    expect(parsed.data.title).toContain('Button');
-    expect(parsed.data.wouldFile).toBe(true);
-  });
-
-  it('ASTRYX_GAP_REPORT=off → no gh call, even with --commit flag', () => {
-    const r = runXds(
-      [
-        'gap-report',
-        '--component',
-        'Button',
-        '--category',
-        'other',
-        '--reason',
-        'should be disabled',
-        '--commit',
-      ],
-      {env: {ASTRYX_GAP_REPORT: 'off'}},
-    );
-    // Should exit 0 with a "disabled" message; never calls gh.
-    expect(r.ghWasCalled).toBe(false);
-    expect(r.status).toBe(0);
-    expect(r.stdout + r.stderr).toMatch(/disabled/i);
-  });
-
-  it('--commit in non-TTY mode WOULD invoke gh (verified via shim)', () => {
-    // This proves --commit actually engages the file path. Our shim exits 1
-    // so the CLI will report failure, but the marker proves gh was invoked
-    // with the expected args.
-    const r = runXds(
-      [
-        'gap-report',
-        '--component',
-        'Button',
-        '--category',
-        'other',
-        '--reason',
-        'commit flag should engage filing',
-        '--commit',
-      ],
-      {env: {ASTRYX_GAP_REPORT: ''}}, // re-enable feature; shim will block real call
-    );
-    expect(r.ghWasCalled).toBe(true);
-    expect(r.ghCallArgs).toContain('issue');
-    expect(r.ghCallArgs).toContain('create');
-    expect(r.ghCallArgs).toContain('facebookexperimental/xds');
-  });
-});
-
-describe('swizzle --gap respects safety gates', () => {
-  // swizzle's --output is path-safety guarded: absolute paths and `..`
-  // traversal are rejected (see swizzle.path-safety.test.mjs). These gap
-  // tests only care about the gh-call / status gates, so they write into a
-  // *relative* output dir created under the repo root (a valid, in-root
-  // target) and clean it up afterward. The CLI still resolves @astryxdesign/core via
-  // findCoreDir walking up from the cwd.
-  let swizzleOutDir;
-  beforeEach(() => {
-    swizzleOutDir = fs.mkdtempSync(path.join(repoRoot, '.xds-swizzle-gap-test-'));
-  });
-  afterEach(() => {
-    if (swizzleOutDir) fs.rmSync(swizzleOutDir, {recursive: true, force: true});
-  });
-  // Relative path into the temp dir, so it passes the path-safety guard
-  // (cwd === repoRoot for runXds by default).
-  const relOut = () => path.relative(repoRoot, swizzleOutDir);
-
-  it('swizzle --gap in non-TTY → dry-run, no gh call', () => {
-    const r = runXds([
-      'swizzle',
-      'Button',
-      '--output',
-      relOut(),
-      '--gap',
-      'Need a compact variant',
-      '--gap-category',
-      'missing_variant',
-    ]);
-    expect(r.ghWasCalled).toBe(false);
-    expect(r.status).toBe(0);
-    expect(r.stdout).toMatch(/dry-run/i);
-  });
-
-  it('swizzle --gap --no-report → never engages gap reporting at all', () => {
-    const r = runXds([
-      'swizzle',
-      'Button',
-      '--output',
-      relOut(),
-      '--gap',
-      'Should be suppressed entirely',
-      '--gap-category',
-      'missing_variant',
-      '--no-report',
-    ]);
-    expect(r.ghWasCalled).toBe(false);
-    expect(r.status).toBe(0);
-    // Should not even show a dry-run preview — reporting is suppressed.
-    expect(r.stdout).toMatch(/suppressed/i);
-    expect(r.stdout).not.toMatch(/Would file GitHub issue/i);
-  });
-
-  it('swizzle --gap --no-report --commit → STILL no gh call (no-report wins)', () => {
-    // Critical regression test: --no-report must beat --commit for the
-    // --gap auto-file path. Otherwise CI scripts could file issues.
-    const r = runXds(
-      [
-        'swizzle',
-        'Button',
-        '--output',
-        relOut(),
-        '--gap',
-        'should never file',
-        '--gap-category',
-        'other',
-        '--no-report',
-        '--commit',
-      ],
-      {env: {ASTRYX_GAP_REPORT: ''}},
-    );
-    expect(r.ghWasCalled).toBe(false);
-    expect(r.status).toBe(0);
-  });
-
-  it('swizzle --gap with ASTRYX_GAP_REPORT=off → no gh call', () => {
-    const r = runXds(
-      [
-        'swizzle',
-        'Button',
-        '--output',
-        relOut(),
-        '--gap',
-        'should be disabled by env',
-        '--gap-category',
-        'other',
-        '--commit',
-      ],
-      {env: {ASTRYX_GAP_REPORT: 'off'}},
-    );
-    expect(r.ghWasCalled).toBe(false);
-    expect(r.status).toBe(0);
-  });
-});

package/src/lib/config.mjs

@@ -1,113 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-/**
- * @file Config loader — reads astryx.config.mjs from project root
- *
- * Walks up from cwd looking for astryx.config.mjs.
- * Returns the config object or defaults if not found.
- */
-
-import * as fs from 'node:fs';
-import * as path from 'node:path';
-import {pathToFileURL} from 'node:url';
-import {loadIntegrations} from './integrations.mjs';
-import {validateConfig} from './config-schema.mjs';
-
-const DEFAULTS = {
-  packages: [],
-  integrations: [],
-};
-
-/**
- * Find astryx.config.mjs by walking up from startDir.
- * Returns the absolute path or null.
- */
-export function findConfigPath(startDir = process.cwd()) {
-  let dir = startDir;
-  for (let i = 0; i < 10; i++) {
-    const candidate = path.join(dir, 'astryx.config.mjs');
-    if (fs.existsSync(candidate)) return candidate;
-    const parent = path.dirname(dir);
-    if (parent === dir) break;
-    dir = parent;
-  }
-  return null;
-}
-
-/**
- * Load and return the config from astryx.config.mjs.
- * Returns defaults if no config file is found.
- */
-export async function loadConfig(startDir = process.cwd()) {
-  const configPath = findConfigPath(startDir);
-  if (!configPath) return {...DEFAULTS};
-
-  let rawConfig;
-  try {
-    const mod = await import(pathToFileURL(configPath).href);
-    rawConfig = mod.default || {};
-  } catch {
-    return {...DEFAULTS};
-  }
-
-  const config = validateConfig(rawConfig);
-  const configDir = path.dirname(configPath);
-  const integrationSpecs = normalizeIntegrations(config.integrations);
-  const loadedIntegrations = await loadIntegrations(integrationSpecs, {
-    cwd: configDir,
-  });
-  return {
-    ...DEFAULTS,
-    ...config,
-    packages: normalizePackages(config.packages, configDir),
-    integrations: integrationSpecs,
-    loadedIntegrations,
-    gapReport:
-      config.gapReport ?? firstDefined(loadedIntegrations, 'gapReport'),
-    template: mergeTemplateConfig(config.template, loadedIntegrations),
-  };
-}
-
-/**
- * Normalize packages to an array of unique absolute paths.
- * Filters out empty strings and non-string values.
- * Relative paths resolved from config file directory.
- * Deduplicates by resolved path.
- */
-function normalizePackages(packages, configDir) {
-  if (!packages) return [];
-  const arr = Array.isArray(packages) ? packages : [packages];
-  const seen = new Set();
-  const result = [];
-  for (const p of arr) {
-    if (typeof p !== 'string' || p === '') continue;
-    const resolved = path.isAbsolute(p) ? p : path.resolve(configDir, p);
-    if (seen.has(resolved)) continue;
-    seen.add(resolved);
-    result.push(resolved);
-  }
-  return result;
-}
-
-/**
- * Normalize integration specs to a string array. Integrations are package names
- * or manifest paths consumed by `astryx upgrade --integration`.
- */
-function normalizeIntegrations(integrations) {
-  if (!integrations) return [];
-  const arr = Array.isArray(integrations) ? integrations : [integrations];
-  return arr.filter(value => typeof value === 'string' && value !== '');
-}
-
-function firstDefined(integrations, key) {
-  for (const integration of integrations) {
-    if (integration[key] !== undefined) return integration[key];
-  }
-  return undefined;
-}
-
-function mergeTemplateConfig(template, integrations) {
-  if (template?.get) return template;
-  const integrationTemplate = firstDefined(integrations, 'template');
-  return integrationTemplate ?? template;
-}

package/src/lib/config.test.mjs

@@ -1,91 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-import {afterEach, beforeEach, describe, expect, it} from 'vitest';
-import * as fs from 'node:fs';
-import * as path from 'node:path';
-import {loadConfig} from './config.mjs';
-
-let tmpDir;
-
-beforeEach(() => {
-  tmpDir = fs.mkdtempSync(path.join(process.cwd(), '.astryx-config-test-'));
-});
-
-afterEach(() => {
-  fs.rmSync(tmpDir, {recursive: true, force: true});
-});
-
-function installIntegrationPackage(dir, name = '@nest/xds-meta') {
-  const packageDir = path.join(dir, 'node_modules', ...name.split('/'));
-  fs.mkdirSync(packageDir, {recursive: true});
-  fs.writeFileSync(
-    path.join(packageDir, 'package.json'),
-    JSON.stringify({name, astryx: {integration: './astryx.integration.mjs'}}),
-  );
-  fs.writeFileSync(
-    path.join(packageDir, 'astryx.integration.mjs'),
-    `export default { name: '${name}' };
-`,
-  );
-}
-
-describe('loadConfig', () => {
-  it('normalizes integrations from astryx.config.mjs', async () => {
-    const dir = path.join(tmpDir, 'one');
-    fs.mkdirSync(dir);
-    installIntegrationPackage(dir);
-    fs.writeFileSync(
-      path.join(dir, 'astryx.config.mjs'),
-      `export default { integrations: '@nest/xds-meta' };\n`,
-    );
-    await expect(loadConfig(dir)).resolves.toMatchObject({
-      integrations: ['@nest/xds-meta'],
-    });
-  });
-
-  it('rejects invalid integration package manifests', async () => {
-    const dir = path.join(tmpDir, 'bad');
-    fs.mkdirSync(dir);
-    const packageDir = path.join(dir, 'node_modules', '@bad', 'widgets');
-    fs.mkdirSync(packageDir, {recursive: true});
-    fs.writeFileSync(
-      path.join(dir, 'astryx.config.mjs'),
-      `export default { integrations: '@bad/widgets' };\n`,
-    );
-    fs.writeFileSync(
-      path.join(packageDir, 'package.json'),
-      JSON.stringify({
-        name: '@bad/widgets',
-        astryx: {integration: './astryx.integration.mjs'},
-      }),
-    );
-    fs.writeFileSync(
-      path.join(packageDir, 'astryx.integration.mjs'),
-      `export default { docs: './docs' };\n`,
-    );
-    await expect(loadConfig(dir)).rejects.toThrow(/name/);
-  });
-
-  it('normalizes integration arrays', async () => {
-    const dir = path.join(tmpDir, 'two');
-    fs.mkdirSync(dir);
-    installIntegrationPackage(dir);
-    fs.writeFileSync(
-      path.join(dir, 'astryx.config.mjs'),
-      `export default { integrations: ['@nest/xds-meta', ''] };\n`,
-    );
-    await expect(loadConfig(dir)).resolves.toMatchObject({
-      integrations: ['@nest/xds-meta'],
-    });
-  });
-
-  it('rejects invalid config shapes', async () => {
-    const dir = path.join(tmpDir, 'invalid');
-    fs.mkdirSync(dir);
-    fs.writeFileSync(
-      path.join(dir, 'astryx.config.mjs'),
-      `export default { integrations: [42] };\n`,
-    );
-    await expect(loadConfig(dir)).rejects.toThrow(/integrations/);
-  });
-});

package/src/types/gap-report.d.ts

@@ -1,29 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-/**
- * Gap-report command JSON responses.
- *
- * Invocation                                               -> type discriminator
- * ------------------------------------------------------------------
- * xds --json gap-report --list-categories                 -> gap-report.categories
- * xds --json gap-report --component X --category Y --reason Z -> gap-report.file
- * (invalid category)                                      -> CLIError
- * (interactive mode)                                      -> CLIUnsupportedError (fallback)
- */
-
-/** xds --json gap-report --list-categories */
-export interface GapReportCategoriesResponse {
-  type: 'gap-report.categories';
-  data: GapReportCategoryEntry[];
-}
-
-export interface GapReportCategoryEntry {
-  value: string;
-  label: string;
-}
-
-/** xds --json gap-report --component X --category Y --reason Z */
-export interface GapReportFileResponse {
-  type: 'gap-report.file';
-  data: {filed: boolean; url: string | null};
-}

package/templates/blocks/components/TreeListBranches/TreeListBranchesShowcase.doc.mjs

@@ -1,14 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-/** @type {import('../../../../../core/src/docs-types').TemplateDoc} */
-export const doc = {
-  type: 'block',
-  exampleFor: 'TreeListBranches',
-  name: 'TreeListBranches',
-  displayName: 'Tree List Branches',
-  description: 'Tree with expandable branches at multiple nesting levels.',
-  isReady: true,
-  isShowcase: true,
-  aspectRatio: 4 / 3,
-  componentsUsed: ['TreeList'],
-};

package/templates/blocks/components/TreeListBranches/TreeListBranchesShowcase.tsx

@@ -1,64 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-'use client';
-
-import {TreeList} from '@astryxdesign/core/TreeList';
-
-const noop = () => {};
-
-export default function TreeListBranchesShowcase() {
-  return (
-    <TreeList
-      items={[
-        {
-          id: 'design-system',
-          label: 'Design System',
-          isExpanded: true,
-          children: [
-            {
-              id: 'components',
-              label: 'Components',
-              isExpanded: true,
-              children: [
-                {
-                  id: 'inputs',
-                  label: 'Inputs',
-                  children: [
-                    {id: 'text-input', label: 'TextInput', onClick: noop},
-                    {id: 'checkbox', label: 'Checkbox', onClick: noop},
-                    {id: 'selector', label: 'Selector', onClick: noop},
-                  ],
-                },
-                {
-                  id: 'layout',
-                  label: 'Layout',
-                  children: [
-                    {id: 'stack', label: 'Stack', onClick: noop},
-                    {id: 'grid', label: 'Grid', onClick: noop},
-                  ],
-                },
-              ],
-            },
-            {
-              id: 'tokens',
-              label: 'Tokens',
-              children: [
-                {id: 'colors', label: 'Colors', onClick: noop},
-                {id: 'spacing', label: 'Spacing', onClick: noop},
-                {id: 'typography', label: 'Typography', onClick: noop},
-              ],
-            },
-          ],
-        },
-        {
-          id: 'utilities',
-          label: 'Utilities',
-          children: [
-            {id: 'hooks', label: 'Hooks', onClick: noop},
-            {id: 'helpers', label: 'Helpers', onClick: noop},
-          ],
-        },
-      ]}
-    />
-  );
-}

package/templates/blocks/components/TreeListItem/TreeListItemShowcase.doc.mjs

@@ -1,14 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-/** @type {import('../../../../../core/src/docs-types').TemplateDoc} */
-export const doc = {
-  type: 'block',
-  exampleFor: 'TreeListItem',
-  name: 'TreeListItem',
-  displayName: 'Tree List Item',
-  description: 'Tree items with descriptions, icons, badges, selection, disabled state, and nested expand/collapse. TreeList is data-driven: no composed children API.',
-  isReady: true,
-  isShowcase: true,
-  aspectRatio: 4 / 3,
-  componentsUsed: ['TreeList', 'Badge', 'Icon', 'Layout', 'Text'],
-};

package/templates/blocks/components/TreeListItem/TreeListItemShowcase.tsx

@@ -1,60 +0,0 @@
-// Copyright (c) Meta Platforms, Inc. and affiliates.
-
-'use client';
-
-import {TreeList} from '@astryxdesign/core/TreeList';
-import {Badge} from '@astryxdesign/core/Badge';
-import {Icon} from '@astryxdesign/core/Icon';
-
-const noop = () => {};
-
-export default function TreeListItemShowcase() {
-  return (
-    <TreeList
-      style={{width: 400}}
-      items={[
-        {
-          id: 'inbox',
-          label: 'Inbox',
-          description: '12 unread messages',
-          isExpanded: true,
-          startContent: <Icon icon="info" size="sm" />,
-          endContent: <Badge label="12" variant="info" />,
-          children: [
-            {
-              id: 'primary',
-              label: 'Primary',
-              isSelected: true,
-              startContent: <Icon icon="check" size="sm" />,
-              onClick: noop,
-            },
-            {
-              id: 'updates',
-              label: 'Updates',
-              endContent: <Badge label="4" variant="info" />,
-              onClick: noop,
-            },
-          ],
-        },
-        {
-          id: 'drafts',
-          label: 'Drafts',
-          description: '3 draft messages',
-          startContent: <Icon icon="clock" size="sm" />,
-          onClick: noop,
-        },
-        {
-          id: 'archive',
-          label: 'Archive',
-          onClick: noop,
-        },
-        {
-          id: 'spam',
-          label: 'Spam',
-          isDisabled: true,
-          startContent: <Icon icon="warning" size="sm" />,
-        },
-      ]}
-    />
-  );
-}