action.yaml

name: 'Run typos with reviewdog'
description: '🐶 Run typos with reviewdog on pull requests to improve code review experience.'
author: 'Shemnei'
inputs:
  github_token:
    description: 'GITHUB_TOKEN'
    default: '${{ github.token }}'
  workdir:
    description: 'Working directory relative to the root directory.'
    default: '.'
  ### Flags for reviewdog ###
  level:
    description: 'Report level for reviewdog [info,warning,error]'
    default: 'error'
  reporter:
    description: 'Reporter of reviewdog command [github-pr-check,github-pr-review].'
    default: 'github-pr-check'
  filter_mode:
    description: |
      Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
      Default is added.
    default: 'added'
  fail_on_error:
    description: |
      Exit code for reviewdog when errors are found [true,false]
      Default is `false`.
    default: 'false'
  reviewdog_flags:
    description: 'Additional reviewdog flags'
    default: ''
  ### Flags for typos ###
  exclude:
    description: 'Files or patterns to exclude'
    required: false
  files:
    description: 'Files or patterns to check'
    required: false
  config:
    description: 'Use a custom config file'
    required: false
  extend_identifiers:
    deprecationMessage: 'Added for feature parity but not used in original typos action'
    description: 'Comma separated list of extend identifiers, like someone''s name'
    required: false
  extend_words:
    deprecationMessage: 'Added for feature parity but not used in original typos action'
    description: 'Comma separated list of extend words.'
    required: false
  isolated:
    description: 'Ignore implicit configuration files'
    required: false
    default: false
  write_changes:
    description: 'Write changes to the repository'
    required: false
    default: false
  locale:
    description: 'Language locale to suggest corrections for [en, en-us, en-gb, en-ca, en-au]'
    required: false
  debug:
    description: 'Enables debug options. NOTE: This will significantly increase the log output. Only enable when needed'
    required: false

runs:
  using: 'docker'
  image: 'Dockerfile'

# Ref: https://haya14busa.github.io/github-action-brandings/
branding:
  icon: 'edit'
  color: 'gray-dark'