### Install Migration Tool Utils Source: https://github.com/mgm-tp/a12-migration-tool/blob/main/utils/README.md Install the migration tool utilities as a development dependency using npm. ```sh npm install --save-dev @com.mgmtp.a12.migrationtool/migrationtool-utils ``` -------------------------------- ### Install Migration Tool Core Source: https://github.com/mgm-tp/a12-migration-tool/blob/main/core/README.md Install the migration tool core package as a development dependency. ```sh npm install --save-dev @com.mgmtp.a12.migrationtool/migrationtool-core ``` -------------------------------- ### Start Development Environment Source: https://github.com/mgm-tp/a12-migration-tool/blob/main/README.md Starts the development servers and TypeScript compilers in watch mode. This is the recommended command for active development. ```sh pnpm start ``` -------------------------------- ### Install Dependencies with pnpm Source: https://github.com/mgm-tp/a12-migration-tool/blob/main/README.md Installs all project dependencies and links local packages. This command is essential before building or running the project. ```sh pnpm install ``` -------------------------------- ### Install Migration Tool Packages Source: https://github.com/mgm-tp/a12-migration-tool/blob/main/README.md Install the core and utility packages for the A12 Migration Tool. This is the command to use if you want to integrate the tool into your project. ```sh npm install @com.mgmtp.a12.migrationtool/migrationtool-core @com.mgmtp.a12.migrationtool/migrationtool-utils ``` -------------------------------- ### Migration Tool Utils Help Source: https://github.com/mgm-tp/a12-migration-tool/blob/main/utils/README.md Display the help message for the migration-tool-utils command-line interface, showing available commands and options. ```sh $ migration-tool-utils --help Usage: migration-tool-utils [options] Commands: migration-tool-utils generate-step Create a new step interactively migration-tool-utils compile Compile JSON schemas and all source files migration-tool-utils validate-consistency Validate the model definition in the latest step model is matched the one in core module migration-tool-utils validate-official-version Validate the latest step is an official version for final release Options: --version Show version number [boolean] -c, --config Path to the config file. If not specified, the tool will look for 'migration-tool.config.json' file in the current working directory [string] --help Show help [boolean] ``` -------------------------------- ### Create CLI Migration Tool Source: https://github.com/mgm-tp/a12-migration-tool/blob/main/core/README.md Create a command-line interface migration tool using the migration configuration. ```typescript // cli.ts import { createMigrationCLI } from "@com.mgmtp.a12.migrationtool/migrationtool-core/lib/cli"; import { MIGRATION_CONFIG } from "./config"; createMigrationCLI(MIGRATION_CONFIG); ``` -------------------------------- ### Create API Migration Tool Source: https://github.com/mgm-tp/a12-migration-tool/blob/main/core/README.md Create an API-based migration tool instance using the migration configuration. ```typescript // config.ts import { MIGRATION_STEPS } from "./steps"; export const MIGRATION_CONFIG = { modelType: "page", minimumSupportedVersion: "5.0.0", migrationSteps: MIGRATION_STEPS }; // api.ts import { createMigrationTool } from "@com.mgmtp.a12.migrationtool/migrationtool-core/lib/web"; import { MIGRATION_CONFIG } from "./config"; export const pageMigrationTool = createMigrationTool(MIGRATION_CONFIG); ``` -------------------------------- ### Run Unit Tests Source: https://github.com/mgm-tp/a12-migration-tool/blob/main/README.md Executes unit tests across all packages in the repository. This command helps ensure the integrity and correctness of the migration tool's components. ```sh pnpm test ``` -------------------------------- ### createMigrationCLI Source: https://github.com/mgm-tp/a12-migration-tool/blob/main/core/README.md Creates the command-line interface for any A12 Engine migration tool. This function takes migration parameters and sets up the CLI. ```APIDOC ## createMigrationCLI(params: MigrationParameters): void ### Description Creates the command-line interface for any A12 Engine migration tool. See [`CLI Options`](#cli-options) for command line options. ### Method `createMigrationCLI` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body * **params** (MigrationParameters) - Required - The parameters for configuring the migration CLI. ``` -------------------------------- ### Run Linting Source: https://github.com/mgm-tp/a12-migration-tool/blob/main/README.md Executes the linter to check for code style and potential issues. This command helps maintain code quality and consistency. ```sh pnpm lint ``` -------------------------------- ### createMigrationTool Source: https://github.com/mgm-tp/a12-migration-tool/blob/main/core/README.md Creates an instance of the MigrationTool interface for use in browser environments. This function is used to migrate target models within the browser. ```APIDOC ## createMigrationTool(params: MigrationParameters): MigrationTool ### Description Creates an instance of [`MigrationTool`](#migrationtool) interface that uses to migrate the target models in the browser environments. ### Method `createMigrationTool` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body * **params** (MigrationParameters) - Required - The parameters for configuring the migration tool. ``` -------------------------------- ### Compile Packages Source: https://github.com/mgm-tp/a12-migration-tool/blob/main/README.md Builds all packages within the A12 Migration Tool repository. This command compiles the source code into distributable artifacts. ```sh pnpm compile ``` -------------------------------- ### Format Code Source: https://github.com/mgm-tp/a12-migration-tool/blob/main/README.md Automatically formats the code to fix linting issues and adhere to style guidelines. This command improves code readability and maintainability. ```sh pnpm format ``` -------------------------------- ### Clean Build Artifacts Source: https://github.com/mgm-tp/a12-migration-tool/blob/main/README.md Removes all generated build artifacts from the project. Use this command to ensure a clean state before rebuilding. ```sh pnpm clean ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.