magento / magento/magento2-phpstorm-plugin
Automatic Generation of Magento Store Configurations
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 463
- Forks
- 98
- Avg merge
- 1h 6m
- Merged PRs (30d)
- 3
Description
Is your feature request related to a problem? Please describe.
The problem is the manual and time-consuming process required to add configurations in Magento's system.xml for new modules or features, which is prone to errors and inefficient. This manual process involves defining tabs, sections, groups, and fields for a wide array of configuration types, hindering productivity and increasing the potential for mistakes.
Describe the solution you'd like (*)
I propose an enhancement to the Magento plugin that introduces generator for a broader range of store configuration options. This solution would enable developers to define configurations in the system.xml file more efficiently and generate corresponding classes automatically, such as ConfigProvider classes or helpers. This feature should be designed to accommodate the full spectrum of configuration types (e.g., text fields, select options, multiselects, etc.), adhering to the established hierarchy of tabs, sections, groups, and fields within the Magento Admin configuration UI.
Describe alternatives you've considered
While continuing with the manual process is an alternative, it remains inefficient and error-prone. An automated approach to generating all types of configurations would significantly enhance productivity and reduce errors.
Additional context
The introduction of this feature would mark a significant improvement in the Magento development process by streamlining the configuration management for new features and modules. It would allow developers to focus more on the innovation and development of features rather than being bogged down by the repetitive and meticulous process of configuration setup.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing how the plugin currently handles Magento's system.xml and generated ConfigProvider classes or helpers. Define the supported tabs, sections, groups, fields, and configuration types before identifying the relevant generator entry points. Done means the generator covers the requested hierarchy and types with validation and tests, though no test files are named in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, php
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100