Cleaned up code

Author: rimi-itk

.github/workflows/pr.yml

@@ -23,7 +23,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-versions: [ '8.1' ]
+        php-versions: [ '8.3' ]
         dependency-version: [ prefer-lowest, prefer-stable ]
     steps:
       - uses: actions/checkout@master
@@ -39,24 +39,29 @@ jobs:
         id: composer-cache
         run: echo "::set-output name=dir::$(composer config cache-files-dir)"
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
           restore-keys: ${{ runner.os }}-composer-
       - name: Validate composer files
         run: |
           composer config --no-plugins allow-plugins.mglaman/composer-drupal-lenient true
-          composer validate --strict composer.json
+          # The --strict flag on validate has been removed due to the package drupal/config_entity_revisions 2.0.x-dev
+          # being considered a version cf. https://getcomposer.org/doc/articles/versions.md#branches
+          composer validate composer.json
           # Check that dependencies resolve.
           composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction
+      - name: Check that composer file is normalized
+        run: |
+          composer normalize --dry-run
 
   php-coding-standards:
     name: PHP coding standards
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-versions: [ '8.1' ]
+        php-versions: [ '8.3' ]
     steps:
       - uses: actions/checkout@master
       - name: Setup PHP, with composer and extensions
@@ -71,7 +76,7 @@ jobs:
         id: composer-cache
         run: echo "::set-output name=dir::$(composer config cache-files-dir)"
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
@@ -89,7 +94,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-versions: [ '8.1' ]
+        php-versions: [ '8.3' ]
     steps:
       - uses: actions/checkout@master
       - name: Setup PHP, with composer and extensions
@@ -104,7 +109,7 @@ jobs:
         id: composer-cache
         run: echo "::set-output name=dir::$(composer config cache-files-dir)"
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
@@ -113,27 +118,13 @@ jobs:
         run: |
           ./scripts/code-analysis
 
-  markdownlint:
+  coding-standards-markdown:
+    name: Markdown coding standards
     runs-on: ubuntu-latest
-    name: markdownlint
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
-      - name: Get yarn cache directory path
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-      - name: Cache yarn packages
-        uses: actions/cache@v2
-        id: yarn-cache
-        with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
-      - name: Yarn install
-        uses: actions/setup-node@v2
-        with:
-          node-version: '20'
-      - run: yarn install
-      - name: markdownlint
-        run: yarn coding-standards-check/markdownlint
+        uses: actions/checkout@master
+
+      - name: Coding standards
+        run: |
+          docker run --rm --volume $PWD:/md peterdavehello/markdownlint markdownlint --ignore vendor --ignore LICENSE.md '**/*.md'

.gitignore

@@ -4,5 +4,3 @@
 composer.lock
 vendor
 
-node_modules/
-yarn.lock

.markdownlint.jsonc

@@ -0,0 +1,13 @@
+{
+  "default": true,
+  // https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md
+  "line-length": {
+    "line_length": 120,
+    "code_blocks": false,
+    "tables": false
+  },
+  // https://github.com/DavidAnson/markdownlint/blob/main/doc/md024.md
+  "no-duplicate-heading": {
+    "siblings_only": true
+  }
+}

.markdownlintrc

