Applied php coding standards and cleaned up config files

Author: martinyde

.gitignore

@@ -201,4 +201,5 @@ yarn-error.log
 .DS_Store
 
 .env*.local
+.env.task
 .twig-cs-fixer.cache

.prettierignore

@@ -0,0 +1 @@
+config/

package.json

@@ -1,24 +1,33 @@
 <?xml version="1.0"?>
+<!-- This file is copied from config/drupal/php/.phpcs.xml.dist in https://github.com/itk-dev/devops_itkdev-docker. -->
+<!-- Feel free to edit the file, but consider making a pull request if you find a general issue with the file. -->
+
 <ruleset name="PHP_CodeSniffer">
   <description>The coding standard.</description>
 
-  <file>web/profiles/custom/os2loop/</file>
+  <file>web/profiles/custom/os2loop/modules/</file>
+  <file>web/profiles/custom/os2loop/themes/</file>
 
   <!-- Exclude generated files -->
-  <exclude-pattern>web/profiles/custom/os2loop/themes/os2loop_theme/node_modules/*</exclude-pattern>
-  <exclude-pattern>web/profiles/custom/os2loop/themes/os2loop_theme/build/*</exclude-pattern>
-  <!-- Show progress of the run -->
+  <exclude-pattern>node_modules</exclude-pattern>
+  <exclude-pattern>vendor</exclude-pattern>
+  <exclude-pattern>web/*/custom/*/build/</exclude-pattern>
+  <exclude-pattern>*.css</exclude-pattern>
+  <exclude-pattern>*.js</exclude-pattern>
+
   <arg value="p"/>
 
   <arg name="extensions" value="php,module,inc,install,test,profile,theme,css,info,txt,yml"/>
-  <config name="drupal_core_version" value="9"/>
+
+  <config name="drupal_core_version" value="11"/>
 
   <rule ref="Drupal">
     <!-- <exclude name="Drupal.Files.TxtFileLineLength.TooLong"/> -->
     <!-- We want to be able to use "package" and "version" in our custom modules -->
     <exclude name="Drupal.InfoFiles.AutoAddedKeys.Project"/>
     <exclude name="Drupal.InfoFiles.AutoAddedKeys.Version"/>
+    <exclude name="Drupal.NamingConventions.ValidEnumCase.NoUpperAcronyms" />
+    <exclude name="Drupal.NamingConventions.ValidEnumCase.NoUnderscores" />
   </rule>
-
-  <rule ref="DrupalPractice"/>
+   <rule ref="Squiz.Strings.DoubleQuoteUsage.NotRequired"/>
 </ruleset>

phpcs.xml.dist

@@ -1,10 +1,9 @@
 parameters:
   paths:
-    - web/profiles/custom/os2loop
+    - web/profiles/custom/os2loop/modules
   level: 0
   customRulesetUsed: true
-  ignoreErrors:
-      - '#\Drupal calls should be avoided in classes, use dependency injection instead#'
-      - '#Missing cache backend declaration for performance.#'
-      - '#Plugin manager has cache backend specified but does not declare cache tags.#'
   reportUnmatchedIgnoredErrors: false
+  ignoreErrors:
+        -
+            message: '#\Drupal calls should be avoided in classes, use dependency injection instead#'

phpstan.neon

@@ -5,6 +5,12 @@ vars:
   COMPOSER_INSTALL_ARGUMENTS:
 
 tasks:
+  compose:
+    desc: Run docker compose or itkdev-docker-compose if TASK_DOCKER_COMPOSE is set in .task.env
+    cmds:
+      - "{{ .DOCKER_COMPOSE }} {{ .CLI_ARGS }}"
+    silent: true
+
   up:
     desc: Update (pull and up) docker compose setup and run composer install
     cmds:
@@ -61,3 +67,22 @@ tasks:
       DRUSH_OPTIONS_URI: 'http://{{default .DOCKER_COMPOSE_SITE_DOMAIN .COMPOSE_SERVER_DOMAIN}}'
     cmds:
       - "{{.DOCKER_COMPOSE}} exec --env DRUSH_OPTIONS_URI=$DRUSH_OPTIONS_URI phpfpm vendor/bin/drush {{.CLI_ARGS}}"
+
+  code:check:
+    desc: Check php, twig and markdown files and analyze php code
+    cmds:
+      - task dev:compose -- exec phpfpm vendor/bin/phpcs --standard=phpcs.xml.dist
+      - task dev:compose -- exec phpfpm vendor/bin/phpstan analyse --configuration=phpstan.neon
+      - task dev:compose -- exec phpfpm vendor/bin/twig-cs-fixer lint web/profiles/custom/os2loop/themes/*/templates
+      - docker compose run --rm prettier '**/*.{yml,yaml}' --check
+      - docker compose run --rm prettier 'web/profiles/custom/os2loop/themes/**/css/**/*.{css,scss}' --check
+      - docker run --rm --volume "$PWD:/md" itkdev/markdownlint '**/*.md'
+
+  code:apply-standards:
+    desc: Apply coding standards to php, twig and markdown files
+    cmds:
+      - task dev:compose -- exec phpfpm vendor/bin/phpcbf --standard=phpcs.xml.dist
+      - task dev:compose -- exec phpfpm vendor/bin/twig-cs-fixer lint web/themes/custom/*/templates --fix
+      - docker compose run --rm prettier '**/*.{yml,yaml}' --write
+      - docker compose run --rm prettier 'web/profiles/custom/os2loop/themes/**/css/**/*.{css,scss}' --write
+      - docker run --rm --volume "$PWD:/md" itkdev/markdownlint '**/*.md' --fix

