Support php-cs-fixer #66

zdenekdrahos · 2017-05-08T09:17:16Z

Closes #60

configure dry-run and rules in .phpqa.yml
html report - demo
add as suggested tool
bin/suggested-tools.sh install doesn't work in default "clone", the tool needs Symfony3 components

# install php-cs-fixer after git clone
composer require friendsofphp/php-cs-fixer symfony/filesystem symfony/config symfony/process symfony/finder symfony/console symfony/event-dispatcher phploc/phploc

https://raw.githubusercontent.com/wbushey/public-archive/324efdbc9f1f0a7d9e573a5d241ccb052eb0e97e/TermsWatch/lib/vendor/symfony/lib/plugins/sfPropelPlugin/lib/vendor/propel-generator/test/etc/xsl/str.replace.function.xsl

zdenekdrahos · 2017-05-08T09:20:05Z

@keradus, @mastercoding: could you try this version? thanks

composer update edgedesign/phpqa:dev-php-cs-fixer

keradus · 2017-05-08T09:23:04Z

README.md

@@ -51,6 +51,7 @@ Experimental tool is executed only if the tool is specified in `--tools`.

 Tool | PHP | Supported since | Description | Status |
 ---- | --- | --------------- | ----------- | ------ |
+[php-cs-fixer](http://cs.sensiolabs.org/) | `>= 5.6` | `1.12` | Automatically detect and fix PHP coding standards issues | stable |


FYI: if you want support for lower PHP, go with PHP CS Fixer v2.2+

keradus · 2017-05-08T09:23:56Z

README.md

@@ -199,6 +201,8 @@ Tool | Settings | Default Value | Your value
 [phpcs.standard](https://pear.php.net/manual/en/package.php.php-codesniffer.usage.php#package.php.php-codesniffer.usage.coding-standard) | Coding standard | PSR2 | Name of existing standard (`PEAR`, `PHPCS`, `PSR1`, `PSR2`, `Squiz`,  `Zend`), or path to your coding standard
 [phpcs.ignoreWarnings](https://github.com/EdgedesignCZ/phpqa/issues/53) | If number of allowed errors is compared with warnings+errors, or just errors from `checkstyle.xml` | `false` | Boolean value
 [phpcs.reports](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Reporting) | Report types | [`full`](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Reporting#printing-full-and-summary-reports) report in [cli mode](#output-modes), [`checkstyle`](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Reporting#printing-a-checkstyle-report) in [file mode](#output-modes) | Predefined [report types](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Reporting) or [custom reports](https://github.com/wikidi/codesniffer#examples)
+[php-cs-fixer.rules](http://cs.sensiolabs.org/#usage) | Coding standard rules | `@PSR2` | String value


you may require risky support, as some of the rules require that to be enabled

keradus · 2017-05-08T09:24:23Z

app/report/php-cs-fixer.xsl

+    <xsl:template match="/">
+        <html>
+            <head>
+                <title>php-cs-fixer report</title>


PHP CS Fixer report
(tool name is PHP CS Fixer, not php-cs-fixer)

keradus · 2017-05-08T09:27:53Z

src/CodeAnalysisTasks.php

@@ -384,13 +392,37 @@ function ($relativeDir) {
        );
    }

+    private function phpcsfixer()


if you like, you could execute the code (FixCommand) instead of running it as separated CLI process

mastercoding · 2017-05-08T19:31:03Z

Hi @zdenekdrahos! Great to see that you tackled this so soon. I would propose two configurable options in addition to what you've got:

using-cache (yes/no)
config

The cache is because the results with cache enabled are not always the same. I would default to not using cache.

The configuration file i've got for php-cs-fixer is complex (https://gist.github.com/mastercoding/49db81e63b5b849779ecb79bd1e896e0). It would almost be impossible to put that in your tool.

What do you think?

keradus · 2017-05-09T10:04:33Z

yeah, let point config file instead of mapping the properties

zdenekdrahos · 2017-05-21T08:58:11Z

Thanks for great comments.

@keradus, @mastercoding: Cache can be disabled in config file. Is it necessary to define cache in .phpqa.yml?

The reserved indicator "@" cannot start a plain scalar; you need to quote the scalar at line 17 https://travis-ci.org/EdgedesignCZ/phpqa/jobs/229883765

…uration

v2.2 supports older php and symfony2 components

…rules in .phpqa.yml

zdenekdrahos · 2017-06-01T17:07:14Z

@keradus, @mastercoding: is current version ok? Or is there something you'd like to change?

keradus · 2017-06-01T18:24:30Z

.gitignore

@@ -2,3 +2,4 @@
 /vendor/
 /build/
 phpstan-phpqa.neon
+.php_cs.cache


I would add .php_cs (not .php_cs.dist) as well

keradus · 2017-06-01T18:26:05Z

src/CodeAnalysisTasks.php

+        $analyzedDirs = $this->options->getAnalyzedDirs();
+        $analyzedDir = reset($analyzedDirs);
+        if (count($analyzedDirs) > 1) {
+            $this->say("<error>php-cs-fixer analyzes only first directory {$analyzedDir}</error>");


huh? you could provide multiple paths (dirs or files) in single CLI run

[PhpCsFixer\ConfigurationException\InvalidConfigurationException] For multiple paths config parameter is required. PHP-CS-Fixer/PHP-CS-Fixer#2390

zdenekdrahos added 5 commits April 29, 2017 15:25

php-cs-fixer - add suggested tool, spike cli/file mode

b82052d

https://raw.githubusercontent.com/wbushey/public-archive/324efdbc9f1f0a7d9e573a5d241ccb052eb0e97e/TermsWatch/lib/vendor/symfony/lib/plugins/sfPropelPlugin/lib/vendor/propel-generator/test/etc/xsl/str.replace.function.xsl

php-cs-fixer - load configuration from .phpqa.yml

6afb595

php-cs-fixer - custom xsl template

d6e12a0

php-cs-fixer - fix displaying report in full phpqa report

721a61b

php-cs-fixer - refactoring deifnition of output modes

e7b3e23

zdenekdrahos added the wip label May 8, 2017

keradus reviewed May 8, 2017

View reviewed changes

zdenekdrahos added 8 commits May 21, 2017 11:19

php-cs-fixer - add suggested tool

d8d764a

php-cs-fixer - fix coding standard

b9dbaac

php-cs-fixer - fix rules definition in yaml file

51a8362

The reserved indicator "@" cannot start a plain scalar; you need to quote the scalar at line 17 https://travis-ci.org/EdgedesignCZ/phpqa/jobs/229883765

php-cs-fixer - add documentation for output modes and advanced config…

4f10154

…uration

php-cs-fixer - rename report title

236b1ae

php-cs-fixer - allow risky rules in .phpqa.yml

506041a

php-cs-fixer - fix installing suggested tools after clone

b9b32b7

v2.2 supports older php and symfony2 components

php-cs-fixer - allow custom .php_cs configuration instead of mapping …

966dda6

…rules in .phpqa.yml

zdenekdrahos force-pushed the php-cs-fixer branch from a6fb482 to 966dda6 Compare May 21, 2017 09:20

zdenekdrahos removed the wip label May 21, 2017

keradus reviewed Jun 1, 2017

View reviewed changes

zdenekdrahos added 2 commits June 10, 2017 08:33

php-cs-fixer - ignore configuration file

eca908b

php-cs-fixer - multiple dirs are supported if config file is specified

840901c

[PhpCsFixer\ConfigurationException\InvalidConfigurationException] For multiple paths config parameter is required. PHP-CS-Fixer/PHP-CS-Fixer#2390

zdenekdrahos merged commit 3227212 into master Jun 10, 2017

zdenekdrahos deleted the php-cs-fixer branch June 10, 2017 06:55

gomzyakov mentioned this pull request Jun 5, 2022

Look at quality tools gomzyakov/secretnotes#88

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support php-cs-fixer #66

Support php-cs-fixer #66

zdenekdrahos commented May 8, 2017 •

edited

Loading

zdenekdrahos commented May 8, 2017

keradus May 8, 2017

keradus May 8, 2017 •

edited

Loading

keradus May 8, 2017

keradus May 8, 2017

mastercoding commented May 8, 2017 •

edited

Loading

keradus commented May 9, 2017

zdenekdrahos commented May 21, 2017 •

edited

Loading

zdenekdrahos commented Jun 1, 2017

keradus Jun 1, 2017

keradus Jun 1, 2017

Support php-cs-fixer #66

Support php-cs-fixer #66

Conversation

zdenekdrahos commented May 8, 2017 • edited Loading

zdenekdrahos commented May 8, 2017

keradus May 8, 2017

Choose a reason for hiding this comment

keradus May 8, 2017 • edited Loading

Choose a reason for hiding this comment

keradus May 8, 2017

Choose a reason for hiding this comment

keradus May 8, 2017

Choose a reason for hiding this comment

mastercoding commented May 8, 2017 • edited Loading

keradus commented May 9, 2017

zdenekdrahos commented May 21, 2017 • edited Loading

zdenekdrahos commented Jun 1, 2017

keradus Jun 1, 2017

Choose a reason for hiding this comment

keradus Jun 1, 2017

Choose a reason for hiding this comment

zdenekdrahos commented May 8, 2017 •

edited

Loading

keradus May 8, 2017 •

edited

Loading

mastercoding commented May 8, 2017 •

edited

Loading

zdenekdrahos commented May 21, 2017 •

edited

Loading