luminus-upgrade
luminus-upgrade
is a command-line tool designed to simplify the migration of eitri-apps
projects that use the luminus
library, upgrading from version 1.x to higher versions in an automated and safe way.
📌 Features
- 🔄 Easy upgrade: Automates the migration from
luminus
1.x to newer versions.
- ✅ Compatibility checks: Ensures a smooth transition without breaking changes.
- ⚡ Fast: Runs quickly but maybe require some user interaction after the upgrade.
🚀 Installation & Usage
None installation is required.
Go to the root directory of your eitri-apps
project and run the following command:
npx luminus-upgrade <version> <eitri-app-root-directory>
- Version: The major version of
luminus
to upgrade to, example: 2 or 3 (in the future)
- Eitri-app root directory: The root directory of your eitri-app project, example: . or ./../my-eitri-app
Example
npx luminus-upgrade 2
Currently, only version 2 is supported. In the future, version 3 will be available:
npx luminus-upgrade 3
Revent
npx luminus-upgrade rollback
or pointing to another eitri-app project
npx luminus-upgrade rollback ../myotherproject/myeitri-app
Example Output
When running the command, you might see an output like this when the upgrade is successful:
🎉 Eitri-App Convert Completed!
⚙️ How It Works
- 🔍 Detects the current luminus version in the project.
- ⬆️ Modifies the eitri-conf.js file to use the new version.
- 🔄 Make a backup folder of the project.
- 📦 Process all jsx files in the project (components also included).
📋 Requirements
- Node.js 16+ is required.
- Must be executed inside an eitri-apps project.
⏪ Rollback / Reverting Changes
- Rollback option will be available in the future.
- But you can always revert the changes renaming the backup folder to src.
🔒 Additional Information
- This tool is private and intended exclusively for eitri-apps projects.
- There is no public repository, open-source license, or contribution process.
- For internal support, please contact the appropriate team at https://eitri.tech
📝 Changelog
[1.0.0] - 2025-02-05
🎉 First Release
- Automated upgrade from
luminus
1.x to 2.x.
- Modify eitri-conf.js file to use the new version.
- Make a backup folder of the project.
- Checks src folder for jsx files.
- Process all jsx files in the project (components also included).
- Checks recent versions of luminus.
[1.0.1] - 2025-02-06
🐛 Fix
- Added a readme file to the project.
[1.1.0] - 2025-02-06
✨ Feature
- Feature to point a path to the eitri-app root directory as second argument
[1.1.1] - 2025-02-07
🐛 Fix
- Improvements on conversion process
[1.2.0] - 2025-02-07
✨ Feature
- Added a option to restore
[1.2.1] - 2025-02-07
🐛 Fix
- Improvements on conversion process
[1.2.2] - 2025-02-07
🐛 Fix
- Improvements on conversion process
[1.2.3] - 2025-02-10
🐛 Fix
- Fix conversion of tags: MaskedInput, Icon and ImageView
[1.2.4] - 2025-02-11
🐛 Fix
- Fix conversion of tags: Icon
[1.2.5] - 2025-02-11
🐛 Fix
- Fix conversion of tags: HtmlRenderer