wearerequired/Lint Action
GitHub Action for detecting and fixing linting errors
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github_token | The GitHub token used to authenticated with GitHub. | no | ${{ github.token }} |
| continue_on_error | Whether the workflow run should also fail when linter failures are detected | no | true |
| auto_fix | Whether linters should try to fix code style issues automatically | no | false |
| commit | Whether to commit and push the changes made by auto_fix | no | true |
| git_no_verify | Bypass the pre-commit and pre-push git hooks | no | false |
| git_name | Username for auto-fix commits | no | Lint Action |
| git_email | Email address for auto-fix commits | no | lint-action@samuelmeuli.com |
| commit_message | Template for auto-fix commit messages. The "${linter}" variable can be used to insert the name of the linter which has created the auto-fix | no | Fix code style issues with ${linter} |
| check_name | Template for the name of the check run. The "${linter}" and "${dir}" variables can be used to insert the name and directory of the linter. | no | ${linter} |
| neutral_check_on_warning | Whether the check run should conclude with a neutral status instead of success when the linter finds only warnings | no | false |
| stylelint | Enable or disable stylelint checks | no | false |
| stylelint_args | Additional arguments to pass to the linter | no | "" |
| stylelint_dir | Directory where the stylelint command should be run | no | — |
| stylelint_extensions | Extensions of files to check with stylelint | no | css |
| stylelint_command_prefix | Shell command to prepend to the linter command | no | "" |
| stylelint_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| gofmt | Enable or disable gofmt checks | no | false |
| gofmt_args | Additional arguments to pass to the linter | no | "" |
| gofmt_dir | Directory where the gofmt command should be run | no | — |
| gofmt_extensions | Extensions of files to check with gofmt | no | go |
| gofmt_command_prefix | Shell command to prepend to the linter command | no | "" |
| gofmt_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| golint | Enable or disable golint checks | no | false |
| golint_args | Additional arguments to pass to the linter | no | "" |
| golint_dir | Directory where the golint command should be run | no | — |
| golint_extensions | Extensions of files to check with golint | no | go |
| golint_command_prefix | Shell command to prepend to the linter command | no | "" |
| golint_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | false |
| staticcheck | Enable or disable staticcheck checks | no | false |
| staticcheck_args | Additional arguments to pass to the linter | no | "" |
| staticcheck_dir | Directory where the staticcheck command should be run | no | — |
| staticcheck_extensions | Extensions of files to check with staticcheck | no | go |
| staticcheck_command_prefix | Shell command to prepend to the linter command | no | "" |
| staticcheck_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | false |
| eslint | Enable or disable ESLint checks | no | false |
| eslint_args | Additional arguments to pass to the linter | no | "" |
| eslint_dir | Directory where the ESLint command should be run | no | — |
| eslint_extensions | Extensions of files to check with ESLint | no | js |
| eslint_command_prefix | Shell command to prepend to the linter command. Will default to `npx --no-install` for NPM and `yarn run --silent` for Yarn. | no | "" |
| eslint_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| prettier | Enable or disable Prettier checks | no | false |
| prettier_args | Additional arguments to pass to the linter | no | "" |
| prettier_dir | Directory where the Prettier command should be run | no | — |
| prettier_extensions | Extensions of files to check with Prettier | no | css,html,js,json,jsx,md,sass,scss,ts,tsx,vue,yaml,yml |
| prettier_command_prefix | Shell command to prepend to the linter command. Will default to `npx --no-install` for NPM and `yarn run --silent` for Yarn. | no | "" |
| prettier_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| xo | Enable or disable XO checks | no | false |
| xo_args | Additional arguments to pass to the linter | no | "" |
| xo_dir | Directory where the XO command should be run | no | — |
| xo_extensions | Extensions of files to check with XO | no | js |
| xo_command_prefix | Shell command to prepend to the linter command. Will default to `npx --no-install` for NPM and `yarn run --silent` for Yarn. | no | "" |
| xo_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| tsc | Enable or disable TypeScript checks | no | false |
| tsc_args | Additional arguments to pass to the linter | no | "" |
| tsc_dir | Directory where the TSC command should be run | no | — |
| tsc_extensions | Extensions of files to check with TSC | no | ts |
| tsc_command_prefix | Shell command to prepend to the linter command. Will default to `npx --no-install` for NPM and `yarn run --silent` for Yarn. | no | "" |
| tsc_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | false |
| php_codesniffer | Enable or disable PHP_CodeSniffer checks | no | false |
| php_codesniffer_args | Additional arguments to pass to the linter | no | "" |
| php_codesniffer_dir | Directory where the PHP_CodeSniffer command should be run | no | — |
| php_codesniffer_extensions | Extensions of files to check with PHP_CodeSniffer | no | php |
| php_codesniffer_command_prefix | Shell command to prepend to the linter command | no | "" |
| php_codesniffer_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | false |
| autopep8 | Enable or disable autopep8 checks | no | false |
| autopep8_args | Additional arguments to pass to the linter | no | "" |
| autopep8_dir | Directory where the autopep8 command should be run | no | — |
| autopep8_extensions | Extensions of files to check with autopep8 | no | py |
| autopep8_command_prefix | Shell command to prepend to the linter command | no | "" |
| autopep8_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| black | Enable or disable Black checks | no | false |
| black_args | Additional arguments to pass to the linter | no | "" |
| black_dir | Directory where the Black command should be run | no | — |
| black_extensions | Extensions of files to check with Black | no | py |
| black_command_prefix | Shell command to prepend to the linter command | no | "" |
| black_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| clang_format | Enable or disable ClangFormat checks | no | false |
| clang_format_args | Additional arguments to pass to the linter | no | "" |
| clang_format_dir | Directory where the ClangFormat command should be run | no | — |
| clang_format_extensions | Extensions of files to check with ClangFormat | no | c,cc,cpp,h,hpp,m,mm |
| clang_format_command_prefix | Shell command to prepend to the linter command | no | "" |
| clang_format_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | false |
| flake8 | Enable or disable Flake8 checks | no | false |
| flake8_args | Additional arguments to pass to the linter | no | "" |
| flake8_dir | Directory where the Flake8 command should be run | no | — |
| flake8_extensions | Extensions of files to check with Flake8 | no | py |
| flake8_command_prefix | Shell command to prepend to the linter command | no | "" |
| flake8_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | false |
| isort | Enable or disable isort checks | no | false |
| isort_args | Additional arguments to pass to the linter | no | "" |
| isort_dir | Directory where the isort command should be run | no | — |
| isort_extensions | Extensions of files to check with isort | no | py |
| isort_command_prefix | Shell command to prepend to the linter command | no | "" |
| isort_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| mypy | Enable or disable Mypy checks | no | false |
| mypy_args | Additional arguments to pass to the linter | no | "" |
| mypy_dir | Directory where the Mypy command should be run | no | — |
| mypy_extensions | Extensions of files to check with Mypy | no | py |
| mypy_command_prefix | Shell command to prepend to the linter command | no | "" |
| mypy_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | false |
| oitnb | Enable or disable oitnb checks | no | false |
| oitnb_args | Additional arguments to pass to the linter | no | "" |
| oitnb_dir | Directory where the oitnb command should be run | no | — |
| oitnb_extensions | Extensions of files to check with oitnb | no | py |
| oitnb_command_prefix | Shell command to prepend to the linter command | no | "" |
| oitnb_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| pylint | Enable or disable Pylint checks | no | false |
| pylint_args | Additional arguments to pass to the linter | no | "" |
| pylint_dir | Directory where the Pylint command should be run | no | — |
| pylint_extensions | Extensions of files to check with Pylint | no | py |
| pylint_command_prefix | Shell command to prepend to the linter command | no | "" |
| pylint_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | false |
| ruff | Enable or disable Ruff checks | no | false |
| ruff_args | Additional arguments to pass to the linter | no | "" |
| ruff_dir | Directory where the Ruff command should be run | no | — |
| ruff_extensions | Extensions of files to check with Ruff | no | py |
| ruff_command_prefix | Shell command to prepend to the linter command | no | "" |
| ruff_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| rubocop | Enable or disable RuboCop checks | no | false |
| rubocop_args | Additional arguments to pass to the linter | no | "" |
| rubocop_dir | Directory where the RuboCop command should be run | no | — |
| rubocop_extensions | Extensions of files to check with RuboCop | no | rb |
| rubocop_command_prefix | Shell command to prepend to the linter command | no | "" |
| rubocop_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| standardrb | Enable or disable Standard Ruby checks | no | false |
| standardrb_args | Additional arguments to pass to the linter | no | "" |
| standardrb_dir | Directory where the standardrb command should be run | no | — |
| standardrb_extensions | Extensions of files to check with standardrb | no | rb |
| standardrb_command_prefix | Shell command to prepend to the linter command | no | "" |
| standardrb_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| erblint | Enable or disable ERB Lint checks | no | false |
| erblint_args | Additional arguments to pass to the linter | no | "" |
| erblint_dir | Directory where the ERB Lint command should be run | no | — |
| erblint_extensions | Extensions of files to check with ERB Lint | no | erb |
| erblint_command_prefix | Shell command to prepend to the linter command | no | "" |
| erblint_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | false |
| clippy | Enable or disable clippy | no | false |
| clippy_args | Additional arguments to pass to the linter | no | "" |
| clippy_dir | Directory where the RuboCop command should be run | no | — |
| clippy_extensions | Extensions of files to check with RuboCop | no | rs |
| clippy_command_prefix | Shell command to prepend to the linter command | no | "" |
| clippy_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| rustfmt | Enable or disable rustfmt | no | false |
| rustfmt_args | Additional arguments to pass to the linter | no | -- --color=never |
| rustfmt_extensions | Extensions of files to check with rustfmt | no | rs |
| rustfmt_dir | Directory where the rustfmt command should be run | no | — |
| rustfmt_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| swiftformat | Enable or disable SwiftFormat checks | no | false |
| swiftformat_args | Additional arguments to pass to the linter | no | "" |
| swiftformat_dir | Directory where the SwiftFormat command should be run | no | — |
| swiftformat_extensions | Extensions of files to check with SwiftFormat | no | swift |
| swiftformat_command_prefix | Shell command to prepend to the linter command | no | "" |
| swiftformat_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| swift_format_lockwood | Enable or disable SwiftFormat checks | no | false |
| swift_format_lockwood_args | Additional arguments to pass to the linter | no | "" |
| swift_format_lockwood_dir | Directory where the SwiftFormat command should be run | no | — |
| swift_format_lockwood_extensions | Extensions of files to check with SwiftFormat | no | swift |
| swift_format_lockwood_command_prefix | Shell command to prepend to the linter command | no | "" |
| swift_format_lockwood_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| swift_format_official | Enable or disable swift-format checks | no | false |
| swift_format_official_args | Additional arguments to pass to the linter | no | "" |
| swift_format_official_dir | Directory where the swift-format command should be run | no | — |
| swift_format_official_extensions | Extrensions of files to check with swift-format | no | swift |
| swift_format_official_command_prefix | Shell command to prepend to the linter command | no | "" |
| swift_format_official_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| swiftlint | Enable or disable SwiftLint checks | no | false |
| swiftlint_args | Additional arguments to pass to the linter | no | "" |
| swiftlint_dir | Directory where the SwiftLint command should be run | no | — |
| swiftlint_extensions | Extensions of files to check with SwiftLint | no | swift |
| swiftlint_command_prefix | Shell command to prepend to the linter command | no | "" |
| swiftlint_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
| dotnet_format | Enable or disable dotnet-format checks | no | false |
| dotnet_format_args | Additional arguments to pass to the linter | no | "" |
| dotnet_format_dir | Directory where the dotnet-format command should be run | no | — |
| dotnet_format_extensions | Extensions of files to check with dotnet-format | no | cs |
| dotnet_format_command_prefix | Shell command to prepend to the linter command | no | "" |
| dotnet_format_auto_fix | Whether this linter should try to fix code style issues automatically. If set to `true`, it will only work if "auto_fix" is set to `true` as well | no | true |
Outputs
no outputs