• Stars
    star
    436
  • Rank 99,877 (Top 2 %)
  • Language
    Java
  • License
    Open Software Lic...
  • Created almost 7 years ago
  • Updated 27 days ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

PHPStorm Plugin for Magento 2

Magento Commerce

PhpStorm Magento 2 Plugin

Version Downloads Made With Love

Installation

  1. Go to Settings > Preferences in the PhpStorm IDE
  2. Navigate to Plugins
  3. Click the Browse repositories... button and search for "Magento PhpStorm"
  4. Install the plugin and restart PhpStorm
  5. Go to Settings > Preferences > Languages & Frameworks > PHP > Frameworks > Magento in the PhpStorm IDE
  6. Check Enable and click the OK button

Works with

  • PhpStorm >= 2023.1
  • JRE >= 17

Features

  • 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

Setting up development environment

  1. Check out this repository
  2. Open a folder with the project in the IntelliJ Ultimate using the open action button.
  3. Make sure that you on the latest develop branch (e.g 5.2.0-develop)
  4. Right-click on the build.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 is java 11, so you should additionally download SDK 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-click magento-2-php-storm-plugin > Tasks -> Intellij -> runIde
  7. Click Run "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.

How to contribute

  1. Start with looking into Community Backlog. Any ticket in Ready for Development and Good 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 the Ready for Grooming column of the Community Backlog. Once it will be discussed and approved the issue will be ready for development.
  4. Refer to the Contributing Guide for more information on how to contribute.

How to create SandBox for development

  1. Create sandbox folder
  2. Copy to sandbox folder composer.json and composer.lock
  3. In sandbox folder create app/code and vendor/magento
  4. Copy any of the magento modules (as for example: framework, module-catalog, module-checkout, module-customer, module-sales) into the vendor/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 to Preferences > Editor > File and Code Templates > Includes tab and add default headers for PHP File Header and XML 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.
 */
-->

Join the #phpstorm-plugin Slack channel to get more involved

License

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

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

More Repositories

1

magento2

Prior to making any Submission(s), you must sign an Adobe Contributor License Agreement, available here at: https://opensource.adobe.com/cla.html. All Submissions you make to Adobe Inc. and its affiliates, assigns and subsidiaries (collectively “Adobe”) are subject to the terms of the Adobe Contributor License Agreement.
PHP
11,535
star
2

pwa-studio

🛠Development tools to build, optimize and deploy Progressive Web Applications for Magento 2.
JavaScript
1,067
star
3

devdocs

[Deprecated] Magento Developer Documentation
Ruby
673
star
4

magento-coding-standard

Magento Coding Standard
PHP
347
star
5

data-migration-tool

Magento Data Migration Tool
PHP
336
star
6

inventory

Magento Inventory Project (a.k.a MSI)
PHP
336
star
7

architecture

A place where Magento architectural discussions happen
274
star
8

magento-cloud-docker

All Submissions you make to Magento Inc. (“Magento") through GitHub are subject to the following terms and conditions: (1) You grant Magento a perpetual, worldwide, non-exclusive, no charge, royalty free, irrevocable license under your applicable copyrights and patents to reproduce, prepare derivative works of, display, publically perform, sublicense and distribute any feedback, ideas, code, or other information (“Submission") you submit through GitHub. (2) Your Submission is an original work of authorship and you are the owner or are legally entitled to grant the license stated above. (3) You agree to the Contributor License Agreement found here: https://github.com/magento/magento2/blob/master/CONTRIBUTOR_LICENSE_AGREEMENT.html
PHP
256
star
9

marketplace-eqp

Magento 1.x Coding Standard
PHP
224
star
10

magento2-sample-data

Magento 2 Sample Data
PHP
212
star
11

magento-cloud

Magento Cloud
PHP
205
star
12

baler

AMD module bundler and preloader for Magento 2 stores.
JavaScript
175
star
13

m2-devtools

Helpful in-browser debugging/inspection tools for the Magento 2 Front-End
TypeScript
171
star
14

magento2-functional-testing-framework

Magento2 Functional Testing Framework
PHP
155
star
15

quality-patches

PHP
148
star
16

graphql-ce

[ARCHIVED] Please use magento/magento2 project
PHP
131
star
17

ece-tools

All Submissions you make to Magento Inc. (“Magento") through GitHub are subject to the following terms and conditions: (1) You grant Magento a perpetual, worldwide, non-exclusive, no charge, royalty free, irrevocable license under your applicable copyrights and patents to reproduce, prepare derivative works of, display, publically perform, sublicense and distribute any feedback, ideas, code, or other information (“Submission") you submit through GitHub. (2) Your Submission is an original work of authorship and you are the owner or are legally entitled to grant the license stated above. (3) You agree to the Contributor License Agreement found here: https://github.com/magento/magento2/blob/master/CONTRIBUTOR_LICENSE_AGREEMENT.html
PHP
117
star
18

magento2-page-builder

Magento2 PageBuilder
JavaScript
80
star
19

