@octaviaflow/upgrade 1.0.0

package/README.md

@@ -0,0 +1,97 @@
+# @octaviaflow/upgrade
+
+> A tool for upgrading Carbon versions
+
+## Getting started
+
+To install `@octaviaflow/upgrade` in your project, you will need to run the following
+command using [npm](https://www.npmjs.com/):
+
+```bash
+npm install -S @octaviaflow/upgrade
+```
+
+If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
+instead:
+
+```bash
+yarn add @octaviaflow/upgrade
+```
+
+## Usage
+
+You can install `@octaviaflow/upgrade` in your project, or use a tool like
+[`npx`](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b)
+by running the following command in your project:
+
+```bash
+npx @octaviaflow/upgrade
+```
+
+Below is a full output of the options and commands available:
+
+```bash
+Usage: @octaviaflow/upgrade [options]
+
+Commands:
+  @octaviaflow/upgrade upgrade                   upgrade your project       [default]
+  @octaviaflow/upgrade migrate <migration>       run a Carbon migration on your
+  [paths...]                                source files
+  @octaviaflow/upgrade migrate list              list all available migrations
+
+Options:
+      --help     Show help                                             [boolean]
+      --version  Show version number                                   [boolean]
+      --force    force execution if the cli encounters an error while doing
+                 safety checks                        [boolean] [default: false]
+  -w, --write    update the files with changes found by running the migration
+                                                      [boolean] [default: false]
+  -v, --verbose  optionally include additional logs, useful for debugging
+                                                      [boolean] [default: false]
+```
+
+### Migrations
+
+Included within the CLI are a number of migrations available to you to be ran on
+your project's source files.
+
+Migrations are automated scripts (codemods) ran using the
+[jscodeshift](https://github.com/facebook/jscodeshift) runner, that will apply
+intelligent transformations to your code.
+
+These migrations range from simple automations like a find and replace of import
+statements, to more sophisticated migrations that rewrite component prop usage,
+configuration, and set up. The source of these migrations can be viewed within
+the
+[transforms folder](https://github.com/octaviaflow-design-system/tree/main/packages/upgrade/transforms).
+Each is tested against a series of test fixtures to ensure transforms are
+predictable and consistently provide the intended output.
+
+#### Output formatting
+
+The output of a codemod may not match your codebase's formatting style. It is
+recommended to always run the result of a codemod through an autoformatter like
+[Prettier](https://prettier.io/).
+
+## 🙌 Contributing
+
+If you have ideas on how we could make your migration experience easier, please
+reach out by
+[opening a new discussion](https://github.com/octaviaflow-design-system/discussions/new).
+
+We're always looking for contributors to help us fix bugs, build new features,
+or help us improve the project documentation. If you're interested, definitely
+check out our [Contributing Guide](/.github/CONTRIBUTING.md)! 👀
+
+## 📝 License
+
+Licensed under the [Apache 2.0 License](/LICENSE).
+
+## <picture><source height="20" width="20" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-dark.svg"><source height="20" width="20" media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"><img height="20" width="20" alt="IBM Telemetry" src="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"></picture> IBM Telemetry
+
+This package uses IBM Telemetry to collect de-identified and anonymized metrics
+data. By installing this package as a dependency you are agreeing to telemetry
+collection. To opt out, see
+[Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection).
+For more information on the data being collected, please see the
+[IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics).

package/bin/carbon-upgrade.js

@@ -0,0 +1,48 @@
+/**
+ * Copyright OctaviaFlow
+ * Author: Vishal Kumar
+ * Created: 11/November/2025
+ * 
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#!/usr/bin/env node
+
+/**
+ * Copyright OctaviaFlow
+ * Author: Vishal Kumar
+ * Created: 11/November/2025
+ * 
+ */
+
+/* eslint-disable no-console */
+
+'use strict';
+
+// Makes the script crash on unhandled rejections instead of silently
+// ignoring them. In the future, promise rejections that are not handled will
+// terminate the Node.js process with a non-zero exit code.
+process.on('unhandledRejection', (error) => {
+  console.error(error);
+});
+
+var currentNodeVersion = process.versions.node;
+var semver = currentNodeVersion.split('.');
+var major = semver[0];
+
+if (major < 14) {
+  console.error(
+    `You are running Node ${currentNodeVersion}.\n` +
+      `octaviaflow-upgrade requires Node 14 or higher, please update your ` +
+      `version of Node.`
+  );
+  process.exit(1);
+}
+
+var { main } = require('../cli');
+
+main(process).catch((error) => {
+  console.error(error);
+  process.exit(1);
+});