/ui5-migration

ARCHIVED - A tool to support the migration of UI5 projects by adapting code for new UI5 framework versions.

Primary LanguageJavaScriptApache License 2.0Apache-2.0

UI5 logo

ui5-migration

Tooling to support the migration of UI5 projects by adapting code for new UI5 framework versions.

REUSE status Build Status npm version

Note: This project is currently in beta. While there are ongoing improvements and round-offs being applied, we see the early release as a great opportunity to collect feedback from the community to further advance the UI5 migration tooling.

The UI5 migration tool is node.js-based and performs source code replacements and optimizations, reducing or getting rid of deprecated API. It builds upon a powerful parsing of JavaScript sources into an AST (abstract syntax tree) in order to perform the actual code replacements. Migration typically consists of an analysis part and a code modification part.

IMPORTANT: The modified source code needs to be manually reviewed and thoroughly tested. There is no 100% guarantee that the modified code works as expected.

For more details on how-to migrate your project's codebase, please consult additional information such as the migration guide

Installation

Requirements

  • Node.js (version 14 or higher ⚠️)

The migration tool is currently available for early usage. It can be installed with npm.

npm install --global @ui5/migration

Usage

CLI

To verify that the installation worked, run:

ui5-migration --help

Execute migration for the current folder:

ui5-migration migrate

Please see command-line interface for more details.

Available migration tasks

A list of currently available migration tasks can be found here

Formatting options

A list of options to configure the formatting of migration output can be found here

Contributing

Please check our Contribution Guidelines. Your input and support is welcome!

Support

Please follow our Contribution Guidelines on how to report an issue.