lint.yaml

# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
  push:
    branches: [main, master]
  pull_request:
    branches: [main, master]
  schedule:
    # * is a special character in YAML so you have to quote this string
    # Trigger once a week at 00:00 on Sunday
    - cron: "0 0 * * SUN"

name: lint

jobs:
  lint:
    runs-on: ubuntu-latest
    env:
      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
    steps:
      - uses: actions/checkout@v4

      - uses: r-lib/actions/setup-r@v2
        with:
          use-public-rspm: true

      - uses: r-lib/actions/setup-r-dependencies@v2
        with:
          pak-version: devel
          upgrade: 'TRUE'
          extra-packages: |
            r-lib/lintr
            local::.
          needs: lint

      # TODO: Revisit to remove some of these allowances after more important lints
      # have been removed.
      - name: Lint
        run: |
          options(crayon.enabled = TRUE)
          library(lintr)
          lint_package(linters = linters_with_defaults(
            absolute_path_linter = NULL,
            assignment_linter = NULL,
            commented_code_linter = NULL,
            cyclocomp_linter(25L),
            extraction_operator_linter = NULL,
            if_not_else_linter(exceptions = character(0L)),
            implicit_integer_linter = NULL,
            library_call_linter = NULL,
            line_length_linter(120L),
            namespace_linter = NULL,
            nonportable_path_linter = NULL,
            object_name_linter = NULL,
            object_length_linter(50L),
            object_usage_linter = NULL,
            string_boundary_linter = NULL,
            strings_as_factors_linter = NULL,
            todo_comment_linter = NULL,
            undesirable_function_linter = NULL,
            undesirable_operator_linter = NULL,
            unnecessary_concatenation_linter(allow_single_expression = FALSE),
            unused_import_linter = NULL,
            defaults = linters_with_tags(tags = NULL)
          ))
        shell: Rscript {0}