diff --git a/.php_cs b/.php_cs deleted file mode 100644 index d47c4e0207..0000000000 --- a/.php_cs +++ /dev/null @@ -1,16 +0,0 @@ -exclude('doc') - ->exclude('images') - ->exclude('js') - ->exclude('library') - ->exclude('mods') - ->exclude('spec') - ->in(__DIR__) -; - -return Symfony\CS\Config\Config::create() - ->level(Symfony\CS\FixerInterface::PSR2_LEVEL) - ->finder($finder) -; diff --git a/doc/Developers-Intro.md b/doc/Developers-Intro.md index 78da231b6c..53981d0c29 100644 --- a/doc/Developers-Intro.md +++ b/doc/Developers-Intro.md @@ -50,11 +50,6 @@ Programming ###Coding standards For the sake of consistency between contribution and general code readability, Friendica follows the widespread [PSR-2 coding standards](http://www.php-fig.org/psr/psr-2/). -Don't worry, you don't have to know by heart the PSR-2 coding standards to start contributing to Friendica. -Before comitting your work, you can use the PHP Coding Standard Fixer located in the `util` folder this way: - - $> php util/php-cs-fixer.phar fix --level=psr2 - Here's a few primers if you are new to the PSR-2 coding standards: * Indentation is 4 spaces, period. * By default, strings are enclosed in single quotes, but feel free to use double quotes if it makes more sense (SQL queries, adding tabs and line feeds). @@ -63,6 +58,30 @@ Here's a few primers if you are new to the PSR-2 coding standards: * No closing PHP tag * No trailing spaces +Don't worry, you don't have to know by heart the PSR-2 coding standards to start contributing to Friendica. +There are a few tools you can use to check or fix your files before you commit. + +####Check with [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer) + +This tool checks your files against a variety of coding standards, including PSR-2, and ouputs a report of all the standard violations. +You can simply install it through PEAR: `pear install PHP_CodeSniffer` +Once it is installed and available in your PATH, here's the command to run before committing your work: + + $> phpcs --standard=PSR2 + +The output is a list of all the coding standards violations that you should fix before committing your work. +Additionally, `phpcs` integrates with a few IDEs (Eclipse, Netbeans, PHPStorm...) so that you don't have to fiddle with the command line. + +####Fix with PHP Code Beautifier and Fixer (phpbcf) included in PHP Code Sniffer + +If you're getting a massive list of standards violations when running `phpcs`, it can be annoying to fix all the violations by hand. +Thankfully, PHP Code Sniffer is shipped with an automatic code fixer that can take care of the tedious task for you. +Here's the command to automatically fix the files you created/modified: + + $> phpcbf --standard=PSR2 + +If the command-line tools `diff` and `patch` are unavailabe for you, `phpcbf` can use slightly slower PHP equivalents by using the `--no-patch` argument. + ###Code documentation If you are interested in having the documentation of the Friendica code outside of the code files, you can use [Doxygen](http://doxygen.org) to generate it. diff --git a/php-cs-fixer.phar b/php-cs-fixer.phar deleted file mode 100644 index 71c5cfbb70..0000000000 Binary files a/php-cs-fixer.phar and /dev/null differ