mirror of
https://github.com/super-linter/super-linter.git
synced 2024-11-09 18:43:34 -05:00
4.9 KiB
4.9 KiB
Disabling linters and rules
If you find you need to ignore certain errors and warnings, you will need to know the format to disable the linter rules.
Below is examples and documentation for each language and the various methods to disable.
Ruby
Rubocop Config file
Rubocop disable single line
Rubocop disable code block
Rubocop disable entire file
Shell
Shellcheck Config file
Shellcheck disable single line
Shellcheck disable code block
Shellcheck disable entire file
Ansible
Ansible-lint Config file
Ansible-lint disable single line
Ansible-lint disable code block
Ansible-lint disable entire file
YAML
Yamllint Config file
Yamllint disable single line
Yamllint disable code block
Yamllint disable entire file
Python3
Pylint Config file
Pylint disable single line
Pylint disable code block
Pylint disable entire file
JSON
JsonLint Config file
JsonLint disable single line
JsonLint disable code block
JsonLint disable entire file
Markdown
Markdownlint Config file
.markdown-lint.yml- You can pass multiple rules and overwrite default rules
- File should be located at:
.github/linters/.markdownlint.yml
Markdownlint disable single line
## Here is some document
Here is some random data
<!-- markdownlint-disable -->
any violation you want
<!-- markdownlint-restore -->
Here is more data
Markdownlint disable code block
## Here is some document
Here is some random data
<!-- markdownlint-disable -->
any violations you want
<!-- markdownlint-restore -->
Here is more data
Markdownlint disable entire file
- You can encapsulate the entire file with the code block format to disable an entire file from being parsed