Taskfile.yml

# https://taskfile.dev

version: "3"

tasks:
  default:
    cmd: task --list-all
    silent: true

  ddev:
    desc: "Run DDEV command"
    cmd: ddev {{.TASK_ARGS}} {{.CLI_ARGS}}
    internal: true

  coding-standards:apply:
    desc: "Apply coding standards"
    cmds:
      - task: coding-standards:composer:apply
      - task: coding-standards:javascript:apply
      - task: coding-standards:markdown:apply
      - task: coding-standards:php:apply
      - task: coding-standards:yaml:apply

  coding-standards:check:
    desc: "Check coding standards"
    cmds:
      - task: coding-standards:composer:check
      - task: coding-standards:javascript:check
      - task: coding-standards:markdown:check
      - task: coding-standards:php:check
      - task: coding-standards:yaml:check

  coding-standards:composer:apply:
    desc: "Apply coding standards for composer"
    cmds:
      - task: ddev
        vars:
          TASK_ARGS: composer normalize

  coding-standards:composer:check:
    - task: coding-standards:composer:apply
    - task: ddev
      vars:
        TASK_ARGS: composer normalize --dry-run
    - task: ddev
      vars:
        TASK_ARGS: composer validate

  coding-standards:javascript:apply:
    desc: "Apply coding standards for JavaScript"
    cmds:
      # Cf. .github/workflows/javascript.yaml
      - docker compose run --rm prettier 'tests/**/*.{js,ts}' --write

  coding-standards:javascript:check:
    desc: "Apply coding standards for JavaScript"
    cmds:
      - task: coding-standards:javascript:apply
      # Cf. .github/workflows/javascript.yaml
      - docker compose run --rm prettier 'tests/**/*.{js,ts}' --check

  coding-standards:markdown:apply:
    desc: "Apply coding standards for Markdown"
    cmds:
      # Cf. .github/workflows/markdown.yaml
      - docker compose run --rm markdownlint markdownlint '**/*.md' --fix

  coding-standards:markdown:check:
    desc: "Apply and check coding standards for Markdown"
    cmds:
      - task: coding-standards:markdown:apply
      # Cf. .github/workflows/markdown.yaml
      - docker compose run --rm markdownlint markdownlint '**/*.md'

  coding-standards:php:apply:
    desc: "Apply coding standards for PHP"
    cmds:
      # Cf. .github/workflows/php.yaml
      - task: ddev
        vars:
          TASK_ARGS: phpcbf

  coding-standards:php:check:
    desc: "Apply and check coding standards for PHP"
    cmds:
      - task: coding-standards:php:apply
        # phpcbf has weird exit codes …
        ignore_error: true
      # Cf. .github/workflows/php.yaml
      - task: ddev
        vars:
          TASK_ARGS: phpcs

  coding-standards:yaml:apply:
    desc: "Apply coding standards for YAML"
    cmds:
      # Cf. .github/workflows/yaml.yaml
      - docker compose run --rm prettier '**/*.{yml,yaml}' --write

  coding-standards:yaml:check:
    desc: "Apply coding standards for YAML"
    cmds:
      - task: coding-standards:yaml:apply
      # Cf. .github/workflows/yaml.yaml
      - docker compose run --rm prettier '**/*.{yml,yaml}' --check

  code-analysis:
    desc: "Run static code analysis"
    cmds:
      - task: code-analysis:rector
      - task: code-analysis:phpstan

  code-analysis:phpstan:
    desc: "Run PHPStan"
    cmds:
      - task: ddev
        vars:
          TASK_ARGS: phpstan

  code-analysis:rector:
    desc: "Run rector"
    cmds:
      - task: ddev
        vars:
          TASK_ARGS: php vendor/bin/rector

  ddev:start:
    desc: Start DDEV Drupal Contrib setup (https://github.com/ddev/ddev-drupal-contrib)
    cmds:
      # We want a clean slate
      - rm -f composer.lock
      - ddev start
      - ddev poser --no-interaction
      - ddev symlink-project

  ddev:update:
    desc: Update DDEV Drupal Contrib setup (https://github.com/ddev/ddev-drupal-contrib#update)
    cmds:
      - ddev add-on get ddev/ddev-drupal-contrib
      - ddev restart

  translations:extract:
    desc: Extract module translations
    deps:
      - drupal:site:is-installed
    cmds:
      - for:
          - da
        cmd: >-
          ddev drush --yes drupal_translation_extractor:translation:extract {{.ITEM}}
          --dump-messages --force --output=%source/translations/%module.%locale.po
          --require-context=os2forms_f2 module:os2forms_f2
          --sort=asc --clean --debug
          --finder-do-not-ignore-vcs-ignored
      # Show any changes
      - task: translations:git:diff
        ignore_error: true
      # Restore if only some metadata is changed
      - task: translations:git:restore

  translations:git:diff:
    desc: "`git diff` all translation files ignoring timestamp changes"
    # Ignore some PO metadata when git diff'ing, e.g.
    #
    # "POT-Creation-Date: 2025-03-12 18:18+0100\n"
    # "PO-Revision-Date: 2025-03-12 18:18+0100\n"
    cmd: git diff --exit-code --ignore-blank-lines --ignore-matching-lines='^"PO.*-Date' '*.po'

  translations:git:restore:
    desc: '`git restore` all translation file changes if only timestamps are changed (cf. `task {{.TASK | replace ":restore" ":diff" }}`)'
    # https://taskfile.dev/reference/schema#preconditions
    preconditions:
      - sh: task {{.TASK | replace ":restore" ":diff" }}
        msg: |
          Translations seem to have changed.

          Run

              task {{.TASK | replace ":restore" ":diff" }}

          to check.
    cmd: git restore '*.po'

  drupal:site:is-installed:
    internal: true
    preconditions:
      # https://drupal.stackexchange.com/a/318384
      - sh: '[ $(ddev drush status --field=bootstrap) = "Successful" ]'
        msg: |
          It seems that Drupal has not been installed. Run

            task drupal:site:install

          before running this task.

  drupal:site:install:
    desc: Installs Drupal site, enables OS2Forms F2 module and configures Drupal for development and testing
    prompt: Really install (and reset) Drupal site?
    cmds:
      - ddev drush --yes site:install
      - ddev drush --yes user:password admin password
      - ddev drush --yes pm:uninstall update announcements_feed

      # Patch https://github.com/OS2Forms/os2forms/blob/develop/config/optional/pathauto.pattern.os2forms_wf_webforms.yml
      - |
        ddev exec sed --in-place 's/id: node_type$/id: entity_bundle:node/' */modules/contrib/os2forms/config/optional/pathauto.pattern.os2forms_wf_webforms.yml

      - ddev drush --yes pm:install os2forms_f2 os2forms_f2_examples os2forms_f2_test drupal_translation_extractor

      # Some defaults
      - ddev drush --yes config:set os2forms_f2.settings f2_api.log_level debug
      - ddev drush --yes config:set os2forms_f2.settings general.queue os2forms_f2

      # Gin theme
      - ddev drush --yes theme:install gin
      - ddev drush --yes config:set system.theme default gin
      - ddev drush --yes config:set system.theme admin gin
      - ddev drush --yes pm:uninstall navigation
      # - ddev drush --yes config:set gin.settings classic_toolbar horizontal

      - ddev drush --yes config:set webform.settings ui.description_help false --input-format yaml
      - ddev drush --yes config:set webform.settings settings.default_submission_log true --input-format=yaml

      # Languages and locales
      - ddev drush --yes pm:install language locale
      - ddev drush --yes language:add da

      # - ddev drush --yes locale:check
      # - ddev drush --yes locale:update
      # Import our module translations
      - ddev drush --yes locale:import da modules/custom/os2forms_f2/translations/os2forms_f2.da.po

      - task: drupal:site:reset

  drupal:site:reset:
    decs: Create settings for os2forms_f2 module
    prompt: Really reset Drupal site?
    cmds:
      - ddev drush --yes config:import --partial --source modules/custom/os2forms_f2/modules/os2forms_f2_examples/config/install
      - ddev drush --yes config:import --partial --source modules/custom/os2forms_f2/modules/os2forms_f2_test/config/install
      - >-
        ddev drush --yes sql:query "
        TRUNCATE advancedqueue;
        TRUNCATE webform_submission_log;
        TRUNCATE webform_submission_data;
        TRUNCATE webform_submission;
        TRUNCATE os2forms_f2_f2_item;
        ALTER TABLE webform_submission AUTO_INCREMENT = 1;
        UPDATE webform SET next_serial = 1;
        "

  playwright:install:
    desc: Install Playwright stuff
    cmd: ddev playwright-install --pm npm

  user-manual:images:generate:
    desc: Generate user manual images
    deps:
      - drupal:site:is-installed
      - playwright:install
    cmds:
      - cmd: ddev playwright test user-manual-images.spec.ts {{.CLI_ARGS}}
        # We want to postprocess any updated images even if something fails
        ignore_error: true
      - task: user-manual:images:trim
      - task: user-manual:images:restore

  user-manual:images:trim:
    desc: "Trim docs images"
    silent: true
    vars:
      BORDER_WIDTH: 4
    # Trim and add border
    cmd:
      cmd: |
        docker run --volume $PWD:/app --workdir /app --rm itkdev/php8.5-fpm mogrify \
          -strip \
          -background white \
          -trim \
          -gravity north -splice 0x{{.BORDER_WIDTH}}+0+0 \
          -gravity south -splice 0x{{.BORDER_WIDTH}}+0+0 \
          -gravity west -splice {{.BORDER_WIDTH}}x0+0+0 \
          -gravity east -splice {{.BORDER_WIDTH}}x0+0+0 \
          docs/user-manual/da/images/generated/**/*.png
      # https://taskfile.dev/docs/reference/schema#shopt
      shopt: [globstar]

  user-manual:images:restore:
    desc: "Restore docs images that are not visually modified"
    silent: true
    cmd:
      cmd: |
        # https://stackoverflow.com/a/949391
        latest_commit=$(git rev-parse --verify HEAD)

         # M docs/en/images/manager/006-entry-look-up.png
        status_modified_pattern="^ M "

        debug_output_filename=false
        if [[ '{{.COMPARE_OUTPUT_FILENAME | default "-"}}' != '-' ]]; then
          debug_output_filename=true
        fi

        shopt -s globstar nullglob
        for file in docs/user-manual/da/images/generated/**/*.png; do
            status=$(git status --porcelain "$file")
            if [[ "$status" =~ $status_modified_pattern ]]; then
                if git cat-file -p "$latest_commit":"$file" | \
                    docker run --volume $PWD:/app --workdir /app --rm itkdev/php8.5-fpm compare \
                    - \
                    "$file" \
                    {{.COMPARE_OUTPUT_FILENAME | default "-"}} > /dev/null 2>&1; then
                    echo "Restoring $file"
                    git restore "$file"
                else
                    echo "$file modified"
                    if [ "$debug_output_filename" = true ]; then
                      echo
                      echo "Comparison image written to {{.COMPARE_OUTPUT_FILENAME | default "-"}}"
                      echo
                    fi
                fi
            fi
        done
      shopt: [globstar]