@carbon/upgrade 11.18.0 → 11.18.1

package/cli.js

@@ -52629,6 +52629,29 @@ var upgrades = [
             verbose: options.verbose
           });
         }
+      },
+      {
+        name: "refactor-to-callout",
+        description: "Rewrites imports and usages of StaticNotification to Callout",
+        migrate: async (options) => {
+          const transform = import_path2.default.join(TRANSFORM_DIR, "refactor-to-callout.js");
+          const paths = Array.isArray(options.paths) && options.paths.length > 0 ? options.paths : await (0, import_fast_glob2.default)(["**/*.js", "**/*.jsx", "**/*.ts", "**/*.tsx"], {
+            cwd: options.workspaceDir,
+            ignore: [
+              "**/es/**",
+              "**/lib/**",
+              "**/umd/**",
+              "**/node_modules/**",
+              "**/storybook-static/**"
+            ]
+          });
+          await run2({
+            dry: !options.write,
+            transform,
+            paths,
+            verbose: options.verbose
+          });
+        }
       }
     ]
   },
@@ -52657,7 +52680,7 @@ var upgrades = [
 var package_default = {
   name: "@carbon/upgrade",
   description: "A tool for upgrading Carbon versions",
-  version: "11.18.0",
+  version: "11.18.1",
   license: "Apache-2.0",
   bin: {
     "carbon-upgrade": "./bin/carbon-upgrade.js"

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@carbon/upgrade",
   "description": "A tool for upgrading Carbon versions",
-  "version": "11.18.0",
+  "version": "11.18.1",
   "license": "Apache-2.0",
   "bin": {
     "carbon-upgrade": "./bin/carbon-upgrade.js"
@@ -61,5 +61,5 @@
     "@ibm/telemetry-js": "^1.5.0",
     "jscodeshift": "^17.0.0"
   },
-  "gitHead": "ea46616d9ea6afb2f14b862a344203e54d19e5a0"
+  "gitHead": "2df4c295d300f96fae292a00b88f07a99e9a80c7"
 }

package/transforms/__testfixtures__/refactor-to-callout.input.js

@@ -0,0 +1,25 @@
+// Typical imports
+import { unstable__StaticNotification as StaticNotification } from '@carbon/react';
+import { unstable__StaticNotification } from '@carbon/react';
+
+// If they used a custom name
+import { unstable__StaticNotification as SomeOtherName } from '@carbon/react';
+
+// If they already renamed it Callout
+import { unstable__StaticNotification as Callout } from '@carbon/react';
+
+// Local renames like this are unlikely but technically possible
+const LocallyRenamedStaticNotification = unstable__StaticNotification;
+
+// Component usages
+// prettier-ignore
+const App = () => {
+  return (
+    <>
+      <StaticNotification title="Test" />
+      <SomeOtherName title="Test" />
+      <Callout title="Test" />
+      <LocallyRenamedStaticNotification title="Test" />
+    </>
+  );
+};

package/transforms/__testfixtures__/refactor-to-callout.output.js

@@ -0,0 +1,23 @@
+// Typical imports
+import { unstable__Callout as Callout } from '@carbon/react';
+import { unstable__Callout } from '@carbon/react';
+
+// If they used a custom name
+import { unstable__Callout as SomeOtherName } from '@carbon/react';
+
+// If they already renamed it Callout
+import { unstable__Callout as Callout } from '@carbon/react';
+
+// Local renames like this are unlikely but technically possible
+const LocallyRenamedStaticNotification = unstable__Callout;
+
+// Component usages
+// prettier-ignore
+const App = () => {
+  return (<>
+    <Callout title="Test" />
+    <SomeOtherName title="Test" />
+    <Callout title="Test" />
+    <LocallyRenamedStaticNotification title="Test" />
+  </>);
+};

package/transforms/__testfixtures__/refactor-to-callout2.input.js

@@ -0,0 +1,4 @@
+// Existing usages should not be transformed
+import { unstable__Callout } from '@carbon/react';
+import { unstable__Callout as Callout } from '@carbon/react';
+import { unstable__Callout as SomeOtherOtherName } from '@carbon/react';

package/transforms/__testfixtures__/refactor-to-callout2.output.js

@@ -0,0 +1,4 @@
+// Existing usages should not be transformed
+import { unstable__Callout } from '@carbon/react';
+import { unstable__Callout as Callout } from '@carbon/react';
+import { unstable__Callout as SomeOtherOtherName } from '@carbon/react';

package/transforms/__testfixtures__/refactor-to-callout3.input.js

@@ -0,0 +1,5 @@
+// Do not transform potential naming collisions from local paths
+import { unstable__Callout } from './my/local/project';
+import { unstable__Callout as Callout } from './my/local/project';
+import { unstable_StaticNotification } from './my/local/project';
+import { unstable_StaticNotification as StaticNotification } from './my/local/project';

package/transforms/__testfixtures__/refactor-to-callout3.output.js

@@ -0,0 +1,5 @@
+// Do not transform potential naming collisions from local paths
+import { unstable__Callout } from './my/local/project';
+import { unstable__Callout as Callout } from './my/local/project';
+import { unstable_StaticNotification } from './my/local/project';
+import { unstable_StaticNotification as StaticNotification } from './my/local/project';

package/transforms/__testfixtures__/refactor-to-callout4.input.js

@@ -0,0 +1,3 @@
+// Do not transform potential naming collisions from local paths
+import { Callout } from '../my/local/project';
+import { StaticNotification } from './my/local/project';

package/transforms/__testfixtures__/refactor-to-callout4.output.js

@@ -0,0 +1,3 @@
+// Do not transform potential naming collisions from local paths
+import { Callout } from '../my/local/project';
+import { StaticNotification } from './my/local/project';

package/transforms/__tests__/refactor-to-callout.js

@@ -0,0 +1,15 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+'use strict';
+
+const { defineTest } = require('jscodeshift/dist/testUtils');
+
+defineTest(__dirname, 'refactor-to-callout');
+defineTest(__dirname, 'refactor-to-callout', null, 'refactor-to-callout2');
+defineTest(__dirname, 'refactor-to-callout', null, 'refactor-to-callout3');
+defineTest(__dirname, 'refactor-to-callout', null, 'refactor-to-callout4');

package/transforms/refactor-to-callout.js

@@ -0,0 +1,157 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+'use strict';
+
+const defaultOptions = {
+  quote: 'auto',
+  trailingComma: true,
+};
+
+function transform(fileInfo, api, options) {
+  const printOptions = options.printOptions || defaultOptions;
+  const j = api.jscodeshift;
+  const root = j(fileInfo.source);
+
+  // Helper function to check if the import source is from '@carbon/react' or its subpaths
+  function isCarbonReactImport(sourceValue) {
+    return (
+      sourceValue === '@carbon/react' ||
+      sourceValue.startsWith('@carbon/react/es') ||
+      sourceValue.startsWith('@carbon/react/lib')
+    );
+  }
+
+  // Collect names of identifiers imported from '@carbon/react' or its subpaths
+  const importedIdentifiers = new Map(); // Map of local name to transformed name
+
+  // Transform import declarations
+  root.find(j.ImportDeclaration).forEach((path) => {
+    const sourceValue = path.node.source.value;
+
+    // Only transform imports from '@carbon/react' and its subpaths
+    if (!isCarbonReactImport(sourceValue)) {
+      return;
+    }
+
+    path.node.specifiers.forEach((specifier) => {
+      if (specifier.type === 'ImportSpecifier') {
+        let importedName = specifier.imported.name;
+        let localName = specifier.local ? specifier.local.name : importedName;
+        let transformedImportedName = importedName;
+        let transformedLocalName = localName;
+
+        // Transform imported names and local names as necessary
+        if (importedName === 'unstable__StaticNotification') {
+          transformedImportedName = 'unstable__Callout';
+          specifier.imported.name = transformedImportedName;
+
+          if (localName === 'StaticNotification') {
+            transformedLocalName = 'Callout';
+            specifier.local.name = transformedLocalName;
+          } else if (localName === 'unstable__StaticNotification') {
+            transformedLocalName = 'unstable__Callout';
+            specifier.local.name = transformedLocalName;
+          }
+          // If local name is something else (e.g., SomeOtherName), leave it unchanged
+        } else if (importedName === 'StaticNotification') {
+          transformedImportedName = 'Callout';
+          specifier.imported.name = transformedImportedName;
+
+          if (localName === 'StaticNotification') {
+            transformedLocalName = 'Callout';
+            specifier.local.name = transformedLocalName;
+          }
+          // If local name is different, leave it unchanged
+        } else if (importedName === 'StaticNotificationProps') {
+          transformedImportedName = 'CalloutProps';
+          specifier.imported.name = transformedImportedName;
+
+          if (localName === 'StaticNotificationProps') {
+            transformedLocalName = 'CalloutProps';
+            specifier.local.name = transformedLocalName;
+          }
+          // If local name is different, leave it unchanged
+        }
+
+        // If imported name and local name are the same after transformation, remove the alias
+        if (
+          specifier.local &&
+          specifier.local.name === specifier.imported.name
+        ) {
+          delete specifier.local;
+        }
+
+        // Update the mapping of imported identifiers
+        // Only add to the map if the local name or the transformed name is different
+        if (localName !== transformedLocalName) {
+          importedIdentifiers.set(localName, transformedLocalName);
+        }
+      }
+    });
+  });
+
+  // Deduplicate imports
+  const importDeclarations = root.find(j.ImportDeclaration);
+
+  importDeclarations.forEach((path) => {
+    const sourceValue = path.node.source.value;
+
+    // Only deduplicate imports from '@carbon/react' and its subpaths
+    if (!isCarbonReactImport(sourceValue)) {
+      return;
+    }
+
+    const specifiers = path.node.specifiers;
+    const uniqueSpecifiers = [];
+    const seen = new Set();
+
+    specifiers.forEach((specifier) => {
+      const importedName = specifier.imported.name;
+      const localName = specifier.local ? specifier.local.name : importedName;
+      const key = `${importedName}:${localName}`;
+
+      if (!seen.has(key)) {
+        seen.add(key);
+        uniqueSpecifiers.push(specifier);
+      }
+    });
+
+    path.node.specifiers = uniqueSpecifiers;
+  });
+
+  // Remove empty import declarations
+  importDeclarations.forEach((path) => {
+    if (path.node.specifiers.length === 0) {
+      j(path).remove();
+    }
+  });
+
+  // Update usages in the code
+  root.find(j.Identifier).forEach((path) => {
+    const name = path.node.name;
+
+    // Skip if the identifier is part of an import specifier
+    if (
+      path.parent.node.type === 'ImportSpecifier' ||
+      path.parent.node.type === 'ImportDefaultSpecifier' ||
+      path.parent.node.type === 'ImportNamespaceSpecifier'
+    ) {
+      return;
+    }
+
+    // Only transform identifiers that match the imported identifiers
+    if (importedIdentifiers.has(name)) {
+      const transformedName = importedIdentifiers.get(name);
+      path.node.name = transformedName;
+    }
+  });
+
+  return root.toSource(printOptions);
+}
+
+module.exports = transform;