Taskfile.yml

# https://taskfile.dev

version: "3"

env:
  LOCALES:
    - de

tasks:
  install:
    desc: Installs OctoPrint into the current Python environment
    cmds:
      - python -m pip install -e .

  install-dev:
    desc: Installs OctoPrint incl. develop, plugins & docs dependencies into the current Python environment
    cmds:
      - python -m pip install -e ".[develop,plugins,docs]"

  init-dev:
    desc: Prepares a developmenet environment by installing necessary dependencies and activating pre-commit and blame ignore file
    cmds:
      - task: install-dev
      - pre-commit install
      - git config blame.ignoreRevsFile .git-blame-ignore-revs

  check-deps:
    desc: Lists outdated packages in the current venv
    cmds:
      - pip-check -H

  pre-commit:
    desc: Run pre-commit on all files
    cmds:
      - pre-commit run --all-files

  test:
    desc: Run test suites
    cmds:
      - task: test-unit
      - task: test-e2e

  test-unit:
    desc: Run unit tests
    cmds:
      - pytest

  test-e2e:
    desc: Run e2e tests
    cmds:
      - |
        cd tests/playwright
        npx playwright test --grep-invert "@isolated|@csrf"

  test-e2e-ui:
    desc: Run e2e tests interactively
    cmds:
      - |
        cd tests/playwright
        npx playwright test --ui

  test-e2e-install:
    desc: Install e2e test framework & dependencies
    cmds:
      - |
        cd tests/playwright
        npx playwright install

  test-qunit:
    desc: Runs QUnit tests via puppeteer
    cmds:
      - |
        cd tests/static/js
        npx node-qunit-puppeteer test-helpers.html
        npx node-qunit-puppeteer test-client-base.html

  test-qunit-install:
    desc: Install QUnit test dependencies
    cmds:
      - npx puppeteer install chrome

  ### Build related

  build:
    desc: Builds sdist & wheel
    cmds:
      - python -m build --sdist --wheel

  build-sdist:
    desc: Builds sdist
    cmds:
      - python -m build --sdist

  build-wheel:
    desc: Builds wheel
    cmds:
      - python -m build --wheel

  update-assets:
    desc: Updates all assets
    cmds:
      - octoprint dev css:build --all

  watch-assets:
    desc: Monitors all assets and builds them as needed
    cmds:
      - octoprint dev css:watch --all

  ### Translation related

  babel-new:
    desc: Create a new translation for a locale, e.g. task babel-new -- de
    cmds:
      - task: babel-extract
      - |
        pybabel init --input-file=translations/messages.pot --output-dir=translations --locale="{{ .CLI_ARGS }}"

  babel-extract:
    desc: Update pot file from source
    cmds:
      - pybabel extract --mapping-file=babel.cfg --output-file=translations/messages.pot --msgid-bugs-address=i18n@octoprint.org --copyright-holder="The OctoPrint Project" .

  babel-update:
    desc: Update translation files from pot file
    cmds:
      - for:
          var: LOCALES
        cmd: pybabel update --input-file=translations/messages.pot --output-dir=translations --locale={{ .ITEM }}

  babel-refresh:
    desc: Update translation files from source
    cmds:
      - task: babel-extract
      - task: babel-update

  babel-compile:
    desc: Compile translation files
    cmds:
      - pybabel compile --directory=translations

  babel-bundle:
    desc: Bundle translations
    cmds:
      - for:
          var: LOCALES
        cmd: |
          locale="{{ .ITEM }}"
          source="translations/${locale}"
          target="src/octoprint/translations/${locale}"

          [ ! -d "${target}" ] || rm -r "${target}"

          echo "Copying translations for locale ${locale} from ${source} to ${target}..."
          cp -r "${source}" "${target}"

  ### Docs related

  docs-serve:
    desc: Build & serve the docs with automatic updates
    cmds:
      - sphinx-autobuild docs docs/_build/html

  docs-build:
    desc: Build the docs
    cmds:
      - python -m sphinx.cmd.build -b html -v ./docs ./docs/_build

  docs-clean:
    desc: Clean docs output
    cmds:
      - rm -r ./docs/_build

  ### CI related

  ci-update:
    desc: Update GitHub Action workflow files to new versions of used actions
    cmds:
      - npx actions-up --include-branches