.pre-commit-hooks.yaml

- id: no-merge-commits
  name: Don't create merge commits
  entry: Prefer rebase workflow to merge commits
  language: fail
  stages:
    - merge-commit
  description: >
    For projects that use rebase rather than merge workflows, this hook makes it
    easy to enforce that policy. See
    https://git-scm.com/book/en/v2/Git-Branching-Rebasing for more details.

- id: asdf-install
  name: Install correct versions of tools managed by asdf
  entry: asdf install
  language: system
  always_run: true
  pass_filenames: false
  stages:
    - commit
    - push
    - post-checkout
    - post-rewrite
  description: >
    Install or set versions of asdf-managed tools based on .tool-versions unless
    otherwise configured. See
    https://asdf-vm.com/manage/configuration.html#tool-versions for more
    details.

- id: poetry-check
  name: Validate structure of pyproject.toml
  entry: poetry check
  language: system
  files: \.tool-versions|pyproject\.toml
  pass_filenames: false
  description: >
    Check that Poetry dependencies are properly specified. See
    https://python-poetry.org/docs/cli/#check for more details.

- id: poetry-lock
  name: Lock Poetry dependencies
  entry: poetry lock
  language: system
  files: \.tool-versions|poetry\.lock|pyproject\.toml
  pass_filenames: false
  description: >
    Update poetry.lock to match pyproject.toml without upgrading already locked
    dependencies. See https://python-poetry.org/docs/cli/#lock for more
    details.
  args: [--no-update]

- id: poetry-install
  name: Install Poetry dependencies
  entry: poetry install
  language: system
  always_run: true
  pass_filenames: false
  stages:
    - commit
    - push
    - post-checkout
    - post-rewrite
  description: >
    Install all Poetry dependencies from poetry.lock. Uninstall any dependencies
    not found in the lock file. Requires Poetry 1.2+. See
    https://python-poetry.org/docs/cli/#install for more details.
  args: [--sync]

- id: pre-commit-install
  name: Install pre-commit hooks
  entry: poetry run pre-commit install
  language: system
  always_run: true
  pass_filenames: false
  stages:
    - commit
    - push
    - post-checkout
    - post-rewrite
  description: >
    Install default hook types and environments for all available hooks. Ensure
    that updates to pre-commit's Git hook script are applied. See
    https://pre-commit.com/#pre-commit-install and
    https://pre-commit.com/#top_level-default_install_hook_types for more
    details.
  args: [--install-hooks]

- id: yarn-install
  name: Install Yarn dependencies
  entry: yarn install
  language: system
  always_run: true
  pass_filenames: false
  stages:
    - commit
    - push
    - post-checkout
    - post-rewrite
  description: >
    Install all Yarn dependencies, and update yarn.lock. See
    https://yarnpkg.com/cli/install for more details.

- id: yarn-dedupe
  name: Deduplicate Yarn dependencies
  entry: yarn dedupe
  language: system
  files: \.tool-versions|package\.json|yarn(-(\d+\.){2}\d+\.cjs|\.lock)
  pass_filenames: false
  description: >
    Remove all but the highest version of any duplicates. More than one version
    of a package may be required in the case of non-overlapping version
    specifications. See https://yarnpkg.com/cli/dedupe for more details.

- id: yarn-audit
  name: Perform security audit of Yarn dependencies
  entry: yarn npm audit
  language: system
  pass_filenames: false
  description: >
    Check Yarn dependencies for known vulnerabilities. See
    https://yarnpkg.com/cli/npm/audit for more details.
  args: [--all, --recursive]

- id: yarn-sdks
  name: Generate Yarn SDKs
  entry: src/yarn-sdks.sh
  language: script
  files: \.yarn/sdks/|yarn(-(\d+\.){2}\d+\.cjs|\.lock)
  pass_filenames: false
  description: >
    Generate SDKs and settings for editors specified in
    `.yarn/sdks/integrations.yml`. Format VSCode settings with Prettier to
    prevent formatting conflicts with MegaLinter. See
    https://yarnpkg.com/sdks/cli/default for more details.

- id: yarn-build
  name: Build the app
  entry: yarn run build
  language: system
  files: \.tool-versions|package\.json|yarn(-(\d+\.){2}\d+\.cjs|\.lock)|.*\.ts
  pass_filenames: false
  description: >
    Compile TypeScript files to JavaScript. See https://yarnpkg.com/cli/run for
    more details.

- id: yarn-test
  name: Run Yarn tests
  entry: yarn run test
  language: system
  types:
    - ts
  require_serial: true
  description: >
    Run the Jest tests that check the modified files. See
    https://yarnpkg.com/cli/run and
    https://jestjs.io/docs/cli#--findrelatedtests-spaceseparatedlistofsourcefiles
    for more details.
  args: [--passWithNoTests, --findRelatedTests]

- id: megalinter-incremental
  name: Run MegaLinter (skipping linters that run in project mode)
  entry: >
    npx -- mega-linter-runner@v7.7.0
    --container-name megalinter-incremental
    --remove-container
    --fix
    --env LOG_LEVEL=warning
    --filesonly
  language: system
  stages:
    - commit
  require_serial: true
  description: >
    See https://megalinter.io/latest/mega-linter-runner/#usage and
    https://megalinter.io/latest/configuration/ if you wish to override the
    default arguments. mega-linter-runner is specified as an argument so that
    you may override the version (e.g., mega-linter-runner@vx.y.z). Depends on
    npx, which ships with npm 7+, and Docker. Runs very slowly when the
    pertinent Docker image isn't already cached (c.f.,
    https://github.com/marketplace/actions/docker-cache/). If you encounter
    permission errors, try running Docker in rootless mode (c.f.,
    https://github.com/marketplace/actions/rootless-docker/). Linter results are
    logged to the megalinter-reports directory, so list it in your .gitignore.
    Skip linters that run in project mode since they don't run incrementally.

- id: megalinter-full
  name: Run MegaLinter
  entry: >
    npx -- mega-linter-runner@v7.7.0
    --container-name megalinter-full
    --remove-container
    --fix
    --env LOG_LEVEL=warning
  language: system
  stages:
    - push
  require_serial: true
  description: >
    See https://megalinter.io/latest/mega-linter-runner/#usage and
    https://megalinter.io/latest/configuration/ if you wish to override the
    default arguments. mega-linter-runner is specified as an argument so that
    you may override the version (e.g., mega-linter-runner@vx.y.z). Depends on
    npx, which ships with npm 7+, and Docker. Runs very slowly when the
    pertinent Docker image isn't already cached (c.f.,
    https://github.com/marketplace/actions/docker-cache/). If you encounter
    permission errors, try running Docker in rootless mode (c.f.,
    https://github.com/marketplace/actions/rootless-docker/). Linter results are
    logged to the megalinter-reports directory, so list it in your .gitignore.