@@ -122,29 +122,28 @@ run the checks locally.
 
 ```sh
 docker run --rm --volume ${PWD}:/app --workdir /app itkdev/php8.1-fpm composer install
-docker run --rm --volume ${PWD}:/app --workdir /app itkdev/php8.1-fpm composer coding-standards-check
-
 # Fix (some) coding standards issues.
 docker run --rm --volume ${PWD}:/app --workdir /app itkdev/php8.1-fpm composer coding-standards-apply
+docker run --rm --volume ${PWD}:/app --workdir /app itkdev/php8.1-fpm composer coding-standards-check
 ```
 
 ### Markdown
 
 ```sh
-docker run --rm --volume ${PWD}:/app --workdir /app node:20 yarn install
-docker run --rm --volume ${PWD}:/app --workdir /app node:20 yarn coding-standards-check/markdownlint
-
-# Fix (some) coding standards issues.
-docker run --rm --volume ${PWD}:/app --workdir /app node:20 yarn coding-standards-apply/markdownlint
+docker pull peterdavehello/markdownlint
+docker run --rm --volume $PWD:/md peterdavehello/markdownlint markdownlint --ignore vendor --ignore LICENSE.md '**/*.md' --fix
+docker run --rm --volume $PWD:/md peterdavehello/markdownlint markdownlint --ignore vendor --ignore LICENSE.md '**/*.md'
 ```
 
 ## Code analysis
 
 We use [PHPStan](https://phpstan.org/) for static code analysis.
 
-Running statis code analysis on a standalone Drupal module is a bit tricky, so
-we use a helper script to run the analysis:
+Running statis code analysis on a standalone Drupal module is a bit tricky, so we use a helper script to run the
+analysis:
 
-```sh
-./scripts/code-analysis
+```shell
+docker run --rm --volume ${PWD}:/app --workdir /app itkdev/php8.1-fpm ./scripts/code-analysis
 ```
+
+**Note**: Currently the code analysis is only run on the `os2forms_digital_post` sub-module (cf. [`phpstan.neon`](./phpstan.neon)).

README.md

@@ -1,20 +1,22 @@
 # OS2Forms Attachment Drupal module
 
-# Module purpose
+## Module purpose
 
 The aim of this module is to provide an OS2forms attachment element for adding PDF/HTML attachment.
 
 It also supports creation of reusable headers/footers components which are used when rendering the attachments.
 
-# How does it work
+## How does it work
 
-To add custom headers/footer ```admin/structure/webform/config/os2forms_attachment_component```
+To add custom headers/footer `admin/structure/webform/config/os2forms_attachment_component`
 
-To specify headers/footers that will override the default ones on a global level (**Third party settings** -> **Entity print** section): ```admin/structure/webform/config```
+To specify headers/footers that will override the default ones on a global level (**Third party settings** -> **Entity
+print** section): `admin/structure/webform/config`
 
-To specify headers/footers that will override the default ones on a form level (**Third party settings** -> **Entity print** section): ```/admin/structure/webform/manage/[webform]/settings```
+To specify headers/footers that will override the default ones on a form level (**Third party settings** -> **Entity
+print** section): ```/admin/structure/webform/manage/[webform]/settings```
 
-# Overwriting templates
+## Overwriting templates
 
 With some setups it might be necessary to overwrite templates
 in order to access stylesheets or images.

modules/os2forms_attachment/README.md

@@ -1,15 +1,16 @@
 # OS2Forms Autocomplete Drupal module
 
-# Module purpose
+## Module purpose
 
-The aim of this module is to provide a genetic OS2Forms Autocomplete element which can return options from an external webservice.
+The aim of this module is to provide a genetic OS2Forms Autocomplete element which can return options from an external
+webservice.
 
-# How does it work
+## How does it work
 
 Module exposes OS2Forms Autocomplete component that are available in the webform build process.
 
 Build page:
 
-```
+```url
 admin/structure/webform/manage/[webform]
 ```

modules/os2forms_autocomplete/README.md

@@ -1,10 +1,11 @@
 # OS2Forms DAWA Drupal module
 
-# Module purpose
+## Module purpose
 
-The aim of this module is to provide integration with Danish Addresses Web API (DAWA https://dawa.aws.dk) and provider address autocomplete fields.
+The aim of this module is to provide integration with Danish Addresses Web API (DAWA <https://dawa.aws.dk>) and provider
+address autocomplete fields.
 
-# How does it work
+## How does it work
 
 Module exposes couple of new Autocomplete components that are available in the webform build process.
 

modules/os2forms_dawa/README.md

@@ -10,7 +10,7 @@ aftale hvilke certifikater der anvendes. Disse certifikater skal være OCES-3,
 f.eks. FOCES-3, og skal bruges i pem- eller cer-format.
 
 Dernæst oplyses det anvendte certifikats thumbprint eller public-key til Fasit,
-som derefter aktiverer snitfladen. Se evt. 
+som derefter aktiverer snitfladen. Se evt.
 [README#certificate](../README.md#certificate)
 for hvordan et certifikats thumbprint kan findes gennem kommandolinjen.
 
@@ -22,22 +22,22 @@ Her skal følgende sættes op:
 
 * Fasit API base url
   * Basis url’en til Fasit. Denne specificeres af Fasit.
-  * Eksempel: https://webservices.fasit.dk/
+  * Eksempel: <https://webservices.fasit.dk/>
 * Fasit API tenant
   * Fasit tenant. Denne specificeres af Fasit.
   * Eksempel: aarhus
 * Fasit API version
   * Hvilken version af af API’et der skal bruges. Her er mulighederne ’v1’ eller ’v2’. Der bør altid bruges ’v2’.
   * Eksempel: v2
 * Certificate
-  * Her kan angives detaljer til et azure key vault hvori certifikatet ligges (Azure key vault) eller en sti direkte til certifikatet (Filsystem)
+  * Her kan angives detaljer til et azure key vault hvori certifikatet ligges (Azure key vault) eller en sti direkte til
+    certifikatet (Filsystem)
 * Passphrase
   * Passphrase til certifikatet, hvis sådan et eksisterer.
 
-
 Se evt. Fasit Scultz dokumentationen for flere detaljer på opbygningen af endpoint url’er.
 
-Det er desuden muligt at teste om os2forms kan få fat i certifikatet på samme konfigurations-side. 
+Det er desuden muligt at teste om os2forms kan få fat i certifikatet på samme konfigurations-side.
 
 ## Handler
 

modules/os2forms_fasit/docs/BENYTTELSE.md

@@ -1,4 +1,5 @@
 # OS2Forms Forløb Change Log
+
 All notable changes to this project should be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
@@ -17,9 +18,11 @@ before starting to add changes.
 ## 2.5.2 - 27.03.2023
 
 ### Updated
+
 - Bumped drupal/ultimate_cron version fixing [Deprecated function: Implicit conversion from float-string](https://www.drupal.org/project/ultimate_cron/issues/3256142).
 
 ## 2.5.1 - 10.03.2023
+
 - Added github action for checking changelog changes when creating pull requests
 - Added os2forms/os2forms dependency
 - Changed composer patching configuration
@@ -30,18 +33,20 @@ before starting to add changes.
 ## 2.5.0 - 11.10.2022
 
 ### Added
+
 - retry task controller action
 - Added support for inheriting values without creating a submission
 
 ## 2.4.0
 
 ### Added
+
 - Github CI action for checking Drupal Coding standards with PHP Code Sniffer
 - Fixed coding standards issues
 
-
 ## Example of change log record
-```
+
+```markdown
 ## [x.x.x] Release name
 ### Added
 - Description on added functionality.