@progress/kendo-cli 1.9.2 → 1.9.3-develop.1

package/README.md

@@ -274,6 +274,93 @@ Options:
      [string] [choices: "default", "bootstrap", "material", "fluent"] [default: "default"]                                                  
 ```
 
+## Assisted Migration
+
+### Overview
+
+0. Install the Kendo CLI globally.
+
+    ```bash
+    npm i -g @progress/kendo-cli
+    ```
+
+1. In the root of your project, run:
+
+    ```bash
+    npx @progress/kendo-cli migrate
+    ```
+
+    If not already installed, you will be prompted to install the Kendo CLI. Next, this command checks for available Kendo UI updates (including any peer dependencies), prompts you to install the updates, and then applies any available codemods on top. 
+
+2. Confirm that you want to install the available updates.
+3. Confirm that you want to apply the available transformations. 
+4. Review and accept the suggested transformations.<br/>The Kendo CLI begins to apply the available codemods version by version, starting with the transformations for the earliest version. 
+5. Look for newly added code comments to your code. These indicate that you need to further adjust any existing custom logic.
+6. Finally, do a test run of your project to verify that everything works as expected.
+
+### Best Practices
+
+For a more manageable migration process, consider the following recommended practices:
+
+* Migrate between consecutive major versions. For example, migrate from v10 to v11. This lets you review and adjust your code version by version, avoiding possible conflicts between breaking changes.
+* Migrate one package at a time. This provides finer control over the migration process.
+
+### CLI Quick Guide
+
+The following list describes the most common migration scenarios.
+
+* You can run any of the listed commands with or without a package specified.
+* If not already installed, you will be prompted to install the Kendo CLI when running `npx @progress/kendo-cli migrate` for the first time.
+* Once installed, you can also run commands with the `kendo` handle instead of `npx @progress/kendo-cli`. For example: `kendo migrate`.
+
+```bash
+# Install the Kendo CLI globally.
+npm i -g @progress/kendo-cli
+
+# Run a guided migration. You will be prompted every step of the way.
+npx @progress/kendo-cli migrate
+
+# Migrate a specific package.
+npx @progress/kendo-cli migrate @progress/kendo-react-grid
+
+# Migrate between specific versions.
+npx @progress/kendo-cli migrate @progress/kendo-react-grid --from 10 --to 11
+
+# Run a quick migration without any prompts.
+npx @progress/kendo-cli migrate --force
+
+# Only install the available updates. Do not run any codemods.
+# Useful when you want to manually migrate your code.
+npx @progress/kendo-cli migrate --no-codemods
+
+# Only run the available codemods. Do not install any packages.
+# Useful when you already have the packages installed.
+npx @progress/kendo-cli migrate @progress/kendo-react-grid --no-install 
+
+# Ignoring specific files or directories during the migration.
+npx @progress/kendo-cli migrate @progress/kendo-react-grid --no-install --ignore-pattern="dist/**"
+```
+
+### CLI Arguments
+
+If you want more control over the migration, you can use any of the following arguments when running `npx @progress/kendo-cli migrate`.
+
+| Argument | Description | Sample Use |
+| -------- | ----------- | ---------- |
+| `<pkg>`  | Specifies one or more packages for which to execute the assisted migration (with any additional arguments). If not set, runs for all available Kendo packages. | `npx @progress/kendo-cli migrate @progress/kendo-react-grid` |
+| `--help` | Prints the help for the command. | `npx @progress/kendo-cli migrate --help` |
+| `--version`         | Prints the version of the Kendo CLI.            | `npx @progress/kendo-cli --version`          |
+| `--verbose`         | Sets the verbosity level of the command output on a level from 0 (silent) to 5 (most verbose). By default: 1.              | `npx @progress/kendo-cli migrate --verbose=3`           |
+| `--quiet`         | Silences the output as much as possible. Shorthand for `--verbose=0`.           | `npx @progress/kendo-cli migrate --quiet`           |
+| `--force`         | Runs in force mode and does not ask for any confirmations.             | `npx @progress/kendo-cli migrate --force`           |
+| `--to`         | Specifies the package version to migrate to. If not set, migrates to the latest available version of the respective package(s).            | `npx @progress/kendo-cli migrate @progress/kendo-react-grid --codemods --to=11`           |
+| `--from`         | Specifies the package version to migrate from. If not set, uses the current version.            | `npx @progress/kendo-cli migrate @progress/kendo-react-grid --codemods --from=10`           |
+| `--no-install`         | Skips the installation part of the migration. Use this option if you have already updated your packages and want to **only** run the available codemods.             | `npx @progress/kendo-cli migrate --no-install`           |
+| `--no-codemods`         | Skips the codemods step of the migration. Use this option to **only** install the available updates.            | `npx @progress/kendo-cli migrate --no-codemods`           |
+| `--no-peer-deps`         | Skips the installation of any peer dependencies for the updated packages. By default, the `migrate` command always installs the available peer dependencies.            | `npx @progress/kendo-cli migrate --no-peer-deps`           |
+| `--no-optional` | Skips the optional codemods, if any. Use this option to run **only** the required transformations. | `npx @progress/kendo-cli migrate --no-optional` |
+| `--ignore-pattern` | Specifies a glob pattern to ignore specific files or directories during the migration. Use this option to exclude files that you do not want to be modified. | `npx @progress/kendo-cli migrate --ignore-pattern="dist/**"` |
+
 ---
 
 *Copyright © 2023 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.*

package/dist/index.js

@@ -50921,9 +50921,12 @@ function getPkgJsonPath(path) {
         currentPath = (0, path_1.dirname)(currentPath);
     }
 }
-const getFiles = (pattern) => glob.sync(`${cwd}/**/${pattern || defaultPattern}`, {
-    ignore: ["**/node_modules/**"],
-});
+const getFiles = (pattern, ignorePattern) => {
+    let ignorePatterns = ignorePattern ? ["**/node_modules/**", (0, path_1.join)(cwd, ignorePattern)] : ["**/node_modules/**"];
+    return glob.sync(`${cwd}/**/${pattern || defaultPattern}`, {
+        ignore: ignorePatterns,
+    });
+};
 async function shouldRunCodemod(codemod, version, args) {
     const isOptional = codemod.prompt;
     const isForce = args.force;
@@ -50964,7 +50967,7 @@ async function runMigrations({ migrations, pkgPath, pkgJson }, args) {
     let originalRoot;
     let originalFiles;
     let root = (originalRoot = cwd);
-    let files = (originalFiles = getFiles(migrations.options?.pattern));
+    let files = (originalFiles = getFiles(migrations.options?.pattern, args.ignorePattern));
     if (!args.force) {
         root = createTempDiffRoot(cwd, originalFiles);
         files = files.map((file) => file.replace(originalRoot, root));
@@ -51290,6 +51293,10 @@ function builder(yargs) {
         describe: "Runs the optional codemods (code transformations) configured by the `@progress` package.",
         type: "boolean",
         default: true,
+    })
+        .option("ignore-pattern", {
+        describe: "Glob patterns to ignore",
+        type: "string"
     });
 }
 exports.builder = builder;
@@ -51305,7 +51312,7 @@ async function handler(args) {
     }
     if (args.codemods) {
         for (const pkg in updatedDeps) {
-            (0, codemods_1.runCodemodsFor)(pkg, args);
+            await (0, codemods_1.runCodemodsFor)(pkg, args);
         }
     }
 }