APPS-4764 Use default phpcs.xml for the codesniffer tasks. (#169)

* APPS-4764 Use default phpcs.xml, removed allowing to pass a config path for the Code Sniffer. * APPS-4764: Fixed tests. * APPS-4764: Changed default value for code sniffer and fixer tasks. * APPS-4764: Changed default value for code sniffer and fixer tasks. * APPS-4764: Provided\updated help messages for the command that are using code sniffer. * APPS-4769: Moved phpcs options to the ruleset.xml config file and adjusted development and production environments. * APPS-4769: Renamed ruleset.xml to phpcs.xml for automatic usage by default. * APPS-4769: phpcs.xml path fixes and docker stuff updates. * APPS-4769: Fixed typo. * APPS-4769: Changed help messages for the sniffer related tasks and skipped related tests. * APPS-4769: Fixed tests. * APPS-4769: Fixed tests. * APPS-4769: Fixed Eslint tests. Co-authored-by: pavlo.maksymov <[email protected]>
spryker-sdk · Aug 22, 2022 · ab78cb8 · ab78cb8
1 parent 0832d3f
commit ab78cb8
Show file tree

Hide file tree

Showing 8 changed files with 49 additions and 26 deletions.
diff --git a/composer.json b/composer.json
@@ -101,8 +101,8 @@
         "symfony/polyfill-php72": "*"
     },
     "scripts": {
-        "cs-check": "phpcs --colors -p -s --extensions=php --standard=vendor/spryker/code-sniffer/Spryker/ruleset.xml --ignore=/tests/_project/, src/ tests/ extension/",
-        "cs-fix": "phpcbf --colors -p --extensions=php --standard=vendor/spryker/code-sniffer/Spryker/ruleset.xml --ignore=/tests/_project/, src/ tests/ extension/",
+        "cs-check": "phpcs",
+        "cs-fix": "phpcbf",
         "stan": "phpstan analyze -l 8 src/",
         "linters": [
             "@cs-fix",

diff --git a/infrastructure/sdk.Dockerfile b/infrastructure/sdk.Dockerfile
@@ -46,6 +46,7 @@ COPY --chown=spryker:spryker .env.prod ${srcRoot}/.env.prod
 
 RUN --mount=type=cache,id=composer,sharing=locked,target=/home/spryker/.composer/cache,uid=1000 \
   composer dump-autoload -o
+
 ENV APP_ENV=prod
 
 RUN bin/console cache:warmup

diff --git a/phpcs.xml b/phpcs.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0"?>
+<ruleset name="Sdk">
+    <description>
+        Spryker Coding Standard for Project.
+
+        Extends main Spryker Coding Standard.
+        All sniffs in ./Sniffs will be auto loaded
+    </description>
+
+    <rule ref="vendor/spryker/code-sniffer/Spryker/ruleset.xml"/>
+
+    <file>src/</file>
+    <file>tests/</file>
+    <file>extension/</file>
+
+    <exclude-pattern>/tests/_project/*</exclude-pattern>
+    <exclude-pattern>/tests/_output/*</exclude-pattern>
+    <exclude-pattern>/tests/_support/_generated/*</exclude-pattern>
+    <exclude-pattern>/tests/_support/data/*</exclude-pattern>
+
+    <arg name="extensions" value="php" />
+    <arg name="colors"/>
+    <arg value="sp"/>
+
+</ruleset>
diff --git a/src/Extension/Task/CodesnifferFixerTask.yaml b/src/Extension/Task/CodesnifferFixerTask.yaml
@@ -1,10 +1,10 @@
 ---
 id: "validation:php:codestyle-fix"
 short_description: "Check your code by running a static code analysis"
-help: ~
+help: "You may need to set default phpcs standard before using it. By default uses phpcs.xml from the project root."
 stage: build
 version: 1.0.0
-command: "php %sdk_dir%/vendor/bin/phpcbf %severity% --standard=%config% ./%path%"
+command: "php %sdk_dir%/vendor/bin/phpcbf %severity% ./%path%"
 type: local_cli
 optional: true
 placeholders:
@@ -17,13 +17,6 @@ placeholders:
     configuration:
       name: 'severity'
       description: 'Severity level of the CodeSniffer'
-  - name: "%config%"
-    value_resolver: CONFIG_PATH
-    optional: true
-    configuration:
-      name: "config"
-      description: "Config file"
-      defaultValue: "vendor/spryker/code-sniffer/Spryker/ruleset.xml"
   - name: "%path%"
     value_resolver: STATIC
     optional: false

diff --git a/src/Extension/Task/CodesnifferTask.yaml b/src/Extension/Task/CodesnifferTask.yaml
@@ -1,22 +1,15 @@
 ---
 id: "validation:php:codestyle-check"
 short_description: "Check your code by running a static code analysis and generate report with violations"
-help: ~
+help: "You may need to set default phpcs standard before using it. By default uses phpcs.xml from the project root."
 stage: build
 version: 1.0.0
-command: "php %sdk_dir%/vendor/bin/phpcs %severity% --standard=%config% --report=json ./%path% --report-file=%reportDir%/phpcs.codestyle.json"
+command: "php %sdk_dir%/vendor/bin/phpcs %severity% --report=json ./%path% --report-file=%reportDir%/phpcs.codestyle.json"
 type: local_cli
 placeholders:
   - name: "%sdk_dir%"
     value_resolver: SDK_DIR
     optional: true
-  - name: "%config%"
-    value_resolver: CONFIG_PATH
-    optional: true
-    configuration:
-      name: "config"
-      description: "Config file"
-      defaultValue: "vendor/spryker/code-sniffer/Spryker/ruleset.xml"
   - name: "%path%"
     value_resolver: STATIC
     optional: false
@@ -41,7 +34,7 @@ placeholders:
       name: 'severity'
       description: 'Severity level of the CodeSniffer'
 report_converter:
-  name: CheckstyleViolationReportConverter
-  configuration:
-    input_file: phpcs.codestyle.json
-    producer: phpcs
+    name: CheckstyleViolationReportConverter
+    configuration:
+        input_file: phpcs.codestyle.json
+        producer: phpcs
diff --git a/src/Extension/Task/CodesnifferTaskSet.yaml b/src/Extension/Task/CodesnifferTaskSet.yaml
@@ -1,7 +1,7 @@
 ---
 id: "validation:php:codestyle"
 short_description: "Fixes violations and validates your php code using different approaches like codestyle. Generate report in the end."
-help: "Fixes violations and validates your php code using different approaches like codestyle. Generate report in the end."
+help: "Fixes violations and validates your php code using different approaches like codestyle. Generate report in the end. By default uses phpcs.xml from the project root."
 stage: build
 version: 1.0.0
 command: ~

diff --git a/src/Extension/Task/SnifferTaskSet.yaml b/src/Extension/Task/SnifferTaskSet.yaml
@@ -1,7 +1,7 @@
 ---
 id: "validation:php:all"
 short_description: "Validates your php code using different approaches like codestyle, architecural and static analysis"
-help: "Validates your php code using different approaches like codestyle, architecural and static analysis"
+help: "Validates your php code using different approaches like codestyle, architecural and static analysis. By default uses phpcs.xml from the project root."
 stage: build
 version: 1.0.0
 command: ~

diff --git a/tests/_project/project/phpcs.xml b/tests/_project/project/phpcs.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<ruleset name="SdkTest">
+    <description>
+        Spryker Coding Standard Stub for the acceptance tests.
+
+        Extends main Spryker Coding Standard.
+    </description>
+
+    <rule ref="../../../vendor/spryker/code-sniffer/Spryker/ruleset.xml"/>
+
+</ruleset>