diff --git a/README.md b/README.md index 9621d7c..d007faa 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Introduction -This is the MediaCT coding standard for Magento 2 projects. It is based on -the default MediaCT coding standard but some tests have been removed to create +This is the Youwe coding standard for Magento 2 projects. It is based on +the default Magento2 coding standard but some tests have been removed to create a workable and fast standard. # Installation @@ -9,7 +9,7 @@ a workable and fast standard. Use composer to require the standard in a project. ```shell -composer require --dev mediact/coding-standard-magento2 +composer require --dev youwe/coding-standard-magento2 ``` To let PHPCS know that this standard should be used add a phpcs.xml file in the @@ -18,20 +18,20 @@ root of the project. ```xml - + ``` # Integration with PHPStorm and automatic testing The recommended way to enable the coding standard in PHPStorm and automatic -testing is by requiring the MediaCT testing suite in a project. +testing is by requiring the Youwe testing suite in a project. ```shell -composer require --dev mediact/testing-suite +composer require --dev youwe/testing-suite ``` -For more information go to [MediaCT Testing Suite](https://github.com/mediact/testing-suite). +For more information go to [Youwe Testing Suite](https://github.com/YouweGit/testing-suite). # Contribution guidelines diff --git a/composer.json b/composer.json index c7d6552..7ea2e14 100644 --- a/composer.json +++ b/composer.json @@ -1,22 +1,33 @@ { "name": "youwe/coding-standard-magento2", "description": "Youwe PHP Coding Standard for Magento2", - "type": "phpcs-sniffs", - "homepage": "https://github.com/YouweGit/coding-standard-magento2", "license": "proprietary", + "type": "phpcs-sniffs", "authors": [ { "name": "Youwe B.V.", "email": "info@youweagency.com" } ], + "homepage": "https://github.com/YouweGit/coding-standard-magento2", "require": { - "youwe/coding-standard": ">=3.3.0" + "magento/magento-coding-standard": "*", + "youwe/coding-standard": "^3.5.0" }, "autoload": { "psr-0": { - "MediactMagento2": "src/MediactMagento2", - "Magento2": "src/Magento2" + "YouweMagento2": "src/YouweMagento2" } + }, + "scripts": { + "post-install-cmd": [ + "@phpcs-set-paths" + ], + "post-update-cmd": [ + "@phpcs-set-paths" + ], + "phpcs-set-paths": [ + "vendor/bin/phpcs --config-set installed_paths src/,../../magento/magento-coding-standard/,../../phpcompatibility/php-compatibility/" + ] } } diff --git a/src/MediactMagento2/phpmd.xml b/src/MediactMagento2/phpmd.xml deleted file mode 100644 index 2f9b695..0000000 --- a/src/MediactMagento2/phpmd.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - - Mediact coding standards for Magento2 is deprecated please use Magento2. - - diff --git a/src/MediactMagento2/ruleset.xml b/src/MediactMagento2/ruleset.xml deleted file mode 100644 index 4561c7a..0000000 --- a/src/MediactMagento2/ruleset.xml +++ /dev/null @@ -1,11 +0,0 @@ - - - - Mediact coding standards for Magento2 is deprecated please use Magento2. - - diff --git a/src/Magento2/phpmd.xml b/src/YouweMagento2/phpmd.xml similarity index 100% rename from src/Magento2/phpmd.xml rename to src/YouweMagento2/phpmd.xml diff --git a/src/Magento2/ruleset.xml b/src/YouweMagento2/ruleset.xml similarity index 77% rename from src/Magento2/ruleset.xml rename to src/YouweMagento2/ruleset.xml index bf45a16..7d7a07f 100644 --- a/src/Magento2/ruleset.xml +++ b/src/YouweMagento2/ruleset.xml @@ -5,23 +5,30 @@ * https://www.youweagency.com */ --> - - Youwe coding standards for Magento2. + + Youwe coding standards for Magento2 websites and modules + - - - + - + + + + + + + + + - *.phtml + *.phtml,*.xml