security-package

Magento Security Extensions
PHP
73
star
20

magento2-samples

[ONLY Magento 2.0.x Compatible] Code samples for Magento developers
PHP
73
star
21

adobe-stock-integration

Magento Adobe Stock integration Community Project.
PHP
60
star
22

composer-root-update-plugin

PHP
57
star
23

community-features

Magento Features Development is an Initiative to Allows Community Memebers Join to Development of Magento Features
46
star
24

meta-for-magento2

PHP
38
star
25

magento-cloud-patches

All Submissions you make to Magento Inc. (“Magento") through GitHub are subject to the following terms and conditions: (1) You grant Magento a perpetual, worldwide, non-exclusive, no charge, royalty free, irrevocable license under your applicable copyrights and patents to reproduce, prepare derivative works of, display, publically perform, sublicense and distribute any feedback, ideas, code, or other information (“Submission") you submit through GitHub. (2) Your Submission is an original work of authorship and you are the owner or are legally entitled to grant the license stated above. (3) You agree to the Contributor License Agreement found here: https://github.com/magento/magento2/blob/master/CONTRIBUTOR_LICENSE_AGREEMENT.html
PHP
34
star
26

merchdocs

[Deprecated] Magento User Guide
Ruby
33
star
27

magento-semver

Magento Semantic Versioning Checker. Join #svc in our Community Slack: https://opensource.magento.com/slack. Static tests that identify required module version changes based on code diff, and look for backward incompatible changes.
PHP
33
star
28

backlog

Magento product backlog
31
star
29

composer

PHP
31
star
30

bulk-api-ce

Magento 2 CE repository dedicated for implementation of the Bulk API
30
star
31

m2-baler

PHP
30
star
32

commerce-data-export

PHP
25
star
33

magento2-upward-connector

Magento module for routing front-end requests to UPWARD-PHP
PHP
24
star
34

magento2-jp

Magento Community Project for providing best experience for Japanese market
PHP
24
star
35

magento-cloud-components

All Submissions you make to Magento Inc. (“Magento") through GitHub are subject to the following terms and conditions: (1) You grant Magento a perpetual, worldwide, non-exclusive, no charge, royalty free, irrevocable license under your applicable copyrights and patents to reproduce, prepare derivative works of, display, publically perform, sublicense and distribute any feedback, ideas, code, or other information (“Submission") you submit through GitHub. (2) Your Submission is an original work of authorship and you are the owner or are legally entitled to grant the license stated above. (3) You agree to the Contributor License Agreement found here: https://github.com/magento/magento2/blob/master/CONTRIBUTOR_LICENSE_AGREEMENT.html
PHP
23
star
36

glossary

Magento Glossary Application
JavaScript
20
star
37

magento2-kubernetes-devbox

Shell
18
star
38

magento2-pwa

PHP
15
star
39

devdocs-m1

HTML
14
star
40

upward-php

Implementation of UPWARD spec written in PHP
PHP
14
star
41

magento-eslint

Shared ESLint configuration for Magento PWA-related projects
JavaScript
13
star
42

knowledge-base

Shell
12
star
43

ts-types

TypeScript Definitions for Magento 2
8
star
44

catalog-storefront

PHP
7
star
45

module-grpc

PHP
6
star
46

aep-launch

PHP
6
star
47

pagebuilder-docs

Page Builder development documentation
5
star
48

magento-japan-tax

PHP
5
star
49

graphql

TypeScript
5
star
50

storefront-message-broker

PHP
4
star
51

storefront-search-ce

PHP
4
star
52

app-builder-samples

JavaScript
4
star
53

pwa-tests

4
star
54

composer-dependency-version-audit-plugin

validating packages through a composer plugin
PHP
4
star
55

adobe-commerce-catalog-service

4
star
56

page-builder-types

Magento Page Builder Types
4
star
57

devdocs-mbi

Magento Business Intelligence developer documentation
4
star
58

directive-parser

Parses Magento PWA Studio directives
JavaScript
3
star
59

marketplace-subscriptions

PHP
3
star
60

adobe-ims

PHP
3
star
61

storefront-product-reviews-ce

PHP
2
star
62

storefront-pricing-ce

PHP
2
star
63

magento2devbox-web

PHP
2
star
64

magento-zend-memory

PHP
2
star
65

magento-zend-log

PHP
2
star
66

magento-zend-exception

PHP
2
star
67

magento-zend-db

PHP
2
star
68

magento-zend-cache

PHP
2
star
69

magento-zend-pdf

PHP
2
star
70

php-proto-generator

A tool to generate Magento modules from proto definitions
PHP
2
star
71

mtf

PHP
2
star
72

magento-zend-loader

PHP
2
star
73

language-ja_JP

Japanese Language Pack for Magento 2 Resources
PHP
2
star
74

inventory-composer-installer

PHP
1
star
75

devops-cla-test-public

1
star
76

storefront-authentication-ce

1
star
77

magento2-pwa-commerce

1
star