Skip to content

Commit c713e6c

Browse files
author
Robert Egginton
committed
Replaced additional installed_path with README.md instruction
1 parent 13afa92 commit c713e6c

File tree

2 files changed

+18
-5
lines changed

2 files changed

+18
-5
lines changed

README.md

+16-3
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,22 @@
22

33
A set of Magento rules for [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) tool.
44

5-
### Installation
6-
For development puposes you can install Magento Coding Standard by cloning this GitHub repo
5+
#### Installation within a Magento 2 site
6+
To use within your Magento 2 project you can use:
7+
````
8+
composer require --dev magento/magento-coding-standard
9+
````
10+
Due to security, when installed this way the Magento standard for phpcs cannot be added automatically.
11+
You can achieve this by adding the following to your project's `composer.json`:
12+
````
13+
"scripts": {
14+
"post-install-cmd": "vendor/bin/phpcs --config-set installed_paths ../../magento/magento-coding-standard/",
15+
"post-update-cmd": "vendor/bin/phpcs --config-set installed_paths ../../magento/magento-coding-standard/"
16+
}
17+
````
18+
19+
### Installation for development
20+
You can install Magento Coding Standard by cloning this GitHub repo
721
```
822
$ git clone [email protected]:magento/magento-coding-standard.git
923
$ cd magento-coding-standard
@@ -13,7 +27,6 @@ It is possible also to install a standalone application via [Composer](https://g
1327
```
1428
$ composer create-project magento/magento-coding-standard --stability=dev magento-coding-standard
1529
```
16-
Or require `magento/magento-coding-standard` inside your project using `composer require` command.
1730

1831
#### Verify installation
1932
Command should return the list of installed coding standards including Magento.

composer.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0"
1515
},
1616
"scripts": {
17-
"post-install-cmd": "vendor/bin/phpcs --config-set installed_paths ../../magento/magento-coding-standard/,../../..",
18-
"post-update-cmd": "vendor/bin/phpcs --config-set installed_paths ../../magento/magento-coding-standard/,../../.."
17+
"post-install-cmd": "vendor/bin/phpcs --config-set installed_paths ../../..",
18+
"post-update-cmd": "vendor/bin/phpcs --config-set installed_paths ../../.."
1919
}
2020
}

0 commit comments

Comments
 (0)