@arcgis/codemod 5.2.0-next.112 → 5.2.0-next.113

package/README.md

@@ -2,15 +2,11 @@
 
 A codemod toolkit for updating and modernizing ArcGIS Maps SDK for JavaScript codebases.
 
-This package provides automated refactors to help migrate away from deprecated or legacy patterns. Starting with removing the `__esri` namespace in TypeScript projects and replacing it with explicit imports.
-
-## Features
-
-- Automated refactor to remove `__esri` namespace usage
-- Converts global namespace types to explicit `@arcgis/core` imports
-- Normalizes legacy Calcite icon names
-- Detects edge cases and warns when changes can’t be safely automated
-- Respects `.gitignore` by default
+This package provides automated refactors to help migrate away from deprecated or legacy patterns.
+These include codemods for removing the `__esri` namespace and
+converting global namespace types to explicit `@arcgis/core` imports,
+normalizing legacy Calcite icon names,
+and updating geometry operator usage.
 
 ## Requirements
 
@@ -20,12 +16,25 @@ This package provides automated refactors to help migrate away from deprecated o
 
 ## Before you begin
 
+Ensure your project's dependencies are up to date, for example with `pnpm install`.
+
 If your project uses **ESLint, Prettier, or other formatters/linters**, run them after the codemod to ensure consistent formatting.
 
 > [!Note]
-> This codemod modifies files in place and does not provide an interactive dry-run mode. We recommend running it in a project that is under version control (Git) so you can review changes using `git diff` or your IDE’s diff tools. If your project is not under version control, create a backup before running the codemod.
+> Codemods modify files in place and do not provide an interactive dry-run mode. We recommend running it in a project
+> that is under version control (Git) so you can review changes using `git diff` or your IDE’s diff tools. If your
+> project is not under version control, create a backup before running the codemod.
+
+By default, codemods run on all TypeScript files in the current directory and subdirectories.
+You can manually run it on a different directory by providing it as an argument.
 
-## Usage
+Codemods respect `.gitignore` files and will not modify any files ignored by them.
+
+## Available codemods
+
+- [`refactor-out-esri-namespace`](#refactor-out-the-__esri-namespace)
+- [`normalize-calcite-icon-names`](#normalize-calcite-icon-names)
+- [`geometry-operator-renames`](#rename-geometry-operators)
 
 ### Refactor out the `__esri` namespace
 
@@ -33,21 +42,12 @@ The `refactor-out-esri-namespace` codemod replaces `__esri` types with explicit
 
 > Note: Before running the codemod, update all `@arcgis/*` packages in your `package.json` to the most recent version.
 
-Run it in the root of your project:
-
-```sh
-npx @arcgis/codemod run refactor-out-esri-namespace
-```
-
-By default, the codemod runs on all TypeScript files in the current directory and subdirectories, excluding files ignored by your `.gitignore`.
-You can manually run it on a different directory by providing an argument:
+Run it in the root of your project or with an explicit target directory:
 
 ```sh
-npx @arcgis/codemod run refactor-out-esri-namespace target-directory
+npx @arcgis/codemod run refactor-out-esri-namespace [<target-directory>]
 ```
 
-#### What the codemod does
-
 **Before:**
 
 ```tsx
@@ -78,18 +78,16 @@ These will be reported in the console, manually review all changes before commit
 
 ### Normalize Calcite icon names
 
-The `normalize-calcite-icon-names` codemod updates camelCase and legacy Calcite icon names to their normalized kebab-case equivalents. It handles icon attributes on Calcite components and traces icon values through variables, properties, assignments, function returns, and forwarded component properties. This helps prepare for [calcite-design-system#14967](https://github.com/Esri/calcite-design-system/issues/14967) and [calcite-design-system#14966](https://github.com/Esri/calcite-design-system/issues/14966).
-
-Run it in the root of your project:
-
-```sh
-npx @arcgis/codemod run normalize-calcite-icon-names
-```
+The `normalize-calcite-icon-names` codemod updates camelCase and legacy Calcite icon names to their normalized
+kebab-case equivalents. It handles icon attributes on Calcite components and traces icon values through variables,
+properties, assignments, function returns, and forwarded component properties. This helps prepare for
+[calcite-design-system#14967](https://github.com/Esri/calcite-design-system/issues/14967) and
+[calcite-design-system#14966](https://github.com/Esri/calcite-design-system/issues/14966).
 
-You can also provide a target directory:
+Run it in the root of your project or with an explicit target directory:
 
 ```sh
-npx @arcgis/codemod run normalize-calcite-icon-names target-directory
+npx @arcgis/codemod run normalize-calcite-icon-names [<target-directory>]
 ```
 
 **Before:**
@@ -104,7 +102,36 @@ npx @arcgis/codemod run normalize-calcite-icon-names target-directory
 <calcite-button iconStart="3d-glasses" iconEnd="arrow-left-10" />
 ```
 
+### Rename Geometry Operators
+
+At 5.2, geometry operator functions were renamed to improve consistency and discoverability.
+The `geometry-operator-renames` codemod updates geometry operator calls to use the new names.
+It additionally inlines namespace imports, which are now unnecessary.
+
+Run it in the root of your project or with an explicit target directory:
+
+```sh
+npx @arcgis/codemod run geometry-operator-renames [<target-directory>]
+```
+
+**Before:**
+
+````ts
+import * as bufferOperator from "@arcgis/core/geometry/operators/bufferOperator";
+const options: bufferOperator.Options = { unit: "meters" };
+const buffered = bufferOperator.execute(polyline, 250, options);
+```
+
+**After:**
+
+```ts
+import { bufferExecute, type BufferExecuteOptions } from "@arcgis/core/geometry/operators/bufferOperator";
+const options: BufferExecuteOptions = { unit: "meters" };
+const buffered = bufferExecute(polyline, 250, options);
+````
+
 ## License
 
-This package is licensed under the terms described in the `LICENSE.md` file, located in the root of the package, and at https://js.arcgis.com/5.2/LICENSE.txt.
+This package is licensed under the terms described in the `LICENSE.md` file,
+located in the root of the package, and at https://js.arcgis.com/5.2/LICENSE.txt.
 For third party notices, see https://js.arcgis.com/5.2/third-party-notices.txt.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/codemod",
-  "version": "5.2.0-next.112",
+  "version": "5.2.0-next.113",
   "description": "A codemod toolkit for updating and modernizing ArcGIS Maps SDK for JavaScript codebases.",
   "type": "module",
   "exports": {
@@ -11,9 +11,9 @@
   ],
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@arcgis/api-extractor": "5.2.0-next.112",
-    "@arcgis/node-toolkit": "5.2.0-next.112",
-    "@arcgis/toolkit": "5.2.0-next.112",
+    "@arcgis/api-extractor": "5.2.0-next.113",
+    "@arcgis/node-toolkit": "5.2.0-next.113",
+    "@arcgis/toolkit": "5.2.0-next.113",
     "@commander-js/extra-typings": "^15.0.0",
     "commander": "^15.0.0",
     "tinyglobby": "~0.2.17",