From a137b16ddc274338df34a35ca833741449bab26c Mon Sep 17 00:00:00 2001 From: Joseph Marino Date: Mon, 26 Oct 2020 22:57:10 -0400 Subject: [PATCH] Removed table 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 --- docs/using-rules-files.md | 19 ++----------------- 1 file changed, 2 insertions(+), 17 deletions(-) diff --git a/docs/using-rules-files.md b/docs/using-rules-files.md index 3d3dc32a..88791134 100644 --- a/docs/using-rules-files.md +++ b/docs/using-rules-files.md @@ -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