Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Gradle Intellij plugin to version 2 [WIP] #2473

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
17 changes: 1 addition & 16 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,16 +1,3 @@
# Windows image file caches
Thumbs.db
ehthumbs.db

# Folder config file
Desktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Windows Installer files
*.cab
*.msi
*.msm
*.msp

Expand Down Expand Up @@ -49,6 +36,4 @@ out
.gradle
.idea-sandbox
build
gradle
gradlew
gradlew.bat
.intellijPlatform/*
32 changes: 19 additions & 13 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0).

## 5.4.0

### Changed

- Updated Gradle Intellij plugin to version 2 [#2473](https://github.com/magento/magento2-phpstorm-plugin/pull/2473)
The project no longer requires the paid Ultimate edition of IntelliJ IDEA. It can now run seamlessly in the Community edition.
Enabled code emulation directly within PHPStorm, eliminating the dependency on IntelliJ IDEA for this functionality.

## 5.3.1

### Fixed
Expand Down Expand Up @@ -431,7 +437,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0).

### Added

- PWA pure function Live Template
- PWA pure function Live Template

### Fixed

Expand Down Expand Up @@ -516,7 +522,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0).
- Code Inspection: GraphQL resolver in the scope of a PHP Class
- Code Inspection: Duplicated Observer Usage in events XML
- Moved plugin configuration from `Settings > Preferences > Languages & Frameworks > PHP > Magento` to
`Settings > Preferences > Languages & Frameworks > PHP > Frameworks > Magento`
`Settings > Preferences > Languages & Frameworks > PHP > Frameworks > Magento`
- Fixed support of 202## 0.* versions of IDE's

## 0.3.0
Expand All @@ -541,7 +547,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0).
- Added project detector
- Move configuration section to "Languages & Frameworks > Php > Magento"
- Remove deprecated elements

## 0.2.2

### Added
Expand All @@ -551,23 +557,23 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0).
### Fixed

- Fixed "Project disposed" exception

## 0.2.1

### Added

- added module name for "Goto configuration" labels

## 0.2.0

### Added

- WebApi routes
- nicer "Goto configuration" labels
- plugin settings (manual reindex, URN generation, plugin on/off)
## 0.1

## 0.1.0

### Added

- Context type completion for:
Expand All @@ -580,9 +586,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0).
- virtualType arguments resolution
- webapi.xml interface/method completion/references
- Support for old people using PhpStorm 8 or JDK## 1.7

## 0.0.9

### Added

- Added Reference and completion support for layouts
Expand All @@ -607,13 +613,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0).
- Added reference to configuration and observers (classes or virtualType)
- Added reference to observers from configuration
- Added reference to event dispatch from configuration

## 0.0.6

### Added

- Added reference and completion support for virtual types/classes/arguments in DI configuration

## 0.0.5

### Added
Expand Down
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@
</a>
</p>

<!-- Plugin description -->
# PhpStorm Magento 2 Plugin

This is a PhpStorm IDE plugin for a better Magento 2 development workflow.
<!-- Plugin description end -->

[![Version](http://phpstorm.espend.de/badge/8024/version)](https://plugins.jetbrains.com/plugin/8024)
[![Downloads](http://phpstorm.espend.de/badge/8024/downloads)](https://plugins.jetbrains.com/plugin/8024)
[![Made With Love](https://img.shields.io/badge/Made%20With-Love-orange.svg)](https://magento.com)
Expand Down Expand Up @@ -41,21 +45,21 @@
## Setting up development environment

1. Check out this repository
1. Open a folder with the project in the IntelliJ Ultimate using the `open` action button.
1. Open a folder with the project in the IntelliJ CE using the `open` action button.
1. Make sure that you on the latest develop branch (e.g `5.4.0-develop`)
1. Right-click on the `build.gradle` file, choose "Import Gradle project" (if this is not exist look for "Build module '<root folder name>'") (you need to have Gradle plugin installed)
1. 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.
- 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.
1. When the Gradle sections appeared in the right bar, navigate there and right-click `magento-2-php-storm-plugin > Tasks -> Intellij -> runIde`
1. 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](https://github.com/magento/magento2-phpstorm-plugin/projects/2). 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](https://github.com/magento/magento2-phpstorm-plugin/issues/new). 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.
- **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](https://github.com/magento/magento2-phpstorm-plugin/projects/2). Once it will be discussed and approved the issue will be ready for development.
4) Refer to the [Contributing Guide](https://github.com/magento/magento2-phpstorm-plugin/blob/2.1.0-develop/.github/CONTRIBUTING.md) for more information on how to contribute.

Expand All @@ -65,7 +69,7 @@
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:**
```php
/**
Expand All @@ -91,4 +95,4 @@ declare(strict_types=1);

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

Please read the [LICENSE.txt](https://github.com/magento/magento2-phpstorm-plugin/blob/master/LICENSE.txt) for the full text of the [Open Software License v. 3.0 (OSL-3.0)](http://opensource.org/licenses/osl-3.0.php).
Please read the [LICENSE.txt](https://github.com/magento/magento2-phpstorm-plugin/blob/master/LICENSE.txt) for the full text of the [Open Software License v. 3.0 (OSL-3.0)](http://opensource.org/licenses/osl-3.0.php).
137 changes: 0 additions & 137 deletions build.gradle

This file was deleted.

Loading
Loading