diff --git a/modules/developer_manual/nav.adoc b/modules/developer_manual/nav.adoc index ad49745ad2..4379e2ca1d 100644 --- a/modules/developer_manual/nav.adoc +++ b/modules/developer_manual/nav.adoc @@ -13,6 +13,7 @@ *** xref:core/configfile.adoc[Application Configuration] *** xref:core/theming.adoc[Theming] *** xref:core/translation.adoc[Translation] +*** xref:core/code-standard.adoc[Code Standards Compliance] *** xref:testing/index.adoc[Testing] **** xref:testing/test-pilots.adoc[ownCloud Test Pilots] **** xref:testing/unit-testing.adoc[Unit Testing] diff --git a/modules/developer_manual/pages/core/code-standard.adoc b/modules/developer_manual/pages/core/code-standard.adoc new file mode 100644 index 0000000000..be56de8a6f --- /dev/null +++ b/modules/developer_manual/pages/core/code-standard.adoc @@ -0,0 +1,37 @@ += Code Standards Compliance +:owncloud-coding-standard-url: https://github.com/owncloud/coding-standard +:phpcsfixer-url: https://github.com/FriendsOfPhp/PHP-CS-Fixer + +== Fixing Code Standard Violations + +To ensure that your code follows the ownCloud standard, run `make test-php-style-fix` before a PR is initially submitted and before any additional changes to it are made. +Doing so automatically corrects any standards violations. +The command runs {phpcsfixer-url}[php-cs-fixer] over the codebase, using {owncloud-coding-standard-url}[ownCloud's coding-standard], loaded from `.php_cs.dist` in the root directory of your ownCloud installation. + +== Viewing Code Standard Violations + +TIP: For further details about the coding standard please refer to the {owncloud-coding-standard-url}[owncloud/coding-standard] repository. + +If you’re only interested in checking style errors, run `make test-php-style`. +After running it, you will see console output, similar to the example below: + +[source,console] +---- +php -d zend.enable_gc=0 vendor-bin/owncloud-codestyle/vendor/bin/php-cs-fixer fix -v --diff --diff-format udiff --allow-risky yes --dry-run +Loaded config ownCloud coding standard from "/ownCloud/core/.php_cs.dist". +Using cache file ".php_cs.cache". +.....................................................................................................................................................F........................................................................................ +Legend: ?-unknown, I-invalid file syntax, file ignored, S-Skipped, .-no changes, F-fixed, E-error + 1) apps/files_sharing/tests/Iterator/WritableAppsPathsFilterIteratorTest.php (class_definition, braces) + ---------- begin diff ---------- +--- Original ++++ New +@@ -23,5 +23,4 @@ + use Test\TestCase; + + class WritableAppsPathsFilterIteratorTest extends TestCase { +- + } + + ----------- end diff ----------- +----