mirror of
https://github.com/super-linter/super-linter.git
synced 2024-11-22 06:01:05 -05:00
cleaner (#2008)
* cleaner * fix bad name * fix name * adding flag * fix links * noise * fix rules * fix to warn * remove textlint
This commit is contained in:
parent
3472ac360c
commit
57e0530d1b
12 changed files with 9 additions and 2760 deletions
|
@ -1,20 +0,0 @@
|
||||||
# Natural language Test Cases
|
|
||||||
|
|
||||||
This folder holds the test cases for **natural language**.
|
|
||||||
|
|
||||||
## Additional Docs
|
|
||||||
|
|
||||||
No Additional information is needed for this test case.
|
|
||||||
|
|
||||||
## Good Test Cases
|
|
||||||
|
|
||||||
The test cases denoted: `LANGUAGE_good_FILE.EXTENSION` are all valid, and should pass successfully when linted.
|
|
||||||
|
|
||||||
- **Note:** They are linted utilizing the default linter rules.
|
|
||||||
|
|
||||||
## Bad Test Cases
|
|
||||||
|
|
||||||
The test cases denoted: `LANGUAGE_bad_FILE.EXTENSION` are **NOT** valid, and should trigger errors when linted.
|
|
||||||
|
|
||||||
- **Note:** They are linted utilizing the default linter rules.
|
|
||||||
{"mode":"full","isActive":false}
|
|
|
@ -1 +0,0 @@
|
||||||
https://eslint.org/docs/user-guide/configuring#configuration-file-formats
|
|
|
@ -1 +0,0 @@
|
||||||
https://eslint.org/docs/user-guide/configuring/#configuration-file-formats
|
|
6
.github/CONTRIBUTING.md
vendored
6
.github/CONTRIBUTING.md
vendored
|
@ -26,7 +26,7 @@ We're thrilled that you'd like to contribute to this project. Your help is essen
|
||||||
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
|
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
|
||||||
|
|
||||||
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
|
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
|
||||||
- Write [good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
|
- Write [good commit messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
|
||||||
|
|
||||||
Draft pull requests are also welcome to get feedback early on, or if there is something blocking you.
|
Draft pull requests are also welcome to get feedback early on, or if there is something blocking you.
|
||||||
|
|
||||||
|
@ -59,8 +59,8 @@ If you are the current maintainer of this action you can create releases from th
|
||||||
## Resources
|
## Resources
|
||||||
|
|
||||||
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
|
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
|
||||||
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
|
- [Using Pull Requests](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
|
||||||
- [GitHub Help](https://help.github.com)
|
- [GitHub Help](https://docs.github.com/en)
|
||||||
|
|
||||||
[pulls]: https://github.com/github/super-linter/pulls
|
[pulls]: https://github.com/github/super-linter/pulls
|
||||||
[pr]: https://github.com/github/super-linter/compare
|
[pr]: https://github.com/github/super-linter/compare
|
||||||
|
|
|
@ -68,9 +68,9 @@ members of the project's leadership.
|
||||||
## Attribution
|
## Attribution
|
||||||
|
|
||||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||||
available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
|
available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct/)
|
||||||
|
|
||||||
[homepage]: https://www.contributor-covenant.org
|
[homepage]: https://www.contributor-covenant.org
|
||||||
|
|
||||||
For answers to common questions about this code of conduct, see
|
For answers to common questions about this code of conduct, see
|
||||||
[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq)
|
[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq/)
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
This repository is for the **GitHub Action** to run a **Super-Linter**.
|
This repository is for the **GitHub Action** to run a **Super-Linter**.
|
||||||
It is a simple combination of various linters, written in `bash`, to help validate your source code.
|
It is a simple combination of various linters, written in `bash`, to help validate your source code.
|
||||||
|
|
||||||
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/51071879604e4f319859d4daf91c68f5)](https://www.codacy.com/gh/github/super-linter/dashboard?utm_source=github.com&utm_medium=referral&utm_content=github/super-linter&utm_campaign=Badge_Grade)
|
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/51071879604e4f319859d4daf91c68f5)](https://app.codacy.com/gh/github/super-linter/dashboard?utm_source=github.com&utm_medium=referral&utm_content=github/super-linter&utm_campaign=Badge_Grade)
|
||||||
|
|
||||||
**The end goal of this tool:**
|
**The end goal of this tool:**
|
||||||
|
|
||||||
|
@ -80,7 +80,6 @@ Developers on **GitHub** can call the **GitHub Action** to lint their code base
|
||||||
| **LaTeX** | [ChkTex](https://www.nongnu.org/chktex/) |
|
| **LaTeX** | [ChkTex](https://www.nongnu.org/chktex/) |
|
||||||
| **Lua** | [luacheck](https://github.com/luarocks/luacheck) |
|
| **Lua** | [luacheck](https://github.com/luarocks/luacheck) |
|
||||||
| **Markdown** | [markdownlint](https://github.com/igorshubovych/markdownlint-cli#readme) |
|
| **Markdown** | [markdownlint](https://github.com/igorshubovych/markdownlint-cli#readme) |
|
||||||
| **Natural language** | [textlint](https://textlint.github.io/) |
|
|
||||||
| **OpenAPI** | [spectral](https://github.com/stoplightio/spectral) |
|
| **OpenAPI** | [spectral](https://github.com/stoplightio/spectral) |
|
||||||
| **Perl** | [perlcritic](https://metacpan.org/pod/Perl::Critic) |
|
| **Perl** | [perlcritic](https://metacpan.org/pod/Perl::Critic) |
|
||||||
| **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/) |
|
| **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/) |
|
||||||
|
@ -315,7 +314,6 @@ But if you wish to select or exclude specific linters, we give you full control
|
||||||
| **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`) |
|
| **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`) |
|
||||||
| **TERRAFORM_TFLINT_CONFIG_FILE** | `.tflint.hcl` | Filename for [tfLint configuration](https://github.com/terraform-linters/tflint) (ex: `.tflint.hcl`) |
|
| **TERRAFORM_TFLINT_CONFIG_FILE** | `.tflint.hcl` | Filename for [tfLint configuration](https://github.com/terraform-linters/tflint) (ex: `.tflint.hcl`) |
|
||||||
| **TERRAFORM_TERRASCAN_CONFIG_FILE**| `terrascan.toml` | Filename for [terrascan configuration](https://github.com/accurics/terrascan) (ex: `terrascan.toml`) |
|
| **TERRAFORM_TERRASCAN_CONFIG_FILE**| `terrascan.toml` | Filename for [terrascan configuration](https://github.com/accurics/terrascan) (ex: `terrascan.toml`) |
|
||||||
| **TEXTLINT_CONFIG_FILE** | `.textlintrc` | Filename for [textlint configuration](https://textlint.github.io/docs/getting-started.html#configuration) (ex: `.textlintrc`) |
|
|
||||||
| **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`) |
|
| **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`) |
|
||||||
| **USE_FIND_ALGORITHM** | `false` | By default, we use `git diff` to find all files in the workspace and what has been updated, this would enable the Linux `find` method instead to find all files to lint |
|
| **USE_FIND_ALGORITHM** | `false` | By default, we use `git diff` to find all files in the workspace and what has been updated, this would enable the Linux `find` method instead to find all files to lint |
|
||||||
| **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_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. |
|
||||||
|
@ -353,7 +351,6 @@ But if you wish to select or exclude specific linters, we give you full control
|
||||||
| **VALIDATE_LATEX** | `true` | Flag to enable or disable the linting process of the LaTeX language. |
|
| **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_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_MARKDOWN** | `true` | Flag to enable or disable the linting process of the Markdown language. |
|
||||||
| **VALIDATE_NATURAL_LANGUAGE** | `true` | Flag to enable or disable the linting process of the natural language. |
|
|
||||||
| **VALIDATE_OPENAPI** | `true` | Flag to enable or disable the linting process of the OpenAPI 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_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** | `true` | Flag to enable or disable the linting process of the PHP language. (Utilizing: PHP built-in linter) (keep for backward compatibility) |
|
||||||
|
|
|
@ -1,6 +0,0 @@
|
||||||
{
|
|
||||||
"filters": {},
|
|
||||||
"rules": {
|
|
||||||
"no-dead-link": true
|
|
||||||
}
|
|
||||||
}
|
|
2713
dependencies/package-lock.json
generated
vendored
2713
dependencies/package-lock.json
generated
vendored
File diff suppressed because it is too large
Load diff
2
dependencies/package.json
vendored
2
dependencies/package.json
vendored
|
@ -39,8 +39,6 @@
|
||||||
"stylelint-config-standard": "^22.0.0",
|
"stylelint-config-standard": "^22.0.0",
|
||||||
"stylelint-scss": "^3.21.0",
|
"stylelint-scss": "^3.21.0",
|
||||||
"tekton-lint": "^0.5.2",
|
"tekton-lint": "^0.5.2",
|
||||||
"textlint": "^12.0.2",
|
|
||||||
"textlint-rule-no-dead-link": "^4.7.0",
|
|
||||||
"typescript": "^4.4.3"
|
"typescript": "^4.4.3"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -578,7 +578,6 @@ function BuildFileList() {
|
||||||
# Append the file to the array #
|
# Append the file to the array #
|
||||||
################################
|
################################
|
||||||
FILE_ARRAY_MARKDOWN+=("${FILE}")
|
FILE_ARRAY_MARKDOWN+=("${FILE}")
|
||||||
FILE_ARRAY_TEXTLINT+=("${FILE}")
|
|
||||||
|
|
||||||
######################
|
######################
|
||||||
# Get the PHP files #
|
# Get the PHP files #
|
||||||
|
|
|
@ -405,7 +405,7 @@ function RunAdditionalInstalls() {
|
||||||
info "Found PHP files to validate, and [VALIDATE_PHP_PSALM] set to true, need to run composer install"
|
info "Found PHP files to validate, and [VALIDATE_PHP_PSALM] set to true, need to run composer install"
|
||||||
info "looking for composer.json in the users repository..."
|
info "looking for composer.json in the users repository..."
|
||||||
mapfile -t COMPOSER_FILE_ARRAY < <(find / -name composer.json 2>&1)
|
mapfile -t COMPOSER_FILE_ARRAY < <(find / -name composer.json 2>&1)
|
||||||
debug "COMPOSER_FILE_ARRAY contents: ${COMPOSER_FILE_ARRAY[*]}"
|
debug "COMPOSER_FILE_ARRAY contents:[${COMPOSER_FILE_ARRAY[*]}]"
|
||||||
############################################
|
############################################
|
||||||
# Check if we found the file in the system #
|
# Check if we found the file in the system #
|
||||||
############################################
|
############################################
|
||||||
|
@ -415,7 +415,7 @@ function RunAdditionalInstalls() {
|
||||||
info "Found [composer.json] at:[${LINE}]"
|
info "Found [composer.json] at:[${LINE}]"
|
||||||
COMPOSER_CMD=$(
|
COMPOSER_CMD=$(
|
||||||
cd "${PATH}" || exit 1
|
cd "${PATH}" || exit 1
|
||||||
composer install 2>&1
|
composer install --no-progress -q 2>&1
|
||||||
)
|
)
|
||||||
|
|
||||||
##############
|
##############
|
||||||
|
|
|
@ -168,8 +168,6 @@ TERRAFORM_TFLINT_FILE_NAME="${TERRAFORM_TFLINT_CONFIG_FILE:-.tflint.hcl}"
|
||||||
# shellcheck disable=SC2034 # Variable is referenced indirectly
|
# shellcheck disable=SC2034 # Variable is referenced indirectly
|
||||||
TERRAFORM_TERRASCAN_FILE_NAME="${TERRAFORM_TERRASCAN_CONFIG_FILE:-terrascan.toml}"
|
TERRAFORM_TERRASCAN_FILE_NAME="${TERRAFORM_TERRASCAN_CONFIG_FILE:-terrascan.toml}"
|
||||||
# shellcheck disable=SC2034 # Variable is referenced indirectly
|
# shellcheck disable=SC2034 # Variable is referenced indirectly
|
||||||
TEXTLINT_FILE_NAME="${TEXTLINT_CONFIG_FILE:-.textlintrc}"
|
|
||||||
# shellcheck disable=SC2034 # Variable is referenced indirectly
|
|
||||||
TSX_FILE_NAME="${TYPESCRIPT_ES_CONFIG_FILE:-.eslintrc.yml}"
|
TSX_FILE_NAME="${TYPESCRIPT_ES_CONFIG_FILE:-.eslintrc.yml}"
|
||||||
# shellcheck disable=SC2034 # Variable is referenced indirectly
|
# shellcheck disable=SC2034 # Variable is referenced indirectly
|
||||||
TYPESCRIPT_ES_FILE_NAME="${TYPESCRIPT_ES_CONFIG_FILE:-.eslintrc.yml}"
|
TYPESCRIPT_ES_FILE_NAME="${TYPESCRIPT_ES_CONFIG_FILE:-.eslintrc.yml}"
|
||||||
|
@ -206,7 +204,7 @@ LANGUAGE_ARRAY=('ANSIBLE' 'ARM' 'BASH' 'BASH_EXEC' 'CLANG_FORMAT'
|
||||||
'DOCKERFILE' 'DOCKERFILE_HADOLINT' 'EDITORCONFIG' 'ENV' 'GITHUB_ACTIONS'
|
'DOCKERFILE' 'DOCKERFILE_HADOLINT' 'EDITORCONFIG' 'ENV' 'GITHUB_ACTIONS'
|
||||||
'GITLEAKS' 'GHERKIN' 'GO' 'GOOGLE_JAVA_FORMAT' 'GROOVY' 'HTML' 'JAVA'
|
'GITLEAKS' 'GHERKIN' 'GO' 'GOOGLE_JAVA_FORMAT' 'GROOVY' 'HTML' 'JAVA'
|
||||||
'JAVASCRIPT_ES' "${JAVASCRIPT_STYLE_NAME}" 'JSCPD' 'JSON' 'JSONC' 'JSX'
|
'JAVASCRIPT_ES' "${JAVASCRIPT_STYLE_NAME}" 'JSCPD' 'JSON' 'JSONC' 'JSX'
|
||||||
'KUBERNETES_KUBEVAL' 'KOTLIN' 'LATEX' 'LUA' 'MARKDOWN' 'NATURAL_LANGUAGE'
|
'KUBERNETES_KUBEVAL' 'KOTLIN' 'LATEX' 'LUA' 'MARKDOWN'
|
||||||
'OPENAPI' 'PERL' 'PHP_BUILTIN' 'PHP_PHPCS' 'PHP_PHPSTAN' 'PHP_PSALM'
|
'OPENAPI' 'PERL' 'PHP_BUILTIN' 'PHP_PHPCS' 'PHP_PHPSTAN' 'PHP_PSALM'
|
||||||
'POWERSHELL' 'PROTOBUF' 'PYTHON_BLACK' 'PYTHON_PYLINT' 'PYTHON_FLAKE8'
|
'POWERSHELL' 'PROTOBUF' 'PYTHON_BLACK' 'PYTHON_PYLINT' 'PYTHON_FLAKE8'
|
||||||
'PYTHON_ISORT' 'PYTHON_MYPY' 'R' 'RAKU' 'RUBY' 'RUST_2015' 'RUST_2018'
|
'PYTHON_ISORT' 'PYTHON_MYPY' 'R' 'RAKU' 'RUBY' 'RUST_2015' 'RUST_2018'
|
||||||
|
@ -253,7 +251,6 @@ LINTER_NAMES_ARRAY['KUBERNETES_KUBEVAL']="kubeval"
|
||||||
LINTER_NAMES_ARRAY['LATEX']="chktex"
|
LINTER_NAMES_ARRAY['LATEX']="chktex"
|
||||||
LINTER_NAMES_ARRAY['LUA']="lua"
|
LINTER_NAMES_ARRAY['LUA']="lua"
|
||||||
LINTER_NAMES_ARRAY['MARKDOWN']="markdownlint"
|
LINTER_NAMES_ARRAY['MARKDOWN']="markdownlint"
|
||||||
LINTER_NAMES_ARRAY['NATURAL_LANGUAGE']="textlint"
|
|
||||||
LINTER_NAMES_ARRAY['OPENAPI']="spectral"
|
LINTER_NAMES_ARRAY['OPENAPI']="spectral"
|
||||||
LINTER_NAMES_ARRAY['PERL']="perl"
|
LINTER_NAMES_ARRAY['PERL']="perl"
|
||||||
LINTER_NAMES_ARRAY['PHP_BUILTIN']="php"
|
LINTER_NAMES_ARRAY['PHP_BUILTIN']="php"
|
||||||
|
@ -871,7 +868,6 @@ if [ -n "${MARKDOWN_CUSTOM_RULE_GLOBS}" ]; then
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
fi
|
fi
|
||||||
LINTER_COMMANDS_ARRAY['NATURAL_LANGUAGE']="textlint ${NATURAL_LANGUAGE_LINTER_RULES}"
|
|
||||||
LINTER_COMMANDS_ARRAY['OPENAPI']="spectral lint -r ${OPENAPI_LINTER_RULES}"
|
LINTER_COMMANDS_ARRAY['OPENAPI']="spectral lint -r ${OPENAPI_LINTER_RULES}"
|
||||||
LINTER_COMMANDS_ARRAY['PERL']="perlcritic"
|
LINTER_COMMANDS_ARRAY['PERL']="perlcritic"
|
||||||
LINTER_COMMANDS_ARRAY['PHP_BUILTIN']="php -l -c ${PHP_BUILTIN_LINTER_RULES}"
|
LINTER_COMMANDS_ARRAY['PHP_BUILTIN']="php -l -c ${PHP_BUILTIN_LINTER_RULES}"
|
||||||
|
|
Loading…
Reference in a new issue