@mittwald/flow-codemods 1.1.46 → 1.1.48

package/dist/migrations/popover-open-state-props/transform.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Renames the `defaultOpen` prop to `isDefaultOpen` on `Popover`,
+ * `ContextualHelp` and `ContextMenu`.
+ *
+ * The scope is deliberately narrow, and here that is not only about same-named
+ * components from other packages. `defaultOpen` is react-aria's own prop and
+ * Flow passes it straight through on `Select`, `MenuTrigger`, `Tooltip`,
+ * `TooltipTrigger`, `DialogTrigger`, `DatePicker` and `DateRangePicker`, where
+ * it did not change — renaming it there would remove a working prop.
+ *
+ * Only JSX elements that resolve to one of the three — imported (named or as a
+ * namespace) from `@mittwald/flow-react-components` or
+ * `@mittwald/flow-remote-react-components`, including their subpath entries —
+ * are touched.
+ *
+ * An element that already carries `isDefaultOpen` keeps it and only loses the
+ * stale `defaultOpen`, which mirrors the runtime: `isDefaultOpen` wins.
+ *
+ * The other two changes of this migration are not here. `isOpen` and
+ * `onOpenChange` changed behaviour, not spelling: whether a given `isOpen` is
+ * meant to control the popover, and whether an `onOpenChange` handler performed
+ * or suppressed the close, is not decidable from the source. `apply` asks for
+ * those by hand.
+ */
+const popoverOpenStatePropsTransform = (fileInfo, { j }) => {
+    const flowPackages = [
+        "@mittwald/flow-react-components",
+        "@mittwald/flow-remote-react-components",
+    ];
+    const affectedComponents = new Set([
+        "Popover",
+        "ContextualHelp",
+        "ContextMenu",
+    ]);
+    const isFlowImport = (source) => flowPackages.some((pkg) => source === pkg || source.startsWith(`${pkg}/`));
+    const root = j(fileInfo.source, { parser: "tsx" });
+    // Local JSX identifier -> canonical component name (resolves `as` aliases).
+    const localToComponent = new Map();
+    // Local names of `import * as Flow` namespace imports from a Flow package.
+    const flowNamespaces = new Set();
+    root
+        .find(j.ImportDeclaration)
+        .filter((path) => isFlowImport(String(path.node.source.value)))
+        .forEach((path) => {
+        for (const specifier of path.node.specifiers ?? []) {
+            if (specifier.type === "ImportSpecifier" &&
+                specifier.imported.type === "Identifier" &&
+                affectedComponents.has(specifier.imported.name)) {
+                localToComponent.set(String(specifier.local?.name ?? specifier.imported.name), String(specifier.imported.name));
+            }
+            else if (specifier.type === "ImportNamespaceSpecifier" &&
+                specifier.local) {
+                flowNamespaces.add(String(specifier.local.name));
+            }
+        }
+    });
+    if (localToComponent.size === 0 && flowNamespaces.size === 0) {
+        return fileInfo.source;
+    }
+    let changed = false;
+    root.find(j.JSXOpeningElement).forEach((path) => {
+        const name = path.node.name;
+        let isAffected = false;
+        if (name.type === "JSXIdentifier") {
+            isAffected = localToComponent.has(name.name);
+        }
+        else if (name.type === "JSXMemberExpression" &&
+            name.object.type === "JSXIdentifier" &&
+            name.property.type === "JSXIdentifier") {
+            isAffected =
+                flowNamespaces.has(name.object.name) &&
+                    affectedComponents.has(name.property.name);
+        }
+        if (!isAffected) {
+            return;
+        }
+        const attributes = path.node.attributes ?? [];
+        const isNamed = (attribute, key) => attribute.type === "JSXAttribute" &&
+            attribute.name.type === "JSXIdentifier" &&
+            attribute.name.name === key;
+        if (!attributes.some((attribute) => isNamed(attribute, "defaultOpen"))) {
+            return;
+        }
+        changed = true;
+        if (attributes.some((attribute) => isNamed(attribute, "isDefaultOpen"))) {
+            path.node.attributes = attributes.filter((attribute) => !isNamed(attribute, "defaultOpen"));
+            return;
+        }
+        for (const attribute of attributes) {
+            if (isNamed(attribute, "defaultOpen") &&
+                attribute.type === "JSXAttribute" &&
+                attribute.name.type === "JSXIdentifier") {
+                attribute.name.name = "isDefaultOpen";
+            }
+        }
+    });
+    return changed ? root.toSource() : fileInfo.source;
+};
+exports.default = popoverOpenStatePropsTransform;

package/dist/migrations.generated.js

@@ -3,6 +3,15 @@
 // Source: packages/codemods/src/migrations/<id>/entry.md
 /** Every migration, newest first. Bodies live in `src/migrations`. */
 export const migrations = [
+    {
+        id: "popover-open-state-props",
+        since: "1.1.47",
+        title: "Popover: `defaultOpen` renamed, `isOpen` and `onOpenChange` now work",
+        kind: "migration",
+        action: "codemod",
+        remotePackage: true,
+        apply: "Rename `defaultOpen` to `isDefaultOpen` on `Popover`, `ContextualHelp` and `ContextMenu` — a codemod does it, scoped to those three. Leave `defaultOpen` alone on `Select`, `MenuTrigger`, `Tooltip`, `TooltipTrigger`, `DialogTrigger`, `DatePicker` and `DateRangePicker`, where it is react-aria's own prop and unchanged. Then check every `isOpen` and `onOpenChange` passed to those three by hand, because both changed behaviour and neither is mechanically decidable. `isOpen` used to be ignored and now controls the popover: a value that is not kept up to date through `onOpenChange` keeps the popover closed. `onOpenChange` used to take over the open state and now only reports it, so a handler that performed the close itself — `onOpenChange={(open) => controller.setOpen(open)}` — can drop that call, and a handler that relied on the prop to *suppress* the close no longer does; use the controller's `onClose` for that.",
+    },
     {
         id: "tabler-icons-no-longer-transitive",
         since: "1.1.40",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/flow-codemods",
-  "version": "1.1.46",
+  "version": "1.1.48",
   "type": "module",
   "description": "Codemods and an upgrade CLI for consumers of Flow, mittwald's design system",
   "homepage": "https://flow.mittwald.de",
@@ -38,5 +38,5 @@
     "vitest": "^4.1.11",
     "yaml": "^2.8.1"
   },
-  "gitHead": "6e6d23d148abd4884fd8f955e0c26641265a6854"
+  "gitHead": "29caa832765bca544d6fae2e4c05e8b3dedcdcb3"
 }