actions/lint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-11-25 23:51:07 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 31

more typos

Browse source
This commit is contained in:
Barry 2020-06-30 15:14:49 +01:00
parent df08d4a24f
commit fa35dd2fe3
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/disabling-linters.md
View file

@ -3,9 +3,9 @@ Linters can often require configuring to ensure they work with your codebase and
To run with your own configuration for a linter, copy the relevant [`TEMPLATE` configuration file for the linter you are using from this repo](https://github.com/github/super-linter/tree/master/TEMPLATES) into the `.github/linters` folder in your own repository, and then edit it to modify, disable - or even add - rules and configuration to suit how you want your code checked.
How the changes are made differ for each linter, and also how much Super-Linter has decided to change the linter's defaults. So, for some linters (e.g. [pylint for python](https://github.com/github/super-linter/blob/master/TEMPLATES/.python-lint)), there may be a large configuration file. For others (e.g. [eslint for JavaScript](https://github.com/github/super-linter/blob/master/TEMPLATES/.stylelintrc.json)) the default configuration file may initially be nearly empty. And for some (e.g. StandardJS) it may not be possible to change configuration at all so there is not Template file.
How the changes are made differ for each linter, and also how much Super-Linter has decided to change the linter's defaults. So, for some linters (e.g. [pylint for python](https://github.com/github/super-linter/blob/master/TEMPLATES/.python-lint)), there may be a large configuration file. For others (e.g. [eslint for JavaScript](https://github.com/github/super-linter/blob/master/TEMPLATES/.stylelintrc.json)) the default configuration file may initially be nearly empty. And for some (e.g. StandardJS) it may not be possible to change configuration at all so there is no Template file.
Where a configuration file exists in your repo, it will be used in preference to the default one in the Super-Linter `TEMPLATES` directory (not in addition to it), and where one doesn't exist the `TEMPLATES` version will be used. So you should copy all configuration required from the template and not just the config you want to change.
Where a configuration file exists in your repo, it will be used in preference to the default one in the Super-Linter `TEMPLATES` directory (not in addition to it), and where one doesn't exist the `TEMPLATES` version will be used. So you should copy the complete configuration file you require to change from the `TEMPLATES` directory and not just the lines of config you want to change.
It is possible to have custom configuration for some linters, and continue to use the default from `TEMPLATES` directory for others, so if you use Python and JavaScript and only need to tweak the Python rules, then only have a custom configuration for pylint and continue to use the default `TEMPLATE` from the main repo for ESLint, for example.