@astryxdesign/cli 0.1.0 → 0.1.1-canary.129bf0e

package/src/codemods/transforms/v0.1.0/__tests__/migrate-xds-config-surfaces.test.mjs

@@ -0,0 +1,116 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+import {describe, it, expect} from 'vitest';
+
+async function applyConfigCodemod(files) {
+  const {default: transform} =
+    await import('../migrate-xds-config-surfaces.mjs');
+  const config = {
+    packageJson: files['package.json']
+      ? {path: 'package.json', source: files['package.json']}
+      : null,
+    astryxConfig: files['astryx.config.mjs']
+      ? {path: 'astryx.config.mjs', source: files['astryx.config.mjs']}
+      : null,
+    xdsConfig: files['xds.config.mjs']
+      ? {path: 'xds.config.mjs', source: files['xds.config.mjs']}
+      : null,
+  };
+  return transform({path: process.cwd(), source: ''}, {config});
+}
+
+describe('migrate-xds-config-surfaces', () => {
+  it('extracts package.json xds config into astryx.config.mjs and removes the package key in place', async () => {
+    const input = `{
+    "dependencies": {"@xds/core":"^0.0.15"},
+    "xds"  : {"theme":"neutral","docs":"./src"}
+}
+`;
+
+    const result = await applyConfigCodemod({'package.json': input});
+    expect(result.errors ?? []).toEqual([]);
+    expect(result.changes).toEqual([
+      {
+        path: 'package.json',
+        source: `{
+    "dependencies": {"@xds/core":"^0.0.15"}
+}
+`,
+      },
+      {
+        path: 'astryx.config.mjs',
+        source: `export default {
+  "theme": "neutral",
+  "docs": "./src"
+};
+`,
+      },
+    ]);
+  });
+
+  it('extracts package.json astryx config into astryx.config.mjs too', async () => {
+    const result = await applyConfigCodemod({
+      'package.json': `{"astryx":{"theme":"neutral"}}\n`,
+    });
+    expect(result.changes).toEqual([
+      {path: 'package.json', source: `{}\n`},
+      {
+        path: 'astryx.config.mjs',
+        source: `export default {
+  "theme": "neutral"
+};
+`,
+      },
+    ]);
+  });
+
+  it('bails when package.json contains both xds and astryx config keys', async () => {
+    const result = await applyConfigCodemod({
+      'package.json': `{"xds":{"theme":"default"},"astryx":{"theme":"neutral"}}\n`,
+    });
+    expect(result.errors?.[0]?.error).toMatch(/both xds and astryx/);
+  });
+
+  it('does not rewrite dependency keys in package.json', async () => {
+    const input = `{"dependencies":{"@xds/core":"^0.0.15"}}\n`;
+    const result = await applyConfigCodemod({'package.json': input});
+    expect(result.changes).toEqual([]);
+  });
+
+  it('bails when package config and astryx.config.mjs both exist', async () => {
+    const result = await applyConfigCodemod({
+      'package.json': `{"xds":{"theme":"neutral"}}\n`,
+      'astryx.config.mjs': `export default {};\n`,
+    });
+    expect(result.errors?.[0]?.error).toMatch(/migrate the config manually/);
+  });
+
+  it('bails when package config and xds.config.mjs both exist', async () => {
+    const result = await applyConfigCodemod({
+      'package.json': `{"xds":{"theme":"neutral"}}\n`,
+      'xds.config.mjs': `export default {};\n`,
+    });
+    expect(result.errors?.[0]?.error).toMatch(/migrate the config manually/);
+  });
+
+  it('renames xds.config.mjs to astryx.config.mjs when no package config exists', async () => {
+    const result = await applyConfigCodemod({
+      'xds.config.mjs': "export default { theme: 'neutral' };\n",
+    });
+    expect(result.changes).toEqual([
+      {
+        path: 'astryx.config.mjs',
+        source: "export default { theme: 'neutral' };\n",
+      },
+      {path: 'xds.config.mjs', delete: true},
+    ]);
+  });
+
+  it('bails when xds.config.mjs and astryx.config.mjs both exist', async () => {
+    const result = await applyConfigCodemod({
+      'xds.config.mjs': `export default {};\n`,
+      'astryx.config.mjs': `export default {};\n`,
+    });
+    expect(result.errors?.[0]?.error).toMatch(/migrate the config manually/);
+  });
+});

package/src/codemods/transforms/v0.1.0/__tests__/migrate-xds-module-specifiers.test.mjs

