actions/lint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-11-21 13:41:19 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
lint/README.md

387 lines
49 KiB
Markdown
Raw Normal View History

initial commit
2019-10-21 10:12:50 -04:00
# Super-Linter
Format Markdown
2020-07-21 13:08:05 -04:00
Fix markdown lint errors
2020-06-25 11:04:02 -04:00
This repository is for the **GitHub Action** to run a **Super-Linter**.
Fix typo (combination on → combination of)
2020-06-18 13:56:16 -04:00
It is a simple combination of various linters, written in `bash`, to help validate your source code.
update readme
2020-04-30 10:06:20 -04:00
Generate a code coverage report (#1353) * Generate a code coverage report * make linters happy * adding action and badge * no report for me * Upload the test report * adding folders * spaces not tabs * makefiles love tabs * spacing is important * rawr * Fix makefile * Add diagnostic info * Set UID and GID * Make info * Add docker images in diagnostic info * Move info before testing the local action * Add missing -C to git diff-tree * Reset ownership * Add missing quotes * Sudo * Attempt to fix ARM test * Attempt to fix go test Co-authored-by: Admiral Awkbar <admiralawkbar@github.com>
2021-04-22 14:56:18 -04:00
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/51071879604e4f319859d4daf91c68f5)](https://www.codacy.com/gh/github/super-linter/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=github/super-linter&amp;utm_campaign=Badge_Grade)
some simple cleanup
2020-08-19 16:26:57 -04:00
**The end goal of this tool:**
Format Markdown
2020-07-21 13:08:05 -04:00
Mention that the default branch is usually master or main Since 'main' is the now the default for new repos moving forward.
2020-11-09 02:16:07 -05:00
- Prevent broken code from being uploaded to the default branch (_Usually_ `master` or `main`)
update readme
2020-04-30 10:06:20 -04:00
- Help establish coding best practices across multiple languages
- Build guidelines for code layout and format
- Automate the process to help streamline code reviews
Add Table of Contents to README
2020-06-25 20:08:05 -04:00
## Table of Contents
Format Markdown
2020-07-21 13:08:05 -04:00
- [Super-Linter](#super-linter)
- [Table of Contents](#table-of-contents)
- [How it Works](#how-it-works)
- [Supported Linters](#supported-linters)
- [How to use](#how-to-use)
- [Example connecting GitHub Action Workflow](#example-connecting-github-action-workflow)
Make Super-Linter more famous with badge links on repos using it :)
2020-09-10 03:48:11 -04:00
- [Add Super-Linter badge in your repository README](#add-super-linter-badge-in-your-repository-readme)
Format Markdown
2020-07-21 13:08:05 -04:00
- [Environment variables](#environment-variables)
- [Template rules files](#template-rules-files)
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.
2020-10-25 20:06:49 -04:00
- [Using your own rules files](#using-your-own-rules-files)
update readme
2020-10-28 20:07:35 -04:00
- [Disabling rules](#disabling-rules)
Add README index
2020-09-05 06:54:56 -04:00
- [Filter linted files](#filter-linted-files)
Format Markdown
2020-07-21 13:08:05 -04:00
- [Docker Hub](#docker-hub)
- [Run Super-Linter outside GitHub Actions](#run-super-linter-outside-github-actions)
- [Local (troubleshooting/debugging/enhancements)](#local-troubleshootingdebuggingenhancements)
- [Azure](#azure)
- [GitLab](#gitlab)
- [Visual Studio Code](#visual-studio-code)
- [Limitations](#limitations)
- [How to contribute](#how-to-contribute)
- [License](#license)
Add Table of Contents to README
2020-06-25 20:08:05 -04:00
docs: clarify action behavior in README
2020-05-05 00:06:29 -04:00
## How it Works
The super-linter finds issues and reports them to the console output. Fixes are suggested in the console output but not automatically fixed, and a status check will show up as failed on the pull request.
Add disclaimer about local development
2020-06-24 15:45:26 -04:00
The design of the **Super-Linter** is currently to allow linting to occur in **GitHub Actions** as a part of continuous integration occurring on pull requests as the commits get pushed. It works best when commits are being pushed early and often to a branch with an open or draft pull request. There is some desire to move this closer to local development for faster feedback on linting errors but this is not yet supported.
docs: clarify action behavior in README
2020-05-05 00:06:29 -04:00
## Supported Linters
update readme
2020-04-30 10:06:20 -04:00
Developers on **GitHub** can call the **GitHub Action** to lint their code base with the following list of linters:
initial commit
2019-10-21 10:12:50 -04:00
Improve LINTER_RULES_PATH docs, about it beein relative (#1093) * Improve LINTER_RULES_PATH docs, about it beein relative * Update using-rules-files.md Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2021-01-04 12:11:35 -05:00
| _Language_ | _Linter_ |
| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Ansible** | [ansible-lint](https://github.com/ansible/ansible-lint) |
| **Azure Resource Manager (ARM)** | [arm-ttk](https://github.com/azure/arm-ttk) |
| **AWS CloudFormation templates** | [cfn-lint](https://github.com/aws-cloudformation/cfn-python-lint/) |
| **C#** | [dotnet-format](https://github.com/dotnet/format) |
| **CSS** | [stylelint](https://stylelint.io/) |
| **Clojure** | [clj-kondo](https://github.com/borkdude/clj-kondo) |
| **CoffeeScript** | [coffeelint](https://coffeelint.github.io/) |
Install, configure, and run jscpd. Add missing tests (#1032) Co-authored-by: Gabo <gabo.fdc@gmail.com> Co-authored-by: Matt Desmond <beardofedu@github.com> Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2021-01-27 14:47:34 -05:00
| **Copy/paste detection** | [jscpd](https://github.com/kucherenko/jscpd) |
Improve LINTER_RULES_PATH docs, about it beein relative (#1093) * Improve LINTER_RULES_PATH docs, about it beein relative * Update using-rules-files.md Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2021-01-04 12:11:35 -05:00
| **Dart** | [dartanalyzer](https://dart.dev/guides/language/analysis-options) |
| **Dockerfile** | [dockerfilelint](https://github.com/replicatedhq/dockerfilelint.git) / [hadolint](https://github.com/hadolint/hadolint) |
| **EDITORCONFIG** | [editorconfig-checker](https://github.com/editorconfig-checker/editorconfig-checker) |
| **ENV** | [dotenv-linter](https://github.com/dotenv-linter/dotenv-linter) |
| **Gherkin** | [gherkin-lint](https://github.com/vsiakka/gherkin-lint) |
| **Golang** | [golangci-lint](https://github.com/golangci/golangci-lint) |
| **Groovy** | [npm-groovy-lint](https://github.com/nvuillam/npm-groovy-lint) |
| **HTML** | [HTMLHint](https://github.com/htmlhint/HTMLHint) |
| **Java** | [checkstyle](https://checkstyle.org) |
| **JavaScript** | [eslint](https://eslint.org/) / [standard js](https://standardjs.com/) |
| **JSON** | [jsonlint](https://github.com/zaach/jsonlint) |
| **Kubeval** | [kubeval](https://github.com/instrumenta/kubeval) |
| **Kotlin** | [ktlint](https://github.com/pinterest/ktlint) |
| **LaTeX** | [ChkTex](https://www.nongnu.org/chktex/) |
| **Lua** | [luacheck](https://github.com/luarocks/luacheck) |
| **Markdown** | [markdownlint](https://github.com/igorshubovych/markdownlint-cli#readme) |
| **OpenAPI** | [spectral](https://github.com/stoplightio/spectral) |
| **Perl** | [perlcritic](https://metacpan.org/pod/Perl::Critic) |
Fixed dead PHPStan link in README Changed https://phpstan.org/n to https://phpstan.org. This should close issue #958
2020-11-04 15:23:31 -05:00
| **PHP** | [PHP built-in linter](https://www.php.net/) / [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) / [PHPStan](https://phpstan.org/) / [Psalm](https://psalm.dev/) |
Improve LINTER_RULES_PATH docs, about it beein relative (#1093) * Improve LINTER_RULES_PATH docs, about it beein relative * Update using-rules-files.md Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2021-01-04 12:11:35 -05:00
| **PowerShell** | [PSScriptAnalyzer](https://github.com/PowerShell/Psscriptanalyzer) |
| **Protocol Buffers** | [protolint](https://github.com/yoheimuta/protolint) |
| **Python3** | [pylint](https://www.pylint.org/) / [flake8](https://flake8.pycqa.org/en/latest/) / [black](https://github.com/psf/black) / [isort](https://pypi.org/project/isort/) |
| **R** | [lintr](https://github.com/jimhester/lintr) |
| **Raku** | [Raku](https://raku.org) |
| **Ruby** | [RuboCop](https://github.com/rubocop-hq/rubocop) |
Support custom markdownlint rules (#1306) * Support custom rules with markdownlint * Add MARKDOWN_CUSTOM_RULE_GLOBS to README.md * Fix shellcheck issues and use bash array for globs * Fix shfmt issues Co-authored-by: Gabriel Diaz <gabo.fdc@gmail.com>
2021-03-10 10:06:06 -05:00
| **Rust** | [Rustfmt](https://github.com/rust-lang/rustfmt) / [Clippy](https://github.com/rust-lang/rust-clippy) |
Improve LINTER_RULES_PATH docs, about it beein relative (#1093) * Improve LINTER_RULES_PATH docs, about it beein relative * Update using-rules-files.md Co-authored-by: Lukas Gravley <admiralawkbar@github.com>
2021-01-04 12:11:35 -05:00
| **Shell** | [Shellcheck](https://github.com/koalaman/shellcheck) / [executable bit check] / [shfmt](https://github.com/mvdan/sh) |
| **Snakemake** | [snakefmt](https://github.com/snakemake/snakefmt/) / [snakemake --lint](https://snakemake.readthedocs.io/en/stable/snakefiles/writing_snakefiles.html#best-practices) |
| **SQL** | [sql-lint](https://github.com/joereynolds/sql-lint) |
| **Tekton** | [tekton-lint](https://github.com/IBM/tekton-lint) |
| **Terraform** | [tflint](https://github.com/terraform-linters/tflint) / [terrascan](https://github.com/accurics/terrascan) |
| **Terragrunt** | [terragrunt](https://github.com/gruntwork-io/terragrunt) |
| **TypeScript** | [eslint](https://eslint.org/) / [standard js](https://standardjs.com/) |
| **XML** | [LibXML](http://xmlsoft.org/) |
| **YAML** | [YamlLint](https://github.com/adrienverge/yamllint) |
initial commit
2019-10-21 10:12:50 -04:00
## How to use
Format Markdown
2020-07-21 13:08:05 -04:00
replace gif with tutorial link
2020-07-01 12:38:15 -04:00
More in-depth [tutorial](https://www.youtube.com/watch?v=EDAmFKO4Zt0&t=118s) available
Add gif to readme
2020-06-30 19:45:08 -04:00
initial commit
2019-10-21 10:12:50 -04:00
To use this **GitHub** Action you will need to complete the following:
Format Markdown
2020-07-21 13:08:05 -04:00
format into steps
2020-06-30 19:27:52 -04:00
1. Create a new file in your repository called `.github/workflows/linter.yml`
Add gif to readme
2020-06-30 19:45:08 -04:00
2. Copy the example workflow from below into that new file, no extra configuration required
format into steps
2020-06-30 19:27:52 -04:00
3. Commit that file to a new branch
4. Open up a pull request and observe the action working
Format Markdown
2020-07-21 13:08:05 -04:00
5. Enjoy your more _stable_, and _cleaner_ code base
format into steps
2020-06-30 19:27:52 -04:00
6. Check out the [Wiki](https://github.com/github/super-linter/wiki) for customization options
initial commit
2019-10-21 10:12:50 -04:00
Bit more explanation
2020-08-10 18:41:32 -04:00
**NOTE:** If you pass the _Environment_ variable `GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}` in your workflow, then the **GitHub Super-Linter** will mark the status of each individual linter run in the Checks section of a pull request. Without this you will only see the overall status of the full run. There is no need to set the **GitHub** Secret as it is automatically set by GitHub, it only needs to be passed to the action.
adding the code
2020-07-20 15:07:56 -04:00
added
2019-10-23 13:23:46 -04:00
### Example connecting GitHub Action Workflow
Format Markdown
2020-07-21 13:08:05 -04:00
adding them docs
2020-02-05 10:23:47 -05:00
In your repository you should have a `.github/workflows` folder with **GitHub** Action similar to below:
initial commit
2019-10-21 10:12:50 -04:00
- `.github/workflows/linter.yml`
Add template (#1273) * adding template for users to pull * adding template
2021-02-26 15:40:21 -05:00
- Example file can be found at `TEMPLATES/linter.yml`
initial commit
2019-10-21 10:12:50 -04:00
This file should have the following code:
```yml
---
###########################
###########################
## Linter GitHub Actions ##
###########################
###########################
name: Lint Code Base
#
# Documentation:
# https://help.github.com/en/articles/workflow-syntax-for-github-actions
#
#############################
# Start the job on all push #
#############################
Update doc to only push non master
2020-03-03 13:07:43 -05:00
on:
push:
Update README.md
2020-07-01 19:29:23 -04:00
branches-ignore: [master]
Update README.md
2020-07-01 19:34:44 -04:00
# Remove the line above to run when pushing to master
Update README.md
2020-07-01 19:29:23 -04:00
pull_request:
branches: [master]
initial commit
2019-10-21 10:12:50 -04:00
###############
# Set the Job #
###############
jobs:
build:
# Name the Job
name: Lint Code Base
# Set the agent to run on
runs-on: ubuntu-latest
##################
# Load all steps #
##################
steps:
##########################
# Checkout the code base #
##########################
- name: Checkout Code
README example: `actions/checkout@master` -> `actions/checkout@v2`
2020-06-18 12:13:26 -04:00
uses: actions/checkout@v2
Fetch full git history to get a proper list of changed files within super-linter
2020-10-09 07:17:56 -04:00
with:
# Full git history is needed to get a proper list of changed files within `super-linter`
fetch-depth: 0
initial commit
2019-10-21 10:12:50 -04:00
################################
# Run Linter against code base #
################################
- name: Lint Code Base
docs: remove note about using docker:// it seems GitHub Actions now respects `actions.yml` directives when using docker actions, thus making this note redundant
2020-08-17 12:55:11 -04:00
uses: github/super-linter@v3
updating code
2019-10-25 12:29:31 -04:00
env:
VALIDATE_ALL_CODEBASE: false
better example of usage
2020-07-01 09:29:22 -04:00
DEFAULT_BRANCH: master
adding the code
2020-07-20 15:07:56 -04:00
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
initial commit
2019-10-21 10:12:50 -04:00
```
adding docs
2020-01-09 10:48:46 -05:00
Make Super-Linter more famous with badge links on repos using it :)
2020-09-10 03:48:11 -04:00
### Add Super-Linter badge in your repository README
You can show Super-Linter status with a badge in your repository README
[![GitHub Super-Linter](https://github.com/nvuillam/npm-groovy-lint/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter)
Format:
```markdown
[![GitHub Super-Linter](https://github.com/<OWNER>/<REPOSITORY>/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter)
```
Example:
```markdown
[![GitHub Super-Linter](https://github.com/nvuillam/npm-groovy-lint/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter)
```
_Note:_ IF you did not use `Lint Code Base` as GitHub Action name, please read [GitHub Actions Badges documentation](https://docs.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#adding-a-workflow-status-badge-to-your-repository)
make it better
2020-05-14 09:57:58 -04:00
## Environment variables
Format Markdown
2020-07-21 13:08:05 -04:00
Clean up documentation We add documentation on how the variables now work, and remove duplication in run-linter-locally.md
2020-06-12 18:10:18 -04:00
The super-linter allows you to pass the following `ENV` variables to be able to trigger different functionality.
Update documentation about VALIDATE_[LANGUAGE] vars
2020-08-11 22:16:36 -04:00
_Note:_ All the `VALIDATE_[LANGUAGE]` variables behave in a very specific way:
Documentation
2020-09-05 06:43:30 -04:00
Update documentation about VALIDATE_[LANGUAGE] vars
2020-08-11 22:16:36 -04:00
- If none of them are passed, then they all default to true.
- If any one of the variables are set to true, we default to leaving any unset variable to false (only validate those languages).
- If any one of the variables are set to false, we default to leaving any unset variable to true (only exclude those languages).
- If there are `VALIDATE_[LANGUAGE]` variables set to both true and false. It will fail.
docs(readme): fix typo languages
2020-06-18 16:13:20 -04:00
This means that if you run the linter "out of the box", all languages will be checked.
Update documentation about VALIDATE_[LANGUAGE] vars
2020-08-11 22:16:36 -04:00
But if you wish to select or exclude specific linters, we give you full control to choose which linters are run, and won't run anything unexpected.
make it better
2020-05-14 09:57:58 -04:00
Support custom markdownlint rules (#1306) * Support custom rules with markdownlint * Add MARKDOWN_CUSTOM_RULE_GLOBS to README.md * Fix shellcheck issues and use bash array for globs * Fix shfmt issues Co-authored-by: Gabriel Diaz <gabo.fdc@gmail.com>
2021-03-10 10:06:06 -05:00
| **ENV VAR** | **Default Value** | **Notes** |
| ---------------------------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **ACTIONS_RUNNER_DEBUG** | `false` | Flag to enable additional information about the linter, versions, and additional output. |
Add new ENV VAR to set ansible-lint config file (#1424)
2021-04-11 23:24:43 -04:00
| **ANSIBLE_CONFIG_FILE** | `.ansible-lint.yml` | Filename for [Ansible-lint configuration](https://ansible-lint.readthedocs.io/en/latest/configuring.html#configuration-file) (ex: `.ansible-lint`, `.ansible-lint.yml`) |
Support custom markdownlint rules (#1306) * Support custom rules with markdownlint * Add MARKDOWN_CUSTOM_RULE_GLOBS to README.md * Fix shellcheck issues and use bash array for globs * Fix shfmt issues Co-authored-by: Gabriel Diaz <gabo.fdc@gmail.com>
2021-03-10 10:06:06 -05:00
| **ANSIBLE_DIRECTORY** | `/ansible` | Flag to set the root directory for Ansible file location(s), relative to `DEFAULT_WORKSPACE`. Set to `.` to use the top-level of the `DEFAULT_WORKSPACE`. |
| **CSS_FILE_NAME** | `.stylelintrc.json` | Filename for [Stylelint configuration](https://github.com/stylelint/stylelint) (ex: `.stylelintrc.yml`, `.stylelintrc.yaml`) |
| **DEFAULT_BRANCH** | `master` | The name of the repository default branch. |
| **DEFAULT_WORKSPACE** | `/tmp/lint` | The location containing files to lint if you are running locally. |
| **DISABLE_ERRORS** | `false` | Flag to have the linter complete with exit code 0 even if errors were detected. |
| **DOCKERFILE_HADOLINT_FILE_NAME** | `.hadolint.yaml` | Filename for [hadolint configuration](https://github.com/hadolint/hadolint) (ex: `.hadolintlintrc.yaml`) |
| **EDITORCONFIG_FILE_NAME** | `.ecrc` | Filename for [editorconfig-checker configuration](https://github.com/editorconfig-checker/editorconfig-checker) |
| **ERROR_ON_MISSING_EXEC_BIT** | `false` | If set to `false`, the `bash-exec` linter will report a warning if a shell script is not executable. If set to `true`, the `bash-exec` linter will report an error instead. |
| **FILTER_REGEX_EXCLUDE** | `none` | Regular expression defining which files will be excluded from linting (ex: `.*src/test.*`) |
| **FILTER_REGEX_INCLUDE** | `all` | Regular expression defining which files will be processed by linters (ex: `.*src/.*`) |
Allow to override github api url (#1395)
2021-03-23 14:26:14 -04:00
| **GITHUB_DOMAIN** | `github.com` | Specify a custom Github domain in case Github Enterprise is used: e.g. `github.myenterprise.com` |
| **GITHUB_CUSTOM_API_URL** | `api.github.com` | Specify a custom Github API URL in case Github Enterprise is used: e.g. `https://github.myenterprise.com/api/v3/`|
Support custom markdownlint rules (#1306) * Support custom rules with markdownlint * Add MARKDOWN_CUSTOM_RULE_GLOBS to README.md * Fix shellcheck issues and use bash array for globs * Fix shfmt issues Co-authored-by: Gabriel Diaz <gabo.fdc@gmail.com>
2021-03-10 10:06:06 -05:00
| **IGNORE_GITIGNORED_FILES** | `false` | If set to `true`, super-linter will ignore all the files that are ignored by Git. |
| **JAVASCRIPT_ES_CONFIG_FILE** | `.eslintrc.yml` | Filename for [eslint configuration](https://eslint.org/docs/user-guide/configuring#configuration-file-formats) (ex: `.eslintrc.yml`, `.eslintrc.json`) |
| **JAVASCRIPT_DEFAULT_STYLE** | `standard` | Flag to set the default style of javascript. Available options: **standard**/**prettier** |
| **JSCPD_CONFIG_FILE** | `.jscpd.json` | Filename for JSCPD configuration |
| **LINTER_RULES_PATH** | `.github/linters` | Directory for all linter configuration rules. |
| **LOG_FILE** | `super-linter.log` | The file name for outputting logs. All output is sent to the log file regardless of `LOG_LEVEL`. |
| **LOG_LEVEL** | `VERBOSE` | How much output the script will generate to the console. One of `ERROR`, `WARN`, `NOTICE`, `VERBOSE`, `DEBUG` or `TRACE`. |
| **MULTI_STATUS** | `true` | A status API is made for each language that is linted to make visual parsing easier. |
| **MARKDOWN_CONFIG_FILE** | `.markdown-lint.yml` | Filename for [Markdownlint configuration](https://github.com/DavidAnson/markdownlint#optionsconfig) (ex: `.markdown-lint.yml`, `.markdownlint.json`, `.markdownlint.yaml`) |
| **MARKDOWN_CUSTOM_RULE_GLOBS** | `.markdown-lint/rules,rules/**` | Comma-separated list of [file globs](https://github.com/igorshubovych/markdownlint-cli#globbing) matching [custom Markdownlint rule files](https://github.com/DavidAnson/markdownlint/blob/main/doc/CustomRules.md). |
| **OUTPUT_FORMAT** | `none` | The report format to be generated, besides the stdout one. Output format of tap is currently using v13 of the specification. Supported formats: tap |
| **OUTPUT_FOLDER** | `super-linter.report` | The location where the output reporting will be generated to. Output folder must not previously exist. |
| **OUTPUT_DETAILS** | `simpler` | What level of details to be reported. Supported formats: simpler or detailed. |
| **PYTHON_BLACK_CONFIG_FILE** | `.python-black` | Filename for [black configuration](https://github.com/psf/black/blob/master/docs/compatible_configs.md) (ex: `.isort.cfg`, `pyproject.toml`) |
| **PYTHON_FLAKE8_CONFIG_FILE** | `.flake8` | Filename for [flake8 configuration](https://flake8.pycqa.org/en/latest/user/configuration.html) (ex: `.flake8`, `tox.ini`) |
| **PYTHON_ISORT_CONFIG_FILE** | `.isort.cfg` | Filename for [isort configuration](https://pycqa.github.io/isort/docs/configuration/config_files/) (ex: `.isort.cfg`, `pyproject.toml`) |
adding Python MyPy (#1401) * adding fun * fix whitespace * adding tests * adding the array * bug in file name * fix tap * makes no sense * adding the hammer * adding some extra protbuf
2021-03-24 15:00:23 -04:00
| **PYTHON_MYPY_CONFIG_FILE** | `.mypy.ini` | Filename for [mypy configuration](https://mypy.readthedocs.io/en/stable/config_file.html) (ex: `.mypi.ini`, `setup.config`) |
Support custom markdownlint rules (#1306) * Support custom rules with markdownlint * Add MARKDOWN_CUSTOM_RULE_GLOBS to README.md * Fix shellcheck issues and use bash array for globs * Fix shfmt issues Co-authored-by: Gabriel Diaz <gabo.fdc@gmail.com>
2021-03-10 10:06:06 -05:00
| **PYTHON_PYLINT_CONFIG_FILE** | `.python-lint` | Filename for [pylint configuration](https://pylint.pycqa.org/en/latest/user_guide/run.html?highlight=rcfile#command-line-options) (ex: `.python-lint`, `.pylintrc`) |
| **RUBY_CONFIG_FILE** | `.ruby-lint.yml` | Filename for [rubocop configuration](https://docs.rubocop.org/rubocop/configuration.html) (ex: `.ruby-lint.yml`, `.rubocop.yml`) |
| **SUPPRESS_POSSUM** | `false` | If set to `true`, will hide the ASCII possum at top of log output. Default is `false` |
| **SNAKEMAKE_SNAKEFMT_CONFIG_FILE** | `.snakefmt.toml` | Filename for [Snakemake configuration](https://github.com/snakemake/snakefmt#configuration) (ex: `pyproject.toml`, `.snakefmt.toml`) |
adding it (#1396) * adding it * i kant read * make go go away
2021-03-23 13:02:16 -04:00
| **SQL_CONFIG_FILE** | `.sql-config.json` | Filename for [SQL-Lint configuration](https://sql-lint.readthedocs.io/en/latest/files/configuration.html) (ex: `sql-config.json` , `.config.json`) |
Support custom markdownlint rules (#1306) * Support custom rules with markdownlint * Add MARKDOWN_CUSTOM_RULE_GLOBS to README.md * Fix shellcheck issues and use bash array for globs * Fix shfmt issues Co-authored-by: Gabriel Diaz <gabo.fdc@gmail.com>
2021-03-10 10:06:06 -05:00
| **TYPESCRIPT_ES_CONFIG_FILE** | `.eslintrc.yml` | Filename for [eslint configuration](https://eslint.org/docs/user-guide/configuring#configuration-file-formats) (ex: `.eslintrc.yml`, `.eslintrc.json`) |
| **VALIDATE_ALL_CODEBASE** | `true` | Will parse the entire repository and find all files to validate across all types. **NOTE:** When set to `false`, only **new** or **edited** files will be parsed for validation. |
| **VALIDATE_ANSIBLE** | `true` | Flag to enable or disable the linting process of the Ansible language. |
| **VALIDATE_ARM** | `true` | Flag to enable or disable the linting process of the ARM language. |
| **VALIDATE_BASH** | `true` | Flag to enable or disable the linting process of the Bash language. |
| **VALIDATE_BASH_EXEC** | `true` | Flag to enable or disable the linting process of the Bash language to validate if file is stored as executable. |
| **VALIDATE_CLOJURE** | `true` | Flag to enable or disable the linting process of the Clojure language. |
| **VALIDATE_CLOUDFORMATION** | `true` | Flag to enable or disable the linting process of the AWS Cloud Formation language. |
| **VALIDATE_COFFEE** | `true` | Flag to enable or disable the linting process of the Coffeescript language. |
| **VALIDATE_CSHARP** | `true` | Flag to enable or disable the linting process of the C# language. |
| **VALIDATE_CSS** | `true` | Flag to enable or disable the linting process of the CSS language. |
| **VALIDATE_DART** | `true` | Flag to enable or disable the linting process of the Dart language. |
| **VALIDATE_DOCKERFILE** | `true` | Flag to enable or disable the linting process of the Docker language. |
| **VALIDATE_DOCKERFILE_HADOLINT** | `true` | Flag to enable or disable the linting process of the Docker language. |
| **VALIDATE_EDITORCONFIG** | `true` | Flag to enable or disable the linting process with the editorconfig. |
| **VALIDATE_ENV** | `true` | Flag to enable or disable the linting process of the ENV language. |
| **VALIDATE_GHERKIN** | `true` | Flag to enable or disable the linting process of the Gherkin language. |
| **VALIDATE_GO** | `true` | Flag to enable or disable the linting process of the Golang language. |
| **VALIDATE_GROOVY** | `true` | Flag to enable or disable the linting process of the language. |
| **VALIDATE_HTML** | `true` | Flag to enable or disable the linting process of the HTML language. |
| **VALIDATE_JAVA** | `true` | Flag to enable or disable the linting process of the language. |
| **VALIDATE_JAVASCRIPT_ES** | `true` | Flag to enable or disable the linting process of the Javascript language. (Utilizing: eslint) |
| **VALIDATE_JAVASCRIPT_STANDARD** | `true` | Flag to enable or disable the linting process of the Javascript language. (Utilizing: standard) |
| **VALIDATE_JSCPD** | `true` | Flag to enable or disable the JSCPD. |
| **VALIDATE_JSON** | `true` | Flag to enable or disable the linting process of the JSON language. |
| **VALIDATE_JSX** | `true` | Flag to enable or disable the linting process for jsx files (Utilizing: eslint) |
| **VALIDATE_KOTLIN** | `true` | Flag to enable or disable the linting process of the Kotlin language. |
| **VALIDATE_KUBERNETES_KUBEVAL** | `true` | Flag to enable or disable the linting process of Kubernetes descriptors with Kubeval |
| **VALIDATE_LATEX** | `true` | Flag to enable or disable the linting process of the LaTeX language. |
| **VALIDATE_LUA** | `true` | Flag to enable or disable the linting process of the language. |
| **VALIDATE_MARKDOWN** | `true` | Flag to enable or disable the linting process of the Markdown language. |
| **VALIDATE_OPENAPI** | `true` | Flag to enable or disable the linting process of the OpenAPI language. |
| **VALIDATE_PERL** | `true` | Flag to enable or disable the linting process of the Perl language. |
| **VALIDATE_PHP** | `true` | Flag to enable or disable the linting process of the PHP language. (Utilizing: PHP built-in linter) (keep for backward compatibility) |
| **VALIDATE_PHP_BUILTIN** | `true` | Flag to enable or disable the linting process of the PHP language. (Utilizing: PHP built-in linter) |
| **VALIDATE_PHP_PHPCS** | `true` | Flag to enable or disable the linting process of the PHP language. (Utilizing: PHP CodeSniffer) |
| **VALIDATE_PHP_PHPSTAN** | `true` | Flag to enable or disable the linting process of the PHP language. (Utilizing: PHPStan) |
| **VALIDATE_PHP_PSALM** | `true` | Flag to enable or disable the linting process of the PHP language. (Utilizing: PSalm) |
| **VALIDATE_PROTOBUF** | `true` | Flag to enable or disable the linting process of the Protobuf language. |
| **VALIDATE_PYTHON** | `true` | Flag to enable or disable the linting process of the Python language. (Utilizing: pylint) (keep for backward compatibility) |
| **VALIDATE_PYTHON_BLACK** | `true` | Flag to enable or disable the linting process of the Python language. (Utilizing: black) |
| **VALIDATE_PYTHON_FLAKE8** | `true` | Flag to enable or disable the linting process of the Python language. (Utilizing: flake8) |
| **VALIDATE_PYTHON_ISORT** | `true` | Flag to enable or disable the linting process of the Python language. (Utilizing: isort) |
adding Python MyPy (#1401) * adding fun * fix whitespace * adding tests * adding the array * bug in file name * fix tap * makes no sense * adding the hammer * adding some extra protbuf
2021-03-24 15:00:23 -04:00
| **VALIDATE_PYTHON_MYPY** | `true` | Flag to enable or disable the linting process of the Python language. (Utilizing: mypy) |
Support custom markdownlint rules (#1306) * Support custom rules with markdownlint * Add MARKDOWN_CUSTOM_RULE_GLOBS to README.md * Fix shellcheck issues and use bash array for globs * Fix shfmt issues Co-authored-by: Gabriel Diaz <gabo.fdc@gmail.com>
2021-03-10 10:06:06 -05:00
| **VALIDATE_PYTHON_PYLINT** | `true` | Flag to enable or disable the linting process of the Python language. (Utilizing: pylint) |
| **VALIDATE_POWERSHELL** | `true` | Flag to enable or disable the linting process of the Powershell language. |
| **VALIDATE_R** | `true` | Flag to enable or disable the linting process of the R language. |
| **VALIDATE_RAKU** | `true` | Flag to enable or disable the linting process of the Raku language. |
| **VALIDATE_RUBY** | `true` | Flag to enable or disable the linting process of the Ruby language. |
| **VALIDATE_RUST_2015** | `true` | Flag to enable or disable the linting process of the Rust language. (edition: 2015) |
| **VALIDATE_RUST_2018** | `true` | Flag to enable or disable the linting process of Rust language. (edition: 2018) |
| **VALIDATE_RUST_CLIPPY** | `true` | Flag to enable or disable the clippy linting process of Rust language. |
| **VALIDATE_SHELL_SHFMT** | `true` | Flag to enable or disable the linting process of Shell scripts. (Utilizing: shfmt) |
| **VALIDATE_SNAKEMAKE_LINT** | `true` | Flag to enable or disable the linting process of Snakefiles. (Utilizing: snakemake --lint) |
| **VALIDATE_SNAKEMAKE_SNAKEFMT** | `true` | Flag to enable or disable the linting process of Snakefiles. (Utilizing: snakefmt) |
| **VALIDATE_STATES** | `true` | Flag to enable or disable the linting process for AWS States Language. |
| **VALIDATE_SQL** | `true` | Flag to enable or disable the linting process of the SQL language. |
| **VALIDATE_TEKTON** | `true` | Flag to enable or disable the linting process of the Tekton language. |
| **VALIDATE_TERRAFORM** | `true` | Flag to enable or disable the linting process of the Terraform language. |
| **VALIDATE_TERRAFORM_TERRASCAN** | `true` | Flag to enable or disable the linting process of the Terraform language for security related issues. |
| **VALIDATE_TERRAGRUNT** | `true` | Flag to enable or disable the linting process for Terragrunt files. |
| **VALIDATE_TSX** | `true` | Flag to enable or disable the linting process for tsx files (Utilizing: eslint) |
| **VALIDATE_TYPESCRIPT_ES** | `true` | Flag to enable or disable the linting process of the Typescript language. (Utilizing: eslint) |
| **VALIDATE_TYPESCRIPT_STANDARD** | `true` | Flag to enable or disable the linting process of the Typescript language. (Utilizing: standard) |
| **VALIDATE_XML** | `true` | Flag to enable or disable the linting process of the XML language. |
| **VALIDATE_YAML** | `true` | Flag to enable or disable the linting process of the YAML language. |
| **YAML_CONFIG_FILE** | `.yaml-lint.yml` | Filename for [Yamllint configuration](https://yamllint.readthedocs.io/en/stable/configuration.html) (ex: `.yaml-lint.yml`, `.yamllint.yml`) |
adding them docs
2020-02-05 10:23:47 -05:00
### Template rules files
Format Markdown
2020-07-21 13:08:05 -04:00
You can use the **GitHub** **Super-Linter** _with_ or _without_ your own personal rules sets. This allows for greater flexibility for each individual code base. The Template rules all try to follow the standards we believe should be enabled at the basic level.
adding them docs
2020-02-05 10:23:47 -05:00
- Copy **any** or **all** template rules files from `TEMPLATES/` into your repository in the location: `.github/linters/` of your repository
Fix typo this repositories -> this repository's
2020-06-19 14:20:20 -04:00
- 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)
Update README.md
2019-10-23 14:15:12 -04: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.
2020-10-25 20:06:49 -04:00
### 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
Format Markdown
2020-07-21 13:08:05 -04:00
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)
Adding linkage
2020-04-23 12:39:13 -04:00
Documentation
2020-09-05 06:43:30 -04:00
## Filter linted files
If you need to lint only a folder or exclude some files from linting, you can use optional environment parameters `FILTER_REGEX_INCLUDE` and `FILTER_REGEX_EXCLUDE`
Use YAML syntax in FILTER_REGEX examples I think it probably makes more sense for the examples in this README to follow YAML syntax, assuming that people will be running super-linter as a GitHub Action. There's a separate doc covering the process for running the linter locally, in which case, of course, environment variables would be set with an equals sign. It's not a big deal, but I thought I would make the suggestion.
2020-09-17 07:31:50 -04:00
Examples:
Documentation
2020-09-05 06:43:30 -04:00
Use YAML syntax in FILTER_REGEX examples I think it probably makes more sense for the examples in this README to follow YAML syntax, assuming that people will be running super-linter as a GitHub Action. There's a separate doc covering the process for running the linter locally, in which case, of course, environment variables would be set with an equals sign. It's not a big deal, but I thought I would make the suggestion.
2020-09-17 07:31:50 -04:00
- Lint only src folder: `FILTER_REGEX_INCLUDE: .*src/.*`
- Do not lint files inside test folder: `FILTER_REGEX_EXCLUDE: .*test/.*`
- Do not lint javascript files inside test folder: `FILTER_REGEX_EXCLUDE: .*test/.*.js`
Documentation
2020-09-05 06:43:30 -04:00
adding docs
2020-01-09 10:48:46 -05:00
## Docker Hub
Format Markdown
2020-07-21 13:08:05 -04:00
Fix code links
2020-07-21 14:25:46 -04:00
The **Docker** container that is built from this repository is located at [github/super-linter](https://hub.docker.com/r/github/super-linter)
Update README.md
2019-10-23 14:15:12 -04:00
Add Azure and Gitlab options
2020-07-14 20:14:01 -04:00
## Run Super-Linter outside GitHub Actions
Format Markdown
2020-07-21 13:08:05 -04:00
Add Azure and Gitlab options
2020-07-14 20:14:01 -04:00
### Local (troubleshooting/debugging/enhancements)
Format Markdown
2020-07-21 13:08:05 -04:00
Cleanup of linter rules prints:
2020-04-27 13:21:38 -04:00
If you find that you need to run super-linter locally, you can follow the documentation at [Running super-linter locally](https://github.com/github/super-linter/blob/master/docs/run-linter-locally.md)
initial commit
2019-10-21 10:12:50 -04:00
Add disclaimer about local development
2020-06-24 15:45:26 -04:00
Check out the [note](#how-it-works) in **How it Works** to understand more about the **Super-Linter** linting locally versus via continuous integration.
Add Azure and Gitlab options
2020-07-14 20:14:01 -04:00
### Azure
Format Markdown
2020-07-21 13:08:05 -04:00
Added https links to domains that support SSL/TLS. Some links in this README link to domains that support https but https was not used in the link.
2020-09-10 17:20:41 -04:00
Check out this [article](https://blog.tyang.org/2020/06/27/use-github-super-linter-in-azure-pipelines/)
Add Azure and Gitlab options
2020-07-14 20:14:01 -04:00
### GitLab
Format Markdown
2020-07-21 13:08:05 -04:00
Add Azure and Gitlab options
2020-07-14 20:14:01 -04:00
Check out this [snippet](https://gitlab.com/snippets/1988376)
An additional GitLab example (#1065) Co-authored-by: Darwin Sanoy <dsanoy@gitlab.com> Co-authored-by: Gabriel Diaz <gabo.fdc@gmail.com>
2020-12-24 10:59:22 -05:00
And this Guided Exploration: [GitLab CI CD Extension for Super-Linter](https://gitlab.com/guided-explorations/ci-cd-plugin-extensions/ci-cd-plugin-extension-github-action-super-linter)
Add Azure and Gitlab options
2020-07-14 20:14:01 -04:00
### Visual Studio Code
Format Markdown
2020-07-21 13:08:05 -04:00
Add Azure and Gitlab options
2020-07-14 20:14:01 -04:00
You can checkout this repository using [Container Remote Development](https://code.visualstudio.com/docs/remote/containers), and debug the linter using the `Test Linter` task.
![Example](https://user-images.githubusercontent.com/15258962/85165778-2d2ce700-b21b-11ea-803e-3f6709d8e609.gif)
typo
2020-08-25 07:32:13 -04:00
We will also support [GitHub Codespaces](https://github.com/features/codespaces/) once it becomes available
adding them docs
2020-02-05 10:23:47 -05:00
update readme
2020-04-30 10:06:20 -04:00
## Limitations
Format Markdown
2020-07-21 13:08:05 -04:00
Fix capitalization [skip ci] * Markdown [1,2] has no capital 'd' * CoffeeScript [3,4], JavaScript [5,6], TypeScript [7,8,9] all capitalize 'S' * GitHub [10,11] capitalizes the 'H' References: [1] https://en.wikipedia.org/wiki/Markdown [2] https://daringfireball.net/projects/markdown/syntax [3] https://en.wikipedia.org/wiki/CoffeeScript [4] https://coffeescript.org/ [5] https://en.wikipedia.org/wiki/JavaScript [6] https://developer.mozilla.org/en-US/docs/Web/JavaScript [7] https://en.wikipedia.org/wiki/TypeScript [8] https://www.typescriptlang.org/ [9] https://github.com/Microsoft/TypeScript [10] https://en.wikipedia.org/wiki/GitHub [11] https://github.com/about
2020-06-18 11:57:58 -04:00
Below are a list of the known limitations for the **GitHub Super-Linter**:
Format Markdown
2020-07-21 13:08:05 -04:00
readme: fix typo
2020-05-07 16:16:57 -04:00
- Due to being completely packaged at run time, you will not be able to update dependencies or change versions of the enclosed linters and binaries
Fixes typo in README
2020-06-30 10:40:23 -04:00
- Additional details from `package.json` are not read by the **GitHub Super-Linter**
update readme
2020-04-30 10:06:20 -04:00
- Downloading additional codebases as dependencies from private repositories will fail due to lack of permissions
adding docs
2020-01-09 10:48:46 -05:00
## How to contribute
Format Markdown
2020-07-21 13:08:05 -04:00
s/Github/GitHub/g
2020-01-09 18:01:23 -05:00
If you would like to help contribute to this **GitHub** Action, please see [CONTRIBUTING](https://github.com/github/super-linter/blob/master/.github/CONTRIBUTING.md)
initial commit
2019-10-21 10:12:50 -04:00
Format Markdown
2020-07-21 13:08:05 -04:00
---
initial commit
2019-10-21 10:12:50 -04:00
### License
Format Markdown
2020-07-21 13:08:05 -04:00
Specify license type
2020-04-28 14:55:15 -04:00
- [MIT License](https://github.com/github/super-linter/blob/master/LICENSE)
Reference in a new issue Copy permalink