action.yml

# ref: https://help.github.com/en/actions/building-actions/metadata-syntax-for-github-actions
name: Clojure Lint Action
description: A simple GitHub Actions to lint Clojure Code with clj-kondo

author: Nick Nichols

branding:
  color: purple
  icon: search

runs:
  using: docker
  image: Dockerfile

inputs:
  github_token:
    required: false
    description: 'GITHUB_TOKEN.'
    default: '${{ github.token }}'
  level:
    required: false
    description: 'Report level for reviewdog [info,warning,error]'
    default: 'error'
  reporter:
    required: false
    description: |
      Reporter of reviewdog command [github-pr-check,github-pr-review,github-check].
      Default is github-pr-check.
      github-pr-review can use Markdown and add a link to rule page in reviewdog reports.
    default: 'github-pr-check'
  filter_mode:
    required: false
    description: |
      Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
      Default is added.
    default: 'added'
  fail_on_error:
    required: false
    description: |
      Exit code for reviewdog when errors are found [true,false]
      Default is `false`.
    default: 'false'
  reviewdog_flags:
    required: false
    description: 'Additional reviewdog flags'
    default: ''
  path:
    required: false
    description: "Base directory to run clj-kondo. Same as `[path]` of `find` command."
    default: '.'
  pattern:
    required: false
    description: "File patterns of target files. Same as `-name [pattern]` of `find` command."
    default: '*.clj*'
  exclude:
    required: false
    description: "Exclude patterns of target files. Same as `-not -path [exclude]` of `find` command."
  clj_kondo_config:
    required: false
    description: "Flags to pass to clj-kondo's `--config` option, which may either be in-line options or a path to a config file."
    default: '{:output {:pattern "{{filename}}:{{row}}:{{col}}: {{message}}"}}'