mirror of
https://github.com/super-linter/super-linter.git
synced 2024-11-06 01:05:54 -05:00
Added "Using your own rules files" to the README
Added a "Using your own rules files" section to the README under the "Template rules" section. This section may help developers new to super-linter avoid running into issues #864 and #685.
This commit is contained in:
parent
c5ba851b72
commit
c846cfd9ce
2 changed files with 51 additions and 1 deletions
|
@ -21,6 +21,7 @@ It is a simple combination of various linters, written in `bash`, to help valida
|
|||
- [Add Super-Linter badge in your repository README](#add-super-linter-badge-in-your-repository-readme)
|
||||
- [Environment variables](#environment-variables)
|
||||
- [Template rules files](#template-rules-files)
|
||||
- [Using your own rules files](#using-your-own-rules-files)
|
||||
- [Disabling rules](#disabling-rules)
|
||||
- [Filter linted files](#filter-linted-files)
|
||||
- [Docker Hub](#docker-hub)
|
||||
|
@ -296,7 +297,11 @@ You can use the **GitHub** **Super-Linter** _with_ or _without_ your own persona
|
|||
- Copy **any** or **all** template rules files from `TEMPLATES/` into your repository in the location: `.github/linters/` of your repository
|
||||
- If your repository does not have rules files, they will fall back to defaults in [this repository's `TEMPLATE` folder](https://github.com/github/super-linter/tree/master/TEMPLATES)
|
||||
|
||||
## Disabling rules
|
||||
### Using your own rules files
|
||||
|
||||
If your repository contains your own rules files that live outside of a ``.github/linters/`` directory, you will have to tell Super-Linter where your rules files are located in your repository, and what their file names are. To learn more, see [Using your own rules files](docs/using-rules-files.md).
|
||||
|
||||
### Disabling rules
|
||||
|
||||
If you need to disable certain _rules_ and _functionality_, you can view [Disable Rules](https://github.com/github/super-linter/blob/master/docs/disabling-linters.md)
|
||||
|
||||
|
|
45
docs/using-rules-files.md
Normal file
45
docs/using-rules-files.md
Normal file
|
@ -0,0 +1,45 @@
|
|||
# Using your own rules files
|
||||
|
||||
If your repository contains your own rules files that live outside of a ``.github/linters/`` directory, you will have to tell Super-Linter where your rules files are located in your repository, and what their file names are.
|
||||
|
||||
You can tell Super-Linter where your rules files are located with the ``LINTER_RULES_PATH`` ENV VAR, and you can tell Super-Linter what their file names are by using any of the ENV VARS from the table below.
|
||||
|
||||
| ENV VARS that can be used with LINTER_RULES_PATH |
|
||||
| --------------------------------- |
|
||||
| CSS_FILE_NAME |
|
||||
| DOCKERFILE_HADOLINT_FILE_NAME |
|
||||
| EDITORCONFIG_FILE_NAME |
|
||||
| JAVASCRIPT_ES_CONFIG_FILE |
|
||||
| MARKDOWN_CONFIG_FILE |
|
||||
| PYTHON_PYLINT_CONFIG_FILE |
|
||||
| PYTHON_FLAKE8_CONFIG_FILE |
|
||||
| PYTHON_BLACK_CONFIG_FILE |
|
||||
| RUBY_CONFIG_FILE |
|
||||
| SNAKEMAKE_SNAKEFMT_CONFIG_FILE |
|
||||
| TYPESCRIPT_ES_CONFIG_FILE |
|
||||
| JAVASCRIPT_ES_LINTER_RULES |
|
||||
|
||||
### Here is an example
|
||||
|
||||
Below is an example of how to configure the ``env`` section of Super-Linter's ``linter.yml`` to lint JavaScript and CSS code using ``eslint`` and ``stylelint`` with your own ``.eslintrc.json`` and ``.stylelintrc.json`` rules files that are located in the root directory of your repository.
|
||||
|
||||
``` yaml
|
||||
env:
|
||||
VALIDATE_ALL_CODEBASE: false
|
||||
DEFAULT_BRANCH: master
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
LINTER_RULES_PATH: /
|
||||
CSS_FILE_NAME: .styelintrc.json
|
||||
JAVASCRIPT_ES_CONFIG_FILE: .eslintrc.json
|
||||
VALIDATE_CSS: true
|
||||
VALIDATE_JAVASCRIPT_ES: true
|
||||
```
|
||||
|
||||
The above example tells Super-Linter:
|
||||
|
||||
a) Your rules files are located in your repository's root directory using the ``LINTER_RULES_PATH: /`` ENV VAR.
|
||||
|
||||
b) Your eslint and stylelint rules files are named ``.stylelintrc.json`` and ``.eslintrc.json`` using the ``CSS_FILE_NAME: .styelintrc.json`` and ``JAVASCRIPT_ES_CONFIG_FILE: .eslintrc.json`` ENV VARS.
|
||||
|
||||
c) To use ``stylelint`` and ``eslint`` to lint all CSS and JavaScript code using the ``VALIDATE_CSS: true`` and ``VALIDATE_JAVASCRIPT_ES: true`` ENV VARS.
|
Loading…
Reference in a new issue