@@ -0,0 +1,51 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+import {describe, it, expect} from 'vitest';
+
+async function applyTransform(source, filePath = 'test.tsx') {
+  const {default: transform} =
+    await import('../migrate-xds-module-specifiers.mjs');
+  const jscodeshift = (await import('jscodeshift')).default;
+  const j = jscodeshift.withParser('tsx');
+  const api = {jscodeshift: j, stats: () => {}, report: () => {}};
+  const file = {source, path: filePath};
+  const result = transform(file, api);
+  return result ?? source;
+}
+
+describe('migrate-xds-module-specifiers', () => {
+  it('renames import and export source paths including subpaths', async () => {
+    const input = [
+      "import {Button} from '@xds/core/Button';",
+      "import '@xds/theme-default/theme.css';",
+      "export {LabThing} from '@xds/lab/Thing';",
+      "export * from '@xds/core/theme';",
+    ].join('\n');
+
+    const output = await applyTransform(input);
+    expect(output).toContain('@astryxdesign/core/Button');
+    expect(output).toContain('@astryxdesign/theme-neutral/theme.css');
+    expect(output).toContain('@astryxdesign/lab/Thing');
+    expect(output).toContain('@astryxdesign/core/theme');
+    expect(output).not.toContain('@xds/');
+  });
+
+  it('renames dynamic import and require string literals', async () => {
+    const output = await applyTransform(
+      [
+        "const mod = await import('@xds/core/theme');",
+        "const core = require('@xds/core');",
+      ].join('\n'),
+      'test.ts',
+    );
+    expect(output).toContain('@astryxdesign/core/theme');
+    expect(output).toContain('@astryxdesign/core');
+    expect(output).not.toContain('@xds/');
+  });
+
+  it('does not rewrite ordinary string literals', async () => {
+    const input = "const packageName = '@xds/core';";
+    const output = await applyTransform(input, 'test.ts');
+    expect(output).toBe(input);
+  });
+});

package/src/codemods/transforms/v0.1.0/index.mjs

@@ -0,0 +1,28 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * @file v0.1.0 transform manifest
+ *
+ * Lists all codemods for the v0.1.0 release in the order they should run.
+ */
+
+import migrateXdsConfigSurfaces, {
+  meta as migrateXdsConfigSurfacesMeta,
+} from './migrate-xds-config-surfaces.mjs';
+
+import migrateXdsModuleSpecifiers, {
+  meta as migrateXdsModuleSpecifiersMeta,
+} from './migrate-xds-module-specifiers.mjs';
+
+export default [
+  {
+    name: 'migrate-xds-config-surfaces',
+    transform: migrateXdsConfigSurfaces,
+    meta: migrateXdsConfigSurfacesMeta,
+  },
+  {
+    name: 'migrate-xds-module-specifiers',
+    transform: migrateXdsModuleSpecifiers,
+    meta: migrateXdsModuleSpecifiersMeta,
+  },
+];

package/src/codemods/transforms/v0.1.0/migrate-xds-config-surfaces.mjs