task/Taskfile.yml

@@ -2,7 +2,7 @@
 
 namespace Drupal\os2loop_documents\Controller;
 
-use Drupal\Console\Core\Utils\NestedArray;
+use Drupal\Component\Utility\NestedArray;
 use Drupal\Core\Controller\ControllerBase;
 use Drupal\Core\Entity\EntityStorageInterface;
 use Drupal\Core\File\FileUrlGeneratorInterface;

web/profiles/custom/os2loop/modules/os2loop_documents/src/Controller/EntityPrintController.php

@@ -64,12 +64,12 @@ private function handleTextFormats(array &$form, FormStateInterface $form_state,
     if ($useRichText) {
       $form['os2loop_question_content']['widget'][0]['#better_formats']['settings']['allowed_formats'] =
         ['os2loop_question_rich_text' => 'os2loop_question_rich_text'];
-      $form["os2loop_question_content"]["widget"][0]["#format"] = 'os2loop_question_rich_text';
+      $form['os2loop_question_content']['widget'][0]['#format'] = 'os2loop_question_rich_text';
     }
     else {
       $form['os2loop_question_content']['widget'][0]['#better_formats']['settings']['allowed_formats'] =
         ['os2loop_question_plain_text' => 'os2loop_question_plain_text'];
-      $form["os2loop_question_content"]["widget"][0]["#format"] = 'os2loop_question_plain_text';
+      $form['os2loop_question_content']['widget'][0]['#format'] = 'os2loop_question_plain_text';
     }
 
     // We must use a static callback here to prevent “LogicException: The

web/profiles/custom/os2loop/modules/os2loop_question/src/Helper/Helper.php

@@ -34,7 +34,7 @@ public function execute($node = NULL) {
     if ($node) {
       /** @var \Drupal\node\NodeInterface $node */
       if (!$node->hasField('os2loop_shared_rev_date')) {
-        throw new \RuntimeException("Revisioning date field not found on node.");
+        throw new \RuntimeException('Revisioning date field not found on node.');
       }
       $node->set('os2loop_shared_rev_date', $this->getNextRevisionDate()->format('Y-m-d'));
       $node->save();