diff --git a/Oefenweb/ruleset.xml b/CakePHPOefenweb/ruleset.xml similarity index 86% rename from Oefenweb/ruleset.xml rename to CakePHPOefenweb/ruleset.xml index 926fa7a..512a96d 100644 --- a/Oefenweb/ruleset.xml +++ b/CakePHPOefenweb/ruleset.xml @@ -1,5 +1,5 @@ - + Oefenweb Code Sniffer for CakePHP diff --git a/README.md b/README.md index 680001d..804c378 100644 --- a/README.md +++ b/README.md @@ -7,37 +7,19 @@ This code works with [phpcs](https://github.com/squizlabs/PHP_CodeSniffer) and c It's generally recommended to install these code sniffs with `composer`: ```sh -composer global require --dev 'cakephp/cakephp-codesniffer=1.*'; -``` - -Modify `~/.composer/composer.json`. - -```json -"require-dev": { - "oefenweb/cakephp-codesniffer": "dev-master" -}, -"repositories": [ - { - "type": "vcs", - "url": "https://github.com/Oefenweb/cakephp-codesniffer" - } -] +mkdir CakePHPOefenweb && cd $_ && composer require oefenweb/cakephp-codesniffer=dev-master; ``` ```sh -composer global update oefenweb/cakephp-codesniffer; -~/.composer/vendor/bin/phpcs --config-set \ - installed_paths "${HOME}/.composer/vendor/cakephp/cakephp-codesniffer,${HOME}/.composer/vendor/oefenweb/cakephp-codesniffer"; +vendor/bin/phpcs \ + --config-set installed_paths "${PWD}/vendor/cakephp/cakephp-codesniffer,${PWD}/vendor/oefenweb/cakephp-codesniffer" \ +; ``` This lets `phpcs` know where to find your new sniffs. Ensure that you do not overwrite any existing `installed_paths` value. ## Usage -When these sniffs are installed with `composer`, ensure that you have configured the CodeSniffer `installed_paths` setting. - -Once `installed_paths` is configured, you can run phpcs using: - ```sh -~/.composer/vendor/bin/phpcs . --standard=Oefenweb --extensions=ctp,php --ignore=app/Vendor --ignore=app/Plugin; +vendor/bin/phpcs --standard=CakePHPOefenweb ~/foo/bar/index.php; ```