Added YAML linting

Author: rimi-itk

.editorconfig

@@ -13,5 +13,5 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.{js,scss,yaml}]
+[*.{js,scss}]
 indent_size = 2

.github/workflows/pr.yaml

@@ -259,6 +259,15 @@ jobs:
       - name: markdownlint
         run: yarn check-coding-standards/markdownlint
 
+  yamllint:
+    name: yamllint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: yamllint
+        run: docker run --rm --volume $(pwd):/data cytopia/yamllint -f github .
+
   translations:
     runs-on: ubuntu-20.04
     strategy:

.yamllint.yaml

@@ -0,0 +1,33 @@
+# @see https://yamllint.readthedocs.io/en/stable/configuration.html#extending-the-default-configuration
+extends: default
+
+ignore:
+    - .docker/
+    - .github/
+    - node_modules/
+    - vendor/
+    - 'docker-compose*.yml'
+
+rules:
+    # @see https://yamllint.readthedocs.io/en/stable/rules.html#module-yamllint.rules.braces
+    braces:
+        min-spaces-inside: 1
+        max-spaces-inside: 1
+    # @see https://yamllint.readthedocs.io/en/stable/rules.html#module-yamllint.rules.brackets
+    brackets:
+        min-spaces-inside: 0
+        max-spaces-inside: 1
+    # @see https://yamllint.readthedocs.io/en/stable/rules.html#module-yamllint.rules.comments
+    comments:
+        min-spaces-from-content: 1
+        require-starting-space: false
+    # @see https://yamllint.readthedocs.io/en/stable/rules.html#module-yamllint.rules.document_start
+    document-start:
+        present: false
+    # @see https://yamllint.readthedocs.io/en/stable/rules.html#module-yamllint.rules.indentation
+    indentation:
+        spaces: 4
+    # 80 chars should be enough, but don't fail if a line is longer
+    line-length:
+        max: 160
+        level: warning

CHANGELOG.md

@@ -10,6 +10,8 @@ about writing changes to this log.
 
 ## [Unreleased]
 
+- Added YAML linting.
+
 ## [1.1.2] 2023-02-17
 
 - [SUPP0RT-874](https://jira.itkdev.dk/browse/SUPP0RT-874)

README.md

@@ -370,6 +370,12 @@ we decided to adhere to in this project.
   docker run -v ${PWD}:/app itkdev/yarn:latest markdownlint README.md
   ```
 
+* YAML
+
+  ```sh
+  docker run --rm --volume $(pwd):/data cytopia/yamllint config
+  ```
+
 ## Code analysis
 
 We use [PHPStan](https://phpstan.org/) and [Psalm](https://psalm.dev/) for code

config/config.yml

@@ -1,11 +1,11 @@
 # app/config/config.yml
 twig:
-  form_themes:
-    - LexikFormFilterBundle:Form:form_div_layout.html.twig
+    form_themes:
+        - LexikFormFilterBundle:Form:form_div_layout.html.twig
 
 lexik_form_filter:
-  listeners:
-    doctrine_orm: true
-    doctrine_dbal: false
-    doctrine_mongodb: false
-  where_method: ~  # null | and | or
+    listeners:
+        doctrine_orm: true
+        doctrine_dbal: false
+        doctrine_mongodb: false
+    where_method: ~  # null | and | or

config/packages/dev/security.yaml

@@ -1,5 +1,5 @@
 security:
-  firewalls:
-    main:
-      custom_authenticators:
-          - App\Security\MasqueradeAuthenticator
+    firewalls:
+        main:
+            custom_authenticators:
+                - App\Security\MasqueradeAuthenticator

config/packages/doctrine.yaml

@@ -23,6 +23,6 @@ doctrine:
                 prefix: 'App\Monolog'
                 alias: Log
         filters:
-          case_deleted_filter:
-              class: App\Doctrine\CaseDeletedFilter
-              enabled: true
+            case_deleted_filter:
+                class: App\Doctrine\CaseDeletedFilter
+                enabled: true

config/packages/fos_ckeditor.yaml

@@ -19,4 +19,4 @@ fos_ck_editor:
             editor:
                 - ['Bold', 'Italic', 'Underline', 'StrikeThrough']
                 - ['BulletedList', 'NumberedList']
-                - ['Outdent', 'Indent', 'TextColor']
+                - ['Outdent', 'Indent', 'TextColor']

config/packages/itkdev_openid_connect.yaml

@@ -1,19 +1,19 @@
 itkdev_openid_connect:
-  cache_options:
-    cache_pool: 'cache.app' # Cache item pool for caching discovery document and CLI login tokens
-  cli_login_options:
-    cli_redirect: '%env(CLI_REDIRECT)%' # Redirect route for CLI login
-  openid_providers:
-    admin:
-      options:
-        metadata_url: '%env(ADMIN_OIDC_METADATA_URL)%'
-        client_id: '%env(ADMIN_OIDC_CLIENT_ID)%'
-        client_secret: '%env(ADMIN_OIDC_CLIENT_SECRET)%'
-        redirect_route: 'default'
+    cache_options:
+        cache_pool: 'cache.app' # Cache item pool for caching discovery document and CLI login tokens
+    cli_login_options:
+        cli_redirect: '%env(CLI_REDIRECT)%' # Redirect route for CLI login
+    openid_providers:
+        admin:
+            options:
+                metadata_url: '%env(ADMIN_OIDC_METADATA_URL)%'
+                client_id: '%env(ADMIN_OIDC_CLIENT_ID)%'
+                client_secret: '%env(ADMIN_OIDC_CLIENT_SECRET)%'
+                redirect_route: 'default'
 
-    board-member:
-      options:
-        metadata_url: '%env(BOARD_MEMBER_OIDC_METADATA_URL)%'
-        client_id: '%env(BOARD_MEMBER_OIDC_CLIENT_ID)%'
-        client_secret: '%env(BOARD_MEMBER_OIDC_CLIENT_SECRET)%'
-        redirect_route: 'default'
+        board-member:
+            options:
+                metadata_url: '%env(BOARD_MEMBER_OIDC_METADATA_URL)%'
+                client_id: '%env(BOARD_MEMBER_OIDC_CLIENT_ID)%'
+                client_secret: '%env(BOARD_MEMBER_OIDC_CLIENT_SECRET)%'
+                redirect_route: 'default'