@@ -0,0 +1,230 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * @file Codemod: migrate XDS config surfaces to Astryx v0.1.0
+ *
+ * The v0.1.0 CLI reads astryx.config.mjs. This config codemod migrates
+ * legacy xds.config.mjs and package.json's top-level `xds` config without
+ * changing dependency names or versions.
+ */
+
+export const meta = {
+  title: 'Migrate xds config surfaces to astryx',
+  description:
+    'Moves legacy package.json xds config into astryx.config.mjs, or renames ' +
+    'xds.config.mjs when no package.json config exists. Bails out if both exist.',
+  pr: '#3092',
+  codemodType: 'config',
+};
+
+function findTopLevelKey(source, targetKey) {
+  let depth = 0;
+  let inString = false;
+  let escaped = false;
+  let stringStart = -1;
+
+  for (let i = 0; i < source.length; i++) {
+    const ch = source[i];
+
+    if (inString) {
+      if (escaped) {
+        escaped = false;
+        continue;
+      }
+      if (ch === '\\') {
+        escaped = true;
+        continue;
+      }
+      if (ch !== '"') continue;
+
+      inString = false;
+      const rawKey = source.slice(stringStart + 1, i);
+      if (depth !== 1 || rawKey !== targetKey) continue;
+
+      let j = i + 1;
+      while (/\s/.test(source[j] ?? '')) j++;
+      if (source[j] !== ':') continue;
+
+      const valueStart = j + 1;
+      const value = readJsonValue(source, valueStart);
+      if (!value) return null;
+      return {keyStart: stringStart, keyEnd: i + 1, colon: j, ...value};
+    }
+
+    if (ch === '"') {
+      inString = true;
+      stringStart = i;
+      continue;
+    }
+    if (ch === '{' || ch === '[') depth++;
+    else if (ch === '}' || ch === ']') depth--;
+  }
+  return null;
+}
+
+function readJsonValue(source, start) {
+  let i = start;
+  while (/\s/.test(source[i] ?? '')) i++;
+  const valueStart = i;
+  let inString = false;
+  let escaped = false;
+  let depth = 0;
+
+  for (; i < source.length; i++) {
+    const ch = source[i];
+    if (inString) {
+      if (escaped) {
+        escaped = false;
+        continue;
+      }
+      if (ch === '\\') {
+        escaped = true;
+        continue;
+      }
+      if (ch === '"') inString = false;
+      continue;
+    }
+    if (ch === '"') {
+      inString = true;
+      continue;
+    }
+    if (ch === '{' || ch === '[') {
+      depth++;
+      continue;
+    }
+    if (ch === '}' || ch === ']') {
+      if (depth === 0) break;
+      depth--;
+      continue;
+    }
+    if (depth === 0 && ch === ',') break;
+  }
+
+  const valueEnd = i;
+  const rawValue = source.slice(valueStart, valueEnd).trim();
+  try {
+    JSON.parse(rawValue);
+  } catch {
+    return null;
+  }
+  return {valueStart, valueEnd, rawValue, terminator: source[i]};
+}
+
+function removeTopLevelProperty(source, property) {
+  let removeStart = property.keyStart;
+  let removeEnd = property.valueEnd;
+
+  if (source[removeEnd] === ',') {
+    removeEnd++;
+    if (source[removeEnd] === '\n') removeEnd++;
+    return source.slice(0, removeStart) + source.slice(removeEnd);
+  }
+
+  let i = removeStart - 1;
+  while (/\s/.test(source[i] ?? '')) i--;
+  if (source[i] === ',') {
+    const whitespaceBetweenCommaAndKey = source.slice(i + 1, removeStart);
+    const preservedWhitespace = whitespaceBetweenCommaAndKey.includes('\n')
+      ? '\n'
+      : '';
+    return source.slice(0, i) + preservedWhitespace + source.slice(removeEnd);
+  }
+
+  return source.slice(0, removeStart) + source.slice(removeEnd);
+}
+
+function formatConfigSource(rawConfig) {
+  const parsed = JSON.parse(rawConfig);
+  return `export default ${JSON.stringify(parsed, null, 2)};\n`;
+}
+
+function migratePackageJsonConfig(config) {
+  if (!config.packageJson) return {changes: []};
+
+  const packageJson = config.packageJson.source;
+  const xdsConfig = findTopLevelKey(packageJson, 'xds');
+  const astryxConfig = findTopLevelKey(packageJson, 'astryx');
+  if (!xdsConfig && !astryxConfig) return {changes: []};
+
+  if (config.astryxConfig) {
+    return {
+      errors: [
+        {
+          file: 'package.json',
+          error:
+            'package.json contains xds/astryx config and astryx.config.mjs already exists; migrate the config manually.',
+        },
+      ],
+    };
+  }
+
+  if (xdsConfig && astryxConfig) {
+    return {
+      errors: [
+        {
+          file: 'package.json',
+          error:
+            'package.json contains both xds and astryx config keys; migrate the config manually.',
+        },
+      ],
+    };
+  }
+
+  const configProperty = astryxConfig ?? xdsConfig;
+  const packageJsonWithoutConfig = removeTopLevelProperty(
+    packageJson,
+    configProperty,
+  );
+  return {
+    changes: [
+      {path: 'package.json', source: packageJsonWithoutConfig},
+      {
+        path: 'astryx.config.mjs',
+        source: formatConfigSource(configProperty.rawValue),
+      },
+    ],
+  };
+}
+
+function migrateXdsConfigFile(config) {
+  if (!config.xdsConfig) return {changes: []};
+  if (config.astryxConfig) {
+    return {
+      errors: [
+        {
+          file: 'xds.config.mjs',
+          error:
+            'xds.config.mjs and astryx.config.mjs both exist; migrate the config manually.',
+        },
+      ],
+    };
+  }
+  return {
+    changes: [
+      {path: 'astryx.config.mjs', source: config.xdsConfig.source},
+      {path: 'xds.config.mjs', delete: true},
+    ],
+  };
+}
+
+export default function transformer(_file, api) {
+  const config = api.config ?? {};
+  const packageResult = migratePackageJsonConfig(config);
+  if (packageResult.errors?.length) return packageResult;
+  if (packageResult.changes?.length) {
+    if (config.xdsConfig) {
+      return {
+        errors: [
+          {
+            file: 'package.json',
+            error:
+              'package.json contains xds/astryx config and xds.config.mjs exists; migrate the config manually.',
+          },
+        ],
+      };
+    }
+    return packageResult;
+  }
+
+  return migrateXdsConfigFile(config);
+}

