Repository files navigation

PhpStorm IDE Plugin for a better Magento 2 development workflow.

Support the Project If you find this plugin helpful and want to support its development, consider buying the contributors a coffee: Thank you to our sponsors—your support means everything: Lucas van Staden Ivan Chepurnyi

• Configuration smart completion and references for XML/JavaScript files
• Navigate to configuration reference in scope of class/interface
• Go to plugin reference in scope of class/interface and method
• Navigate to Web API configuration reference in scope of class/interface and method
• Plugin class methods generation
• Plugin declaration inspection
• RequireJS reference navigation and completion
• MFTF reference navigation and completion
• GraphQL navigation line markers
• Code generation
• Inspections for XML configuration

1. Go toSettings > Preferences in the PhpStorm IDE
2. Navigate toPlugins
3. Click theBrowse repositories... button and search for "Magento PhpStorm"
4. Install the plugin and restart PhpStorm
5. Go toSettings > Preferences > Languages & Frameworks > PHP > Frameworks > Magento in the PhpStorm IDE
6. CheckEnable and click theOK button

• PhpStorm >= 2023.1
• JRE >= 17

1. Check out this repository
2. Open a folder with the project in the IntelliJ CE using theopen action button.
3. Make sure that you on the latest develop branch (e.g5.4.0-develop)
4. Right-click on thebuild.gradle file, choose "Import Gradle project" (if this is not exist look for "Build module ''") (you need to have Gradle plugin installed)
5. Check if the right SDK version is used for the project.
   • Current Java version for the project isjava 11, so you should additionally downloadSDK 11 and choose it in the module settings:Right click by the project root > Open Module Settings > Project Settings > Project > Project SDK
   • Check if right SDK version is used for the Gradle plugin:Intellij IDEA > Preferences... > Build, Execution, Deployment > Build Tools > Gradle > Gradle JVM and choose your JDK.
6. When the Gradle sections appeared in the right bar, navigate there and right-clickmagento-2-php-storm-plugin > Tasks -> Intellij -> runIde
7. ClickRun "magento-2-php-storm-plugin" to run the plugin. You should see a new instance of IntelliJ launched with the plugin installed. Make sure the plugin is enabled in IntelliJ settings and indexing is finished. Plugin features should be accessible at this point.

1. Start with looking intoCommunity Backlog. Any ticket inReady for Development andGood First Issue columns are a good candidates to start.
2. Didn't satisfy your requirements?Create a new issue. It can be for example:
   • Bug report - Found a bug in the code? Let us know!
   • Enhancement - Know how to improve existing functionality? Open an issue describe how to enhance the plugin.
   • New feature proposal - Know how to make a killer feature? Do not hesitate to submit your proposal.
3. The issue will appear in theReady for Grooming column of theCommunity Backlog. Once it will be discussed and approved the issue will be ready for development.
4. Refer to theContributing Guide for more information on how to contribute.

1. SDKDeveloping a Plugin
2. Good Presentation about platformHow We Built Comma, the Raku IDE, on the IntelliJ Platform
3. Plugin exampleidea-php-symfony2-plugin

1. Create sandbox folder
2. Copy to sandbox foldercomposer.json andcomposer.lock
3. In sandbox folder createapp/code andvendor/magento
4. Copy any of the magento modules (as for example:framework,module-catalog,module-checkout,module-customer,module-sales) into thevendor/magento folder. It is better to add as few modules as possible to reduce reindexing time during application running
5. (Nice to have) Open IDE and go toPreferences > Editor > File and Code Templates > Includes tab and add default headers forPHP File Header andXML File Header

PHP File Header:

/** * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */declare(strict_types=1);

XML File Header:

<!--/** * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */-->

Each Magento source file included in this distribution is licensed under OSL-3.0 license.

Please read theLICENSE.txt for the full text of theOpen Software License v. 3.0 (OSL-3.0).