https://github.com/nntoan/magento2-phpstorm-templates

Easier daily development with Magento 2 PhpStorm templates.
https://github.com/nntoan/magento2-phpstorm-templates

magento2 phpstorm-settings phpstorm-templates

Last synced: about 1 month ago
JSON representation

Easier daily development with Magento 2 PhpStorm templates.

• Host: GitHub
• URL: https://github.com/nntoan/magento2-phpstorm-templates
• Owner: nntoan
• Created: 2018-02-05T04:55:04.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-07-29T09:30:37.000Z (almost 7 years ago)
• Last Synced: 2026-01-27T11:03:54.780Z (4 months ago)
• Topics: magento2, phpstorm-settings, phpstorm-templates
• Language: PHP
• Size: 154 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Magento 2 PHPStorm Preferences

This project is intended to setup useful PHPStorm Templates for Magento 2 Projects.

## Disclaimer

This project overrides the default file template `PHP Class.php` to add a specific header comments.

We need to edit this file instead of creating a new one because automatic Namespace only works on this specific template.

All other templates are custom ones with a naming prefix `2M` in order to make them unique.

## Installation

1. Clone the repository to your machine

    * `git clone https://github.com/nntoan/magento2-phpstorm-templates`

2. Copy `fileTemplates/includes/nntoan_variables.txt.dist` to `fileTemplates/includes/nntoan_variables.txt`

3. Copy or symlink all folders inside `/Preferences` to:

    * Windows: `/./config/`

    * Linux: `~\./config/`

    * Mac OS: `~/Library/Preferences//`

4. Set your personal configuration for comments on PHPStorm `Preferences -> Editor -> File and Code Templates -> nntoan_variables`

    ![Comments settings](docs/img/comments_settings.png)

## Available Templates

* [File Templates](docs/fileTemplates.md)

* [Live Templates](docs/liveTemplates.md)

## Usage

All file and live templates namings start with `2M` except `PHP Class.php`.

We need to use the default `PHP Class.php` because automatic Namespace only works on this specific template.

## Contribute

You can contribute with new templates following this manual:

* [Contribute manual](./docs/contribute.md)

## Demo

![Video Demo](docs/img/video-demo.gif)