From dcaa69f9bbc29620f340db97b271ade392789ba3 Mon Sep 17 00:00:00 2001 From: Jannis Leifeld Date: Tue, 21 Jan 2025 10:08:56 +0100 Subject: [PATCH] docs: add upgrade information for Meteor components --- .../system-updates/meteor-components.md | 52 +++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 guides/plugins/plugins/administration/system-updates/meteor-components.md diff --git a/guides/plugins/plugins/administration/system-updates/meteor-components.md b/guides/plugins/plugins/administration/system-updates/meteor-components.md new file mode 100644 index 000000000..18d5cc2d5 --- /dev/null +++ b/guides/plugins/plugins/administration/system-updates/meteor-components.md @@ -0,0 +1,52 @@ +--- +nav: + title: Upgrading to Meteor Components + position: 260 +--- + +# Future Development Roadmap: Upgrading to Meteor Components + +> **Note:** The information provided in this article, including timelines and specific implementations, is subject to change. +> This document serves as a general guideline for our development direction. + +## Introduction + +With the release of Shopware 6.7, we will replace several current administration components with components from the [Meteor Component Library](https://meteor-component-library.vercel.app/). + +## Why Meteor Components? + +The Meteor Component Library is Shopware's official collection of reusable components that are used across multiple Shopware projects and are built on the Shopware Design System. + +Using a shared component library offers several advantages: +- **Consistent Design**: All components follow the Shopware Design System guidelines. +- **Consistent Behavior**: All components share standardized behavior patterns and API conventions. +- **Reusability**: Components can be seamlessly integrated across different projects and apps. +- **Maintenance**: Updates and improvements to components are managed centrally and automatically propagate to all projects using the component library. + +## Migration guide + +For each component being replaced, we provide a detailed upgrade guide that explains the migration process from the old component to the new Meteor Component. You can find these guides in the technical upgrade documentation for the release. + +## Using Code mods for migration + +To simplify the plugin migration process, we provide codemods that automatically replace old components with new Meteor Components. + +### Prerequisites +- A development version of Shopware must be installed +- Your plugin must be located in the `custom/plugins` folder + +### Running the Migration Tool +1. Execute the following composer command: + ```bash + # Main command which outputs also the help text + composer run admin:code-mods + + ## Example with arguments + # composer run admin:code-mods -- --plugin-name example-plugin --fix + ``` +2. Provide your plugin name and target Shopware version for migration +3. The tool will: + - Automatically replace compatible components with Meteor Components + - Add guidance comments for components that require manual migration + - Check for and update other deprecated code where possible + \ No newline at end of file