File tree Expand file tree Collapse file tree 1 file changed +10
-0
lines changed Expand file tree Collapse file tree 1 file changed +10
-0
lines changed Original file line number Diff line number Diff line change @@ -6,6 +6,8 @@ based on Magento 2 coding standards but tuned to be less annoying!
66
77## Usage
88
9+ ### Usage on a regular Space48 Warden based Magento 2 project:
10+
911After pulling and installing/updating project locally run following command to update local git hooks and install npm packages:
1012``` shell
1113make linters-init
@@ -25,6 +27,11 @@ When fixing errors, to see predicted linters output you can instead of trying to
2527make precommit
2628```
2729
30+ ### Usage on other projects
31+
32+ Run ` vendor/bin/grumphp git:init ` to add githook
33+ Grumphp will sniff your code on any git commit
34+
2835### Ignoring Rules
2936in the linters output you will see hints with rule names being violated. If for some reason you can not fix violated rule
3037feel free to ignore it using Suppress Warning comment corresponding concrete linter type (see hints in output or google).
@@ -52,6 +59,9 @@ make analyse
5259
5360Add Code Quality tool to the Magento Project:
5461
62+ ### Warning!
63+ Eslisnt and Stylelint requires ** NodeJs v10** or higher.
64+
5565### Installation on a regular _ Space48 Warden based Magento 2_ project:
5666
5767On Magento versions ** earlier than 2.4** add following to 'require' section of project's ` composer.json ` :
You can’t perform that action at this time.
0 commit comments