profiidev/Rust 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 }} |
| git_user_name | Git user name to use for auto-fix commits | no | GitHub Action |
| git_user_email | Git user email to use for auto-fix commits | no | action@github.com |
| git_sign_commits | Whether to sign auto-fix commits using Github API. | no | false |
| 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 |
| 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 | chore: 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 |
| forgejo | Enable or disable Forgejo support. If your repository is hosted on Forgejo, you need to set this to `true` to make the action work correctly. | no | false |
| api_url | The API URL to use for GitHub or Forgejo API requests. If not set, it will default to `https://api.github.com` for GitHub and `https://forgejo.com/api/v1` for Forgejo. | no | — |
| 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 |
| 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 |
| 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 |
| svelte | Enable or disable Svelte checks | no | false |
| svelte_args | Additional arguments to pass to the linter | no | "" |
| svelte_dir | Directory where the Svelte command should be run | no | — |
| svelte_extensions | Extensions of files to check with Svelte | no | svelte |
| svelte_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 | "" |
| svelte_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 |
| oxfmt | Enable or disable oxfmt checks | no | false |
| oxfmt_args | Additional arguments to pass to the linter | no | "" |
| oxfmt_dir | Directory where the oxfmt command should be run | no | — |
| oxfmt_extensions | Extensions of files to check with oxmft | no | css,html,js,json,jsx,md,sass,scss,ts,tsx,vue,yaml,yml |
| oxfmt_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 | "" |
| oxfmt_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 |
| oxlint | Enable or disable oxlint checks | no | false |
| oxlint_args | Additional arguments to pass to the linter | no | "" |
| oxlint_dir | Directory where the oxlint command should be run | no | — |
| oxlint_extensions | Extensions of files to check with oxlint | no | none |
| oxlint_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 | "" |
| oxlint_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