actions/superlint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-11-06 01:05:54 -05:00
Code Issues Projects Releases Packages Wiki Activity

Removed table

Browse source 
Removed table containing ENV VARS that
could be configured with LINTER_RULES_PATH
from the "Using your own rules files" section.
Added text letting users know that they should
refer to the environment variables table in
the README for a list of filename ENV VARS
This commit is contained in:
Joseph Marino 2020-10-26 22:57:10 -04:00
parent c846cfd9ce
commit a137b16ddc
No known key found for this signature in database
GPG key ID: C09B75A513E58053
1 changed files with 2 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/using-rules-files.md
View file

@ -1,23 +1,8 @@
# 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.
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 filenames 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 |
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 filenames are by using any of the filename ENV VARS listed in the [Environment variables table](/README.md#Environment-variables). You can determine which ENV VARS are filename ENV VARS by looking in the notes column for the term "filename."
### Here is an example