@lablup/ui-common-cli 0.2.0-alpha.15 → 0.2.0-alpha.17

package/cli/sync-astryx.mjs

@@ -125,14 +125,16 @@ function listAstryxCodemods(repo, from, to) {
  * @param {string} version ui-common version to record under
  * @param {{from: string, to: string}} astryx
  * @param {{codemods: Array<{id: string, version: string, title: string}>, optional: string[]}} listed
+ * @param {{from: string, to: string} | null} [lab] the lab canary move, when `--lab` was given
  */
-export function upstreamManifest(repo, version, astryx, listed) {
+export function upstreamManifest(repo, version, astryx, listed, lab = null) {
   const file = join(repo, CLI_PACKAGE_DIR, "codemods", version, "upstream.json");
   /** @type {any} */
   let manifest = {
     $comment:
-      "Written by `ui-common sync-astryx`. Astryx codemods consumers need when they upgrade across this ui-common version; `ui-common upgrade` runs them with @lablup/ui-common specifiers swapped for Astryx's.",
+      "Written by `ui-common sync-astryx`. Astryx codemods consumers need when they upgrade across this ui-common version; `ui-common upgrade` runs them with @lablup/ui-common specifiers swapped for Astryx's, and moves the consumer's lab pin and core override.",
     astryx,
+    ...(lab ? { lab } : {}),
     codemods: listed.codemods,
     optional: listed.optional,
   };
@@ -143,6 +145,14 @@ export function upstreamManifest(repo, version, astryx, listed) {
     manifest = {
       ...manifest,
       astryx: { from: previous.astryx.from, to: astryx.to },
+      ...(lab || previous.lab
+        ? {
+            lab: {
+              from: previous.lab?.from ?? lab.from,
+              to: lab?.to ?? previous.lab.to,
+            },
+          }
+        : {}),
       codemods: [
         ...previous.codemods,
         ...listed.codemods.filter((c) => !ids.has(c.id)),
@@ -162,6 +172,23 @@ export function upstreamManifest(repo, version, astryx, listed) {
  * @param {string} pin the new @astryxdesign/core pin
  * @returns {Array<{name: string, file: string, after: string}>}
  */
+/**
+ * Where the 0.1 -> 0.2 migration tells a consumer which `@astryxdesign/lab`
+ * to add (`requiresPackages` in migration/0.1-to-0.2.json). It is the exact
+ * canary ui-common peers on, so it moves with `--lab`.
+ */
+export function labRequirementEdits(repo, lab) {
+  const name = `${CLI_PACKAGE_DIR}/migration/0.1-to-0.2.json`;
+  const file = join(repo, name);
+  if (!existsSync(file)) return [];
+  const before = readFileSync(file, "utf8");
+  const after = before.replace(
+    /("@astryxdesign\/lab":\s*")[^"]+(")/g,
+    (_, open, close) => `${open}${lab}${close}`,
+  );
+  return after === before ? [] : [{ name, file, before, after }];
+}
+
 export function labOverrideEdits(repo, pin) {
   const edits = [];
   for (const name of ["README.md", "pnpm-workspace.yaml"]) {
@@ -279,6 +306,11 @@ export async function syncAstryxCommand(argv) {
   for (const edit of labOverrideEdits(repo, target)) {
     out(`  ${edit.name}: lab's core override → ${target}`);
   }
+  if (lab) {
+    for (const edit of labRequirementEdits(repo, lab)) {
+      out(`  ${edit.name}: the lab pin consumers are told to add → ${lab}`);
+    }
+  }
 
   /** @param {string} title @param {string} cmd @param {string[]} args */
   const step = (title, cmd, args) => {
@@ -328,6 +360,9 @@ export async function syncAstryxCommand(argv) {
       recordAs,
       { from: current, to: target },
       listed,
+      lab
+        ? { from: pkg.peerDependencies?.[LAB] ?? pkg.devDependencies?.[LAB], to: lab }
+        : null,
     );
     out(
       `\nWould record ${manifest.codemods.length} codemod(s) in ${file.slice(repo.length + 1)} (as listed by the installed CLI; the new CLI may add more):`,
@@ -350,6 +385,12 @@ export async function syncAstryxCommand(argv) {
   writeFileSync(pkgFile, `${JSON.stringify(pkg, null, 2)}\n`);
   writeFileSync(cliPkgFile, `${JSON.stringify(cliPkg, null, 2)}\n`);
   out(`  package.json and ${CLI_PACKAGE_DIR}/package.json written`);
+  if (lab) {
+    for (const edit of labRequirementEdits(repo, lab)) {
+      writeFileSync(edit.file, edit.after);
+      out(`  ${edit.name}: the lab pin consumers are told to add moved to ${lab}`);
+    }
+  }
   for (const edit of labOverrideEdits(repo, target)) {
     writeFileSync(edit.file, edit.after);
     out(`  ${edit.name}: lab's core override moved to ${target}`);
@@ -398,6 +439,9 @@ export async function syncAstryxCommand(argv) {
       recordAs,
       { from: current, to: target },
       listed,
+      lab
+        ? { from: pkg.peerDependencies?.[LAB] ?? pkg.devDependencies?.[LAB], to: lab }
+        : null,
     );
     mkdirSync(join(file, ".."), { recursive: true });
     writeFileSync(file, `${JSON.stringify(manifest, null, 2)}\n`);

package/codemods/0.2/package-json.mjs

@@ -19,7 +19,7 @@ import { LAB_PACKAGE, stylexPeer, UIC } from "./map.mjs";
 /** The CLI package, released in lockstep with ui-common. */
 export const CLI_PACKAGE = "@lablup/ui-common-cli";
 
-const FIELDS = /** @type {const} */ ([
+export const FIELDS = /** @type {const} */ ([
   "dependencies",
   "devDependencies",
   "peerDependencies",
@@ -37,7 +37,7 @@ function isSorted(object) {
  * @param {string} name
  * @param {string} range
  */
-function addDependency(pkg, field, name, range) {
+export function addDependency(pkg, field, name, range) {
   const current = pkg[field] ?? {};
   const next = { ...current, [name]: range };
   pkg[field] = isSorted(current)
@@ -50,8 +50,9 @@ function addDependency(pkg, field, name, range) {
  * @param {string} to
  * @returns {{value: string, note?: string} | null}
  */
-function bumpSpec(spec, to) {
-  if (/^(workspace:|link:|file:|npm:|git|https?:)/.test(spec)) return null;
+export function bumpSpec(spec, to) {
+  // `catalog:` names a pnpm catalog entry; the version lives there, not here.
+  if (/^(workspace:|link:|file:|npm:|catalog:|git|https?:)/.test(spec)) return null;
   const simple = /^([\^~]?)v?\d+(\.\d+){0,2}(-[0-9A-Za-z.-]+)?$/.exec(spec.trim());
   if (simple) return { value: `${simple[1]}${to}` };
   return {
@@ -166,7 +167,7 @@ export function narrowReactRange(range, floor) {
  * @param {any} pkg parsed package.json, edited in place
  * @param {{projectDir?: string, note: (message: string) => void, editFile?: (path: string, edit: (current: string | null) => string | undefined) => void}} ctx
  */
-function addLabOverride(pkg, ctx) {
+export function addLabOverride(pkg, ctx) {
   const pin = uiCommonPackageJson(targetUiCommonRoot(ctx.projectDir)).dependencies?.[
     CORE
   ];

package/codemods/0.2.0-alpha.16/upstream.json

@@ -0,0 +1,24 @@
+{
+  "$comment": "Written by `ui-common sync-astryx`. Astryx codemods consumers need when they upgrade across this ui-common version; `ui-common upgrade` runs them with @lablup/ui-common specifiers swapped for Astryx's, and moves the consumer's lab pin and core override.",
+  "astryx": {
+    "from": "0.6.2",
+    "to": "0.6.5"
+  },
+  "lab": {
+    "from": "0.6.2-canary.c9fb1ad",
+    "to": "0.6.5-canary.8701623"
+  },
+  "codemods": [
+    {
+      "id": "migrate-theme-catalog-to-descriptors",
+      "version": "0.6.4",
+      "title": "Give each integration theme a typed descriptor instead of the manifest.json catalog"
+    },
+    {
+      "id": "migrate-native-picker-to-presentation",
+      "version": "0.6.4",
+      "title": "Migrate nativePicker to presentation"
+    }
+  ],
+  "optional": []
+}

package/codemods/upstream.mjs

@@ -14,6 +14,8 @@
  */
 import { importAstryxInternal } from "../cli/paths.mjs";
 import { rewriteSpecifiers } from "../cli/rewrite.mjs";
+import { LAB_PACKAGE, UIC } from "./0.2/map.mjs";
+import { addLabOverride, bumpSpec, CLI_PACKAGE, FIELDS } from "./0.2/package-json.mjs";
 
 const DEFAULT_EXTENSIONS = [".tsx", ".ts", ".jsx", ".js", ".mjs", ".cjs"];
 
@@ -85,7 +87,7 @@ export function swapModuleSpecifiers(j, source, swap) {
 }
 
 /**
- * @typedef {{astryx: {from: string, to: string}, codemods: Array<{id: string, version: string, title?: string}>}} UpstreamManifest
+ * @typedef {{astryx: {from: string, to: string}, lab?: {from: string, to: string}, codemods: Array<{id: string, version: string, title?: string}>}} UpstreamManifest
  */
 
 /**
@@ -107,6 +109,11 @@ export function wrapAstryxTransform(entry, version) {
         { path: file.path, source: swapped },
         { jscodeshift: j, stats: () => {}, report: () => {} },
       );
+      if (out != null && typeof out.then === "function") {
+        throw new Error(
+          `Astryx codemod "${entry.name}" is asynchronous (not a file transform); run \`ui-common astryx upgrade\` for it.`,
+        );
+      }
       if (out == null || out === swapped) return undefined;
       return swapModuleSpecifiers(j, out, rewriteSpecifiers);
     },
@@ -145,11 +152,80 @@ export async function upstreamStep(manifest) {
       );
       continue;
     }
+    // A project codemod takes the package root and returns a plan of writes,
+    // not a file transform; it concerns an Astryx integration package (theme
+    // catalogs, manifests), which a ui-common consumer is not.
+    if (found.entry.meta?.codemodType === "project") {
+      notes.push(
+        `Astryx codemod "${codemod.id}" rewrites an Astryx integration package (${found.entry.meta.title}); run \`ui-common astryx upgrade\` if this project is one.`,
+      );
+      continue;
+    }
     transforms.push(wrapAstryxTransform(found.entry, found.version));
   }
   return {
     title: `Astryx ${manifest.astryx.from} → ${manifest.astryx.to} codemods`,
     transforms,
     notes,
+    packageJson: (text, ctx) => transformPackageJson(text, ctx, manifest),
   };
 }
+
+/**
+ * The package.json side of an Astryx bump. The codemods above rewrite source;
+ * this moves what a consumer pins by hand: the exact `@lablup/ui-common` and
+ * `@lablup/ui-common-cli` versions to the target, and, in a project that
+ * declares `@astryxdesign/lab`, the lab canary to the one this ui-common
+ * peers on, with lab's core override pointed at the new core (the 0.2 step's
+ * own logic, reused). Without it an alpha-to-alpha upgrade ran the codemods
+ * and left the old lab beside the new core.
+ *
+ * @param {string} text package.json source
+ * @param {{to: string, projectDir?: string, note: (message: string) => void, editFile?: Function}} ctx
+ * @param {UpstreamManifest} manifest
+ */
+export function transformPackageJson(text, ctx, manifest) {
+  const pkg = JSON.parse(text);
+  const indent = /^([ \t]+)"/m.exec(text)?.[1] ?? "  ";
+  const fields = FIELDS.filter((f) => pkg[f]?.[UIC] != null);
+  if (fields.length === 0) return undefined;
+
+  for (const [name, exact] of [
+    [UIC, false],
+    [CLI_PACKAGE, true],
+  ]) {
+    for (const field of FIELDS) {
+      const spec = pkg[field]?.[name];
+      if (spec == null) continue;
+      const bumped = bumpSpec(spec, ctx.to);
+      if (!bumped) {
+        ctx.note(
+          `${field}["${name}"] is "${spec}"; not a version, so it was left alone.`,
+        );
+        continue;
+      }
+      const value = exact ? ctx.to : bumped.value;
+      if (value !== spec) {
+        pkg[field][name] = value;
+        ctx.note(`${field}["${name}"]: "${spec}" → "${value}".`);
+      }
+    }
+  }
+
+  const lab = manifest.lab?.to;
+  const labFields = FIELDS.filter((f) => pkg[f]?.[LAB_PACKAGE] != null);
+  if (lab && labFields.length > 0) {
+    for (const field of labFields) {
+      const spec = pkg[field][LAB_PACKAGE];
+      if (spec === lab || bumpSpec(spec, lab) == null) continue;
+      pkg[field][LAB_PACKAGE] = lab;
+      ctx.note(
+        `${field}["${LAB_PACKAGE}"]: "${spec}" → "${lab}": ${UIC} ${ctx.to} peers on this lab canary exactly.`,
+      );
+    }
+    addLabOverride(pkg, ctx);
+  }
+
+  const out = `${JSON.stringify(pkg, null, indent)}${text.endsWith("\n") ? "\n" : ""}`;
+  return out === text ? undefined : out;
+}

package/migration/0.1-to-0.2.json

@@ -212,7 +212,7 @@
         "names": { "Drawer": "Drawer", "DrawerProps": "DrawerProps" }
       },
       "alternatives": [],
-      "requiresPackages": { "@astryxdesign/lab": "0.6.2-canary.c9fb1ad" },
+      "requiresPackages": { "@astryxdesign/lab": "0.6.5-canary.8701623" },
       "propRenames": [
         {
           "from": "onClose",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lablup/ui-common-cli",
-  "version": "0.2.0-alpha.15",
+  "version": "0.2.0-alpha.17",
   "description": "The ui-common command line: the pinned Astryx CLI in @lablup/ui-common terms, the agent block, and the upgrade codemods",
   "license": "Apache-2.0",
   "author": "Lablup Inc.",
@@ -36,15 +36,15 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@astryxdesign/cli": "0.6.2",
+    "@astryxdesign/cli": "0.6.5",
     "jscodeshift": "^17.4.0",
     "postcss": "^8.5.25",
     "postcss-selector-parser": "^7.1.6"
   },
   "peerDependencies": {
-    "@lablup/ui-common": "0.2.0-alpha.15"
+    "@lablup/ui-common": "0.2.0-alpha.17"
   },
   "devDependencies": {
-    "@lablup/ui-common": "0.2.0-alpha.15"
+    "@lablup/ui-common": "0.2.0-alpha.17"
   }
 }