magento / magento/magento2-phpstorm-plugin

Scaffold a simple shipping method

Open
#1,881 1 comment 0 reactions 0 assignees View on GitHub
code generation Complex good first issue Priority: P3
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.**
Currently, developing a custom shipping method in Magento requires manually creating various files and writing boilerplate code, which can be time-consuming and prone to errors. This process can be challenging, especially for new developers or those unfamiliar with Magento's shipping method architecture.

**Describe the solution you'd like (*)**
I would like to request a feature in the PhpStorm plugin for Magento that allows developers to easily scaffold a simple shipping method. This feature should generate the basic files and code structure needed for a custom shipping method, including necessary XML configurations, Model, and any other required classes. The scaffolded code should follow Magento's best practices and provide placeholders or comments to guide further customizations.

**Describe alternatives you've considered**
An alternative solution is to continue manually creating the shipping method, but this approach is less efficient and more prone to errors. Another option could be to use third-party tools or scripts for scaffolding, but having this functionality integrated into the PhpStorm plugin would be more convenient and consistent with Magento development workflows.

**Additional context**
The ability to quickly scaffold a simple shipping method would greatly enhance the development experience in Magento, making it easier for developers to create custom shipping solutions and encouraging adherence to Magento's coding standards. This feature would be particularly beneficial for new Magento developers or those working on projects with multiple custom shipping methods.

Contributor guide

Open the contributing guide

Research direction

No files, tests, or plugin entry points are named. Start by locating how the PhpStorm plugin currently implements generators or other scaffolding features, then define the required shipping-method files, generated structure, and acceptance checks before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, php
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.