package/src/codemods/transforms/v0.1.0/migrate-xds-module-specifiers.mjs

@@ -0,0 +1,84 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * @file Codemod: migrate module specifiers from @xds/* to @astryxdesign/*
+ *
+ * The v0.1.0 release moved the public package scope from @xds to
+ * @astryxdesign. Consumers update dependencies first, install, then run
+ * `astryx upgrade`; this transform only updates JS/TS module specifiers in
+ * source code.
+ */
+
+export const meta = {
+  title: 'Migrate module specifiers from @xds/* to @astryxdesign/*',
+  description:
+    'Updates JS/TS import, export, dynamic import, and require module ' +
+    'specifiers from @xds/* to the @astryxdesign/* packages used by Astryx v0.1.0.',
+  pr: '#3092',
+  fileExtensions: ['.js', '.jsx', '.ts', '.tsx', '.mjs', '.cjs'],
+};
+
+const PACKAGE_RENAMES = new Map([
+  ['@xds/build', '@astryxdesign/build'],
+  ['@xds/cli', '@astryxdesign/cli'],
+  ['@xds/core', '@astryxdesign/core'],
+  ['@xds/lab', '@astryxdesign/lab'],
+  ['@xds/theme-butter', '@astryxdesign/theme-butter'],
+  ['@xds/theme-chocolate', '@astryxdesign/theme-chocolate'],
+  ['@xds/theme-daily', '@astryxdesign/theme-neutral'],
+  ['@xds/theme-default', '@astryxdesign/theme-neutral'],
+  ['@xds/theme-gothic', '@astryxdesign/theme-gothic'],
+  ['@xds/theme-matcha', '@astryxdesign/theme-matcha'],
+  ['@xds/theme-neutral', '@astryxdesign/theme-neutral'],
+  ['@xds/theme-stone', '@astryxdesign/theme-stone'],
+  ['@xds/theme-y2k', '@astryxdesign/theme-y2k'],
+]);
+
+function renamePackageSpecifier(value) {
+  if (typeof value !== 'string') return value;
+  for (const [from, to] of PACKAGE_RENAMES) {
+    if (value === from) return to;
+    if (value.startsWith(from + '/')) return to + value.slice(from.length);
+  }
+  return value;
+}
+
+function rewriteLiteral(node) {
+  if (!node || typeof node.value !== 'string') return false;
+  const next = renamePackageSpecifier(node.value);
+  if (next === node.value) return false;
+  node.value = next;
+  return true;
+}
+
+export default function transformer(file, api) {
+  const j = api.jscodeshift;
+  const root = j(file.source);
+  let hasChanges = false;
+
+  root.find(j.ImportDeclaration).forEach(path => {
+    hasChanges = rewriteLiteral(path.node.source) || hasChanges;
+  });
+
+  root.find(j.ExportNamedDeclaration).forEach(path => {
+    hasChanges = rewriteLiteral(path.node.source) || hasChanges;
+  });
+
+  root.find(j.ExportAllDeclaration).forEach(path => {
+    hasChanges = rewriteLiteral(path.node.source) || hasChanges;
+  });
+
+  root.find(j.CallExpression).forEach(path => {
+    const isDynamicImport = path.node.callee.type === 'Import';
+    const isRequire =
+      path.node.callee.type === 'Identifier' &&
+      path.node.callee.name === 'require';
+    if (!isDynamicImport && !isRequire) return;
+    const [arg] = path.node.arguments;
+    if (arg?.type === 'StringLiteral' || arg?.type === 'Literal') {
+      hasChanges = rewriteLiteral(arg) || hasChanges;
+    }
+  });
+
+  return hasChanges ? root.toSource() : undefined;
+}