From 2a22e2014f295465470c28d61f1c8bb57b8c6f53 Mon Sep 17 00:00:00 2001 From: Nicolas Vuillamy Date: Tue, 12 Jul 2022 06:25:13 +0000 Subject: [PATCH] [automation] Auto-update linters version, help and documentation --- .automation/generated/linter-helps.json | 470 ++++++++-------- .automation/generated/linter-versions.json | 4 +- .automation/generated/megalinter-users.json | 30 +- CHANGELOG.md | 2 + README.md | 252 ++++----- docs/all_linters.md | 186 +++---- docs/configuration.md | 4 +- docs/descriptors/action.md | 12 +- docs/descriptors/action_actionlint.md | 60 +-- docs/descriptors/ansible.md | 12 +- docs/descriptors/ansible_ansible_lint.md | 56 +- docs/descriptors/arm.md | 12 +- docs/descriptors/arm_arm_ttk.md | 40 +- docs/descriptors/bash.md | 16 +- docs/descriptors/bash_bash_exec.md | 58 +- docs/descriptors/bash_shellcheck.md | 78 +-- docs/descriptors/bash_shfmt.md | 74 +-- docs/descriptors/c.md | 12 +- docs/descriptors/c_cpplint.md | 32 +- docs/descriptors/clojure.md | 12 +- docs/descriptors/clojure_clj_kondo.md | 46 +- docs/descriptors/cloudformation.md | 12 +- docs/descriptors/cloudformation_cfn_lint.md | 48 +- docs/descriptors/coffee.md | 12 +- docs/descriptors/coffee_coffeelint.md | 42 +- docs/descriptors/copypaste.md | 12 +- docs/descriptors/copypaste_jscpd.md | 52 +- docs/descriptors/cpp.md | 12 +- docs/descriptors/cpp_cpplint.md | 32 +- docs/descriptors/csharp.md | 12 +- docs/descriptors/csharp_dotnet_format.md | 32 +- docs/descriptors/css.md | 14 +- docs/descriptors/css_scss_lint.md | 68 +-- docs/descriptors/css_stylelint.md | 74 +-- docs/descriptors/dart.md | 12 +- docs/descriptors/dart_dartanalyzer.md | 42 +- docs/descriptors/dockerfile.md | 12 +- docs/descriptors/dockerfile_hadolint.md | 68 +-- docs/descriptors/editorconfig.md | 12 +- .../editorconfig_editorconfig_checker.md | 58 +- docs/descriptors/env.md | 12 +- docs/descriptors/env_dotenv_linter.md | 56 +- docs/descriptors/gherkin.md | 12 +- docs/descriptors/gherkin_gherkin_lint.md | 36 +- docs/descriptors/go.md | 14 +- docs/descriptors/go_golangci_lint.md | 54 +- docs/descriptors/go_revive.md | 44 +- docs/descriptors/graphql.md | 12 +- .../graphql_graphql_schema_linter.md | 58 +- docs/descriptors/groovy.md | 12 +- docs/descriptors/groovy_npm_groovy_lint.md | 64 +-- docs/descriptors/html.md | 12 +- docs/descriptors/html_htmlhint.md | 70 +-- docs/descriptors/java.md | 12 +- docs/descriptors/java_checkstyle.md | 46 +- docs/descriptors/javascript.md | 16 +- docs/descriptors/javascript_eslint.md | 58 +- docs/descriptors/javascript_prettier.md | 64 +-- docs/descriptors/javascript_standard.md | 54 +- docs/descriptors/json.md | 18 +- docs/descriptors/json_eslint_plugin_jsonc.md | 64 +-- docs/descriptors/json_jsonlint.md | 56 +- docs/descriptors/json_prettier.md | 86 +-- docs/descriptors/json_v8r.md | 68 +-- docs/descriptors/jsx.md | 12 +- docs/descriptors/jsx_eslint.md | 58 +- docs/descriptors/kotlin.md | 12 +- docs/descriptors/kotlin_ktlint.md | 60 +-- docs/descriptors/kubernetes.md | 16 +- docs/descriptors/kubernetes_kubeconform.md | 58 +- docs/descriptors/kubernetes_kubeval.md | 58 +- docs/descriptors/latex.md | 14 +- docs/descriptors/latex_chktex.md | 40 +- docs/descriptors/lua.md | 12 +- docs/descriptors/lua_luacheck.md | 50 +- docs/descriptors/markdown.md | 18 +- .../markdown_markdown_link_check.md | 58 +- .../markdown_markdown_table_formatter.md | 58 +- docs/descriptors/markdown_markdownlint.md | 72 +-- docs/descriptors/markdown_remark_lint.md | 48 +- docs/descriptors/openapi.md | 12 +- docs/descriptors/openapi_spectral.md | 66 +-- docs/descriptors/perl.md | 12 +- docs/descriptors/perl_perlcritic.md | 30 +- docs/descriptors/php.md | 20 +- docs/descriptors/php_phpcs.md | 52 +- docs/descriptors/php_phplint.md | 36 +- docs/descriptors/php_phpstan.md | 44 +- docs/descriptors/php_psalm.md | 44 +- docs/descriptors/powershell.md | 12 +- docs/descriptors/powershell_powershell.md | 40 +- docs/descriptors/protobuf.md | 12 +- docs/descriptors/protobuf_protolint.md | 66 +-- docs/descriptors/puppet.md | 12 +- docs/descriptors/puppet_puppet_lint.md | 38 +- docs/descriptors/python.md | 18 +- docs/descriptors/python_bandit.md | 48 +- docs/descriptors/python_black.md | 58 +- docs/descriptors/python_flake8.md | 50 +- docs/descriptors/python_isort.md | 54 +- docs/descriptors/python_mypy.md | 54 +- docs/descriptors/python_pylint.md | 510 +++++++++--------- docs/descriptors/r.md | 14 +- docs/descriptors/r_lintr.md | 50 +- docs/descriptors/raku.md | 12 +- docs/descriptors/raku_raku.md | 44 +- docs/descriptors/repository.md | 28 +- docs/descriptors/repository_devskim.md | 30 +- docs/descriptors/repository_dustilock.md | 26 +- docs/descriptors/repository_git_diff.md | 50 +- docs/descriptors/repository_gitleaks.md | 56 +- docs/descriptors/repository_goodcheck.md | 54 +- docs/descriptors/repository_secretlint.md | 56 +- docs/descriptors/repository_semgrep.md | 58 +- docs/descriptors/repository_syft.md | 32 +- docs/descriptors/repository_trivy.md | 56 +- docs/descriptors/rst.md | 14 +- docs/descriptors/rst_rst_lint.md | 32 +- docs/descriptors/rst_rstcheck.md | 40 +- docs/descriptors/ruby.md | 12 +- docs/descriptors/ruby_rubocop.md | 58 +- docs/descriptors/rust.md | 12 +- docs/descriptors/rust_clippy.md | 34 +- docs/descriptors/salesforce.md | 14 +- .../salesforce_sfdx_scanner_apex.md | 44 +- .../salesforce_sfdx_scanner_aura.md | 36 +- .../salesforce_sfdx_scanner_lwc.md | 36 +- docs/descriptors/scala.md | 12 +- docs/descriptors/scala_scalafix.md | 34 +- docs/descriptors/snakemake.md | 16 +- docs/descriptors/snakemake_snakefmt.md | 34 +- docs/descriptors/snakemake_snakemake.md | 62 +-- docs/descriptors/spell.md | 16 +- docs/descriptors/spell_cspell.md | 62 +-- docs/descriptors/spell_misspell.md | 54 +- docs/descriptors/sql.md | 16 +- docs/descriptors/sql_sql_lint.md | 62 +-- docs/descriptors/sql_sqlfluff.md | 58 +- docs/descriptors/sql_tsqllint.md | 40 +- docs/descriptors/swift.md | 12 +- docs/descriptors/swift_swiftlint.md | 42 +- docs/descriptors/tekton.md | 12 +- docs/descriptors/tekton_tekton_lint.md | 58 +- docs/descriptors/terraform.md | 24 +- docs/descriptors/terraform_checkov.md | 40 +- docs/descriptors/terraform_kics.md | 34 +- docs/descriptors/terraform_terraform_fmt.md | 44 +- docs/descriptors/terraform_terragrunt.md | 38 +- docs/descriptors/terraform_terrascan.md | 32 +- docs/descriptors/terraform_tflint.md | 38 +- docs/descriptors/tsx.md | 12 +- docs/descriptors/tsx_eslint.md | 58 +- docs/descriptors/typescript.md | 16 +- docs/descriptors/typescript_eslint.md | 58 +- docs/descriptors/typescript_prettier.md | 64 +-- docs/descriptors/typescript_standard.md | 54 +- docs/descriptors/vbdotnet.md | 12 +- docs/descriptors/vbdotnet_dotnet_format.md | 32 +- docs/descriptors/xml.md | 14 +- docs/descriptors/xml_xmllint.md | 56 +- docs/descriptors/yaml.md | 16 +- docs/descriptors/yaml_prettier.md | 86 +-- docs/descriptors/yaml_v8r.md | 68 +-- docs/descriptors/yaml_yamllint.md | 66 +-- docs/flavors.md | 34 +- docs/flavors/ci_light.md | 52 +- docs/flavors/documentation.md | 100 ++-- docs/flavors/dotnet.md | 116 ++-- docs/flavors/go.md | 104 ++-- docs/flavors/java.md | 104 ++-- docs/flavors/javascript.md | 118 ++-- docs/flavors/php.md | 108 ++-- docs/flavors/python.md | 116 ++-- docs/flavors/ruby.md | 102 ++-- docs/flavors/rust.md | 102 ++-- docs/flavors/salesforce.md | 106 ++-- docs/flavors/security.md | 52 +- docs/flavors/swift.md | 102 ++-- docs/flavors/terraform.md | 112 ++-- docs/index.md | 218 ++++---- docs/reporters.md | 4 +- docs/standalone-linters.md | 50 +- docs/supported-linters.md | 218 ++++---- flavors/ci_light/action.yml | 2 +- flavors/documentation/action.yml | 2 +- flavors/dotnet/action.yml | 2 +- flavors/go/action.yml | 2 +- flavors/java/action.yml | 2 +- flavors/javascript/action.yml | 2 +- flavors/php/action.yml | 2 +- flavors/python/action.yml | 2 +- flavors/ruby/action.yml | 2 +- flavors/rust/action.yml | 2 +- flavors/salesforce/action.yml | 2 +- flavors/security/action.yml | 2 +- flavors/swift/action.yml | 2 +- flavors/terraform/action.yml | 2 +- mega-linter-runner/README.md | 218 ++++---- .../megalinter-configuration.jsonschema.json | 7 - 199 files changed, 4770 insertions(+), 4775 deletions(-) diff --git a/.automation/generated/linter-helps.json b/.automation/generated/linter-helps.json index 470c9f7a2f4..10935c19630 100644 --- a/.automation/generated/linter-helps.json +++ b/.automation/generated/linter-helps.json @@ -345,8 +345,8 @@ " input).", " --python-cell-magics TEXT When processing Jupyter Notebooks, add the", " given magic to the list of known python-", - " magics (pypy, python3, capture, prun,", - " timeit, python, time). Useful for formatting", + " magics (python, prun, pypy, time, python3,", + " capture, timeit). Useful for formatting", " cells with custom python magics.", " -S, --skip-string-normalization", " Don't normalize string quotes or prefixes.", @@ -1603,8 +1603,8 @@ " of opening bracket's line.", " --ignore errors Comma-separated list of errors and warnings to ignore", " (or skip). For example, ``--ignore=E4,E51,W234``.", - " (Default: ['E704', 'W504', 'E123', 'E121', 'W503',", - " 'E226', 'E126', 'E24'])", + " (Default: ['E126', 'W503', 'E121', 'E123', 'E704',", + " 'W504', 'E24', 'E226'])", " --extend-ignore errors", " Comma-separated list of errors and warnings to add to", " the list of ignored ones. For example, ``--extend-", @@ -4158,41 +4158,6 @@ " Warning level messages displayed, use \"--disable=all", " --enable=classes --disable=W\".", "", - "String:", - " Check string literals.", - "", - " --check-str-concat-over-line-jumps ", - " This flag controls whether the implicit-str-concat", - " should generate a warning on implicit string", - " concatenation in sequences defined over several lines.", - " (default: False)", - " --check-quote-consistency ", - " This flag controls whether inconsistent-quotes", - " generates a warning when the character used as a quote", - " delimiter is used inconsistently within a module.", - " (default: False)", - "", - "Exceptions:", - " Exception related checks.", - "", - " --overgeneral-exceptions ", - " Exceptions that will emit a warning when caught.", - " (default: ('BaseException', 'Exception'))", - "", - "Refactoring:", - " Looks for code which can be refactored.", - "", - " --max-nested-blocks ", - " Maximum number of nested blocks for function / method", - " body (default: 5)", - " --never-returning-functions ", - " Complete name of functions that never returns. When", - " checking for inconsistent-return-statements if a never", - " returning function is called then it will be", - " considered as an explicit return statement and no", - " message will be printed. (default: ('sys.exit',", - " 'argparse.parse_error'))", - "", "Format:", " Formatting checker.", "", @@ -4221,183 +4186,12 @@ " Expected format of line ending, e.g. empty (any line", " ending), LF or CRLF. (default: )", "", - "Typecheck:", - " Try to find bugs in the code using type inference.", - "", - " --ignore-on-opaque-inference ", - " This flag controls whether pylint should warn about", - " no-member and similar checks whenever an opaque object", - " is returned when inferring. The inference can return", - " multiple potential results while evaluating a Python", - " object, but some branches might not be evaluated,", - " which results in partial inference. In that case, it", - " might be useful to still emit no-member and other", - " checks for the rest of the inferred objects. (default:", - " True)", - " --mixin-class-rgx ", - " Regex pattern to define which classes are considered", - " mixins. (default: .*[Mm]ixin)", - " --ignore-mixin-members ", - " Tells whether missing members accessed in mixin class", - " should be ignored. A class is considered mixin if its", - " name matches the mixin-class-rgx option. (default:", - " True)", - " --ignored-checks-for-mixins ", - " List of symbolic message names to ignore for Mixin", - " members. (default: ['no-member', 'not-async-context-", - " manager', 'not-context-manager', 'attribute-defined-", - " outside-init'])", - " --ignore-none ", - " Tells whether to warn about missing members when the", - " owner of the attribute is inferred to be None.", - " (default: True)", - " --ignored-classes ", - " List of class names for which member attributes should", - " not be checked (useful for classes with dynamically", - " set attributes). This supports the use of qualified", - " names. (default: ('optparse.Values', 'thread._local',", - " '_thread._local', 'argparse.Namespace'))", - " --generated-members ", - " List of members which are set dynamically and missed", - " by pylint inference system, and so shouldn't trigger", - " E1101 when accessed. Python regular expressions are", - " accepted. (default: ())", - " --contextmanager-decorators ", - " List of decorators that produce context managers, such", - " as contextlib.contextmanager. Add to this list to", - " register other decorators that produce valid context", - " managers. (default: ['contextlib.contextmanager'])", - " --missing-member-hint-distance ", - " The minimum edit distance a name should have in order", - " to be considered a similar match for a missing member", - " name. (default: 1)", - " --missing-member-max-choices ", - " The total number of similar names that should be taken", - " in consideration when showing a hint for a missing", - " member. (default: 1)", - " --missing-member-hint ", - " Show a hint with possible names when a member name was", - " not found. The aspect of finding the hint is based on", - " edit distance. (default: True)", - " --signature-mutators ", - " List of decorators that change the signature of a", - " decorated function. (default: [])", - "", - "Variables:", - " BaseChecker for variables.", - "", - " --init-import ", - " Tells whether we should check for unused import in", - " __init__ files. (default: False)", - " --dummy-variables-rgx ", - " A regular expression matching the name of dummy", - " variables (i.e. expected to not be used). (default: _+", - " $|(_[a-zA-Z0-9_]*[a-zA-Z0-", - " 9]+?$)|dummy|^ignored_|^unused_)", - " --additional-builtins ", - " List of additional names supposed to be defined in", - " builtins. Remember that you should avoid defining new", - " builtins when possible. (default: ())", - " --callbacks ", - " List of strings which can identify a callback function", - " by name. A callback name must start or end with one of", - " those strings. (default: ('cb_', '_cb'))", - " --redefining-builtins-modules ", - " List of qualified module names which can have objects", - " that can redefine builtins. (default: ('six.moves',", - " 'past.builtins', 'future.builtins', 'builtins', 'io'))", - " --ignored-argument-names ", - " Argument names that match this expression will be", - " ignored. Default to name with leading underscore.", - " (default: re.compile('_.*|^ignored_|^unused_'))", - " --allow-global-unused-variables ", - " Tells whether unused global variables should be", - " treated as a violation. (default: True)", - " --allowed-redefined-builtins ", - " List of names allowed to shadow builtins (default: ())", - "", - "Spelling:", - " Check spelling in comments and docstrings.", - "", - " --spelling-dict ", - " Spelling dictionary name. Available dictionaries:", - " none. To make it work, install the 'python-enchant'", - " package. (default: )", - " --spelling-ignore-words ", - " List of comma separated words that should not be", - " checked. (default: )", - " --spelling-private-dict-file ", - " A path to a file that contains the private dictionary;", - " one word per line. (default: )", - " --spelling-store-unknown-words ", - " Tells whether to store unknown words to the private", - " dictionary (see the --spelling-private-dict-file", - " option) instead of raising a message. (default: n)", - " --max-spelling-suggestions N", - " Limits count of emitted suggestions for spelling", - " mistakes. (default: 4)", - " --spelling-ignore-comment-directives ", - " List of comma separated words that should be", - " considered directives if they appear at the beginning", - " of a comment and should not be checked. (default: fmt:", - " on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:)", - "", - "Classes:", - " Checker for class nodes.", - "", - " --defining-attr-methods ", - " List of method names used to declare (i.e. assign)", - " instance attributes. (default: ('__init__', '__new__',", - " 'setUp', '__post_init__'))", - " --valid-classmethod-first-arg ", - " List of valid names for the first argument in a class", - " method. (default: ('cls',))", - " --valid-metaclass-classmethod-first-arg ", - " List of valid names for the first argument in a", - " metaclass class method. (default: ('cls',))", - " --exclude-protected ", - " List of member names, which should be excluded from", - " the protected access warning. (default: ('_asdict',", - " '_fields', '_replace', '_source', '_make'))", - " --check-protected-access-in-special-methods ", - " Warn about protected attribute access inside special", - " methods (default: False)", - "", - "Design:", - " Checker of potential misdesigns.", + "Exceptions:", + " Exception related checks.", "", - " --max-args Maximum number of arguments for function / method.", - " (default: 5)", - " --max-locals Maximum number of locals for function / method body.", - " (default: 15)", - " --max-returns Maximum number of return / yield for function / method", - " body. (default: 6)", - " --max-branches Maximum number of branch for function / method body.", - " (default: 12)", - " --max-statements ", - " Maximum number of statements in function / method", - " body. (default: 50)", - " --max-parents Maximum number of parents for a class (see R0901).", - " (default: 7)", - " --ignored-parents ", - " List of qualified class names to ignore when counting", - " class parents (see R0901) (default: ())", - " --max-attributes ", - " Maximum number of attributes for a class (see R0902).", - " (default: 7)", - " --min-public-methods ", - " Minimum number of public methods for a class (see", - " R0903). (default: 2)", - " --max-public-methods ", - " Maximum number of public methods for a class (see", - " R0904). (default: 20)", - " --max-bool-expr ", - " Maximum number of boolean expressions in an if", - " statement (see R0916). (default: 5)", - " --exclude-too-few-public-methods [,...]", - " List of regular expressions of class ancestor names to", - " ignore when counting public methods (see R0903)", - " (default: [])", + " --overgeneral-exceptions ", + " Exceptions that will emit a warning when caught.", + " (default: ('BaseException', 'Exception'))", "", "Basic:", " --good-names Good variable names which should always be accepted,", @@ -4524,14 +4318,67 @@ " Minimum line length for functions/classes that require", " docstrings, shorter ones are exempt. (default: -1)", "", - "Miscellaneous:", - " BaseChecker for encoding issues.", + "Typecheck:", + " Try to find bugs in the code using type inference.", "", - " --notes ", - " List of note tags to take in consideration, separated", - " by a comma. (default: ('FIXME', 'XXX', 'TODO'))", - " --notes-rgx Regular expression of note tags to take in", - " consideration. (default: )", + " --ignore-on-opaque-inference ", + " This flag controls whether pylint should warn about", + " no-member and similar checks whenever an opaque object", + " is returned when inferring. The inference can return", + " multiple potential results while evaluating a Python", + " object, but some branches might not be evaluated,", + " which results in partial inference. In that case, it", + " might be useful to still emit no-member and other", + " checks for the rest of the inferred objects. (default:", + " True)", + " --mixin-class-rgx ", + " Regex pattern to define which classes are considered", + " mixins. (default: .*[Mm]ixin)", + " --ignore-mixin-members ", + " Tells whether missing members accessed in mixin class", + " should be ignored. A class is considered mixin if its", + " name matches the mixin-class-rgx option. (default:", + " True)", + " --ignored-checks-for-mixins ", + " List of symbolic message names to ignore for Mixin", + " members. (default: ['no-member', 'not-async-context-", + " manager', 'not-context-manager', 'attribute-defined-", + " outside-init'])", + " --ignore-none ", + " Tells whether to warn about missing members when the", + " owner of the attribute is inferred to be None.", + " (default: True)", + " --ignored-classes ", + " List of class names for which member attributes should", + " not be checked (useful for classes with dynamically", + " set attributes). This supports the use of qualified", + " names. (default: ('optparse.Values', 'thread._local',", + " '_thread._local', 'argparse.Namespace'))", + " --generated-members ", + " List of members which are set dynamically and missed", + " by pylint inference system, and so shouldn't trigger", + " E1101 when accessed. Python regular expressions are", + " accepted. (default: ())", + " --contextmanager-decorators ", + " List of decorators that produce context managers, such", + " as contextlib.contextmanager. Add to this list to", + " register other decorators that produce valid context", + " managers. (default: ['contextlib.contextmanager'])", + " --missing-member-hint-distance ", + " The minimum edit distance a name should have in order", + " to be considered a similar match for a missing member", + " name. (default: 1)", + " --missing-member-max-choices ", + " The total number of similar names that should be taken", + " in consideration when showing a hint for a missing", + " member. (default: 1)", + " --missing-member-hint ", + " Show a hint with possible names when a member name was", + " not found. The aspect of finding the hint is based on", + " edit distance. (default: True)", + " --signature-mutators ", + " List of decorators that change the signature of a", + " decorated function. (default: [])", "", "Similarities:", " Checks for similarities and duplicated code.", @@ -4551,18 +4398,6 @@ " Signatures are removed from the similarity computation", " (default: True)", "", - "Logging:", - " Checks use of the logging module.", - "", - " --logging-modules ", - " Logging modules to check that the string format", - " arguments are in logging function parameter format.", - " (default: ('logging',))", - " --logging-format-style ", - " The type of string formatting that logging methods do.", - " `old` means using % formatting, `new` is for `{}`", - " formatting. (default: old)", - "", "Imports:", " BaseChecker for import statements.", "", @@ -4596,7 +4431,172 @@ " just the top level one. (default: ())", " --allow-wildcard-with-all ", " Allow wildcard imports from modules that define", - " __all__. (default: False)" + " __all__. (default: False)", + "", + "Refactoring:", + " Looks for code which can be refactored.", + "", + " --max-nested-blocks ", + " Maximum number of nested blocks for function / method", + " body (default: 5)", + " --never-returning-functions ", + " Complete name of functions that never returns. When", + " checking for inconsistent-return-statements if a never", + " returning function is called then it will be", + " considered as an explicit return statement and no", + " message will be printed. (default: ('sys.exit',", + " 'argparse.parse_error'))", + "", + "Variables:", + " BaseChecker for variables.", + "", + " --init-import ", + " Tells whether we should check for unused import in", + " __init__ files. (default: False)", + " --dummy-variables-rgx ", + " A regular expression matching the name of dummy", + " variables (i.e. expected to not be used). (default: _+", + " $|(_[a-zA-Z0-9_]*[a-zA-Z0-", + " 9]+?$)|dummy|^ignored_|^unused_)", + " --additional-builtins ", + " List of additional names supposed to be defined in", + " builtins. Remember that you should avoid defining new", + " builtins when possible. (default: ())", + " --callbacks ", + " List of strings which can identify a callback function", + " by name. A callback name must start or end with one of", + " those strings. (default: ('cb_', '_cb'))", + " --redefining-builtins-modules ", + " List of qualified module names which can have objects", + " that can redefine builtins. (default: ('six.moves',", + " 'past.builtins', 'future.builtins', 'builtins', 'io'))", + " --ignored-argument-names ", + " Argument names that match this expression will be", + " ignored. Default to name with leading underscore.", + " (default: re.compile('_.*|^ignored_|^unused_'))", + " --allow-global-unused-variables ", + " Tells whether unused global variables should be", + " treated as a violation. (default: True)", + " --allowed-redefined-builtins ", + " List of names allowed to shadow builtins (default: ())", + "", + "Miscellaneous:", + " BaseChecker for encoding issues.", + "", + " --notes ", + " List of note tags to take in consideration, separated", + " by a comma. (default: ('FIXME', 'XXX', 'TODO'))", + " --notes-rgx Regular expression of note tags to take in", + " consideration. (default: )", + "", + "Logging:", + " Checks use of the logging module.", + "", + " --logging-modules ", + " Logging modules to check that the string format", + " arguments are in logging function parameter format.", + " (default: ('logging',))", + " --logging-format-style ", + " The type of string formatting that logging methods do.", + " `old` means using % formatting, `new` is for `{}`", + " formatting. (default: old)", + "", + "Spelling:", + " Check spelling in comments and docstrings.", + "", + " --spelling-dict ", + " Spelling dictionary name. Available dictionaries:", + " none. To make it work, install the 'python-enchant'", + " package. (default: )", + " --spelling-ignore-words ", + " List of comma separated words that should not be", + " checked. (default: )", + " --spelling-private-dict-file ", + " A path to a file that contains the private dictionary;", + " one word per line. (default: )", + " --spelling-store-unknown-words ", + " Tells whether to store unknown words to the private", + " dictionary (see the --spelling-private-dict-file", + " option) instead of raising a message. (default: n)", + " --max-spelling-suggestions N", + " Limits count of emitted suggestions for spelling", + " mistakes. (default: 4)", + " --spelling-ignore-comment-directives ", + " List of comma separated words that should be", + " considered directives if they appear at the beginning", + " of a comment and should not be checked. (default: fmt:", + " on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:)", + "", + "Design:", + " Checker of potential misdesigns.", + "", + " --max-args Maximum number of arguments for function / method.", + " (default: 5)", + " --max-locals Maximum number of locals for function / method body.", + " (default: 15)", + " --max-returns Maximum number of return / yield for function / method", + " body. (default: 6)", + " --max-branches Maximum number of branch for function / method body.", + " (default: 12)", + " --max-statements ", + " Maximum number of statements in function / method", + " body. (default: 50)", + " --max-parents Maximum number of parents for a class (see R0901).", + " (default: 7)", + " --ignored-parents ", + " List of qualified class names to ignore when counting", + " class parents (see R0901) (default: ())", + " --max-attributes ", + " Maximum number of attributes for a class (see R0902).", + " (default: 7)", + " --min-public-methods ", + " Minimum number of public methods for a class (see", + " R0903). (default: 2)", + " --max-public-methods ", + " Maximum number of public methods for a class (see", + " R0904). (default: 20)", + " --max-bool-expr ", + " Maximum number of boolean expressions in an if", + " statement (see R0916). (default: 5)", + " --exclude-too-few-public-methods [,...]", + " List of regular expressions of class ancestor names to", + " ignore when counting public methods (see R0903)", + " (default: [])", + "", + "String:", + " Check string literals.", + "", + " --check-str-concat-over-line-jumps ", + " This flag controls whether the implicit-str-concat", + " should generate a warning on implicit string", + " concatenation in sequences defined over several lines.", + " (default: False)", + " --check-quote-consistency ", + " This flag controls whether inconsistent-quotes", + " generates a warning when the character used as a quote", + " delimiter is used inconsistently within a module.", + " (default: False)", + "", + "Classes:", + " Checker for class nodes.", + "", + " --defining-attr-methods ", + " List of method names used to declare (i.e. assign)", + " instance attributes. (default: ('__init__', '__new__',", + " 'setUp', '__post_init__'))", + " --valid-classmethod-first-arg ", + " List of valid names for the first argument in a class", + " method. (default: ('cls',))", + " --valid-metaclass-classmethod-first-arg ", + " List of valid names for the first argument in a", + " metaclass class method. (default: ('cls',))", + " --exclude-protected ", + " List of member names, which should be excluded from", + " the protected access warning. (default: ('_asdict',", + " '_fields', '_replace', '_source', '_make'))", + " --check-protected-access-in-special-methods ", + " Warn about protected attribute access inside special", + " methods (default: False)" ], "raku": [ "/opt/rakudo-pkg/share/perl6/runtime/perl6.moarvm [switches] [--] [programfile] [arguments]", diff --git a/.automation/generated/linter-versions.json b/.automation/generated/linter-versions.json index 262804e8535..c441cbe0828 100644 --- a/.automation/generated/linter-versions.json +++ b/.automation/generated/linter-versions.json @@ -6,7 +6,7 @@ "bash-exec": "5.1.16", "black": "22.6.0", "cfn-lint": "0.61.2", - "checkov": "2.1.43", + "checkov": "2.1.44", "checkstyle": "10.3.1", "chktex": "1.7.6", "clippy": "0.1.62", @@ -83,7 +83,7 @@ "standard": "15.0.1", "stylelint": "14.9.1", "swiftlint": "0.46.5", - "syft": "0.50.0", + "syft": "0.51.0", "tekton-lint": "0.6.0", "terraform-fmt": "1.2.4", "terragrunt": "0.38.4", diff --git a/.automation/generated/megalinter-users.json b/.automation/generated/megalinter-users.json index 460ee5252d1..30ec0609337 100644 --- a/.automation/generated/megalinter-users.json +++ b/.automation/generated/megalinter-users.json @@ -110,7 +110,7 @@ "releases_url": "https://api.github.com/repos/nektos/act/releases{/id}", "size": 6053, "ssh_url": "git@github.com:nektos/act.git", - "stargazers_count": 25920, + "stargazers_count": 25921, "stargazers_url": "https://api.github.com/repos/nektos/act/stargazers", "statuses_url": "https://api.github.com/repos/nektos/act/statuses/{sha}", "subscribers_count": 117, @@ -127,15 +127,15 @@ "golang" ], "trees_url": "https://api.github.com/repos/nektos/act/git/trees{/sha}", - "updated_at": "2022-07-12T03:22:55Z", + "updated_at": "2022-07-12T06:23:40Z", "url": "https://api.github.com/repos/nektos/act", "visibility": "public", - "watchers": 25920, - "watchers_count": 25920, + "watchers": 25921, + "watchers_count": 25921, "web_commit_signoff_required": false }, "repo_url": "https://github.com/nektos/act", - "stargazers": 25920 + "stargazers": 25921 }, { "info": { @@ -716,7 +716,7 @@ }, "private": false, "pulls_url": "https://api.github.com/repos/oxsecurity/megalinter/pulls{/number}", - "pushed_at": "2022-07-12T05:36:17Z", + "pushed_at": "2022-07-12T05:44:26Z", "releases_url": "https://api.github.com/repos/oxsecurity/megalinter/releases{/id}", "size": 175437, "ssh_url": "git@github.com:oxsecurity/megalinter.git", @@ -824,8 +824,8 @@ "network_count": 88, "node_id": "MDEwOlJlcG9zaXRvcnkyMzA5OTk4MjY=", "notifications_url": "https://api.github.com/repos/onedr0p/home-ops/notifications{?since,all,participating}", - "open_issues": 11, - "open_issues_count": 11, + "open_issues": 12, + "open_issues_count": 12, "owner": { "avatar_url": "https://avatars.githubusercontent.com/u/213795?v=4", "events_url": "https://api.github.com/users/onedr0p/events{/privacy}", @@ -848,7 +848,7 @@ }, "private": false, "pulls_url": "https://api.github.com/repos/onedr0p/home-ops/pulls{/number}", - "pushed_at": "2022-07-12T01:32:42Z", + "pushed_at": "2022-07-12T06:03:42Z", "releases_url": "https://api.github.com/repos/onedr0p/home-ops/releases{/id}", "size": 24595, "ssh_url": "git@github.com:onedr0p/home-ops.git", @@ -1702,8 +1702,8 @@ "network_count": 19, "node_id": "MDEwOlJlcG9zaXRvcnkyODc1MDA0NTY=", "notifications_url": "https://api.github.com/repos/bjw-s/home-ops/notifications{?since,all,participating}", - "open_issues": 10, - "open_issues_count": 10, + "open_issues": 9, + "open_issues_count": 9, "owner": { "avatar_url": "https://avatars.githubusercontent.com/u/6213398?v=4", "events_url": "https://api.github.com/users/bjw-s/events{/privacy}", @@ -1726,7 +1726,7 @@ }, "private": false, "pulls_url": "https://api.github.com/repos/bjw-s/home-ops/pulls{/number}", - "pushed_at": "2022-07-12T01:37:51Z", + "pushed_at": "2022-07-12T06:09:07Z", "releases_url": "https://api.github.com/repos/bjw-s/home-ops/releases{/id}", "size": 30635, "ssh_url": "git@github.com:bjw-s/home-ops.git", @@ -3123,8 +3123,8 @@ "network_count": 19, "node_id": "MDEwOlJlcG9zaXRvcnkxNzcxNTQ3Mzc=", "notifications_url": "https://api.github.com/repos/philips-software/embeddedinfralib/notifications{?since,all,participating}", - "open_issues": 7, - "open_issues_count": 7, + "open_issues": 6, + "open_issues_count": 6, "organization": { "avatar_url": "https://avatars.githubusercontent.com/u/39734771?v=4", "events_url": "https://api.github.com/users/philips-software/events{/privacy}", @@ -3167,7 +3167,7 @@ }, "private": false, "pulls_url": "https://api.github.com/repos/philips-software/embeddedinfralib/pulls{/number}", - "pushed_at": "2022-07-11T22:35:38Z", + "pushed_at": "2022-07-12T06:03:41Z", "releases_url": "https://api.github.com/repos/philips-software/embeddedinfralib/releases{/id}", "size": 28952, "ssh_url": "git@github.com:philips-software/embeddedinfralib.git", diff --git a/CHANGELOG.md b/CHANGELOG.md index 030ae92aedf..e17819a2f4f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), Note: Can be used with `megalinter/megalinter@beta` in your GitHub Action mega-linter.yml file, or with `megalinter/megalinter:beta` docker image - Linter versions upgrades + - [syft](https://github.com/anchore/syft) from 0.50.0 to **0.51.0** on 2022-07-12 + - [checkov](https://www.checkov.io/) from 2.1.43 to **2.1.44** on 2022-07-12 ## [v6.0.3] - 2022-07-11 diff --git a/README.md b/README.md index 32a5653ac97..8b2c90b7a59 100644 --- a/README.md +++ b/README.md @@ -178,124 +178,124 @@ All linters are integrated in the [MegaLinter docker image](https://hub.docker.c ### Languages -| | Language | Linter | Configuration key | Additional | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**BASH**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash.md#readme) | [bash-exec](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_bash_exec.md#readme) | [BASH_EXEC](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_bash_exec.md#readme) | | -| | | [shellcheck](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shellcheck.md#readme) | [BASH_SHELLCHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shellcheck.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [shfmt](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shfmt.md#readme) | [BASH_SHFMT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shfmt.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**C**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c.md#readme) | [cpplint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c_cpplint.md#readme) | [C_CPPLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c_cpplint.md#readme) | | -| | [**CLOJURE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure.md#readme) | [clj-kondo](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure_clj_kondo.md#readme) | [CLOJURE_CLJ_KONDO](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure_clj_kondo.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/borkdude/clj-kondo?cacheSeconds=3600)](https://github.com/borkdude/clj-kondo) | -| | [**COFFEE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/coffee.md#readme) | [coffeelint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/coffee_coffeelint.md#readme) | [COFFEE_COFFEELINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/coffee_coffeelint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/clutchski/coffeelint?cacheSeconds=3600)](https://github.com/clutchski/coffeelint) | -| | [**C++** (CPP)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp.md#readme) | [cpplint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp_cpplint.md#readme) | [CPP_CPPLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp_cpplint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/cpplint/cpplint?cacheSeconds=3600)](https://github.com/cpplint/cpplint) | -| | [**C#** (CSHARP)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp.md#readme) | [dotnet-format](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp_dotnet_format.md#readme) | [CSHARP_DOTNET_FORMAT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp_dotnet_format.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/dotnet/format?cacheSeconds=3600)](https://github.com/dotnet/format) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**DART**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dart.md#readme) | [dartanalyzer](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dart_dartanalyzer.md#readme) | [DART_DARTANALYZER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dart_dartanalyzer.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/dart-lang/sdk?cacheSeconds=3600)](https://github.com/dart-lang/sdk) | -| | [**GO**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go.md#readme) | [golangci-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_golangci_lint.md#readme) | [GO_GOLANGCI_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_golangci_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/golangci/golangci-lint?cacheSeconds=3600)](https://github.com/golangci/golangci-lint) | -| | | [revive](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_revive.md#readme) | [GO_REVIVE](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_revive.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/mgechev/revive?cacheSeconds=3600)](https://github.com/mgechev/revive) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**GROOVY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/groovy.md#readme) | [npm-groovy-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/groovy_npm_groovy_lint.md#readme) | [GROOVY_NPM_GROOVY_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/groovy_npm_groovy_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**JAVA**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java.md#readme) | [checkstyle](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java_checkstyle.md#readme) | [JAVA_CHECKSTYLE](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java_checkstyle.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/checkstyle/checkstyle?cacheSeconds=3600)](https://github.com/checkstyle/checkstyle) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**JAVASCRIPT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript.md#readme) | [eslint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_eslint.md#readme) | [JAVASCRIPT_ES](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_eslint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [standard](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_standard.md#readme) | [JAVASCRIPT_STANDARD](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_standard.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [prettier](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_prettier.md#readme) | [JAVASCRIPT_PRETTIER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_prettier.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**JSX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx.md#readme) | [eslint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx_eslint.md#readme) | [JSX_ESLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx_eslint.md#readme) | ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**KOTLIN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin.md#readme) | [ktlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin_ktlint.md#readme) | [KOTLIN_KTLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin_ktlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**LUA**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua.md#readme) | [luacheck](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua_luacheck.md#readme) | [LUA_LUACHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua_luacheck.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/luarocks/luacheck?cacheSeconds=3600)](https://github.com/luarocks/luacheck) | -| | [**PERL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/perl.md#readme) | [perlcritic](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/perl_perlcritic.md#readme) | [PERL_PERLCRITIC](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/perl_perlcritic.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/Perl-Critic/Perl-Critic?cacheSeconds=3600)](https://github.com/Perl-Critic/Perl-Critic) | -| | [**PHP**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php.md#readme) | [phpcs](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpcs.md#readme) | [PHP_PHPCS](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpcs.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/squizlabs/PHP_CodeSniffer?cacheSeconds=3600)](https://github.com/squizlabs/PHP_CodeSniffer) | -| | | [phpstan](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpstan.md#readme) | [PHP_PHPSTAN](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpstan.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/phpstan/phpstan?cacheSeconds=3600)](https://github.com/phpstan/phpstan) | -| | | [psalm](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_psalm.md#readme) | [PHP_PSALM](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_psalm.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/vimeo/psalm?cacheSeconds=3600)](https://github.com/vimeo/psalm) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [phplint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phplint.md#readme) | [PHP_PHPLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phplint.md#readme) | | -| | [**POWERSHELL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell.md#readme) | [powershell](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell_powershell.md#readme) | [POWERSHELL_POWERSHELL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell_powershell.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PowerShell/PSScriptAnalyzer?cacheSeconds=3600)](https://github.com/PowerShell/PSScriptAnalyzer) | -| | [**PYTHON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python.md#readme) | [pylint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_pylint.md#readme) | [PYTHON_PYLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_pylint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/pylint?cacheSeconds=3600)](https://github.com/PyCQA/pylint) | -| | | [black](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_black.md#readme) | [PYTHON_BLACK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_black.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/psf/black?cacheSeconds=3600)](https://github.com/psf/black) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [flake8](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_flake8.md#readme) | [PYTHON_FLAKE8](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_flake8.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/flake8?cacheSeconds=3600)](https://github.com/PyCQA/flake8) | -| | | [isort](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_isort.md#readme) | [PYTHON_ISORT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_isort.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/isort?cacheSeconds=3600)](https://github.com/PyCQA/isort) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [bandit](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_bandit.md#readme) | [PYTHON_BANDIT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_bandit.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/bandit?cacheSeconds=3600)](https://github.com/PyCQA/bandit) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [mypy](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_mypy.md#readme) | [PYTHON_MYPY](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_mypy.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/python/mypy?cacheSeconds=3600)](https://github.com/python/mypy) | -| | [**R**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/r.md#readme) | [lintr](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/r_lintr.md#readme) | [R_LINTR](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/r_lintr.md#readme) | | -| | [**RAKU**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/raku.md#readme) | [raku](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/raku_raku.md#readme) | [RAKU_RAKU](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/raku_raku.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rakudo/rakudo?cacheSeconds=3600)](https://github.com/rakudo/rakudo) | -| | [**RUBY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ruby.md#readme) | [rubocop](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ruby_rubocop.md#readme) | [RUBY_RUBOCOP](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ruby_rubocop.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rubocop-hq/rubocop?cacheSeconds=3600)](https://github.com/rubocop-hq/rubocop) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**RUST**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rust.md#readme) | [clippy](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rust_clippy.md#readme) | [RUST_CLIPPY](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rust_clippy.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rust-lang/rust-clippy?cacheSeconds=3600)](https://github.com/rust-lang/rust-clippy) | -| | [**SALESFORCE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce.md#readme) | [sfdx-scanner-apex](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_apex.md#readme) | [SALESFORCE_SFDX_SCANNER_APEX](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_apex.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | -| | | [sfdx-scanner-aura](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_aura.md#readme) | [SALESFORCE_SFDX_SCANNER_AURA](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_aura.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | -| | | [sfdx-scanner-lwc](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_lwc.md#readme) | [SALESFORCE_SFDX_SCANNER_LWC](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_lwc.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | -| | [**SCALA**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/scala.md#readme) | [scalafix](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/scala_scalafix.md#readme) | [SCALA_SCALAFIX](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/scala_scalafix.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/scalacenter/scalafix?cacheSeconds=3600)](https://github.com/scalacenter/scalafix) | -| | [**SQL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql.md#readme) | [sql-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sql_lint.md#readme) | [SQL_SQL_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sql_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | -| | | [sqlfluff](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sqlfluff.md#readme) | [SQL_SQLFLUFF](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sqlfluff.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | -| | | [tsqllint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_tsqllint.md#readme) | [SQL_TSQLLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_tsqllint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/tsqllint/tsqllint?cacheSeconds=3600)](https://github.com/tsqllint/tsqllint) | -| | [**SWIFT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/swift.md#readme) | [swiftlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/swift_swiftlint.md#readme) | [SWIFT_SWIFTLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/swift_swiftlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/realm/SwiftLint?cacheSeconds=3600)](https://github.com/realm/SwiftLint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**TSX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx.md#readme) | [eslint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx_eslint.md#readme) | [TSX_ESLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx_eslint.md#readme) | ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**TYPESCRIPT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript.md#readme) | [eslint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_eslint.md#readme) | [TYPESCRIPT_ES](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_eslint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [standard](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_standard.md#readme) | [TYPESCRIPT_STANDARD](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_standard.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [prettier](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_prettier.md#readme) | [TYPESCRIPT_PRETTIER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_prettier.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**Visual Basic .NET** (VBDOTNET)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/vbdotnet.md#readme) | [dotnet-format](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/vbdotnet_dotnet_format.md#readme) | [VBDOTNET_DOTNET_FORMAT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/vbdotnet_dotnet_format.md#readme) | ![formatter](https://shields.io/badge/-format-yellow) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**BASH**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash.md#readme) | [bash-exec](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_bash_exec.md#readme)| [BASH_EXEC](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_bash_exec.md#readme)| | +| | | [shellcheck](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shellcheck.md#readme)| [BASH_SHELLCHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shellcheck.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [shfmt](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shfmt.md#readme)| [BASH_SHFMT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shfmt.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**C**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c.md#readme) | [cpplint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c_cpplint.md#readme)| [C_CPPLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c_cpplint.md#readme)| | +| | [**CLOJURE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure.md#readme) | [clj-kondo](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure_clj_kondo.md#readme)| [CLOJURE_CLJ_KONDO](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure_clj_kondo.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/borkdude/clj-kondo?cacheSeconds=3600)](https://github.com/borkdude/clj-kondo) | +| | [**COFFEE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/coffee.md#readme) | [coffeelint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/coffee_coffeelint.md#readme)| [COFFEE_COFFEELINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/coffee_coffeelint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/clutchski/coffeelint?cacheSeconds=3600)](https://github.com/clutchski/coffeelint) | +| | [**C++** (CPP)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp.md#readme) | [cpplint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp_cpplint.md#readme)| [CPP_CPPLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp_cpplint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/cpplint/cpplint?cacheSeconds=3600)](https://github.com/cpplint/cpplint) | +| | [**C#** (CSHARP)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp.md#readme) | [dotnet-format](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp_dotnet_format.md#readme)| [CSHARP_DOTNET_FORMAT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp_dotnet_format.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/dotnet/format?cacheSeconds=3600)](https://github.com/dotnet/format) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**DART**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dart.md#readme) | [dartanalyzer](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dart_dartanalyzer.md#readme)| [DART_DARTANALYZER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dart_dartanalyzer.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/dart-lang/sdk?cacheSeconds=3600)](https://github.com/dart-lang/sdk) | +| | [**GO**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go.md#readme) | [golangci-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_golangci_lint.md#readme)| [GO_GOLANGCI_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_golangci_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/golangci/golangci-lint?cacheSeconds=3600)](https://github.com/golangci/golangci-lint) | +| | | [revive](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_revive.md#readme)| [GO_REVIVE](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_revive.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/mgechev/revive?cacheSeconds=3600)](https://github.com/mgechev/revive) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**GROOVY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/groovy.md#readme) | [npm-groovy-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/groovy_npm_groovy_lint.md#readme)| [GROOVY_NPM_GROOVY_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/groovy_npm_groovy_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**JAVA**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java.md#readme) | [checkstyle](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java_checkstyle.md#readme)| [JAVA_CHECKSTYLE](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java_checkstyle.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/checkstyle/checkstyle?cacheSeconds=3600)](https://github.com/checkstyle/checkstyle) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**JAVASCRIPT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript.md#readme) | [eslint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_eslint.md#readme)| [JAVASCRIPT_ES](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_eslint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [standard](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_standard.md#readme)| [JAVASCRIPT_STANDARD](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_standard.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [prettier](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_prettier.md#readme)| [JAVASCRIPT_PRETTIER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_prettier.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**JSX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx.md#readme) | [eslint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx_eslint.md#readme)| [JSX_ESLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx_eslint.md#readme)| ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**KOTLIN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin.md#readme) | [ktlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin_ktlint.md#readme)| [KOTLIN_KTLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin_ktlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**LUA**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua.md#readme) | [luacheck](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua_luacheck.md#readme)| [LUA_LUACHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua_luacheck.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/luarocks/luacheck?cacheSeconds=3600)](https://github.com/luarocks/luacheck) | +| | [**PERL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/perl.md#readme) | [perlcritic](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/perl_perlcritic.md#readme)| [PERL_PERLCRITIC](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/perl_perlcritic.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/Perl-Critic/Perl-Critic?cacheSeconds=3600)](https://github.com/Perl-Critic/Perl-Critic) | +| | [**PHP**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php.md#readme) | [phpcs](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpcs.md#readme)| [PHP_PHPCS](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpcs.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/squizlabs/PHP_CodeSniffer?cacheSeconds=3600)](https://github.com/squizlabs/PHP_CodeSniffer) | +| | | [phpstan](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpstan.md#readme)| [PHP_PHPSTAN](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpstan.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/phpstan/phpstan?cacheSeconds=3600)](https://github.com/phpstan/phpstan) | +| | | [psalm](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_psalm.md#readme)| [PHP_PSALM](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_psalm.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/vimeo/psalm?cacheSeconds=3600)](https://github.com/vimeo/psalm) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [phplint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phplint.md#readme)| [PHP_PHPLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phplint.md#readme)| | +| | [**POWERSHELL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell.md#readme) | [powershell](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell_powershell.md#readme)| [POWERSHELL_POWERSHELL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell_powershell.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PowerShell/PSScriptAnalyzer?cacheSeconds=3600)](https://github.com/PowerShell/PSScriptAnalyzer) | +| | [**PYTHON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python.md#readme) | [pylint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_pylint.md#readme)| [PYTHON_PYLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_pylint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/pylint?cacheSeconds=3600)](https://github.com/PyCQA/pylint) | +| | | [black](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_black.md#readme)| [PYTHON_BLACK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_black.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/psf/black?cacheSeconds=3600)](https://github.com/psf/black) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [flake8](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_flake8.md#readme)| [PYTHON_FLAKE8](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_flake8.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/flake8?cacheSeconds=3600)](https://github.com/PyCQA/flake8) | +| | | [isort](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_isort.md#readme)| [PYTHON_ISORT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_isort.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/isort?cacheSeconds=3600)](https://github.com/PyCQA/isort) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [bandit](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_bandit.md#readme)| [PYTHON_BANDIT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_bandit.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/bandit?cacheSeconds=3600)](https://github.com/PyCQA/bandit) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [mypy](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_mypy.md#readme)| [PYTHON_MYPY](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_mypy.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/python/mypy?cacheSeconds=3600)](https://github.com/python/mypy) | +| | [**R**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/r.md#readme) | [lintr](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/r_lintr.md#readme)| [R_LINTR](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/r_lintr.md#readme)| | +| | [**RAKU**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/raku.md#readme) | [raku](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/raku_raku.md#readme)| [RAKU_RAKU](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/raku_raku.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rakudo/rakudo?cacheSeconds=3600)](https://github.com/rakudo/rakudo) | +| | [**RUBY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ruby.md#readme) | [rubocop](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ruby_rubocop.md#readme)| [RUBY_RUBOCOP](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ruby_rubocop.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rubocop-hq/rubocop?cacheSeconds=3600)](https://github.com/rubocop-hq/rubocop) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**RUST**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rust.md#readme) | [clippy](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rust_clippy.md#readme)| [RUST_CLIPPY](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rust_clippy.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rust-lang/rust-clippy?cacheSeconds=3600)](https://github.com/rust-lang/rust-clippy) | +| | [**SALESFORCE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce.md#readme) | [sfdx-scanner-apex](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_apex.md#readme)| [SALESFORCE_SFDX_SCANNER_APEX](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_apex.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | +| | | [sfdx-scanner-aura](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_aura.md#readme)| [SALESFORCE_SFDX_SCANNER_AURA](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_aura.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | +| | | [sfdx-scanner-lwc](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_lwc.md#readme)| [SALESFORCE_SFDX_SCANNER_LWC](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_lwc.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | +| | [**SCALA**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/scala.md#readme) | [scalafix](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/scala_scalafix.md#readme)| [SCALA_SCALAFIX](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/scala_scalafix.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/scalacenter/scalafix?cacheSeconds=3600)](https://github.com/scalacenter/scalafix) | +| | [**SQL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql.md#readme) | [sql-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sql_lint.md#readme)| [SQL_SQL_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sql_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | +| | | [sqlfluff](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sqlfluff.md#readme)| [SQL_SQLFLUFF](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sqlfluff.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | +| | | [tsqllint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_tsqllint.md#readme)| [SQL_TSQLLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_tsqllint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/tsqllint/tsqllint?cacheSeconds=3600)](https://github.com/tsqllint/tsqllint) | +| | [**SWIFT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/swift.md#readme) | [swiftlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/swift_swiftlint.md#readme)| [SWIFT_SWIFTLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/swift_swiftlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/realm/SwiftLint?cacheSeconds=3600)](https://github.com/realm/SwiftLint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**TSX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx.md#readme) | [eslint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx_eslint.md#readme)| [TSX_ESLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx_eslint.md#readme)| ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**TYPESCRIPT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript.md#readme) | [eslint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_eslint.md#readme)| [TYPESCRIPT_ES](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_eslint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [standard](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_standard.md#readme)| [TYPESCRIPT_STANDARD](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_standard.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [prettier](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_prettier.md#readme)| [TYPESCRIPT_PRETTIER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_prettier.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**Visual Basic .NET** (VBDOTNET)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/vbdotnet.md#readme) | [dotnet-format](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/vbdotnet_dotnet_format.md#readme)| [VBDOTNET_DOTNET_FORMAT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/vbdotnet_dotnet_format.md#readme)| ![formatter](https://shields.io/badge/-format-yellow) | ### Formats -| | Format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**CSS**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css.md#readme) | [stylelint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_stylelint.md#readme) | [CSS_STYLELINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_stylelint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [scss-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_scss_lint.md#readme) | [CSS_SCSS_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_scss_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | -| | [**ENV**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env.md#readme) | [dotenv-linter](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env_dotenv_linter.md#readme) | [ENV_DOTENV_LINTER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env_dotenv_linter.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql.md#readme) | [graphql-schema-linter](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md#readme) | [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | -| | [**HTML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html.md#readme) | [htmlhint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_htmlhint.md#readme) | [HTML_HTMLHINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_htmlhint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | -| | [**JSON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json.md#readme) | [jsonlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_jsonlint.md#readme) | [JSON_JSONLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_jsonlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | -| | | [eslint-plugin-jsonc](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_eslint_plugin_jsonc.md#readme) | [JSON_ESLINT_PLUGIN_JSONC](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_eslint_plugin_jsonc.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [v8r](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_v8r.md#readme) | [JSON_V8R](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_v8r.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | -| | | [prettier](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_prettier.md#readme) | [JSON_PRETTIER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_prettier.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**LATEX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex.md#readme) | [chktex](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md#readme) | [LATEX_CHKTEX](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md#readme) | | -| | [**MARKDOWN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown.md#readme) | [markdownlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdownlint.md#readme) | [MARKDOWN_MARKDOWNLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdownlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [remark-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_remark_lint.md#readme) | [MARKDOWN_REMARK_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_remark_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/remarkjs/remark-lint?cacheSeconds=3600)](https://github.com/remarkjs/remark-lint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [markdown-link-check](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_link_check.md#readme) | [MARKDOWN_MARKDOWN_LINK_CHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_link_check.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | -| | | [markdown-table-formatter](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_table_formatter.md#readme) | [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_table_formatter.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**PROTOBUF**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/protobuf.md#readme) | [protolint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/protobuf_protolint.md#readme) | [PROTOBUF_PROTOLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/protobuf_protolint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**RST**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst.md#readme) | [rst-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rst_lint.md#readme) | [RST_RST_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rst_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/twolfson/restructuredtext-lint?cacheSeconds=3600)](https://github.com/twolfson/restructuredtext-lint) | -| | | [rstcheck](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rstcheck.md#readme) | [RST_RSTCHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rstcheck.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/myint/rstcheck?cacheSeconds=3600)](https://github.com/myint/rstcheck) | -| | [**XML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/xml.md#readme) | [xmllint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/xml_xmllint.md#readme) | [XML_XMLLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/xml_xmllint.md#readme) | | -| | [**YAML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml.md#readme) | [prettier](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_prettier.md#readme) | [YAML_PRETTIER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_prettier.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [yamllint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_yamllint.md#readme) | [YAML_YAMLLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_yamllint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | -| | | [v8r](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_v8r.md#readme) | [YAML_V8R](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_v8r.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | Format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**CSS**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css.md#readme) | [stylelint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_stylelint.md#readme)| [CSS_STYLELINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_stylelint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [scss-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_scss_lint.md#readme)| [CSS_SCSS_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_scss_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | +| | [**ENV**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env.md#readme) | [dotenv-linter](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env_dotenv_linter.md#readme)| [ENV_DOTENV_LINTER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env_dotenv_linter.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**GRAPHQL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql.md#readme) | [graphql-schema-linter](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md#readme)| [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**HTML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html.md#readme) | [htmlhint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_htmlhint.md#readme)| [HTML_HTMLHINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_htmlhint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | +| | [**JSON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json.md#readme) | [jsonlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_jsonlint.md#readme)| [JSON_JSONLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_jsonlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | +| | | [eslint-plugin-jsonc](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_eslint_plugin_jsonc.md#readme)| [JSON_ESLINT_PLUGIN_JSONC](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_eslint_plugin_jsonc.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [v8r](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_v8r.md#readme)| [JSON_V8R](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_v8r.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | | [prettier](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_prettier.md#readme)| [JSON_PRETTIER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_prettier.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**LATEX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex.md#readme) | [chktex](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md#readme)| [LATEX_CHKTEX](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md#readme)| | +| | [**MARKDOWN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown.md#readme) | [markdownlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdownlint.md#readme)| [MARKDOWN_MARKDOWNLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdownlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [remark-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_remark_lint.md#readme)| [MARKDOWN_REMARK_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_remark_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/remarkjs/remark-lint?cacheSeconds=3600)](https://github.com/remarkjs/remark-lint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [markdown-link-check](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_link_check.md#readme)| [MARKDOWN_MARKDOWN_LINK_CHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_link_check.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | +| | | [markdown-table-formatter](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_table_formatter.md#readme)| [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_table_formatter.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**PROTOBUF**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/protobuf.md#readme) | [protolint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/protobuf_protolint.md#readme)| [PROTOBUF_PROTOLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/protobuf_protolint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**RST**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst.md#readme) | [rst-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rst_lint.md#readme)| [RST_RST_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rst_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/twolfson/restructuredtext-lint?cacheSeconds=3600)](https://github.com/twolfson/restructuredtext-lint) | +| | | [rstcheck](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rstcheck.md#readme)| [RST_RSTCHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rstcheck.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/myint/rstcheck?cacheSeconds=3600)](https://github.com/myint/rstcheck) | +| | [**XML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/xml.md#readme) | [xmllint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/xml_xmllint.md#readme)| [XML_XMLLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/xml_xmllint.md#readme)| | +| | [**YAML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml.md#readme) | [prettier](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_prettier.md#readme)| [YAML_PRETTIER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_prettier.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [yamllint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_yamllint.md#readme)| [YAML_YAMLLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_yamllint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | +| | | [v8r](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_v8r.md#readme)| [YAML_V8R](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_v8r.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | ### Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ACTION**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action.md#readme) | [actionlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action_actionlint.md#readme) | [ACTION_ACTIONLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action_actionlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | -| | [**ANSIBLE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ansible.md#readme) | [ansible-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ansible_ansible_lint.md#readme) | [ANSIBLE_ANSIBLE_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ansible_ansible_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | -| | [**ARM**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/arm.md#readme) | [arm-ttk](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/arm_arm_ttk.md#readme) | [ARM_ARM_TTK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/arm_arm_ttk.md#readme) | | -| | [**CLOUDFORMATION**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cloudformation.md#readme) | [cfn-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cloudformation_cfn_lint.md#readme) | [CLOUDFORMATION_CFN_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cloudformation_cfn_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/aws-cloudformation/cfn-lint?cacheSeconds=3600)](https://github.com/aws-cloudformation/cfn-lint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**DOCKERFILE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dockerfile.md#readme) | [hadolint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dockerfile_hadolint.md#readme) | [DOCKERFILE_HADOLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dockerfile_hadolint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**EDITORCONFIG**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/editorconfig.md#readme) | [editorconfig-checker](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/editorconfig_editorconfig_checker.md#readme) | [EDITORCONFIG_EDITORCONFIG_CHECKER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/editorconfig_editorconfig_checker.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | -| | [**GHERKIN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/gherkin.md#readme) | [gherkin-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/gherkin_gherkin_lint.md#readme) | [GHERKIN_GHERKIN_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/gherkin_gherkin_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/vsiakka/gherkin-lint?cacheSeconds=3600)](https://github.com/vsiakka/gherkin-lint) | -| | [**KUBERNETES**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes.md#readme) | [kubeval](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeval.md#readme) | [KUBERNETES_KUBEVAL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeval.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | -| | | [kubeconform](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeconform.md#readme) | [KUBERNETES_KUBECONFORM](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeconform.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | -| | [**OPENAPI**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/openapi.md#readme) | [spectral](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/openapi_spectral.md#readme) | [OPENAPI_SPECTRAL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/openapi_spectral.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | -| | [**PUPPET**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/puppet.md#readme) | [puppet-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/puppet_puppet_lint.md#readme) | [PUPPET_PUPPET_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/puppet_puppet_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rodjek/puppet-lint?cacheSeconds=3600)](https://github.com/rodjek/puppet-lint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**SNAKEMAKE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake.md#readme) | [snakemake](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakemake.md#readme) | [SNAKEMAKE_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakemake.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | -| | | [snakefmt](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakefmt.md#readme) | [SNAKEMAKE_SNAKEFMT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakefmt.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakefmt?cacheSeconds=3600)](https://github.com/snakemake/snakefmt) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**TEKTON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tekton.md#readme) | [tekton-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tekton_tekton_lint.md#readme) | [TEKTON_TEKTON_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tekton_tekton_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | -| | [**TERRAFORM**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform.md#readme) | [tflint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_tflint.md#readme) | [TERRAFORM_TFLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_tflint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/terraform-linters/tflint?cacheSeconds=3600)](https://github.com/terraform-linters/tflint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [terrascan](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terrascan.md#readme) | [TERRAFORM_TERRASCAN](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terrascan.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/accurics/terrascan?cacheSeconds=3600)](https://github.com/accurics/terrascan) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [terragrunt](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terragrunt.md#readme) | [TERRAFORM_TERRAGRUNT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terragrunt.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/gruntwork-io/terragrunt?cacheSeconds=3600)](https://github.com/gruntwork-io/terragrunt) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [terraform-fmt](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terraform_fmt.md#readme) | [TERRAFORM_TERRAFORM_FMT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terraform_fmt.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/hashicorp/terraform?cacheSeconds=3600)](https://github.com/hashicorp/terraform) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [checkov](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_checkov.md#readme) | [TERRAFORM_CHECKOV](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_checkov.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/bridgecrewio/checkov?cacheSeconds=3600)](https://github.com/bridgecrewio/checkov) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [kics](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_kics.md#readme) | [TERRAFORM_KICS](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_kics.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/checkmarx/kics?cacheSeconds=3600)](https://github.com/checkmarx/kics) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ACTION**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action.md#readme) | [actionlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action_actionlint.md#readme)| [ACTION_ACTIONLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action_actionlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | +| | [**ANSIBLE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ansible.md#readme) | [ansible-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ansible_ansible_lint.md#readme)| [ANSIBLE_ANSIBLE_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ansible_ansible_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | +| | [**ARM**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/arm.md#readme) | [arm-ttk](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/arm_arm_ttk.md#readme)| [ARM_ARM_TTK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/arm_arm_ttk.md#readme)| | +| | [**CLOUDFORMATION**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cloudformation.md#readme) | [cfn-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cloudformation_cfn_lint.md#readme)| [CLOUDFORMATION_CFN_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cloudformation_cfn_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/aws-cloudformation/cfn-lint?cacheSeconds=3600)](https://github.com/aws-cloudformation/cfn-lint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**DOCKERFILE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dockerfile.md#readme) | [hadolint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dockerfile_hadolint.md#readme)| [DOCKERFILE_HADOLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dockerfile_hadolint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**EDITORCONFIG**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/editorconfig.md#readme) | [editorconfig-checker](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/editorconfig_editorconfig_checker.md#readme)| [EDITORCONFIG_EDITORCONFIG_CHECKER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/editorconfig_editorconfig_checker.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | +| | [**GHERKIN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/gherkin.md#readme) | [gherkin-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/gherkin_gherkin_lint.md#readme)| [GHERKIN_GHERKIN_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/gherkin_gherkin_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/vsiakka/gherkin-lint?cacheSeconds=3600)](https://github.com/vsiakka/gherkin-lint) | +| | [**KUBERNETES**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes.md#readme) | [kubeval](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeval.md#readme)| [KUBERNETES_KUBEVAL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeval.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | +| | | [kubeconform](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeconform.md#readme)| [KUBERNETES_KUBECONFORM](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeconform.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | +| | [**OPENAPI**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/openapi.md#readme) | [spectral](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/openapi_spectral.md#readme)| [OPENAPI_SPECTRAL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/openapi_spectral.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | +| | [**PUPPET**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/puppet.md#readme) | [puppet-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/puppet_puppet_lint.md#readme)| [PUPPET_PUPPET_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/puppet_puppet_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rodjek/puppet-lint?cacheSeconds=3600)](https://github.com/rodjek/puppet-lint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**SNAKEMAKE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake.md#readme) | [snakemake](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakemake.md#readme)| [SNAKEMAKE_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakemake.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | +| | | [snakefmt](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakefmt.md#readme)| [SNAKEMAKE_SNAKEFMT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakefmt.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakefmt?cacheSeconds=3600)](https://github.com/snakemake/snakefmt) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**TEKTON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tekton.md#readme) | [tekton-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tekton_tekton_lint.md#readme)| [TEKTON_TEKTON_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tekton_tekton_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | +| | [**TERRAFORM**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform.md#readme) | [tflint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_tflint.md#readme)| [TERRAFORM_TFLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_tflint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/terraform-linters/tflint?cacheSeconds=3600)](https://github.com/terraform-linters/tflint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [terrascan](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terrascan.md#readme)| [TERRAFORM_TERRASCAN](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terrascan.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/accurics/terrascan?cacheSeconds=3600)](https://github.com/accurics/terrascan) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [terragrunt](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terragrunt.md#readme)| [TERRAFORM_TERRAGRUNT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terragrunt.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/gruntwork-io/terragrunt?cacheSeconds=3600)](https://github.com/gruntwork-io/terragrunt) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [terraform-fmt](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terraform_fmt.md#readme)| [TERRAFORM_TERRAFORM_FMT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terraform_fmt.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/hashicorp/terraform?cacheSeconds=3600)](https://github.com/hashicorp/terraform) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [checkov](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_checkov.md#readme)| [TERRAFORM_CHECKOV](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_checkov.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/bridgecrewio/checkov?cacheSeconds=3600)](https://github.com/bridgecrewio/checkov) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [kics](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_kics.md#readme)| [TERRAFORM_KICS](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_kics.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/checkmarx/kics?cacheSeconds=3600)](https://github.com/checkmarx/kics) | ### Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**COPYPASTE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/copypaste.md#readme) | [jscpd](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/copypaste_jscpd.md#readme) | [COPYPASTE_JSCPD](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/copypaste_jscpd.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | -| | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md#readme) | [devskim](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_devskim.md#readme) | [REPOSITORY_DEVSKIM](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_devskim.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/microsoft/DevSkim?cacheSeconds=3600)](https://github.com/microsoft/DevSkim) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [dustilock](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_dustilock.md#readme) | [REPOSITORY_DUSTILOCK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_dustilock.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/Checkmarx/dustilock?cacheSeconds=3600)](https://github.com/Checkmarx/dustilock) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [git_diff](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_git_diff.md#readme) | [REPOSITORY_GIT_DIFF](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_git_diff.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | -| | | [gitleaks](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_gitleaks.md#readme) | [REPOSITORY_GITLEAKS](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_gitleaks.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [goodcheck](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_goodcheck.md#readme) | [REPOSITORY_GOODCHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_goodcheck.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | -| | | [secretlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_secretlint.md#readme) | [REPOSITORY_SECRETLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_secretlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [semgrep](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_semgrep.md#readme) | [REPOSITORY_SEMGREP](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_semgrep.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [syft](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_syft.md#readme) | [REPOSITORY_SYFT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_syft.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/anchore/syft?cacheSeconds=3600)](https://github.com/anchore/syft) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_trivy.md#readme) | [REPOSITORY_TRIVY](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_trivy.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SPELL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell.md#readme) | [misspell](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_misspell.md#readme) | [SPELL_MISSPELL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_misspell.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [cspell](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_cspell.md#readme) | [SPELL_CSPELL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_cspell.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**COPYPASTE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/copypaste.md#readme) | [jscpd](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/copypaste_jscpd.md#readme)| [COPYPASTE_JSCPD](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/copypaste_jscpd.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | +| | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md#readme) | [devskim](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_devskim.md#readme)| [REPOSITORY_DEVSKIM](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_devskim.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/microsoft/DevSkim?cacheSeconds=3600)](https://github.com/microsoft/DevSkim) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [dustilock](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_dustilock.md#readme)| [REPOSITORY_DUSTILOCK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_dustilock.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/Checkmarx/dustilock?cacheSeconds=3600)](https://github.com/Checkmarx/dustilock) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [git_diff](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_git_diff.md#readme)| [REPOSITORY_GIT_DIFF](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_git_diff.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | +| | | [gitleaks](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_gitleaks.md#readme)| [REPOSITORY_GITLEAKS](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_gitleaks.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [goodcheck](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_goodcheck.md#readme)| [REPOSITORY_GOODCHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_goodcheck.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | +| | | [secretlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_secretlint.md#readme)| [REPOSITORY_SECRETLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_secretlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [semgrep](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_semgrep.md#readme)| [REPOSITORY_SEMGREP](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_semgrep.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [syft](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_syft.md#readme)| [REPOSITORY_SYFT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_syft.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/anchore/syft?cacheSeconds=3600)](https://github.com/anchore/syft) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_trivy.md#readme)| [REPOSITORY_TRIVY](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_trivy.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SPELL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell.md#readme) | [misspell](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_misspell.md#readme)| [SPELL_MISSPELL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_misspell.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [cspell](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_cspell.md#readme)| [SPELL_CSPELL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_cspell.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | @@ -827,23 +827,23 @@ To improve run performances, we generate **Flavored MegaLinter images** containi _The following table does not display docker pulls from [MegaLinter v4 images](https://hub.docker.com/r/nvuillam/mega-linter)._ -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/ci_light.md#readme) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/documentation.md#readme) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/dotnet.md#readme) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/go.md#readme) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/java.md#readme) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/javascript.md#readme) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/php.md#readme) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/python.md#readme) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/ruby.md#readme) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/rust.md#readme) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/salesforce.md#readme) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [security](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/security.md#readme) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | -| | [swift](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/swift.md#readme) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/terraform.md#readme) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/ci_light.md#readme) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/documentation.md#readme) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/dotnet.md#readme) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/go.md#readme) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/java.md#readme) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/javascript.md#readme) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/php.md#readme) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/python.md#readme) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/ruby.md#readme) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/rust.md#readme) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/salesforce.md#readme) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [security](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/security.md#readme) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | [swift](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/swift.md#readme) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://github.com/oxsecurity/megalinter/tree/main/docs/flavors/terraform.md#readme) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | If you need a new flavor, [post an issue](https://github.com/oxsecurity/megalinter/issues) :wink: diff --git a/docs/all_linters.md b/docs/all_linters.md index e4504155c07..88db6ec1a7b 100644 --- a/docs/all_linters.md +++ b/docs/all_linters.md @@ -3,96 +3,96 @@ # References -| Linter | Version | License | Popularity | Descriptors | Ref | URL | -|:--------------------------------------------------------------------------------------------------------|:--------------:|:-------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------:| -| [**actionlint**](https://github.com/rhysd/actionlint){target=_blank} | 1.6.15 | [MIT](licenses/actionlint.md) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint){target=_blank} | [ACTION](descriptors/action_actionlint.md) | :white_circle: | [Repository](https://github.com/rhysd/actionlint){target=_blank} | -| [**ansible-lint**](https://github.com/ansible/ansible-lint){target=_blank} | 6.0.2 | [GPL-3.0](licenses/ansible-lint.md) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint){target=_blank} | [ANSIBLE](descriptors/ansible_ansible_lint.md) | :white_circle: | [Repository](https://github.com/ansible/ansible-lint){target=_blank} | -| [**arm-ttk**](https://github.com/Azure/arm-ttk){target=_blank} | N/A | | | [ARM](descriptors/arm_arm_ttk.md) | :white_circle: | [Web Site](https://github.com/Azure/arm-ttk){target=_blank} | -| [**bandit**](https://github.com/PyCQA/bandit){target=_blank} | 1.7.4 | [Apache-2.0](licenses/bandit.md) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/bandit?cacheSeconds=3600)](https://github.com/PyCQA/bandit){target=_blank} | [PYTHON](descriptors/python_bandit.md) | :white_circle: | [Repository](https://github.com/PyCQA/bandit){target=_blank} | -| [**bash-exec**](https://tiswww.case.edu/php/chet/bash/bashtop.html){target=_blank} | 5.1.16 | | | [BASH](descriptors/bash_bash_exec.md) | | [Web Site](https://tiswww.case.edu/php/chet/bash/bashtop.html){target=_blank} | -| [**black**](https://github.com/psf/black){target=_blank} | 22.6.0 | [MIT](licenses/black.md) | [![GitHub stars](https://img.shields.io/github/stars/psf/black?cacheSeconds=3600)](https://github.com/psf/black){target=_blank} | [PYTHON](descriptors/python_black.md) | :white_circle: | [Repository](https://github.com/psf/black){target=_blank} | -| [**cfn-lint**](https://github.com/aws-cloudformation/cfn-lint){target=_blank} | 0.61.2 | [MIT-0](licenses/cfn-lint.md) | [![GitHub stars](https://img.shields.io/github/stars/aws-cloudformation/cfn-lint?cacheSeconds=3600)](https://github.com/aws-cloudformation/cfn-lint){target=_blank} | [CLOUDFORMATION](descriptors/cloudformation_cfn_lint.md) | :white_circle: | [Repository](https://github.com/aws-cloudformation/cfn-lint){target=_blank} | -| [**checkov**](https://github.com/bridgecrewio/checkov){target=_blank} | 2.1.43 | [Apache-2.0](licenses/checkov.md) | [![GitHub stars](https://img.shields.io/github/stars/bridgecrewio/checkov?cacheSeconds=3600)](https://github.com/bridgecrewio/checkov){target=_blank} | [TERRAFORM](descriptors/terraform_checkov.md) | :no_entry_sign: | [Repository](https://github.com/bridgecrewio/checkov){target=_blank} | -| [**checkstyle**](https://github.com/checkstyle/checkstyle){target=_blank} | 10.3.1 | [LGPL-2.1](licenses/checkstyle.md) | [![GitHub stars](https://img.shields.io/github/stars/checkstyle/checkstyle?cacheSeconds=3600)](https://github.com/checkstyle/checkstyle){target=_blank} | [JAVA](descriptors/java_checkstyle.md) | :heart: | [MegaLinter reference](https://checkstyle.sourceforge.io/index.html#Related_Tools_Active_Tools){target=_blank} | -| [**chktex**](https://www.nongnu.org/chktex){target=_blank} | 1.7.6 | | | [LATEX](descriptors/latex_chktex.md) | :white_circle: | [Web Site](https://www.nongnu.org/chktex){target=_blank} | -| [**clippy**](https://github.com/rust-lang/rust-clippy){target=_blank} | 0.1.62 | | [![GitHub stars](https://img.shields.io/github/stars/rust-lang/rust-clippy?cacheSeconds=3600)](https://github.com/rust-lang/rust-clippy){target=_blank} | [RUST](descriptors/rust_clippy.md) | :white_circle: | [Repository](https://github.com/rust-lang/rust-clippy){target=_blank} | -| [**clj-kondo**](https://github.com/borkdude/clj-kondo){target=_blank} | 2022.04.25 | | [![GitHub stars](https://img.shields.io/github/stars/borkdude/clj-kondo?cacheSeconds=3600)](https://github.com/borkdude/clj-kondo){target=_blank} | [CLOJURE](descriptors/clojure_clj_kondo.md) | :heart: | [MegaLinter reference](https://github.com/borkdude/clj-kondo/blob/master/doc/ci-integration.md#github){target=_blank} | -| [**coffeelint**](https://github.com/clutchski/coffeelint){target=_blank} | 5.2.9 | [Other](licenses/coffeelint.md) | [![GitHub stars](https://img.shields.io/github/stars/clutchski/coffeelint?cacheSeconds=3600)](https://github.com/clutchski/coffeelint){target=_blank} | [COFFEE](descriptors/coffee_coffeelint.md) | :white_circle: | [Repository](https://github.com/clutchski/coffeelint){target=_blank} | -| [**cpplint**](https://github.com/cpplint/cpplint){target=_blank} | 1.6.0 | | | [C](descriptors/c_cpplint.md)
[CPP](descriptors/cpp_cpplint.md) | :white_circle: | [Web Site](https://github.com/cpplint/cpplint){target=_blank} | -| [**cspell**](https://github.com/streetsidesoftware/cspell){target=_blank} | 6.2.3 | [MIT](licenses/cspell.md) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell){target=_blank} | [SPELL](descriptors/spell_cspell.md) | :heart: | [MegaLinter reference](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell#mega-linter){target=_blank} | -| [**dartanalyzer**](https://github.com/dart-lang/sdk){target=_blank} | N/A | [BSD-3-Clause](licenses/dartanalyzer.md) | [![GitHub stars](https://img.shields.io/github/stars/dart-lang/sdk?cacheSeconds=3600)](https://github.com/dart-lang/sdk){target=_blank} | [DART](descriptors/dart_dartanalyzer.md) | :no_entry_sign: | [Repository](https://github.com/dart-lang/sdk){target=_blank} | -| [**devskim**](https://github.com/microsoft/DevSkim){target=_blank} | 0.6.9 | [MIT](licenses/devskim.md) | [![GitHub stars](https://img.shields.io/github/stars/microsoft/DevSkim?cacheSeconds=3600)](https://github.com/microsoft/DevSkim){target=_blank} | [REPOSITORY](descriptors/repository_devskim.md) | :white_circle: | [Repository](https://github.com/microsoft/DevSkim){target=_blank} | -| [**dotenv-linter**](https://github.com/dotenv-linter/dotenv-linter){target=_blank} | 3.2.0 | [MIT](licenses/dotenv-linter.md) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter){target=_blank} | [ENV](descriptors/env_dotenv_linter.md) | :heart: | [MegaLinter reference](https://dotenv-linter.github.io/#/integrations/mega_linter){target=_blank} | -| [**dotnet-format**](https://github.com/dotnet/format){target=_blank} | 000 | [MIT](licenses/dotnet-format.md) | [![GitHub stars](https://img.shields.io/github/stars/dotnet/format?cacheSeconds=3600)](https://github.com/dotnet/format){target=_blank} | [CSHARP](descriptors/csharp_dotnet_format.md)
[VBDOTNET](descriptors/vbdotnet_dotnet_format.md) | :white_circle: | [Repository](https://github.com/dotnet/format){target=_blank} | -| [**dustilock**](https://github.com/Checkmarx/dustilock){target=_blank} | N/A | [Apache-2.0](licenses/dustilock.md) | [![GitHub stars](https://img.shields.io/github/stars/Checkmarx/dustilock?cacheSeconds=3600)](https://github.com/Checkmarx/dustilock){target=_blank} | [REPOSITORY](descriptors/repository_dustilock.md) | :white_circle: | [Repository](https://github.com/Checkmarx/dustilock){target=_blank} | -| [**editorconfig-checker**](https://github.com/editorconfig-checker/editorconfig-checker){target=_blank} | 2.4.0 | [MIT](licenses/editorconfig-checker.md) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker){target=_blank} | [EDITORCONFIG](descriptors/editorconfig_editorconfig_checker.md) | :heart: | [MegaLinter reference](https://github.com/editorconfig-checker/editorconfig-checker#mega-linter){target=_blank} | -| [**eslint**](https://github.com/eslint/eslint){target=_blank} | 8.19.0 | [MIT](licenses/eslint.md) | [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint){target=_blank} | [JAVASCRIPT](descriptors/javascript_eslint.md)
[JSX](descriptors/jsx_eslint.md)
[TSX](descriptors/tsx_eslint.md)
[TYPESCRIPT](descriptors/typescript_eslint.md) | :heart: | [MegaLinter reference](https://eslint.org/docs/user-guide/integrations#source-control){target=_blank} | -| [**eslint-plugin-jsonc**](https://github.com/ota-meshi/eslint-plugin-jsonc){target=_blank} | 2.3.1 | [MIT](licenses/eslint-plugin-jsonc.md) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc){target=_blank} | [JSON](descriptors/json_eslint_plugin_jsonc.md) | :heart: | [MegaLinter reference](https://eslint.org/docs/user-guide/integrations#source-control){target=_blank} | -| [**flake8**](https://github.com/PyCQA/flake8){target=_blank} | 4.0.1 | [MIT](licenses/flake8.md) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/flake8?cacheSeconds=3600)](https://github.com/PyCQA/flake8){target=_blank} | [PYTHON](descriptors/python_flake8.md) | :white_circle: | [Repository](https://github.com/PyCQA/flake8){target=_blank} | -| [**gherkin-lint**](https://github.com/vsiakka/gherkin-lint){target=_blank} | N/A | [ISC](licenses/gherkin-lint.md) | [![GitHub stars](https://img.shields.io/github/stars/vsiakka/gherkin-lint?cacheSeconds=3600)](https://github.com/vsiakka/gherkin-lint){target=_blank} | [GHERKIN](descriptors/gherkin_gherkin_lint.md) | :white_circle: | [Repository](https://github.com/vsiakka/gherkin-lint){target=_blank} | -| [**git_diff**](https://github.com/git/git){target=_blank} | 2.34.2 | [LGPL-2.1](licenses/git_diff.md) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git){target=_blank} | [REPOSITORY](descriptors/repository_git_diff.md) | | [Repository](https://github.com/git/git){target=_blank} | -| [**gitleaks**](https://github.com/zricethezav/gitleaks){target=_blank} | 8.8.7 | [MIT](licenses/gitleaks.md) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks){target=_blank} | [REPOSITORY](descriptors/repository_gitleaks.md) | :white_circle: | [Repository](https://github.com/zricethezav/gitleaks){target=_blank} | -| [**golangci-lint**](https://github.com/golangci/golangci-lint){target=_blank} | 1.46.2 | [GPL-3.0](licenses/golangci-lint.md) | [![GitHub stars](https://img.shields.io/github/stars/golangci/golangci-lint?cacheSeconds=3600)](https://github.com/golangci/golangci-lint){target=_blank} | [GO](descriptors/go_golangci_lint.md) | :white_circle: | [Repository](https://github.com/golangci/golangci-lint){target=_blank} | -| [**goodcheck**](https://github.com/sider/goodcheck){target=_blank} | 3.1.0 | [MIT](licenses/goodcheck.md) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck){target=_blank} | [REPOSITORY](descriptors/repository_goodcheck.md) | :white_circle: | [Repository](https://github.com/sider/goodcheck){target=_blank} | -| [**graphql-schema-linter**](https://github.com/cjoudrey/graphql-schema-linter){target=_blank} | 3.0.1 | [MIT](licenses/graphql-schema-linter.md) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter){target=_blank} | [GRAPHQL](descriptors/graphql_graphql_schema_linter.md) | :hammer_and_wrench: | [Pull Request](https://github.com/cjoudrey/graphql-schema-linter/pull/272){target=_blank} | -| [**hadolint**](https://github.com/hadolint/hadolint){target=_blank} | 2.10.0 | [GPL-3.0](licenses/hadolint.md) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint){target=_blank} | [DOCKERFILE](descriptors/dockerfile_hadolint.md) | :heart: | [MegaLinter reference](https://github.com/hadolint/hadolint/blob/master/docs/INTEGRATION.md#mega-linter){target=_blank} | -| [**htmlhint**](https://github.com/htmlhint/HTMLHint){target=_blank} | 1.1.4 | [MIT](licenses/htmlhint.md) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint){target=_blank} | [HTML](descriptors/html_htmlhint.md) | :heart: | [MegaLinter reference](https://htmlhint.com/docs/user-guide/integrations/task-runner){target=_blank} | -| [**isort**](https://github.com/PyCQA/isort){target=_blank} | 5.10.1 | [MIT](licenses/isort.md) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/isort?cacheSeconds=3600)](https://github.com/PyCQA/isort){target=_blank} | [PYTHON](descriptors/python_isort.md) | :white_circle: | [Repository](https://github.com/PyCQA/isort){target=_blank} | -| [**jscpd**](https://github.com/kucherenko/jscpd){target=_blank} | 3.3.26 | [MIT](licenses/jscpd.md) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd){target=_blank} | [COPYPASTE](descriptors/copypaste_jscpd.md) | :heart: | [MegaLinter reference](https://github.com/kucherenko/jscpd#who-uses-jscpd){target=_blank} | -| [**jsonlint**](https://github.com/zaach/jsonlint){target=_blank} | 1.6.3 | | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint){target=_blank} | [JSON](descriptors/json_jsonlint.md) | :hammer_and_wrench: | [Pull Request](https://github.com/zaach/jsonlint/pull/127){target=_blank} | -| [**kics**](https://github.com/checkmarx/kics){target=_blank} | 1.5.11 | [Apache-2.0](licenses/kics.md) | [![GitHub stars](https://img.shields.io/github/stars/checkmarx/kics?cacheSeconds=3600)](https://github.com/checkmarx/kics){target=_blank} | [TERRAFORM](descriptors/terraform_kics.md) | :heart: | [MegaLinter reference](https://docs.kics.io/latest/integrations/){target=_blank} | -| [**ktlint**](https://github.com/pinterest/ktlint){target=_blank} | 0.46.1 | [MIT](licenses/ktlint.md) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint){target=_blank} | [KOTLIN](descriptors/kotlin_ktlint.md) | :heart: | [MegaLinter reference](https://github.com/pinterest/ktlint#-with-continuous-integration){target=_blank} | -| [**kubeconform**](https://github.com/yannh/kubeconform){target=_blank} | 0.4.12 | [Other](licenses/kubeconform.md) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform){target=_blank} | [KUBERNETES](descriptors/kubernetes_kubeconform.md) | :white_circle: | [Repository](https://github.com/yannh/kubeconform){target=_blank} | -| [**kubeval**](https://github.com/instrumenta/kubeval){target=_blank} | 0.16.1 | [Apache-2.0](licenses/kubeval.md) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval){target=_blank} | [KUBERNETES](descriptors/kubernetes_kubeval.md) | :white_circle: | [Repository](https://github.com/instrumenta/kubeval){target=_blank} | -| [**lintr**](https://lintr.r-lib.org/){target=_blank} | N/A | | | [R](descriptors/r_lintr.md) | :white_circle: | [Web Site](https://lintr.r-lib.org/){target=_blank} | -| [**luacheck**](https://github.com/luarocks/luacheck){target=_blank} | 0.26.1 | [MIT](licenses/luacheck.md) | [![GitHub stars](https://img.shields.io/github/stars/luarocks/luacheck?cacheSeconds=3600)](https://github.com/luarocks/luacheck){target=_blank} | [LUA](descriptors/lua_luacheck.md) | :no_entry_sign: | [Repository](https://github.com/luarocks/luacheck){target=_blank} | -| [**markdown-link-check**](https://github.com/tcort/markdown-link-check){target=_blank} | 3.10.2 | | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check){target=_blank} | [MARKDOWN](descriptors/markdown_markdown_link_check.md) | :heart: | [MegaLinter reference](https://github.com/tcort/markdown-link-check#run-in-other-tools){target=_blank} | -| [**markdown-table-formatter**](https://github.com/nvuillam/markdown-table-formatter){target=_blank} | 1.3.0 | [MIT](licenses/markdown-table-formatter.md) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter){target=_blank} | [MARKDOWN](descriptors/markdown_markdown_table_formatter.md) | :white_circle: | [Repository](https://github.com/nvuillam/markdown-table-formatter){target=_blank} | -| [**markdownlint**](https://github.com/DavidAnson/markdownlint){target=_blank} | 0.31.1 | | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint){target=_blank} | [MARKDOWN](descriptors/markdown_markdownlint.md) | :white_circle: | [Repository](https://github.com/DavidAnson/markdownlint){target=_blank} | -| [**misspell**](https://github.com/client9/misspell){target=_blank} | 0.3.4 | | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell){target=_blank} | [SPELL](descriptors/spell_misspell.md) | :white_circle: | [Repository](https://github.com/client9/misspell){target=_blank} | -| [**mypy**](https://github.com/python/mypy){target=_blank} | 0.961 | [MIT](licenses/mypy.md) | [![GitHub stars](https://img.shields.io/github/stars/python/mypy?cacheSeconds=3600)](https://github.com/python/mypy){target=_blank} | [PYTHON](descriptors/python_mypy.md) | | [Repository](https://github.com/python/mypy){target=_blank} | -| [**npm-groovy-lint**](https://github.com/nvuillam/npm-groovy-lint){target=_blank} | 9.5.0 | [GPL-3.0](licenses/npm-groovy-lint.md) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint){target=_blank} | [GROOVY](descriptors/groovy_npm_groovy_lint.md) | :heart: | [MegaLinter reference](https://nvuillam.github.io/npm-groovy-lint/#mega-linter){target=_blank} | -| [**perlcritic**](https://github.com/Perl-Critic/Perl-Critic){target=_blank} | 1.140 | [Other](licenses/perlcritic.md) | [![GitHub stars](https://img.shields.io/github/stars/Perl-Critic/Perl-Critic?cacheSeconds=3600)](https://github.com/Perl-Critic/Perl-Critic){target=_blank} | [PERL](descriptors/perl_perlcritic.md) | :white_circle: | [Repository](https://github.com/Perl-Critic/Perl-Critic){target=_blank} | -| [**phpcs**](https://github.com/squizlabs/PHP_CodeSniffer){target=_blank} | 3.7.1 | | [![GitHub stars](https://img.shields.io/github/stars/squizlabs/PHP_CodeSniffer?cacheSeconds=3600)](https://github.com/squizlabs/PHP_CodeSniffer){target=_blank} | [PHP](descriptors/php_phpcs.md) | :white_circle: | [Repository](https://github.com/squizlabs/PHP_CodeSniffer){target=_blank} | -| [**phplint**](https://github.com/overtrue/phplint){target=_blank} | 3.0 | | | [PHP](descriptors/php_phplint.md) | :white_circle: | [Web Site](https://github.com/overtrue/phplint){target=_blank} | -| [**phpstan**](https://github.com/phpstan/phpstan){target=_blank} | 1.8.0 | [MIT](licenses/phpstan.md) | [![GitHub stars](https://img.shields.io/github/stars/phpstan/phpstan?cacheSeconds=3600)](https://github.com/phpstan/phpstan){target=_blank} | [PHP](descriptors/php_phpstan.md) | :white_circle: | [Repository](https://github.com/phpstan/phpstan){target=_blank} | -| [**powershell**](https://github.com/PowerShell/PSScriptAnalyzer){target=_blank} | 7.2.5 | | [![GitHub stars](https://img.shields.io/github/stars/PowerShell/PSScriptAnalyzer?cacheSeconds=3600)](https://github.com/PowerShell/PSScriptAnalyzer){target=_blank} | [POWERSHELL](descriptors/powershell_powershell.md) | :white_circle: | [Repository](https://github.com/PowerShell/PSScriptAnalyzer){target=_blank} | -| [**prettier**](https://github.com/prettier/prettier){target=_blank} | 2.7.1 | [MIT](licenses/prettier.md) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier){target=_blank} | [JAVASCRIPT](descriptors/javascript_prettier.md)
[JSON](descriptors/json_prettier.md)
[TYPESCRIPT](descriptors/typescript_prettier.md)
[YAML](descriptors/yaml_prettier.md) | :white_circle: | [Repository](https://github.com/prettier/prettier){target=_blank} | -| [**protolint**](https://github.com/yoheimuta/protolint){target=_blank} | 0.38.2 | | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint){target=_blank} | [PROTOBUF](descriptors/protobuf_protolint.md) | :white_circle: | [Repository](https://github.com/yoheimuta/protolint){target=_blank} | -| [**psalm**](https://github.com/vimeo/psalm){target=_blank} | Psalm.5.x-dev@ | [MIT](licenses/psalm.md) | [![GitHub stars](https://img.shields.io/github/stars/vimeo/psalm?cacheSeconds=3600)](https://github.com/vimeo/psalm){target=_blank} | [PHP](descriptors/php_psalm.md) | :white_circle: | [Repository](https://github.com/vimeo/psalm){target=_blank} | -| [**puppet-lint**](https://github.com/rodjek/puppet-lint){target=_blank} | 2.5.2 | [MIT](licenses/puppet-lint.md) | [![GitHub stars](https://img.shields.io/github/stars/rodjek/puppet-lint?cacheSeconds=3600)](https://github.com/rodjek/puppet-lint){target=_blank} | [PUPPET](descriptors/puppet_puppet_lint.md) | :white_circle: | [Repository](https://github.com/rodjek/puppet-lint){target=_blank} | -| [**pylint**](https://github.com/PyCQA/pylint){target=_blank} | 2.14.4 | [GPL-2.0](licenses/pylint.md) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/pylint?cacheSeconds=3600)](https://github.com/PyCQA/pylint){target=_blank} | [PYTHON](descriptors/python_pylint.md) | :white_circle: | [Repository](https://github.com/PyCQA/pylint){target=_blank} | -| [**raku**](https://github.com/rakudo/rakudo){target=_blank} | 2020.10 | [Artistic-2.0](licenses/raku.md) | [![GitHub stars](https://img.shields.io/github/stars/rakudo/rakudo?cacheSeconds=3600)](https://github.com/rakudo/rakudo){target=_blank} | [RAKU](descriptors/raku_raku.md) | :white_circle: | [Repository](https://github.com/rakudo/rakudo){target=_blank} | -| [**remark-lint**](https://github.com/remarkjs/remark-lint){target=_blank} | 14.0.2 | [MIT](licenses/remark-lint.md) | [![GitHub stars](https://img.shields.io/github/stars/remarkjs/remark-lint?cacheSeconds=3600)](https://github.com/remarkjs/remark-lint){target=_blank} | [MARKDOWN](descriptors/markdown_remark_lint.md) | :white_circle: | [Repository](https://github.com/remarkjs/remark-lint){target=_blank} | -| [**revive**](https://github.com/mgechev/revive){target=_blank} | N/A | [MIT](licenses/revive.md) | [![GitHub stars](https://img.shields.io/github/stars/mgechev/revive?cacheSeconds=3600)](https://github.com/mgechev/revive){target=_blank} | [GO](descriptors/go_revive.md) | :white_circle: | [Repository](https://github.com/mgechev/revive){target=_blank} | -| [**rst-lint**](https://github.com/twolfson/restructuredtext-lint){target=_blank} | 1.4.0 | | [![GitHub stars](https://img.shields.io/github/stars/twolfson/restructuredtext-lint?cacheSeconds=3600)](https://github.com/twolfson/restructuredtext-lint){target=_blank} | [RST](descriptors/rst_rst_lint.md) | :heart: | [MegaLinter reference](https://github.com/twolfson/restructuredtext-lint/wiki/Integration-in-other-tools#integration-in-other-tools){target=_blank} | -| [**rstcheck**](https://github.com/myint/rstcheck){target=_blank} | 6.0.0 | | [![GitHub stars](https://img.shields.io/github/stars/myint/rstcheck?cacheSeconds=3600)](https://github.com/myint/rstcheck){target=_blank} | [RST](descriptors/rst_rstcheck.md) | :hammer_and_wrench: | [Pull Request](https://github.com/myint/rstcheck/pull/73){target=_blank} | -| [**rubocop**](https://github.com/rubocop-hq/rubocop){target=_blank} | 1.31.2 | [MIT](licenses/rubocop.md) | [![GitHub stars](https://img.shields.io/github/stars/rubocop-hq/rubocop?cacheSeconds=3600)](https://github.com/rubocop-hq/rubocop){target=_blank} | [RUBY](descriptors/ruby_rubocop.md) | :heart: | [MegaLinter reference](https://docs.rubocop.org/rubocop/integration_with_other_tools.html#mega-linter-integration){target=_blank} | -| [**scalafix**](https://github.com/scalacenter/scalafix){target=_blank} | 0.10.1 | [Other](licenses/scalafix.md) | [![GitHub stars](https://img.shields.io/github/stars/scalacenter/scalafix?cacheSeconds=3600)](https://github.com/scalacenter/scalafix){target=_blank} | [SCALA](descriptors/scala_scalafix.md) | :heart: | [MegaLinter reference](https://scalacenter.github.io/scalafix/docs/users/installation.html#plugins-for-other-build-tools){target=_blank} | -| [**scss-lint**](https://github.com/sds/scss-lint){target=_blank} | 0.59.0 | | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint){target=_blank} | [CSS](descriptors/css_scss_lint.md) | :white_circle: | [Repository](https://github.com/sds/scss-lint){target=_blank} | -| [**secretlint**](https://github.com/secretlint/secretlint){target=_blank} | 5.2.3 | [MIT](licenses/secretlint.md) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint){target=_blank} | [REPOSITORY](descriptors/repository_secretlint.md) | :heart: | [MegaLinter reference](https://github.com/secretlint/secretlint#mega-linter){target=_blank} | -| [**semgrep**](https://github.com/returntocorp/semgrep){target=_blank} | 0.103.0 | | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep){target=_blank} | [REPOSITORY](descriptors/repository_semgrep.md) | :white_circle: | [Repository](https://github.com/returntocorp/semgrep){target=_blank} | -| [**sfdx-scanner-apex**](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | 2.13.5 | [MIT](licenses/sfdx-scanner-apex.md) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | [SALESFORCE](descriptors/salesforce_sfdx_scanner_apex.md) | :hammer_and_wrench: | [Pull Request](https://github.com/forcedotcom/sfdx-scanner/pull/307){target=_blank} | -| [**sfdx-scanner-aura**](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | 2.13.5 | [MIT](licenses/sfdx-scanner-aura.md) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | [SALESFORCE](descriptors/salesforce_sfdx_scanner_aura.md) | :hammer_and_wrench: | [Pull Request](https://github.com/forcedotcom/sfdx-scanner/pull/307){target=_blank} | -| [**sfdx-scanner-lwc**](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | 2.13.5 | [MIT](licenses/sfdx-scanner-lwc.md) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | [SALESFORCE](descriptors/salesforce_sfdx_scanner_lwc.md) | :hammer_and_wrench: | [Pull Request](https://github.com/forcedotcom/sfdx-scanner/pull/307){target=_blank} | -| [**shellcheck**](https://github.com/koalaman/shellcheck){target=_blank} | 0.8.0 | | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck){target=_blank} | [BASH](descriptors/bash_shellcheck.md) | | [Repository](https://github.com/koalaman/shellcheck){target=_blank} | -| [**shfmt**](https://github.com/mvdan/sh){target=_blank} | 3.6.0 | | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh){target=_blank} | [BASH](descriptors/bash_shfmt.md) | :no_entry_sign: | [Repository](https://github.com/mvdan/sh){target=_blank} | -| [**snakefmt**](https://github.com/snakemake/snakefmt){target=_blank} | 0.6.1 | | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakefmt?cacheSeconds=3600)](https://github.com/snakemake/snakefmt){target=_blank} | [SNAKEMAKE](descriptors/snakemake_snakefmt.md) | :white_circle: | [Repository](https://github.com/snakemake/snakefmt){target=_blank} | -| [**snakemake**](https://github.com/snakemake/snakemake){target=_blank} | 7.8.5 | [MIT](licenses/snakemake.md) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake){target=_blank} | [SNAKEMAKE](descriptors/snakemake_snakemake.md) | :white_circle: | [Repository](https://github.com/snakemake/snakemake){target=_blank} | -| [**spectral**](https://github.com/stoplightio/spectral){target=_blank} | 5.9.2 | [Apache-2.0](licenses/spectral.md) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral){target=_blank} | [OPENAPI](descriptors/openapi_spectral.md) | :white_circle: | [Repository](https://github.com/stoplightio/spectral){target=_blank} | -| [**sql-lint**](https://github.com/joereynolds/sql-lint){target=_blank} | 1.0.0 | | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint){target=_blank} | [SQL](descriptors/sql_sql_lint.md) | :white_circle: | [Repository](https://github.com/joereynolds/sql-lint){target=_blank} | -| [**sqlfluff**](https://github.com/sqlfluff/sqlfluff){target=_blank} | 1.1.0 | [MIT](licenses/sqlfluff.md) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff){target=_blank} | [SQL](descriptors/sql_sqlfluff.md) | :white_circle: | [Repository](https://github.com/sqlfluff/sqlfluff){target=_blank} | -| [**standard**](https://github.com/standard/standard){target=_blank} | 15.0.1 | [MIT](licenses/standard.md) | [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard){target=_blank} | [JAVASCRIPT](descriptors/javascript_standard.md)
[TYPESCRIPT](descriptors/typescript_standard.md) | :white_circle: | [Repository](https://github.com/standard/standard){target=_blank} | -| [**stylelint**](https://github.com/stylelint/stylelint){target=_blank} | 14.9.1 | [MIT](licenses/stylelint.md) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint){target=_blank} | [CSS](descriptors/css_stylelint.md) | :heart: | [MegaLinter reference](https://stylelint.io/user-guide/integrations/other#analysis-platform-engines){target=_blank} | -| [**swiftlint**](https://github.com/realm/SwiftLint){target=_blank} | 0.46.5 | [MIT](licenses/swiftlint.md) | [![GitHub stars](https://img.shields.io/github/stars/realm/SwiftLint?cacheSeconds=3600)](https://github.com/realm/SwiftLint){target=_blank} | [SWIFT](descriptors/swift_swiftlint.md) | :white_circle: | [Repository](https://github.com/realm/SwiftLint){target=_blank} | -| [**syft**](https://github.com/anchore/syft){target=_blank} | 0.50.0 | | [![GitHub stars](https://img.shields.io/github/stars/anchore/syft?cacheSeconds=3600)](https://github.com/anchore/syft){target=_blank} | [REPOSITORY](descriptors/repository_syft.md) | :white_circle: | [Repository](https://github.com/anchore/syft){target=_blank} | -| [**tekton-lint**](https://github.com/IBM/tekton-lint){target=_blank} | 0.6.0 | | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint){target=_blank} | [TEKTON](descriptors/tekton_tekton_lint.md) | :white_circle: | [Repository](https://github.com/IBM/tekton-lint){target=_blank} | -| [**terraform-fmt**](https://github.com/hashicorp/terraform){target=_blank} | 1.2.4 | [MPL-2.0](licenses/terraform-fmt.md) | [![GitHub stars](https://img.shields.io/github/stars/hashicorp/terraform?cacheSeconds=3600)](https://github.com/hashicorp/terraform){target=_blank} | [TERRAFORM](descriptors/terraform_terraform_fmt.md) | :white_circle: | [Repository](https://github.com/hashicorp/terraform){target=_blank} | -| [**terragrunt**](https://github.com/gruntwork-io/terragrunt){target=_blank} | 0.38.4 | [MIT](licenses/terragrunt.md) | [![GitHub stars](https://img.shields.io/github/stars/gruntwork-io/terragrunt?cacheSeconds=3600)](https://github.com/gruntwork-io/terragrunt){target=_blank} | [TERRAFORM](descriptors/terraform_terragrunt.md) | :white_circle: | [Repository](https://github.com/gruntwork-io/terragrunt){target=_blank} | -| [**terrascan**](https://github.com/accurics/terrascan){target=_blank} | 1.15.2 | [Apache-2.0](licenses/terrascan.md) | [![GitHub stars](https://img.shields.io/github/stars/accurics/terrascan?cacheSeconds=3600)](https://github.com/accurics/terrascan){target=_blank} | [TERRAFORM](descriptors/terraform_terrascan.md) | :white_circle: | [Repository](https://github.com/accurics/terrascan){target=_blank} | -| [**tflint**](https://github.com/terraform-linters/tflint){target=_blank} | 0.35.0 | | [![GitHub stars](https://img.shields.io/github/stars/terraform-linters/tflint?cacheSeconds=3600)](https://github.com/terraform-linters/tflint){target=_blank} | [TERRAFORM](descriptors/terraform_tflint.md) | :white_circle: | [Repository](https://github.com/terraform-linters/tflint){target=_blank} | -| [**trivy**](https://github.com/aquasecurity/trivy){target=_blank} | 0.29.2 | [Apache-2.0](licenses/trivy.md) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy){target=_blank} | [REPOSITORY](descriptors/repository_trivy.md) | :white_circle: | [Repository](https://github.com/aquasecurity/trivy){target=_blank} | -| [**tsqllint**](https://github.com/tsqllint/tsqllint){target=_blank} | 1.14.5.0 | [MIT](licenses/tsqllint.md) | [![GitHub stars](https://img.shields.io/github/stars/tsqllint/tsqllint?cacheSeconds=3600)](https://github.com/tsqllint/tsqllint){target=_blank} | [SQL](descriptors/sql_tsqllint.md) | :white_circle: | [Repository](https://github.com/tsqllint/tsqllint){target=_blank} | -| [**v8r**](https://github.com/chris48s/v8r){target=_blank} | 0.13.0 | | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r){target=_blank} | [JSON](descriptors/json_v8r.md)
[YAML](descriptors/yaml_v8r.md) | :no_entry_sign: | [Repository](https://github.com/chris48s/v8r){target=_blank} | -| [**xmllint**](http://xmlsoft.org/xmllint.html){target=_blank} | 20914 | | | [XML](descriptors/xml_xmllint.md) | :white_circle: | [Web Site](http://xmlsoft.org/xmllint.html){target=_blank} | -| [**yamllint**](https://github.com/adrienverge/yamllint){target=_blank} | 1.27.1 | [GPL-3.0](licenses/yamllint.md) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint){target=_blank} | [YAML](descriptors/yaml_yamllint.md) | :no_entry_sign: | [Repository](https://github.com/adrienverge/yamllint){target=_blank} | +| Linter | Version | License | Popularity | Descriptors | Ref | URL | +| :---- | :-----: | :-----: | :-----: | :--------- | :--------------: | :-: | +| [**actionlint**](https://github.com/rhysd/actionlint){target=_blank} | 1.6.15 | [MIT](licenses/actionlint.md) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint){target=_blank} | [ACTION](descriptors/action_actionlint.md) | :white_circle: | [Repository](https://github.com/rhysd/actionlint){target=_blank} | +| [**ansible-lint**](https://github.com/ansible/ansible-lint){target=_blank} | 6.0.2 | [GPL-3.0](licenses/ansible-lint.md) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint){target=_blank} | [ANSIBLE](descriptors/ansible_ansible_lint.md) | :white_circle: | [Repository](https://github.com/ansible/ansible-lint){target=_blank} | +| [**arm-ttk**](https://github.com/Azure/arm-ttk){target=_blank} | N/A | | | [ARM](descriptors/arm_arm_ttk.md) | :white_circle: | [Web Site](https://github.com/Azure/arm-ttk){target=_blank} | +| [**bandit**](https://github.com/PyCQA/bandit){target=_blank} | 1.7.4 | [Apache-2.0](licenses/bandit.md) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/bandit?cacheSeconds=3600)](https://github.com/PyCQA/bandit){target=_blank} | [PYTHON](descriptors/python_bandit.md) | :white_circle: | [Repository](https://github.com/PyCQA/bandit){target=_blank} | +| [**bash-exec**](https://tiswww.case.edu/php/chet/bash/bashtop.html){target=_blank} | 5.1.16 | | | [BASH](descriptors/bash_bash_exec.md) | | [Web Site](https://tiswww.case.edu/php/chet/bash/bashtop.html){target=_blank} | +| [**black**](https://github.com/psf/black){target=_blank} | 22.6.0 | [MIT](licenses/black.md) | [![GitHub stars](https://img.shields.io/github/stars/psf/black?cacheSeconds=3600)](https://github.com/psf/black){target=_blank} | [PYTHON](descriptors/python_black.md) | :white_circle: | [Repository](https://github.com/psf/black){target=_blank} | +| [**cfn-lint**](https://github.com/aws-cloudformation/cfn-lint){target=_blank} | 0.61.2 | [MIT-0](licenses/cfn-lint.md) | [![GitHub stars](https://img.shields.io/github/stars/aws-cloudformation/cfn-lint?cacheSeconds=3600)](https://github.com/aws-cloudformation/cfn-lint){target=_blank} | [CLOUDFORMATION](descriptors/cloudformation_cfn_lint.md) | :white_circle: | [Repository](https://github.com/aws-cloudformation/cfn-lint){target=_blank} | +| [**checkov**](https://github.com/bridgecrewio/checkov){target=_blank} | 2.1.44 | [Apache-2.0](licenses/checkov.md) | [![GitHub stars](https://img.shields.io/github/stars/bridgecrewio/checkov?cacheSeconds=3600)](https://github.com/bridgecrewio/checkov){target=_blank} | [TERRAFORM](descriptors/terraform_checkov.md) | :no_entry_sign: | [Repository](https://github.com/bridgecrewio/checkov){target=_blank} | +| [**checkstyle**](https://github.com/checkstyle/checkstyle){target=_blank} | 10.3.1 | [LGPL-2.1](licenses/checkstyle.md) | [![GitHub stars](https://img.shields.io/github/stars/checkstyle/checkstyle?cacheSeconds=3600)](https://github.com/checkstyle/checkstyle){target=_blank} | [JAVA](descriptors/java_checkstyle.md) | :heart: | [MegaLinter reference](https://checkstyle.sourceforge.io/index.html#Related_Tools_Active_Tools){target=_blank} | +| [**chktex**](https://www.nongnu.org/chktex){target=_blank} | 1.7.6 | | | [LATEX](descriptors/latex_chktex.md) | :white_circle: | [Web Site](https://www.nongnu.org/chktex){target=_blank} | +| [**clippy**](https://github.com/rust-lang/rust-clippy){target=_blank} | 0.1.62 | | [![GitHub stars](https://img.shields.io/github/stars/rust-lang/rust-clippy?cacheSeconds=3600)](https://github.com/rust-lang/rust-clippy){target=_blank} | [RUST](descriptors/rust_clippy.md) | :white_circle: | [Repository](https://github.com/rust-lang/rust-clippy){target=_blank} | +| [**clj-kondo**](https://github.com/borkdude/clj-kondo){target=_blank} | 2022.04.25 | | [![GitHub stars](https://img.shields.io/github/stars/borkdude/clj-kondo?cacheSeconds=3600)](https://github.com/borkdude/clj-kondo){target=_blank} | [CLOJURE](descriptors/clojure_clj_kondo.md) | :heart: | [MegaLinter reference](https://github.com/borkdude/clj-kondo/blob/master/doc/ci-integration.md#github){target=_blank} | +| [**coffeelint**](https://github.com/clutchski/coffeelint){target=_blank} | 5.2.9 | [Other](licenses/coffeelint.md) | [![GitHub stars](https://img.shields.io/github/stars/clutchski/coffeelint?cacheSeconds=3600)](https://github.com/clutchski/coffeelint){target=_blank} | [COFFEE](descriptors/coffee_coffeelint.md) | :white_circle: | [Repository](https://github.com/clutchski/coffeelint){target=_blank} | +| [**cpplint**](https://github.com/cpplint/cpplint){target=_blank} | 1.6.0 | | | [C](descriptors/c_cpplint.md)
[CPP](descriptors/cpp_cpplint.md) | :white_circle: | [Web Site](https://github.com/cpplint/cpplint){target=_blank} | +| [**cspell**](https://github.com/streetsidesoftware/cspell){target=_blank} | 6.2.3 | [MIT](licenses/cspell.md) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell){target=_blank} | [SPELL](descriptors/spell_cspell.md) | :heart: | [MegaLinter reference](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell#mega-linter){target=_blank} | +| [**dartanalyzer**](https://github.com/dart-lang/sdk){target=_blank} | N/A | [BSD-3-Clause](licenses/dartanalyzer.md) | [![GitHub stars](https://img.shields.io/github/stars/dart-lang/sdk?cacheSeconds=3600)](https://github.com/dart-lang/sdk){target=_blank} | [DART](descriptors/dart_dartanalyzer.md) | :no_entry_sign: | [Repository](https://github.com/dart-lang/sdk){target=_blank} | +| [**devskim**](https://github.com/microsoft/DevSkim){target=_blank} | 0.6.9 | [MIT](licenses/devskim.md) | [![GitHub stars](https://img.shields.io/github/stars/microsoft/DevSkim?cacheSeconds=3600)](https://github.com/microsoft/DevSkim){target=_blank} | [REPOSITORY](descriptors/repository_devskim.md) | :white_circle: | [Repository](https://github.com/microsoft/DevSkim){target=_blank} | +| [**dotenv-linter**](https://github.com/dotenv-linter/dotenv-linter){target=_blank} | 3.2.0 | [MIT](licenses/dotenv-linter.md) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter){target=_blank} | [ENV](descriptors/env_dotenv_linter.md) | :heart: | [MegaLinter reference](https://dotenv-linter.github.io/#/integrations/mega_linter){target=_blank} | +| [**dotnet-format**](https://github.com/dotnet/format){target=_blank} | 000 | [MIT](licenses/dotnet-format.md) | [![GitHub stars](https://img.shields.io/github/stars/dotnet/format?cacheSeconds=3600)](https://github.com/dotnet/format){target=_blank} | [CSHARP](descriptors/csharp_dotnet_format.md)
[VBDOTNET](descriptors/vbdotnet_dotnet_format.md) | :white_circle: | [Repository](https://github.com/dotnet/format){target=_blank} | +| [**dustilock**](https://github.com/Checkmarx/dustilock){target=_blank} | N/A | [Apache-2.0](licenses/dustilock.md) | [![GitHub stars](https://img.shields.io/github/stars/Checkmarx/dustilock?cacheSeconds=3600)](https://github.com/Checkmarx/dustilock){target=_blank} | [REPOSITORY](descriptors/repository_dustilock.md) | :white_circle: | [Repository](https://github.com/Checkmarx/dustilock){target=_blank} | +| [**editorconfig-checker**](https://github.com/editorconfig-checker/editorconfig-checker){target=_blank} | 2.4.0 | [MIT](licenses/editorconfig-checker.md) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker){target=_blank} | [EDITORCONFIG](descriptors/editorconfig_editorconfig_checker.md) | :heart: | [MegaLinter reference](https://github.com/editorconfig-checker/editorconfig-checker#mega-linter){target=_blank} | +| [**eslint**](https://github.com/eslint/eslint){target=_blank} | 8.19.0 | [MIT](licenses/eslint.md) | [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint){target=_blank} | [JAVASCRIPT](descriptors/javascript_eslint.md)
[JSX](descriptors/jsx_eslint.md)
[TSX](descriptors/tsx_eslint.md)
[TYPESCRIPT](descriptors/typescript_eslint.md) | :heart: | [MegaLinter reference](https://eslint.org/docs/user-guide/integrations#source-control){target=_blank} | +| [**eslint-plugin-jsonc**](https://github.com/ota-meshi/eslint-plugin-jsonc){target=_blank} | 2.3.1 | [MIT](licenses/eslint-plugin-jsonc.md) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc){target=_blank} | [JSON](descriptors/json_eslint_plugin_jsonc.md) | :heart: | [MegaLinter reference](https://eslint.org/docs/user-guide/integrations#source-control){target=_blank} | +| [**flake8**](https://github.com/PyCQA/flake8){target=_blank} | 4.0.1 | [MIT](licenses/flake8.md) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/flake8?cacheSeconds=3600)](https://github.com/PyCQA/flake8){target=_blank} | [PYTHON](descriptors/python_flake8.md) | :white_circle: | [Repository](https://github.com/PyCQA/flake8){target=_blank} | +| [**gherkin-lint**](https://github.com/vsiakka/gherkin-lint){target=_blank} | N/A | [ISC](licenses/gherkin-lint.md) | [![GitHub stars](https://img.shields.io/github/stars/vsiakka/gherkin-lint?cacheSeconds=3600)](https://github.com/vsiakka/gherkin-lint){target=_blank} | [GHERKIN](descriptors/gherkin_gherkin_lint.md) | :white_circle: | [Repository](https://github.com/vsiakka/gherkin-lint){target=_blank} | +| [**git_diff**](https://github.com/git/git){target=_blank} | 2.34.2 | [LGPL-2.1](licenses/git_diff.md) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git){target=_blank} | [REPOSITORY](descriptors/repository_git_diff.md) | | [Repository](https://github.com/git/git){target=_blank} | +| [**gitleaks**](https://github.com/zricethezav/gitleaks){target=_blank} | 8.8.7 | [MIT](licenses/gitleaks.md) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks){target=_blank} | [REPOSITORY](descriptors/repository_gitleaks.md) | :white_circle: | [Repository](https://github.com/zricethezav/gitleaks){target=_blank} | +| [**golangci-lint**](https://github.com/golangci/golangci-lint){target=_blank} | 1.46.2 | [GPL-3.0](licenses/golangci-lint.md) | [![GitHub stars](https://img.shields.io/github/stars/golangci/golangci-lint?cacheSeconds=3600)](https://github.com/golangci/golangci-lint){target=_blank} | [GO](descriptors/go_golangci_lint.md) | :white_circle: | [Repository](https://github.com/golangci/golangci-lint){target=_blank} | +| [**goodcheck**](https://github.com/sider/goodcheck){target=_blank} | 3.1.0 | [MIT](licenses/goodcheck.md) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck){target=_blank} | [REPOSITORY](descriptors/repository_goodcheck.md) | :white_circle: | [Repository](https://github.com/sider/goodcheck){target=_blank} | +| [**graphql-schema-linter**](https://github.com/cjoudrey/graphql-schema-linter){target=_blank} | 3.0.1 | [MIT](licenses/graphql-schema-linter.md) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter){target=_blank} | [GRAPHQL](descriptors/graphql_graphql_schema_linter.md) | :hammer_and_wrench: | [Pull Request](https://github.com/cjoudrey/graphql-schema-linter/pull/272){target=_blank} | +| [**hadolint**](https://github.com/hadolint/hadolint){target=_blank} | 2.10.0 | [GPL-3.0](licenses/hadolint.md) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint){target=_blank} | [DOCKERFILE](descriptors/dockerfile_hadolint.md) | :heart: | [MegaLinter reference](https://github.com/hadolint/hadolint/blob/master/docs/INTEGRATION.md#mega-linter){target=_blank} | +| [**htmlhint**](https://github.com/htmlhint/HTMLHint){target=_blank} | 1.1.4 | [MIT](licenses/htmlhint.md) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint){target=_blank} | [HTML](descriptors/html_htmlhint.md) | :heart: | [MegaLinter reference](https://htmlhint.com/docs/user-guide/integrations/task-runner){target=_blank} | +| [**isort**](https://github.com/PyCQA/isort){target=_blank} | 5.10.1 | [MIT](licenses/isort.md) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/isort?cacheSeconds=3600)](https://github.com/PyCQA/isort){target=_blank} | [PYTHON](descriptors/python_isort.md) | :white_circle: | [Repository](https://github.com/PyCQA/isort){target=_blank} | +| [**jscpd**](https://github.com/kucherenko/jscpd){target=_blank} | 3.3.26 | [MIT](licenses/jscpd.md) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd){target=_blank} | [COPYPASTE](descriptors/copypaste_jscpd.md) | :heart: | [MegaLinter reference](https://github.com/kucherenko/jscpd#who-uses-jscpd){target=_blank} | +| [**jsonlint**](https://github.com/zaach/jsonlint){target=_blank} | 1.6.3 | | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint){target=_blank} | [JSON](descriptors/json_jsonlint.md) | :hammer_and_wrench: | [Pull Request](https://github.com/zaach/jsonlint/pull/127){target=_blank} | +| [**kics**](https://github.com/checkmarx/kics){target=_blank} | 1.5.11 | [Apache-2.0](licenses/kics.md) | [![GitHub stars](https://img.shields.io/github/stars/checkmarx/kics?cacheSeconds=3600)](https://github.com/checkmarx/kics){target=_blank} | [TERRAFORM](descriptors/terraform_kics.md) | :heart: | [MegaLinter reference](https://docs.kics.io/latest/integrations/){target=_blank} | +| [**ktlint**](https://github.com/pinterest/ktlint){target=_blank} | 0.46.1 | [MIT](licenses/ktlint.md) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint){target=_blank} | [KOTLIN](descriptors/kotlin_ktlint.md) | :heart: | [MegaLinter reference](https://github.com/pinterest/ktlint#-with-continuous-integration){target=_blank} | +| [**kubeconform**](https://github.com/yannh/kubeconform){target=_blank} | 0.4.12 | [Other](licenses/kubeconform.md) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform){target=_blank} | [KUBERNETES](descriptors/kubernetes_kubeconform.md) | :white_circle: | [Repository](https://github.com/yannh/kubeconform){target=_blank} | +| [**kubeval**](https://github.com/instrumenta/kubeval){target=_blank} | 0.16.1 | [Apache-2.0](licenses/kubeval.md) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval){target=_blank} | [KUBERNETES](descriptors/kubernetes_kubeval.md) | :white_circle: | [Repository](https://github.com/instrumenta/kubeval){target=_blank} | +| [**lintr**](https://lintr.r-lib.org/){target=_blank} | N/A | | | [R](descriptors/r_lintr.md) | :white_circle: | [Web Site](https://lintr.r-lib.org/){target=_blank} | +| [**luacheck**](https://github.com/luarocks/luacheck){target=_blank} | 0.26.1 | [MIT](licenses/luacheck.md) | [![GitHub stars](https://img.shields.io/github/stars/luarocks/luacheck?cacheSeconds=3600)](https://github.com/luarocks/luacheck){target=_blank} | [LUA](descriptors/lua_luacheck.md) | :no_entry_sign: | [Repository](https://github.com/luarocks/luacheck){target=_blank} | +| [**markdown-link-check**](https://github.com/tcort/markdown-link-check){target=_blank} | 3.10.2 | | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check){target=_blank} | [MARKDOWN](descriptors/markdown_markdown_link_check.md) | :heart: | [MegaLinter reference](https://github.com/tcort/markdown-link-check#run-in-other-tools){target=_blank} | +| [**markdown-table-formatter**](https://github.com/nvuillam/markdown-table-formatter){target=_blank} | 1.3.0 | [MIT](licenses/markdown-table-formatter.md) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter){target=_blank} | [MARKDOWN](descriptors/markdown_markdown_table_formatter.md) | :white_circle: | [Repository](https://github.com/nvuillam/markdown-table-formatter){target=_blank} | +| [**markdownlint**](https://github.com/DavidAnson/markdownlint){target=_blank} | 0.31.1 | | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint){target=_blank} | [MARKDOWN](descriptors/markdown_markdownlint.md) | :white_circle: | [Repository](https://github.com/DavidAnson/markdownlint){target=_blank} | +| [**misspell**](https://github.com/client9/misspell){target=_blank} | 0.3.4 | | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell){target=_blank} | [SPELL](descriptors/spell_misspell.md) | :white_circle: | [Repository](https://github.com/client9/misspell){target=_blank} | +| [**mypy**](https://github.com/python/mypy){target=_blank} | 0.961 | [MIT](licenses/mypy.md) | [![GitHub stars](https://img.shields.io/github/stars/python/mypy?cacheSeconds=3600)](https://github.com/python/mypy){target=_blank} | [PYTHON](descriptors/python_mypy.md) | | [Repository](https://github.com/python/mypy){target=_blank} | +| [**npm-groovy-lint**](https://github.com/nvuillam/npm-groovy-lint){target=_blank} | 9.5.0 | [GPL-3.0](licenses/npm-groovy-lint.md) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint){target=_blank} | [GROOVY](descriptors/groovy_npm_groovy_lint.md) | :heart: | [MegaLinter reference](https://nvuillam.github.io/npm-groovy-lint/#mega-linter){target=_blank} | +| [**perlcritic**](https://github.com/Perl-Critic/Perl-Critic){target=_blank} | 1.140 | [Other](licenses/perlcritic.md) | [![GitHub stars](https://img.shields.io/github/stars/Perl-Critic/Perl-Critic?cacheSeconds=3600)](https://github.com/Perl-Critic/Perl-Critic){target=_blank} | [PERL](descriptors/perl_perlcritic.md) | :white_circle: | [Repository](https://github.com/Perl-Critic/Perl-Critic){target=_blank} | +| [**phpcs**](https://github.com/squizlabs/PHP_CodeSniffer){target=_blank} | 3.7.1 | | [![GitHub stars](https://img.shields.io/github/stars/squizlabs/PHP_CodeSniffer?cacheSeconds=3600)](https://github.com/squizlabs/PHP_CodeSniffer){target=_blank} | [PHP](descriptors/php_phpcs.md) | :white_circle: | [Repository](https://github.com/squizlabs/PHP_CodeSniffer){target=_blank} | +| [**phplint**](https://github.com/overtrue/phplint){target=_blank} | 3.0 | | | [PHP](descriptors/php_phplint.md) | :white_circle: | [Web Site](https://github.com/overtrue/phplint){target=_blank} | +| [**phpstan**](https://github.com/phpstan/phpstan){target=_blank} | 1.8.0 | [MIT](licenses/phpstan.md) | [![GitHub stars](https://img.shields.io/github/stars/phpstan/phpstan?cacheSeconds=3600)](https://github.com/phpstan/phpstan){target=_blank} | [PHP](descriptors/php_phpstan.md) | :white_circle: | [Repository](https://github.com/phpstan/phpstan){target=_blank} | +| [**powershell**](https://github.com/PowerShell/PSScriptAnalyzer){target=_blank} | 7.2.5 | | [![GitHub stars](https://img.shields.io/github/stars/PowerShell/PSScriptAnalyzer?cacheSeconds=3600)](https://github.com/PowerShell/PSScriptAnalyzer){target=_blank} | [POWERSHELL](descriptors/powershell_powershell.md) | :white_circle: | [Repository](https://github.com/PowerShell/PSScriptAnalyzer){target=_blank} | +| [**prettier**](https://github.com/prettier/prettier){target=_blank} | 2.7.1 | [MIT](licenses/prettier.md) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier){target=_blank} | [JAVASCRIPT](descriptors/javascript_prettier.md)
[JSON](descriptors/json_prettier.md)
[TYPESCRIPT](descriptors/typescript_prettier.md)
[YAML](descriptors/yaml_prettier.md) | :white_circle: | [Repository](https://github.com/prettier/prettier){target=_blank} | +| [**protolint**](https://github.com/yoheimuta/protolint){target=_blank} | 0.38.2 | | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint){target=_blank} | [PROTOBUF](descriptors/protobuf_protolint.md) | :white_circle: | [Repository](https://github.com/yoheimuta/protolint){target=_blank} | +| [**psalm**](https://github.com/vimeo/psalm){target=_blank} | Psalm.5.x-dev@ | [MIT](licenses/psalm.md) | [![GitHub stars](https://img.shields.io/github/stars/vimeo/psalm?cacheSeconds=3600)](https://github.com/vimeo/psalm){target=_blank} | [PHP](descriptors/php_psalm.md) | :white_circle: | [Repository](https://github.com/vimeo/psalm){target=_blank} | +| [**puppet-lint**](https://github.com/rodjek/puppet-lint){target=_blank} | 2.5.2 | [MIT](licenses/puppet-lint.md) | [![GitHub stars](https://img.shields.io/github/stars/rodjek/puppet-lint?cacheSeconds=3600)](https://github.com/rodjek/puppet-lint){target=_blank} | [PUPPET](descriptors/puppet_puppet_lint.md) | :white_circle: | [Repository](https://github.com/rodjek/puppet-lint){target=_blank} | +| [**pylint**](https://github.com/PyCQA/pylint){target=_blank} | 2.14.4 | [GPL-2.0](licenses/pylint.md) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/pylint?cacheSeconds=3600)](https://github.com/PyCQA/pylint){target=_blank} | [PYTHON](descriptors/python_pylint.md) | :white_circle: | [Repository](https://github.com/PyCQA/pylint){target=_blank} | +| [**raku**](https://github.com/rakudo/rakudo){target=_blank} | 2020.10 | [Artistic-2.0](licenses/raku.md) | [![GitHub stars](https://img.shields.io/github/stars/rakudo/rakudo?cacheSeconds=3600)](https://github.com/rakudo/rakudo){target=_blank} | [RAKU](descriptors/raku_raku.md) | :white_circle: | [Repository](https://github.com/rakudo/rakudo){target=_blank} | +| [**remark-lint**](https://github.com/remarkjs/remark-lint){target=_blank} | 14.0.2 | [MIT](licenses/remark-lint.md) | [![GitHub stars](https://img.shields.io/github/stars/remarkjs/remark-lint?cacheSeconds=3600)](https://github.com/remarkjs/remark-lint){target=_blank} | [MARKDOWN](descriptors/markdown_remark_lint.md) | :white_circle: | [Repository](https://github.com/remarkjs/remark-lint){target=_blank} | +| [**revive**](https://github.com/mgechev/revive){target=_blank} | N/A | [MIT](licenses/revive.md) | [![GitHub stars](https://img.shields.io/github/stars/mgechev/revive?cacheSeconds=3600)](https://github.com/mgechev/revive){target=_blank} | [GO](descriptors/go_revive.md) | :white_circle: | [Repository](https://github.com/mgechev/revive){target=_blank} | +| [**rst-lint**](https://github.com/twolfson/restructuredtext-lint){target=_blank} | 1.4.0 | | [![GitHub stars](https://img.shields.io/github/stars/twolfson/restructuredtext-lint?cacheSeconds=3600)](https://github.com/twolfson/restructuredtext-lint){target=_blank} | [RST](descriptors/rst_rst_lint.md) | :heart: | [MegaLinter reference](https://github.com/twolfson/restructuredtext-lint/wiki/Integration-in-other-tools#integration-in-other-tools){target=_blank} | +| [**rstcheck**](https://github.com/myint/rstcheck){target=_blank} | 6.0.0 | | [![GitHub stars](https://img.shields.io/github/stars/myint/rstcheck?cacheSeconds=3600)](https://github.com/myint/rstcheck){target=_blank} | [RST](descriptors/rst_rstcheck.md) | :hammer_and_wrench: | [Pull Request](https://github.com/myint/rstcheck/pull/73){target=_blank} | +| [**rubocop**](https://github.com/rubocop-hq/rubocop){target=_blank} | 1.31.2 | [MIT](licenses/rubocop.md) | [![GitHub stars](https://img.shields.io/github/stars/rubocop-hq/rubocop?cacheSeconds=3600)](https://github.com/rubocop-hq/rubocop){target=_blank} | [RUBY](descriptors/ruby_rubocop.md) | :heart: | [MegaLinter reference](https://docs.rubocop.org/rubocop/integration_with_other_tools.html#mega-linter-integration){target=_blank} | +| [**scalafix**](https://github.com/scalacenter/scalafix){target=_blank} | 0.10.1 | [Other](licenses/scalafix.md) | [![GitHub stars](https://img.shields.io/github/stars/scalacenter/scalafix?cacheSeconds=3600)](https://github.com/scalacenter/scalafix){target=_blank} | [SCALA](descriptors/scala_scalafix.md) | :heart: | [MegaLinter reference](https://scalacenter.github.io/scalafix/docs/users/installation.html#plugins-for-other-build-tools){target=_blank} | +| [**scss-lint**](https://github.com/sds/scss-lint){target=_blank} | 0.59.0 | | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint){target=_blank} | [CSS](descriptors/css_scss_lint.md) | :white_circle: | [Repository](https://github.com/sds/scss-lint){target=_blank} | +| [**secretlint**](https://github.com/secretlint/secretlint){target=_blank} | 5.2.3 | [MIT](licenses/secretlint.md) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint){target=_blank} | [REPOSITORY](descriptors/repository_secretlint.md) | :heart: | [MegaLinter reference](https://github.com/secretlint/secretlint#mega-linter){target=_blank} | +| [**semgrep**](https://github.com/returntocorp/semgrep){target=_blank} | 0.103.0 | | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep){target=_blank} | [REPOSITORY](descriptors/repository_semgrep.md) | :white_circle: | [Repository](https://github.com/returntocorp/semgrep){target=_blank} | +| [**sfdx-scanner-apex**](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | 2.13.5 | [MIT](licenses/sfdx-scanner-apex.md) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | [SALESFORCE](descriptors/salesforce_sfdx_scanner_apex.md) | :hammer_and_wrench: | [Pull Request](https://github.com/forcedotcom/sfdx-scanner/pull/307){target=_blank} | +| [**sfdx-scanner-aura**](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | 2.13.5 | [MIT](licenses/sfdx-scanner-aura.md) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | [SALESFORCE](descriptors/salesforce_sfdx_scanner_aura.md) | :hammer_and_wrench: | [Pull Request](https://github.com/forcedotcom/sfdx-scanner/pull/307){target=_blank} | +| [**sfdx-scanner-lwc**](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | 2.13.5 | [MIT](licenses/sfdx-scanner-lwc.md) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner){target=_blank} | [SALESFORCE](descriptors/salesforce_sfdx_scanner_lwc.md) | :hammer_and_wrench: | [Pull Request](https://github.com/forcedotcom/sfdx-scanner/pull/307){target=_blank} | +| [**shellcheck**](https://github.com/koalaman/shellcheck){target=_blank} | 0.8.0 | | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck){target=_blank} | [BASH](descriptors/bash_shellcheck.md) | | [Repository](https://github.com/koalaman/shellcheck){target=_blank} | +| [**shfmt**](https://github.com/mvdan/sh){target=_blank} | 3.6.0 | | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh){target=_blank} | [BASH](descriptors/bash_shfmt.md) | :no_entry_sign: | [Repository](https://github.com/mvdan/sh){target=_blank} | +| [**snakefmt**](https://github.com/snakemake/snakefmt){target=_blank} | 0.6.1 | | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakefmt?cacheSeconds=3600)](https://github.com/snakemake/snakefmt){target=_blank} | [SNAKEMAKE](descriptors/snakemake_snakefmt.md) | :white_circle: | [Repository](https://github.com/snakemake/snakefmt){target=_blank} | +| [**snakemake**](https://github.com/snakemake/snakemake){target=_blank} | 7.8.5 | [MIT](licenses/snakemake.md) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake){target=_blank} | [SNAKEMAKE](descriptors/snakemake_snakemake.md) | :white_circle: | [Repository](https://github.com/snakemake/snakemake){target=_blank} | +| [**spectral**](https://github.com/stoplightio/spectral){target=_blank} | 5.9.2 | [Apache-2.0](licenses/spectral.md) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral){target=_blank} | [OPENAPI](descriptors/openapi_spectral.md) | :white_circle: | [Repository](https://github.com/stoplightio/spectral){target=_blank} | +| [**sql-lint**](https://github.com/joereynolds/sql-lint){target=_blank} | 1.0.0 | | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint){target=_blank} | [SQL](descriptors/sql_sql_lint.md) | :white_circle: | [Repository](https://github.com/joereynolds/sql-lint){target=_blank} | +| [**sqlfluff**](https://github.com/sqlfluff/sqlfluff){target=_blank} | 1.1.0 | [MIT](licenses/sqlfluff.md) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff){target=_blank} | [SQL](descriptors/sql_sqlfluff.md) | :white_circle: | [Repository](https://github.com/sqlfluff/sqlfluff){target=_blank} | +| [**standard**](https://github.com/standard/standard){target=_blank} | 15.0.1 | [MIT](licenses/standard.md) | [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard){target=_blank} | [JAVASCRIPT](descriptors/javascript_standard.md)
[TYPESCRIPT](descriptors/typescript_standard.md) | :white_circle: | [Repository](https://github.com/standard/standard){target=_blank} | +| [**stylelint**](https://github.com/stylelint/stylelint){target=_blank} | 14.9.1 | [MIT](licenses/stylelint.md) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint){target=_blank} | [CSS](descriptors/css_stylelint.md) | :heart: | [MegaLinter reference](https://stylelint.io/user-guide/integrations/other#analysis-platform-engines){target=_blank} | +| [**swiftlint**](https://github.com/realm/SwiftLint){target=_blank} | 0.46.5 | [MIT](licenses/swiftlint.md) | [![GitHub stars](https://img.shields.io/github/stars/realm/SwiftLint?cacheSeconds=3600)](https://github.com/realm/SwiftLint){target=_blank} | [SWIFT](descriptors/swift_swiftlint.md) | :white_circle: | [Repository](https://github.com/realm/SwiftLint){target=_blank} | +| [**syft**](https://github.com/anchore/syft){target=_blank} | 0.51.0 | | [![GitHub stars](https://img.shields.io/github/stars/anchore/syft?cacheSeconds=3600)](https://github.com/anchore/syft){target=_blank} | [REPOSITORY](descriptors/repository_syft.md) | :white_circle: | [Repository](https://github.com/anchore/syft){target=_blank} | +| [**tekton-lint**](https://github.com/IBM/tekton-lint){target=_blank} | 0.6.0 | | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint){target=_blank} | [TEKTON](descriptors/tekton_tekton_lint.md) | :white_circle: | [Repository](https://github.com/IBM/tekton-lint){target=_blank} | +| [**terraform-fmt**](https://github.com/hashicorp/terraform){target=_blank} | 1.2.4 | [MPL-2.0](licenses/terraform-fmt.md) | [![GitHub stars](https://img.shields.io/github/stars/hashicorp/terraform?cacheSeconds=3600)](https://github.com/hashicorp/terraform){target=_blank} | [TERRAFORM](descriptors/terraform_terraform_fmt.md) | :white_circle: | [Repository](https://github.com/hashicorp/terraform){target=_blank} | +| [**terragrunt**](https://github.com/gruntwork-io/terragrunt){target=_blank} | 0.38.4 | [MIT](licenses/terragrunt.md) | [![GitHub stars](https://img.shields.io/github/stars/gruntwork-io/terragrunt?cacheSeconds=3600)](https://github.com/gruntwork-io/terragrunt){target=_blank} | [TERRAFORM](descriptors/terraform_terragrunt.md) | :white_circle: | [Repository](https://github.com/gruntwork-io/terragrunt){target=_blank} | +| [**terrascan**](https://github.com/accurics/terrascan){target=_blank} | 1.15.2 | [Apache-2.0](licenses/terrascan.md) | [![GitHub stars](https://img.shields.io/github/stars/accurics/terrascan?cacheSeconds=3600)](https://github.com/accurics/terrascan){target=_blank} | [TERRAFORM](descriptors/terraform_terrascan.md) | :white_circle: | [Repository](https://github.com/accurics/terrascan){target=_blank} | +| [**tflint**](https://github.com/terraform-linters/tflint){target=_blank} | 0.35.0 | | [![GitHub stars](https://img.shields.io/github/stars/terraform-linters/tflint?cacheSeconds=3600)](https://github.com/terraform-linters/tflint){target=_blank} | [TERRAFORM](descriptors/terraform_tflint.md) | :white_circle: | [Repository](https://github.com/terraform-linters/tflint){target=_blank} | +| [**trivy**](https://github.com/aquasecurity/trivy){target=_blank} | 0.29.2 | [Apache-2.0](licenses/trivy.md) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy){target=_blank} | [REPOSITORY](descriptors/repository_trivy.md) | :white_circle: | [Repository](https://github.com/aquasecurity/trivy){target=_blank} | +| [**tsqllint**](https://github.com/tsqllint/tsqllint){target=_blank} | 1.14.5.0 | [MIT](licenses/tsqllint.md) | [![GitHub stars](https://img.shields.io/github/stars/tsqllint/tsqllint?cacheSeconds=3600)](https://github.com/tsqllint/tsqllint){target=_blank} | [SQL](descriptors/sql_tsqllint.md) | :white_circle: | [Repository](https://github.com/tsqllint/tsqllint){target=_blank} | +| [**v8r**](https://github.com/chris48s/v8r){target=_blank} | 0.13.0 | | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r){target=_blank} | [JSON](descriptors/json_v8r.md)
[YAML](descriptors/yaml_v8r.md) | :no_entry_sign: | [Repository](https://github.com/chris48s/v8r){target=_blank} | +| [**xmllint**](http://xmlsoft.org/xmllint.html){target=_blank} | 20914 | | | [XML](descriptors/xml_xmllint.md) | :white_circle: | [Web Site](http://xmlsoft.org/xmllint.html){target=_blank} | +| [**yamllint**](https://github.com/adrienverge/yamllint){target=_blank} | 1.27.1 | [GPL-3.0](licenses/yamllint.md) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint){target=_blank} | [YAML](descriptors/yaml_yamllint.md) | :no_entry_sign: | [Repository](https://github.com/adrienverge/yamllint){target=_blank} | diff --git a/docs/configuration.md b/docs/configuration.md index 7e08f604b31..5c91529b954 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -19,7 +19,7 @@ Configuration is assisted with auto-completion and validation in most commonly u | **ENV VAR** | **Default Value** | **Notes** | |------------------------------------------------------------|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **ADDITIONAL_EXCLUDED_DIRECTORIES** | \[\] | List of additional excluded directory basenames. They are excluded at any nested level. | -| [**APPLY_FIXES**](configuration.md#apply-fixes) | `none` | Activates formatting and auto-fixing [(more info)](configuration.md#apply-fixes) | +| [**APPLY_FIXES**](configuration.md#apply-fixes) | `none` | Activates formatting and auto-fixing [(more info)](configuration.md#apply-fixes) | | **DEFAULT_BRANCH** | `HEAD` | Deprecated: The name of the repository's 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. | @@ -46,7 +46,7 @@ Configuration is assisted with auto-completion and validation in most commonly u | **MARKDOWN_DEFAULT_STYLE** | `markdownlint` | Markdown default style to check/apply. `markdownlint`,`remark-lint` | | **MEGALINTER_CONFIG** | `.mega-linter.yml` | Name of MegaLinter configuration file. Can be defined remotely, in that case set this environment variable with the remote URL of `.mega-linter.yml` config file | | **PARALLEL** | `true` | Process linters in parallel to improve overall MegaLinter performance. If true, linters of same language or formats are grouped in the same parallel process to avoid lock issues if fixing the same files | -| [**PLUGINS**](plugins.md) | \[\] | List of plugin urls to install and run during MegaLinter run | +| [**PLUGINS**](plugins.md) | \[\] | List of plugin urls to install and run during MegaLinter run | | [**POST_COMMANDS**](#post-commands) | \[\] | Custom bash commands to run after linters | | [**PRE_COMMANDS**](#pre-commands) | \[\] | Custom bash commands to run before linters | | **PRINT_ALPACA** | `true` | Enable printing alpaca image to console | diff --git a/docs/descriptors/action.md b/docs/descriptors/action.md index b6938faa3c5..82b16604c40 100644 --- a/docs/descriptors/action.md +++ b/docs/descriptors/action.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|------------------------------------|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [actionlint](action_actionlint.md) | [ACTION](action_actionlint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/rhysd/actionlint)](https://github.com/rhysd/actionlint/commits) | ## Linted files @@ -17,10 +17,10 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|-----------------------------|-------------------------------|---------------| -| ACTION_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| ACTION_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| ACTION_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| ACTION_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | ## Behind the scenes diff --git a/docs/descriptors/action_actionlint.md b/docs/descriptors/action_actionlint.md index 82e2fbf58a8..4cc7fa76a96 100644 --- a/docs/descriptors/action_actionlint.md +++ b/docs/descriptors/action_actionlint.md @@ -17,41 +17,41 @@ Static checker for GitHub Actions workflow files - Enable actionlint by adding `ACTION_ACTIONLINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable actionlint by adding `ACTION_ACTIONLINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| ACTION_ACTIONLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| ACTION_ACTIONLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| ACTION_ACTIONLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| ACTION_ACTIONLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| ACTION_ACTIONLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml"]` | -| ACTION_ACTIONLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| ACTION_ACTIONLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| ACTION_ACTIONLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| ACTION_ACTIONLINT_CONFIG_FILE | actionlint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `actionlint.yml` | -| ACTION_ACTIONLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| ACTION_ACTIONLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| ACTION_ACTIONLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | -| ACTION_DIRECTORY | Directory containing ACTION files | `.github/workflows` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| ACTION_ACTIONLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| ACTION_ACTIONLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| ACTION_ACTIONLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| ACTION_ACTIONLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| ACTION_ACTIONLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml"]` | +| ACTION_ACTIONLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| ACTION_ACTIONLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| ACTION_ACTIONLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| ACTION_ACTIONLINT_CONFIG_FILE | actionlint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `actionlint.yml` | +| ACTION_ACTIONLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| ACTION_ACTIONLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| ACTION_ACTIONLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| ACTION_DIRECTORY | Directory containing ACTION files | `.github/workflows` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/ansible.md b/docs/descriptors/ansible.md index aa99ef38a3c..dc87d24bd9b 100644 --- a/docs/descriptors/ansible.md +++ b/docs/descriptors/ansible.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|-----------------------------------------|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [ansible-lint](ansible_ansible_lint.md) | [ANSIBLE](ansible_ansible_lint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/ansible/ansible-lint)](https://github.com/ansible/ansible-lint/commits) | ## Linted files @@ -17,8 +17,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|------------------------------|-------------------------------|---------------| -| ANSIBLE_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| ANSIBLE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| ANSIBLE_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| ANSIBLE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/ansible_ansible_lint.md b/docs/descriptors/ansible_ansible_lint.md index 3df7a35cdbb..47e2b1e2980 100644 --- a/docs/descriptors/ansible_ansible_lint.md +++ b/docs/descriptors/ansible_ansible_lint.md @@ -17,39 +17,39 @@ - Enable ansible-lint by adding `ANSIBLE_ANSIBLE_LINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable ansible-lint by adding `ANSIBLE_ANSIBLE_LINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| ANSIBLE_ANSIBLE_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| ANSIBLE_ANSIBLE_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml"]` | -| ANSIBLE_ANSIBLE_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| ANSIBLE_ANSIBLE_LINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| ANSIBLE_ANSIBLE_LINT_CONFIG_FILE | ansible-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.ansible-lint` | -| ANSIBLE_ANSIBLE_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| ANSIBLE_ANSIBLE_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| ANSIBLE_ANSIBLE_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | -| ANSIBLE_DIRECTORY | Directory containing ANSIBLE files | `ansible` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| ANSIBLE_ANSIBLE_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| ANSIBLE_ANSIBLE_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml"]` | +| ANSIBLE_ANSIBLE_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| ANSIBLE_ANSIBLE_LINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| ANSIBLE_ANSIBLE_LINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| ANSIBLE_ANSIBLE_LINT_CONFIG_FILE | ansible-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.ansible-lint` | +| ANSIBLE_ANSIBLE_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| ANSIBLE_ANSIBLE_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| ANSIBLE_ANSIBLE_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| ANSIBLE_DIRECTORY | Directory containing ANSIBLE files | `ansible` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/arm.md b/docs/descriptors/arm.md index 346effa54d0..786ecee6cfe 100644 --- a/docs/descriptors/arm.md +++ b/docs/descriptors/arm.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|---------------------------|-----------------------|----------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [arm-ttk](arm_arm_ttk.md) | [ARM](arm_arm_ttk.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/Azure/arm-ttk)](https://github.com/Azure/arm-ttk/commits) | ## Linted files @@ -19,10 +19,10 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|--------------------------|-------------------------------|---------------| -| ARM_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| ARM_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| ARM_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| ARM_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | ## Behind the scenes diff --git a/docs/descriptors/arm_arm_ttk.md b/docs/descriptors/arm_arm_ttk.md index d28a2ab413f..241a9f1e0f4 100644 --- a/docs/descriptors/arm_arm_ttk.md +++ b/docs/descriptors/arm_arm_ttk.md @@ -15,37 +15,37 @@ - Enable arm-ttk by adding `ARM_ARM_TTK` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable arm-ttk by adding `ARM_ARM_TTK` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| ARM_ARM_TTK_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| ARM_ARM_TTK_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| ARM_ARM_TTK_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| ARM_ARM_TTK_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| ARM_ARM_TTK_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".json"]` | -| ARM_ARM_TTK_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| ARM_ARM_TTK_PRE_COMMANDS | List of bash commands to run before the linter | None | -| ARM_ARM_TTK_POST_COMMANDS | List of bash commands to run after the linter | None | -| ARM_ARM_TTK_CONFIG_FILE | arm-ttk configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.arm-ttk.psd1` | -| ARM_ARM_TTK_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| ARM_ARM_TTK_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| ARM_ARM_TTK_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| ARM_ARM_TTK_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| ARM_ARM_TTK_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| ARM_ARM_TTK_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| ARM_ARM_TTK_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| ARM_ARM_TTK_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".json"]` | +| ARM_ARM_TTK_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| ARM_ARM_TTK_PRE_COMMANDS | List of bash commands to run before the linter| None | +| ARM_ARM_TTK_POST_COMMANDS | List of bash commands to run after the linter| None | +| ARM_ARM_TTK_CONFIG_FILE | arm-ttk configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.arm-ttk.psd1` | +| ARM_ARM_TTK_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| ARM_ARM_TTK_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| ARM_ARM_TTK_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use arm-ttk in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|--------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Visual Studio Code](https://code.visualstudio.com/) | [ARMTTKExtension](https://marketplace.visualstudio.com/items?itemName=Sam-Cogan.ARMTTKExtension) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/Sam-Cogan.ARMTTKExtension){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:----------------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | ## Behind the scenes diff --git a/docs/descriptors/bash.md b/docs/descriptors/bash.md index a3128b2ed8c..1281352657f 100644 --- a/docs/descriptors/bash.md +++ b/docs/descriptors/bash.md @@ -5,11 +5,11 @@ ## Linters -| Linter | Configuration key | Status | -|----------------------------------|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| -| [bash-exec](bash_bash_exec.md) | [BASH_EXEC](bash_bash_exec.md) | | +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | +| [bash-exec](bash_bash_exec.md) | [BASH_EXEC](bash_bash_exec.md) | | | [shellcheck](bash_shellcheck.md) | [BASH_SHELLCHECK](bash_shellcheck.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/koalaman/shellcheck)](https://github.com/koalaman/shellcheck/commits) | -| [shfmt](bash_shfmt.md) | [BASH_SHFMT](bash_shfmt.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/mvdan/sh)](https://github.com/mvdan/sh/commits) | +| [shfmt](bash_shfmt.md) | [BASH_SHFMT](bash_shfmt.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/mvdan/sh)](https://github.com/mvdan/sh/commits) | ## Linted files @@ -21,10 +21,10 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|---------------------------|-------------------------------|---------------| -| BASH_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| BASH_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| BASH_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| BASH_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | ## Behind the scenes diff --git a/docs/descriptors/bash_bash_exec.md b/docs/descriptors/bash_bash_exec.md index be4155d45b0..75a13a71121 100644 --- a/docs/descriptors/bash_bash_exec.md +++ b/docs/descriptors/bash_bash_exec.md @@ -16,40 +16,40 @@ Note: You can run `git add --chmod=+x myfile.sh` to make a file executable on Wi - Enable bash-exec by adding `BASH_EXEC` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable bash-exec by adding `BASH_EXEC` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------| -| ERROR_ON_MISSING_EXEC_BIT | 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 arror instead | `false` | -| BASH_EXEC_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| BASH_EXEC_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| BASH_EXEC_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| BASH_EXEC_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| BASH_EXEC_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".sh", ".bash", ".dash", ".ksh"]` | -| BASH_EXEC_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| BASH_EXEC_PRE_COMMANDS | List of bash commands to run before the linter | None | -| BASH_EXEC_POST_COMMANDS | List of bash commands to run after the linter | None | -| BASH_EXEC_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| BASH_EXEC_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| ERROR_ON_MISSING_EXEC_BIT | 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 arror instead | `false` | +| BASH_EXEC_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| BASH_EXEC_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| BASH_EXEC_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| BASH_EXEC_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| BASH_EXEC_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".sh", ".bash", ".dash", ".ksh"]` | +| BASH_EXEC_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| BASH_EXEC_PRE_COMMANDS | List of bash commands to run before the linter| None | +| BASH_EXEC_POST_COMMANDS | List of bash commands to run after the linter| None | +| BASH_EXEC_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| BASH_EXEC_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/bash_shellcheck.md b/docs/descriptors/bash_shellcheck.md index 4136719cdcd..e48ae4b7897 100644 --- a/docs/descriptors/bash_shellcheck.md +++ b/docs/descriptors/bash_shellcheck.md @@ -16,55 +16,55 @@ - Enable shellcheck by adding `BASH_SHELLCHECK` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable shellcheck by adding `BASH_SHELLCHECK` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------| -| BASH_SHELLCHECK_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| BASH_SHELLCHECK_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| BASH_SHELLCHECK_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| BASH_SHELLCHECK_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| BASH_SHELLCHECK_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".sh", ".bash", ".dash", ".ksh"]` | -| BASH_SHELLCHECK_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| BASH_SHELLCHECK_PRE_COMMANDS | List of bash commands to run before the linter | None | -| BASH_SHELLCHECK_POST_COMMANDS | List of bash commands to run after the linter | None | -| BASH_SHELLCHECK_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| BASH_SHELLCHECK_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| BASH_SHELLCHECK_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| BASH_SHELLCHECK_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| BASH_SHELLCHECK_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| BASH_SHELLCHECK_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| BASH_SHELLCHECK_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".sh", ".bash", ".dash", ".ksh"]` | +| BASH_SHELLCHECK_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| BASH_SHELLCHECK_PRE_COMMANDS | List of bash commands to run before the linter| None | +| BASH_SHELLCHECK_POST_COMMANDS | List of bash commands to run after the linter| None | +| BASH_SHELLCHECK_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| BASH_SHELLCHECK_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use shellcheck in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-----------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-shellcheck](https://github.com/AtomLinter/linter-shellcheck) | [Visit Web Site](https://github.com/AtomLinter/linter-shellcheck){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](https://github.com/flycheck/flycheck) | [Visit Web Site](https://github.com/flycheck/flycheck){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [flymake-shellcheck](https://github.com/federicotdn/flymake-shellcheck) | [Visit Web Site](https://github.com/federicotdn/flymake-shellcheck){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-shellcheck](https://github.com/SublimeLinter/SublimeLinter-shellcheck) | [Visit Web Site](https://github.com/SublimeLinter/SublimeLinter-shellcheck){target=_blank} | -| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | -| | [vim](https://www.vim.org/) | [neomake](https://github.com/neomake/neomake) | [Visit Web Site](https://github.com/neomake/neomake){target=_blank} | -| | [vim](https://www.vim.org/) | [syntastic](https://github.com/scrooloose/syntastic) | [Visit Web Site](https://github.com/scrooloose/syntastic){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-shellcheck](https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/timonwong.shellcheck){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-shellcheck](https://github.com/AtomLinter/linter-shellcheck) | [Visit Web Site](https://github.com/AtomLinter/linter-shellcheck){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](https://github.com/flycheck/flycheck) | [Visit Web Site](https://github.com/flycheck/flycheck){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [flymake-shellcheck](https://github.com/federicotdn/flymake-shellcheck) | [Visit Web Site](https://github.com/federicotdn/flymake-shellcheck){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-shellcheck](https://github.com/SublimeLinter/SublimeLinter-shellcheck) | [Visit Web Site](https://github.com/SublimeLinter/SublimeLinter-shellcheck){target=_blank} | +| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | +| | [vim](https://www.vim.org/) | [neomake](https://github.com/neomake/neomake) | [Visit Web Site](https://github.com/neomake/neomake){target=_blank} | +| | [vim](https://www.vim.org/) | [syntastic](https://github.com/scrooloose/syntastic) | [Visit Web Site](https://github.com/scrooloose/syntastic){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-shellcheck](https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/timonwong.shellcheck){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/bash_shfmt.md b/docs/descriptors/bash_shfmt.md index 3260dc825c6..7f55c4b9e41 100644 --- a/docs/descriptors/bash_shfmt.md +++ b/docs/descriptors/bash_shfmt.md @@ -16,53 +16,53 @@ - Enable **auto-fixes** by adding `BASH_SHFMT` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------| -| BASH_SHFMT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| BASH_SHFMT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| BASH_SHFMT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| BASH_SHFMT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| BASH_SHFMT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".sh", ".bash", ".dash", ".ksh"]` | -| BASH_SHFMT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| BASH_SHFMT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| BASH_SHFMT_POST_COMMANDS | List of bash commands to run after the linter | None | -| BASH_SHFMT_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | -| BASH_SHFMT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| BASH_SHFMT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| BASH_SHFMT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| BASH_SHFMT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| BASH_SHFMT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| BASH_SHFMT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".sh", ".bash", ".dash", ".ksh"]` | +| BASH_SHFMT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| BASH_SHFMT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| BASH_SHFMT_POST_COMMANDS | List of bash commands to run after the linter| None | +| BASH_SHFMT_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| BASH_SHFMT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use shfmt in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|-----------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [format-shell](https://atom.io/packages/format-shell) | [Visit Web Site](https://atom.io/packages/format-shell){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [emacs-shfmt](https://github.com/purcell/emacs-shfmt/) | [Visit Web Site](https://github.com/purcell/emacs-shfmt/){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [shell-scripts](https://www.jetbrains.com/help/idea/shell-scripts.html) | [Visit Web Site](https://www.jetbrains.com/help/idea/shell-scripts.html){target=_blank} | -| | micro | [micro](https://micro-editor.github.io/) | [Visit Web Site](https://micro-editor.github.io/){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [Sublime-Pretty-Shell](https://github.com/aerobounce/Sublime-Pretty-Shell) | [Visit Web Site](https://github.com/aerobounce/Sublime-Pretty-Shell){target=_blank} | -| | [vim](https://www.vim.org/) | [vim-shfmt](https://github.com/z0mbix/vim-shfmt) | [Visit Web Site](https://github.com/z0mbix/vim-shfmt){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [shell-format](https://marketplace.visualstudio.com/items?itemName=foxundermoon.shell-format) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/foxundermoon.shell-format){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [format-shell](https://atom.io/packages/format-shell) | [Visit Web Site](https://atom.io/packages/format-shell){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [emacs-shfmt](https://github.com/purcell/emacs-shfmt/) | [Visit Web Site](https://github.com/purcell/emacs-shfmt/){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [shell-scripts](https://www.jetbrains.com/help/idea/shell-scripts.html) | [Visit Web Site](https://www.jetbrains.com/help/idea/shell-scripts.html){target=_blank} | +| | micro | [micro](https://micro-editor.github.io/) | [Visit Web Site](https://micro-editor.github.io/){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [Sublime-Pretty-Shell](https://github.com/aerobounce/Sublime-Pretty-Shell) | [Visit Web Site](https://github.com/aerobounce/Sublime-Pretty-Shell){target=_blank} | +| | [vim](https://www.vim.org/) | [vim-shfmt](https://github.com/z0mbix/vim-shfmt) | [Visit Web Site](https://github.com/z0mbix/vim-shfmt){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [shell-format](https://marketplace.visualstudio.com/items?itemName=foxundermoon.shell-format) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/foxundermoon.shell-format){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/c.md b/docs/descriptors/c.md index 74052add9ff..cfede7b6d10 100644 --- a/docs/descriptors/c.md +++ b/docs/descriptors/c.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|-------------------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [cpplint](c_cpplint.md) | [C_CPPLINT](c_cpplint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/cpplint/cpplint)](https://github.com/cpplint/cpplint/commits) | ## Linted files @@ -17,8 +17,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|------------------------|-------------------------------|---------------| -| C_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| C_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| C_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| C_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/c_cpplint.md b/docs/descriptors/c_cpplint.md index b9be966e546..d0524deac4f 100644 --- a/docs/descriptors/c_cpplint.md +++ b/docs/descriptors/c_cpplint.md @@ -15,27 +15,27 @@ - Enable cpplint by adding `C_CPPLINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable cpplint by adding `C_CPPLINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| C_CPPLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| C_CPPLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| C_CPPLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| C_CPPLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| C_CPPLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".c", ".h"]` | -| C_CPPLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| C_CPPLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| C_CPPLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| C_CPPLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| C_CPPLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| C_CPPLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| C_CPPLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| C_CPPLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| C_CPPLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| C_CPPLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".c", ".h"]` | +| C_CPPLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| C_CPPLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| C_CPPLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| C_CPPLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| C_CPPLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:----------------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | ## Behind the scenes diff --git a/docs/descriptors/clojure.md b/docs/descriptors/clojure.md index 074db1744a9..e9c269ca9c0 100644 --- a/docs/descriptors/clojure.md +++ b/docs/descriptors/clojure.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|-----------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [clj-kondo](clojure_clj_kondo.md) | [CLOJURE](clojure_clj_kondo.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/borkdude/clj-kondo)](https://github.com/borkdude/clj-kondo/commits) | ## Linted files @@ -19,8 +19,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|------------------------------|-------------------------------|---------------| -| CLOJURE_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| CLOJURE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| CLOJURE_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| CLOJURE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/clojure_clj_kondo.md b/docs/descriptors/clojure_clj_kondo.md index e87dc1cf923..298b2487e4f 100644 --- a/docs/descriptors/clojure_clj_kondo.md +++ b/docs/descriptors/clojure_clj_kondo.md @@ -25,40 +25,40 @@ - Enable clj-kondo by adding `CLOJURE_CLJ_KONDO` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable clj-kondo by adding `CLOJURE_CLJ_KONDO` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| CLOJURE_CLJ_KONDO_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| CLOJURE_CLJ_KONDO_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| CLOJURE_CLJ_KONDO_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| CLOJURE_CLJ_KONDO_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| CLOJURE_CLJ_KONDO_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".clj", ".cljs", ".cljc", ".edn"]` | -| CLOJURE_CLJ_KONDO_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| CLOJURE_CLJ_KONDO_PRE_COMMANDS | List of bash commands to run before the linter | None | -| CLOJURE_CLJ_KONDO_POST_COMMANDS | List of bash commands to run after the linter | None | -| CLOJURE_CLJ_KONDO_CONFIG_FILE | clj-kondo configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.clj-kondo/config.edn` | -| CLOJURE_CLJ_KONDO_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| CLOJURE_CLJ_KONDO_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| CLOJURE_CLJ_KONDO_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| CLOJURE_CLJ_KONDO_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| CLOJURE_CLJ_KONDO_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| CLOJURE_CLJ_KONDO_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| CLOJURE_CLJ_KONDO_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| CLOJURE_CLJ_KONDO_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".clj", ".cljs", ".cljc", ".edn"]` | +| CLOJURE_CLJ_KONDO_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| CLOJURE_CLJ_KONDO_PRE_COMMANDS | List of bash commands to run before the linter| None | +| CLOJURE_CLJ_KONDO_POST_COMMANDS | List of bash commands to run after the linter| None | +| CLOJURE_CLJ_KONDO_CONFIG_FILE | clj-kondo configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.clj-kondo/config.edn` | +| CLOJURE_CLJ_KONDO_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| CLOJURE_CLJ_KONDO_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| CLOJURE_CLJ_KONDO_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use clj-kondo in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-kondo](https://atom.io/packages/linter-kondo) | [Visit Web Site](https://atom.io/packages/linter-kondo){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck-clj-kondo](https://github.com/borkdude/flycheck-clj-kondo) | [Visit Web Site](https://github.com/borkdude/flycheck-clj-kondo){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-kondo](https://atom.io/packages/linter-kondo) | [Visit Web Site](https://atom.io/packages/linter-kondo){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck-clj-kondo](https://github.com/borkdude/flycheck-clj-kondo) | [Visit Web Site](https://github.com/borkdude/flycheck-clj-kondo){target=_blank} | | | [Visual Studio Code](https://code.visualstudio.com/) | [clj-kondo](https://marketplace.visualstudio.com/items?itemName=borkdude.clj-kondo) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/borkdude.clj-kondo){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [Clojure lint](https://github.com/marcomorain/clojure-lint) | [Visit Web Site](https://github.com/marcomorain/clojure-lint){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [Clojure lint](https://github.com/marcomorain/clojure-lint) | [Visit Web Site](https://github.com/marcomorain/clojure-lint){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:----------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | ## Behind the scenes diff --git a/docs/descriptors/cloudformation.md b/docs/descriptors/cloudformation.md index e9faf2f3ce2..94ab5f7c433 100644 --- a/docs/descriptors/cloudformation.md +++ b/docs/descriptors/cloudformation.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|----------------------------------------|----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [cfn-lint](cloudformation_cfn_lint.md) | [CLOUDFORMATION](cloudformation_cfn_lint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/aws-cloudformation/cfn-lint)](https://github.com/aws-cloudformation/cfn-lint/commits) | ## Linted files @@ -22,8 +22,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|-------------------------------------|-------------------------------|---------------| -| CLOUDFORMATION_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| CLOUDFORMATION_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| CLOUDFORMATION_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| CLOUDFORMATION_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/cloudformation_cfn_lint.md b/docs/descriptors/cloudformation_cfn_lint.md index 83d8146a80b..d47aba651ac 100644 --- a/docs/descriptors/cloudformation_cfn_lint.md +++ b/docs/descriptors/cloudformation_cfn_lint.md @@ -23,40 +23,40 @@ - Enable cfn-lint by adding `CLOUDFORMATION_CFN_LINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable cfn-lint by adding `CLOUDFORMATION_CFN_LINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| CLOUDFORMATION_CFN_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| CLOUDFORMATION_CFN_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| CLOUDFORMATION_CFN_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| CLOUDFORMATION_CFN_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| CLOUDFORMATION_CFN_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml", ".json"]` | -| CLOUDFORMATION_CFN_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| CLOUDFORMATION_CFN_LINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| CLOUDFORMATION_CFN_LINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| CLOUDFORMATION_CFN_LINT_CONFIG_FILE | cfn-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.cfnlintrc.yml` | -| CLOUDFORMATION_CFN_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| CLOUDFORMATION_CFN_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| CLOUDFORMATION_CFN_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| CLOUDFORMATION_CFN_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| CLOUDFORMATION_CFN_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| CLOUDFORMATION_CFN_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| CLOUDFORMATION_CFN_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| CLOUDFORMATION_CFN_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml", ".json"]` | +| CLOUDFORMATION_CFN_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| CLOUDFORMATION_CFN_LINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| CLOUDFORMATION_CFN_LINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| CLOUDFORMATION_CFN_LINT_CONFIG_FILE | cfn-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.cfnlintrc.yml` | +| CLOUDFORMATION_CFN_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| CLOUDFORMATION_CFN_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| CLOUDFORMATION_CFN_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use cfn-lint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|---------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [atom-cfn-lint](https://atom.io/packages/atom-cfn-lint) | [Visit Web Site](https://atom.io/packages/atom-cfn-lint){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [cfn-lint](https://plugins.jetbrains.com/plugin/10973-cfn-lint) | | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter CloudFormation](https://packagecontrol.io/packages/SublimeLinter-contrib-cloudformation) | [Visit Web Site](https://packagecontrol.io/packages/SublimeLinter-contrib-cloudformation){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-cfn-lint](https://marketplace.visualstudio.com/items?itemName=kddejong.vscode-cfn-lint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/kddejong.vscode-cfn-lint){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [atom-cfn-lint](https://atom.io/packages/atom-cfn-lint) | [Visit Web Site](https://atom.io/packages/atom-cfn-lint){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [cfn-lint](https://plugins.jetbrains.com/plugin/10973-cfn-lint) | | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter CloudFormation](https://packagecontrol.io/packages/SublimeLinter-contrib-cloudformation) | [Visit Web Site](https://packagecontrol.io/packages/SublimeLinter-contrib-cloudformation){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-cfn-lint](https://marketplace.visualstudio.com/items?itemName=kddejong.vscode-cfn-lint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/kddejong.vscode-cfn-lint){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------|:--------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | ## Behind the scenes diff --git a/docs/descriptors/coffee.md b/docs/descriptors/coffee.md index 9842c2d4ce3..4075244dd7e 100644 --- a/docs/descriptors/coffee.md +++ b/docs/descriptors/coffee.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|------------------------------------|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [coffeelint](coffee_coffeelint.md) | [COFFEE](coffee_coffeelint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/clutchski/coffeelint)](https://github.com/clutchski/coffeelint/commits) | ## Linted files @@ -16,8 +16,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|-----------------------------|-------------------------------|---------------| -| COFFEE_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| COFFEE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| COFFEE_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| COFFEE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/coffee_coffeelint.md b/docs/descriptors/coffee_coffeelint.md index dfea15df152..84ac0084de1 100644 --- a/docs/descriptors/coffee_coffeelint.md +++ b/docs/descriptors/coffee_coffeelint.md @@ -18,38 +18,38 @@ - Enable coffeelint by adding `COFFEE_COFFEELINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable coffeelint by adding `COFFEE_COFFEELINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| COFFEE_COFFEELINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| COFFEE_COFFEELINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| COFFEE_COFFEELINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| COFFEE_COFFEELINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| COFFEE_COFFEELINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".coffee"]` | -| COFFEE_COFFEELINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| COFFEE_COFFEELINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| COFFEE_COFFEELINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| COFFEE_COFFEELINT_CONFIG_FILE | coffeelint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.coffee-lint.json` | -| COFFEE_COFFEELINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| COFFEE_COFFEELINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| COFFEE_COFFEELINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| COFFEE_COFFEELINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| COFFEE_COFFEELINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| COFFEE_COFFEELINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| COFFEE_COFFEELINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| COFFEE_COFFEELINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".coffee"]` | +| COFFEE_COFFEELINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| COFFEE_COFFEELINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| COFFEE_COFFEELINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| COFFEE_COFFEELINT_CONFIG_FILE | coffeelint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.coffee-lint.json` | +| COFFEE_COFFEELINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| COFFEE_COFFEELINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| COFFEE_COFFEELINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use coffeelint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-----------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|--------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-coffeelint](https://atom.io/packages/linter-coffeelint) | [Visit Web Site](https://atom.io/packages/linter-coffeelint){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-coffeelint](https://atom.io/packages/linter-coffeelint) | [Visit Web Site](https://atom.io/packages/linter-coffeelint){target=_blank} | | | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [coffeelint](https://plugins.jetbrains.com/plugin/7723-coffeelint) | | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | ## Behind the scenes diff --git a/docs/descriptors/copypaste.md b/docs/descriptors/copypaste.md index 0649203f7ce..82e5267326a 100644 --- a/docs/descriptors/copypaste.md +++ b/docs/descriptors/copypaste.md @@ -5,16 +5,16 @@ ## Linters -| Linter | Configuration key | Status | -|-----------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [jscpd](copypaste_jscpd.md) | [COPYPASTE](copypaste_jscpd.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/kucherenko/jscpd)](https://github.com/kucherenko/jscpd/commits) | ## Linted files ## Configuration in MegaLinter -| Variable | Description | Default value | -|--------------------------------|-------------------------------|---------------| -| COPYPASTE_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| COPYPASTE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| COPYPASTE_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| COPYPASTE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/copypaste_jscpd.md b/docs/descriptors/copypaste_jscpd.md index 8ad461fe6d7..ade88a4c3e0 100644 --- a/docs/descriptors/copypaste_jscpd.md +++ b/docs/descriptors/copypaste_jscpd.md @@ -43,37 +43,37 @@ Example: - Enable jscpd by adding `COPYPASTE_JSCPD` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable jscpd by adding `COPYPASTE_JSCPD` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|---------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| COPYPASTE_JSCPD_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| COPYPASTE_JSCPD_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | -| COPYPASTE_JSCPD_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| COPYPASTE_JSCPD_PRE_COMMANDS | List of bash commands to run before the linter | None | -| COPYPASTE_JSCPD_POST_COMMANDS | List of bash commands to run after the linter | None | -| COPYPASTE_JSCPD_CONFIG_FILE | jscpd configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.jscpd.json` | -| COPYPASTE_JSCPD_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| COPYPASTE_JSCPD_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| COPYPASTE_JSCPD_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| COPYPASTE_JSCPD_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| COPYPASTE_JSCPD_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | +| COPYPASTE_JSCPD_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| COPYPASTE_JSCPD_PRE_COMMANDS | List of bash commands to run before the linter| None | +| COPYPASTE_JSCPD_POST_COMMANDS | List of bash commands to run after the linter| None | +| COPYPASTE_JSCPD_CONFIG_FILE | jscpd configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.jscpd.json` | +| COPYPASTE_JSCPD_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| COPYPASTE_JSCPD_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| COPYPASTE_JSCPD_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/cpp.md b/docs/descriptors/cpp.md index 812c855ceee..02d16f3875e 100644 --- a/docs/descriptors/cpp.md +++ b/docs/descriptors/cpp.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|---------------------------|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [cpplint](cpp_cpplint.md) | [CPP_CPPLINT](cpp_cpplint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/cpplint/cpplint)](https://github.com/cpplint/cpplint/commits) | ## Linted files @@ -26,8 +26,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|--------------------------|-------------------------------|---------------| -| CPP_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| CPP_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| CPP_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| CPP_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/cpp_cpplint.md b/docs/descriptors/cpp_cpplint.md index 5ffeac837c0..cb1027c7947 100644 --- a/docs/descriptors/cpp_cpplint.md +++ b/docs/descriptors/cpp_cpplint.md @@ -15,27 +15,27 @@ - Enable cpplint by adding `CPP_CPPLINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable cpplint by adding `CPP_CPPLINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------| -| CPP_CPPLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| CPP_CPPLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| CPP_CPPLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| CPP_CPPLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| CPP_CPPLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".cpp", ".h", ".cc", ".hpp", ".cxx", ".cu", ".hxx", ".c++", ".hh", ".h++", ".cuh"]` | -| CPP_CPPLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| CPP_CPPLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| CPP_CPPLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| CPP_CPPLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| CPP_CPPLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| CPP_CPPLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| CPP_CPPLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| CPP_CPPLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| CPP_CPPLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| CPP_CPPLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".cpp", ".h", ".cc", ".hpp", ".cxx", ".cu", ".hxx", ".c++", ".hh", ".h++", ".cuh"]` | +| CPP_CPPLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| CPP_CPPLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| CPP_CPPLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| CPP_CPPLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| CPP_CPPLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:----------------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | ## Behind the scenes diff --git a/docs/descriptors/csharp.md b/docs/descriptors/csharp.md index f76ad8a2abe..5f28ac2cadb 100644 --- a/docs/descriptors/csharp.md +++ b/docs/descriptors/csharp.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|------------------------------------------|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [dotnet-format](csharp_dotnet_format.md) | [CSHARP](csharp_dotnet_format.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/dotnet/format)](https://github.com/dotnet/format/commits) | ## Linted files @@ -16,10 +16,10 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|-----------------------------|-------------------------------|---------------| -| CSHARP_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| CSHARP_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| CSHARP_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| CSHARP_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | ## Behind the scenes diff --git a/docs/descriptors/csharp_dotnet_format.md b/docs/descriptors/csharp_dotnet_format.md index 05a99ba5557..c3aa54e317e 100644 --- a/docs/descriptors/csharp_dotnet_format.md +++ b/docs/descriptors/csharp_dotnet_format.md @@ -16,27 +16,27 @@ - Enable **auto-fixes** by adding `CSHARP_DOTNET_FORMAT` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| CSHARP_DOTNET_FORMAT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| CSHARP_DOTNET_FORMAT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| CSHARP_DOTNET_FORMAT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| CSHARP_DOTNET_FORMAT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| CSHARP_DOTNET_FORMAT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".cs"]` | -| CSHARP_DOTNET_FORMAT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| CSHARP_DOTNET_FORMAT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| CSHARP_DOTNET_FORMAT_POST_COMMANDS | List of bash commands to run after the linter | None | -| CSHARP_DOTNET_FORMAT_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | -| CSHARP_DOTNET_FORMAT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| CSHARP_DOTNET_FORMAT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| CSHARP_DOTNET_FORMAT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| CSHARP_DOTNET_FORMAT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| CSHARP_DOTNET_FORMAT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| CSHARP_DOTNET_FORMAT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".cs"]` | +| CSHARP_DOTNET_FORMAT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| CSHARP_DOTNET_FORMAT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| CSHARP_DOTNET_FORMAT_POST_COMMANDS | List of bash commands to run after the linter| None | +| CSHARP_DOTNET_FORMAT_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| CSHARP_DOTNET_FORMAT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:----------------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | ## Behind the scenes diff --git a/docs/descriptors/css.md b/docs/descriptors/css.md index 0b5a0713168..93bc39ac0dd 100644 --- a/docs/descriptors/css.md +++ b/docs/descriptors/css.md @@ -5,10 +5,10 @@ ## Linters -| Linter | Configuration key | Status | -|-------------------------------|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [stylelint](css_stylelint.md) | [CSS_STYLELINT](css_stylelint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/stylelint/stylelint)](https://github.com/stylelint/stylelint/commits) | -| [scss-lint](css_scss_lint.md) | [CSS_SCSS_LINT](css_scss_lint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/sds/scss-lint)](https://github.com/sds/scss-lint/commits) | +| [scss-lint](css_scss_lint.md) | [CSS_SCSS_LINT](css_scss_lint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/sds/scss-lint)](https://github.com/sds/scss-lint/commits) | ## Linted files @@ -19,8 +19,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|--------------------------|-------------------------------|---------------| -| CSS_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| CSS_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| CSS_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| CSS_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/css_scss_lint.md b/docs/descriptors/css_scss_lint.md index 2be80311d80..33940fdb346 100644 --- a/docs/descriptors/css_scss_lint.md +++ b/docs/descriptors/css_scss_lint.md @@ -23,50 +23,50 @@ - Enable scss-lint by adding `CSS_SCSS_LINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable scss-lint by adding `CSS_SCSS_LINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| CSS_SCSS_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| CSS_SCSS_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| CSS_SCSS_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| CSS_SCSS_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| CSS_SCSS_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".scss", ".saas"]` | -| CSS_SCSS_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| CSS_SCSS_LINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| CSS_SCSS_LINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| CSS_SCSS_LINT_CONFIG_FILE | scss-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.scss-lint.yml` | -| CSS_SCSS_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| CSS_SCSS_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| CSS_SCSS_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| CSS_SCSS_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| CSS_SCSS_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| CSS_SCSS_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| CSS_SCSS_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| CSS_SCSS_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".scss", ".saas"]` | +| CSS_SCSS_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| CSS_SCSS_LINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| CSS_SCSS_LINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| CSS_SCSS_LINT_CONFIG_FILE | scss-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.scss-lint.yml` | +| CSS_SCSS_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| CSS_SCSS_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| CSS_SCSS_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use scss-lint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|---------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-scss-lint](https://atom.io/packages/linter-scss-lint) | [Visit Web Site](https://atom.io/packages/linter-scss-lint){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [scss-lint-plugin](https://plugins.jetbrains.com/plugin/7530-scss-lint) | | -| | [Visual Studio Code](https://code.visualstudio.com/) | [scss-lint](https://marketplace.visualstudio.com/items?itemName=adamwalzer.scss-lint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/adamwalzer.scss-lint){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-scss-lint](https://atom.io/packages/linter-scss-lint) | [Visit Web Site](https://atom.io/packages/linter-scss-lint){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [scss-lint-plugin](https://plugins.jetbrains.com/plugin/7530-scss-lint) | | +| | [Visual Studio Code](https://code.visualstudio.com/) | [scss-lint](https://marketplace.visualstudio.com/items?itemName=adamwalzer.scss-lint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/adamwalzer.scss-lint){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/css_stylelint.md b/docs/descriptors/css_stylelint.md index e8090f7ce07..5bfbaa981d8 100644 --- a/docs/descriptors/css_stylelint.md +++ b/docs/descriptors/css_stylelint.md @@ -27,53 +27,53 @@ - Enable **auto-fixes** by adding `CSS_STYLELINT` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| CSS_STYLELINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| CSS_STYLELINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| CSS_STYLELINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| CSS_STYLELINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| CSS_STYLELINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".css", ".scss", ".saas"]` | -| CSS_STYLELINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| CSS_STYLELINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| CSS_STYLELINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| CSS_STYLELINT_CONFIG_FILE | stylelint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.stylelintrc.json` | -| CSS_STYLELINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| CSS_STYLELINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| CSS_STYLELINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| CSS_STYLELINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| CSS_STYLELINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| CSS_STYLELINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| CSS_STYLELINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| CSS_STYLELINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".css", ".scss", ".saas"]` | +| CSS_STYLELINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| CSS_STYLELINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| CSS_STYLELINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| CSS_STYLELINT_CONFIG_FILE | stylelint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.stylelintrc.json` | +| CSS_STYLELINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| CSS_STYLELINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| CSS_STYLELINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use stylelint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|----------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-stylelint](https://github.com/AtomLinter/linter-stylelint) | [Visit Web Site](https://github.com/AtomLinter/linter-stylelint){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](https://github.com/flycheck/flycheck) | [Visit Web Site](https://github.com/flycheck/flycheck){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-stylelint](https://github.com/SublimeLinter/SublimeLinter-stylelint) | [Visit Web Site](https://github.com/SublimeLinter/SublimeLinter-stylelint){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-stylelint_d](https://github.com/jo-sm/SublimeLinter-contrib-stylelint_d) | [Visit Web Site](https://github.com/jo-sm/SublimeLinter-contrib-stylelint_d){target=_blank} | -| | [vim](https://www.vim.org/) | [ale](https://github.com/dense-analysis/ale) | [Visit Web Site](https://github.com/dense-analysis/ale){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/stylelint.vscode-stylelint){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-stylelint](https://github.com/AtomLinter/linter-stylelint) | [Visit Web Site](https://github.com/AtomLinter/linter-stylelint){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](https://github.com/flycheck/flycheck) | [Visit Web Site](https://github.com/flycheck/flycheck){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-stylelint](https://github.com/SublimeLinter/SublimeLinter-stylelint) | [Visit Web Site](https://github.com/SublimeLinter/SublimeLinter-stylelint){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-stylelint_d](https://github.com/jo-sm/SublimeLinter-contrib-stylelint_d) | [Visit Web Site](https://github.com/jo-sm/SublimeLinter-contrib-stylelint_d){target=_blank} | +| | [vim](https://www.vim.org/) | [ale](https://github.com/dense-analysis/ale) | [Visit Web Site](https://github.com/dense-analysis/ale){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/stylelint.vscode-stylelint){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/dart.md b/docs/descriptors/dart.md index d6df33c3289..03d8e71fa6e 100644 --- a/docs/descriptors/dart.md +++ b/docs/descriptors/dart.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|--------------------------------------|------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [dartanalyzer](dart_dartanalyzer.md) | [DART](dart_dartanalyzer.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/dart-lang/sdk)](https://github.com/dart-lang/sdk/commits) | ## Linted files @@ -16,8 +16,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|---------------------------|-------------------------------|---------------| -| DART_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| DART_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| DART_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| DART_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/dart_dartanalyzer.md b/docs/descriptors/dart_dartanalyzer.md index 57fac33a179..30da360518b 100644 --- a/docs/descriptors/dart_dartanalyzer.md +++ b/docs/descriptors/dart_dartanalyzer.md @@ -23,37 +23,37 @@ - Enable dartanalyzer by adding `DART_DARTANALYZER` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable dartanalyzer by adding `DART_DARTANALYZER` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| DART_DARTANALYZER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| DART_DARTANALYZER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| DART_DARTANALYZER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| DART_DARTANALYZER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| DART_DARTANALYZER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".dart"]` | -| DART_DARTANALYZER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| DART_DARTANALYZER_PRE_COMMANDS | List of bash commands to run before the linter | None | -| DART_DARTANALYZER_POST_COMMANDS | List of bash commands to run after the linter | None | -| DART_DARTANALYZER_CONFIG_FILE | dartanalyzer configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `analysis_options.yml` | -| DART_DARTANALYZER_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| DART_DARTANALYZER_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| DART_DARTANALYZER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| DART_DARTANALYZER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| DART_DARTANALYZER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| DART_DARTANALYZER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| DART_DARTANALYZER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| DART_DARTANALYZER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".dart"]` | +| DART_DARTANALYZER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| DART_DARTANALYZER_PRE_COMMANDS | List of bash commands to run before the linter| None | +| DART_DARTANALYZER_POST_COMMANDS | List of bash commands to run after the linter| None | +| DART_DARTANALYZER_CONFIG_FILE | dartanalyzer configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `analysis_options.yml` | +| DART_DARTANALYZER_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| DART_DARTANALYZER_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| DART_DARTANALYZER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use dartanalyzer in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|--------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [dart-jetbrains-plugin](https://plugins.jetbrains.com/plugin/6351-dart) | | -| | [Visual Studio Code](https://code.visualstudio.com/) | [dart-code](https://marketplace.visualstudio.com/items?itemName=Dart-Code.dart-code) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/Dart-Code.dart-code){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [dart-jetbrains-plugin](https://plugins.jetbrains.com/plugin/6351-dart) | | +| | [Visual Studio Code](https://code.visualstudio.com/) | [dart-code](https://marketplace.visualstudio.com/items?itemName=Dart-Code.dart-code) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/Dart-Code.dart-code){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:--------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | ## Behind the scenes diff --git a/docs/descriptors/dockerfile.md b/docs/descriptors/dockerfile.md index 87051bf7da9..0bbde317da3 100644 --- a/docs/descriptors/dockerfile.md +++ b/docs/descriptors/dockerfile.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|------------------------------------|-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [hadolint](dockerfile_hadolint.md) | [DOCKERFILE_HADOLINT](dockerfile_hadolint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/hadolint/hadolint)](https://github.com/hadolint/hadolint/commits) | ## Linted files @@ -16,8 +16,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|---------------------------------|-------------------------------|---------------| -| DOCKERFILE_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| DOCKERFILE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| DOCKERFILE_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| DOCKERFILE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/dockerfile_hadolint.md b/docs/descriptors/dockerfile_hadolint.md index 6bd1a215a06..276b813502a 100644 --- a/docs/descriptors/dockerfile_hadolint.md +++ b/docs/descriptors/dockerfile_hadolint.md @@ -17,51 +17,51 @@ - Enable hadolint by adding `DOCKERFILE_HADOLINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable hadolint by adding `DOCKERFILE_HADOLINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| DOCKERFILE_HADOLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| DOCKERFILE_HADOLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| DOCKERFILE_HADOLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| DOCKERFILE_HADOLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| DOCKERFILE_HADOLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | -| DOCKERFILE_HADOLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | `["Dockerfile"]` | -| DOCKERFILE_HADOLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| DOCKERFILE_HADOLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| DOCKERFILE_HADOLINT_CONFIG_FILE | hadolint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.hadolint.yaml` | -| DOCKERFILE_HADOLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| DOCKERFILE_HADOLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| DOCKERFILE_HADOLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| DOCKERFILE_HADOLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| DOCKERFILE_HADOLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| DOCKERFILE_HADOLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| DOCKERFILE_HADOLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| DOCKERFILE_HADOLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | +| DOCKERFILE_HADOLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | `["Dockerfile"]` | +| DOCKERFILE_HADOLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| DOCKERFILE_HADOLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| DOCKERFILE_HADOLINT_CONFIG_FILE | hadolint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.hadolint.yaml` | +| DOCKERFILE_HADOLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| DOCKERFILE_HADOLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| DOCKERFILE_HADOLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use hadolint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|---------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-hadolint](https://atom.io/packages/linter-hadolint) | [Visit Web Site](https://atom.io/packages/linter-hadolint){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-hadolint](https://atom.io/packages/linter-hadolint) | [Visit Web Site](https://atom.io/packages/linter-hadolint){target=_blank} | | | [Visual Studio Code](https://code.visualstudio.com/) | [hadolint](https://marketplace.visualstudio.com/items?itemName=exiasr.hadolint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/exiasr.hadolint){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/editorconfig.md b/docs/descriptors/editorconfig.md index 3275c1da0da..56bbccb2319 100644 --- a/docs/descriptors/editorconfig.md +++ b/docs/descriptors/editorconfig.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|--------------------------------------------------------------|------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [editorconfig-checker](editorconfig_editorconfig_checker.md) | [EDITORCONFIG](editorconfig_editorconfig_checker.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/editorconfig-checker/editorconfig-checker)](https://github.com/editorconfig-checker/editorconfig-checker/commits) | ## Linted files @@ -17,8 +17,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|-----------------------------------|-------------------------------|---------------| -| EDITORCONFIG_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| EDITORCONFIG_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| EDITORCONFIG_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| EDITORCONFIG_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/editorconfig_editorconfig_checker.md b/docs/descriptors/editorconfig_editorconfig_checker.md index 593db703459..c2cf16f1a50 100644 --- a/docs/descriptors/editorconfig_editorconfig_checker.md +++ b/docs/descriptors/editorconfig_editorconfig_checker.md @@ -23,40 +23,40 @@ - Enable editorconfig-checker by adding `EDITORCONFIG_EDITORCONFIG_CHECKER` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable editorconfig-checker by adding `EDITORCONFIG_EDITORCONFIG_CHECKER` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|---------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| EDITORCONFIG_EDITORCONFIG_CHECKER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| EDITORCONFIG_EDITORCONFIG_CHECKER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| EDITORCONFIG_EDITORCONFIG_CHECKER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| EDITORCONFIG_EDITORCONFIG_CHECKER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `["*"]` | -| EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS | List of bash commands to run before the linter | None | -| EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS | List of bash commands to run after the linter | None | -| EDITORCONFIG_EDITORCONFIG_CHECKER_CONFIG_FILE | editorconfig-checker configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.ecrc` | -| EDITORCONFIG_EDITORCONFIG_CHECKER_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| EDITORCONFIG_EDITORCONFIG_CHECKER_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| EDITORCONFIG_EDITORCONFIG_CHECKER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| EDITORCONFIG_EDITORCONFIG_CHECKER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| EDITORCONFIG_EDITORCONFIG_CHECKER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| EDITORCONFIG_EDITORCONFIG_CHECKER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| EDITORCONFIG_EDITORCONFIG_CHECKER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `["*"]` | +| EDITORCONFIG_EDITORCONFIG_CHECKER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| EDITORCONFIG_EDITORCONFIG_CHECKER_PRE_COMMANDS | List of bash commands to run before the linter| None | +| EDITORCONFIG_EDITORCONFIG_CHECKER_POST_COMMANDS | List of bash commands to run after the linter| None | +| EDITORCONFIG_EDITORCONFIG_CHECKER_CONFIG_FILE | editorconfig-checker configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.ecrc` | +| EDITORCONFIG_EDITORCONFIG_CHECKER_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| EDITORCONFIG_EDITORCONFIG_CHECKER_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| EDITORCONFIG_EDITORCONFIG_CHECKER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/env.md b/docs/descriptors/env.md index a9435e2d1df..098ea6da9c8 100644 --- a/docs/descriptors/env.md +++ b/docs/descriptors/env.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|---------------------------------------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [dotenv-linter](env_dotenv_linter.md) | [ENV](env_dotenv_linter.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/dotenv-linter/dotenv-linter)](https://github.com/dotenv-linter/dotenv-linter/commits) | ## Linted files @@ -16,8 +16,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|--------------------------|-------------------------------|---------------| -| ENV_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| ENV_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| ENV_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| ENV_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/env_dotenv_linter.md b/docs/descriptors/env_dotenv_linter.md index da6a469167e..9e1e4e5f72d 100644 --- a/docs/descriptors/env_dotenv_linter.md +++ b/docs/descriptors/env_dotenv_linter.md @@ -24,39 +24,39 @@ - Enable **auto-fixes** by adding `ENV_DOTENV_LINTER` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| ENV_DOTENV_LINTER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| ENV_DOTENV_LINTER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| ENV_DOTENV_LINTER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| ENV_DOTENV_LINTER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| ENV_DOTENV_LINTER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".env"]` | -| ENV_DOTENV_LINTER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| ENV_DOTENV_LINTER_PRE_COMMANDS | List of bash commands to run before the linter | None | -| ENV_DOTENV_LINTER_POST_COMMANDS | List of bash commands to run after the linter | None | -| ENV_DOTENV_LINTER_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| ENV_DOTENV_LINTER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| ENV_DOTENV_LINTER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| ENV_DOTENV_LINTER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| ENV_DOTENV_LINTER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| ENV_DOTENV_LINTER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| ENV_DOTENV_LINTER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".env"]` | +| ENV_DOTENV_LINTER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| ENV_DOTENV_LINTER_PRE_COMMANDS | List of bash commands to run before the linter| None | +| ENV_DOTENV_LINTER_POST_COMMANDS | List of bash commands to run after the linter| None | +| ENV_DOTENV_LINTER_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| ENV_DOTENV_LINTER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/gherkin.md b/docs/descriptors/gherkin.md index 33be32b1814..6b44986990e 100644 --- a/docs/descriptors/gherkin.md +++ b/docs/descriptors/gherkin.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|-----------------------------------------|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [gherkin-lint](gherkin_gherkin_lint.md) | [GHERKIN](gherkin_gherkin_lint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/vsiakka/gherkin-lint)](https://github.com/vsiakka/gherkin-lint/commits) | ## Linted files @@ -16,8 +16,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|------------------------------|-------------------------------|---------------| -| GHERKIN_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| GHERKIN_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| GHERKIN_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| GHERKIN_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/gherkin_gherkin_lint.md b/docs/descriptors/gherkin_gherkin_lint.md index 15394955b55..803d540caaa 100644 --- a/docs/descriptors/gherkin_gherkin_lint.md +++ b/docs/descriptors/gherkin_gherkin_lint.md @@ -16,29 +16,29 @@ - Enable gherkin-lint by adding `GHERKIN_GHERKIN_LINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable gherkin-lint by adding `GHERKIN_GHERKIN_LINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| GHERKIN_GHERKIN_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| GHERKIN_GHERKIN_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| GHERKIN_GHERKIN_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| GHERKIN_GHERKIN_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| GHERKIN_GHERKIN_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".feature"]` | -| GHERKIN_GHERKIN_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| GHERKIN_GHERKIN_LINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| GHERKIN_GHERKIN_LINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| GHERKIN_GHERKIN_LINT_CONFIG_FILE | gherkin-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.gherkin-lintrc` | -| GHERKIN_GHERKIN_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| GHERKIN_GHERKIN_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| GHERKIN_GHERKIN_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| GHERKIN_GHERKIN_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| GHERKIN_GHERKIN_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| GHERKIN_GHERKIN_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| GHERKIN_GHERKIN_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| GHERKIN_GHERKIN_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".feature"]` | +| GHERKIN_GHERKIN_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| GHERKIN_GHERKIN_LINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| GHERKIN_GHERKIN_LINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| GHERKIN_GHERKIN_LINT_CONFIG_FILE | gherkin-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.gherkin-lintrc` | +| GHERKIN_GHERKIN_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| GHERKIN_GHERKIN_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| GHERKIN_GHERKIN_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:----------------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | ## Behind the scenes diff --git a/docs/descriptors/go.md b/docs/descriptors/go.md index aadc281523d..a09dcc185cf 100644 --- a/docs/descriptors/go.md +++ b/docs/descriptors/go.md @@ -5,10 +5,10 @@ ## Linters -| Linter | Configuration key | Status | -|--------------------------------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [golangci-lint](go_golangci_lint.md) | [GO](go_golangci_lint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/golangci/golangci-lint)](https://github.com/golangci/golangci-lint/commits) | -| [revive](go_revive.md) | [GO](go_revive.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/mgechev/revive)](https://github.com/mgechev/revive/commits) | +| [revive](go_revive.md) | [GO](go_revive.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/mgechev/revive)](https://github.com/mgechev/revive/commits) | ## Linted files @@ -17,10 +17,10 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|-------------------------|-------------------------------|---------------| -| GO_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| GO_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| GO_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| GO_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | ## Behind the scenes diff --git a/docs/descriptors/go_golangci_lint.md b/docs/descriptors/go_golangci_lint.md index b9f072a93a5..53a4ae37b62 100644 --- a/docs/descriptors/go_golangci_lint.md +++ b/docs/descriptors/go_golangci_lint.md @@ -25,43 +25,43 @@ - Enable golangci-lint by adding `GO_GOLANGCI_LINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable golangci-lint by adding `GO_GOLANGCI_LINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| GO_GOLANGCI_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| GO_GOLANGCI_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| GO_GOLANGCI_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| GO_GOLANGCI_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| GO_GOLANGCI_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".go"]` | -| GO_GOLANGCI_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| GO_GOLANGCI_LINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| GO_GOLANGCI_LINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| GO_GOLANGCI_LINT_CONFIG_FILE | golangci-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.golangci.yml` | -| GO_GOLANGCI_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| GO_GOLANGCI_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| GO_GOLANGCI_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| GO_GOLANGCI_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| GO_GOLANGCI_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| GO_GOLANGCI_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| GO_GOLANGCI_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| GO_GOLANGCI_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".go"]` | +| GO_GOLANGCI_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| GO_GOLANGCI_LINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| GO_GOLANGCI_LINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| GO_GOLANGCI_LINT_CONFIG_FILE | golangci-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.golangci.yml` | +| GO_GOLANGCI_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| GO_GOLANGCI_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| GO_GOLANGCI_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use golangci-lint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [go-plus](https://atom.io/packages/go-plus) | [Visit Web Site](https://atom.io/packages/go-plus){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck-golandci-lint](https://github.com/weijiangan/flycheck-golangci-lint) | [Visit Web Site](https://github.com/weijiangan/flycheck-golangci-lint){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [SpaceMacs](https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/go/README.org#pre-requisites) | [Visit Web Site](https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/go/README.org#pre-requisites){target=_blank} | -| | goland | [goland](https://www.jetbrains.com/help/go/settings-tools-file-watchers.html) | [Visit Web Site](https://www.jetbrains.com/help/go/settings-tools-file-watchers.html){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-golang-cilint](https://github.com/alecthomas/SublimeLinter-contrib-golang-cilint) | [Visit Web Site](https://github.com/alecthomas/SublimeLinter-contrib-golang-cilint){target=_blank} | -| | [vim](https://www.vim.org/) | [vim-go](https://github.com/fatih/vim-go) | [Visit Web Site](https://github.com/fatih/vim-go){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode.Go](https://marketplace.visualstudio.com/items?itemName=ms-vscode.Go) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/ms-vscode.Go){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [go-plus](https://atom.io/packages/go-plus) | [Visit Web Site](https://atom.io/packages/go-plus){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck-golandci-lint](https://github.com/weijiangan/flycheck-golangci-lint) | [Visit Web Site](https://github.com/weijiangan/flycheck-golangci-lint){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [SpaceMacs](https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/go/README.org#pre-requisites) | [Visit Web Site](https://github.com/syl20bnr/spacemacs/blob/develop/layers/+lang/go/README.org#pre-requisites){target=_blank} | +| | goland | [goland](https://www.jetbrains.com/help/go/settings-tools-file-watchers.html) | [Visit Web Site](https://www.jetbrains.com/help/go/settings-tools-file-watchers.html){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-golang-cilint](https://github.com/alecthomas/SublimeLinter-contrib-golang-cilint) | [Visit Web Site](https://github.com/alecthomas/SublimeLinter-contrib-golang-cilint){target=_blank} | +| | [vim](https://www.vim.org/) | [vim-go](https://github.com/fatih/vim-go) | [Visit Web Site](https://github.com/fatih/vim-go){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode.Go](https://marketplace.visualstudio.com/items?itemName=ms-vscode.Go) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/ms-vscode.Go){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:--------------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | ## Behind the scenes diff --git a/docs/descriptors/go_revive.md b/docs/descriptors/go_revive.md index d6cad051cfa..1e4a76eb9d5 100644 --- a/docs/descriptors/go_revive.md +++ b/docs/descriptors/go_revive.md @@ -15,39 +15,39 @@ - Enable revive by adding `GO_REVIVE` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable revive by adding `GO_REVIVE` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| GO_REVIVE_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| GO_REVIVE_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| GO_REVIVE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| GO_REVIVE_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| GO_REVIVE_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".go"]` | -| GO_REVIVE_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| GO_REVIVE_PRE_COMMANDS | List of bash commands to run before the linter | None | -| GO_REVIVE_POST_COMMANDS | List of bash commands to run after the linter | None | -| GO_REVIVE_CONFIG_FILE | revive configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `revive.toml` | -| GO_REVIVE_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| GO_REVIVE_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| GO_REVIVE_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| GO_REVIVE_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| GO_REVIVE_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| GO_REVIVE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| GO_REVIVE_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| GO_REVIVE_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".go"]` | +| GO_REVIVE_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| GO_REVIVE_PRE_COMMANDS | List of bash commands to run before the linter| None | +| GO_REVIVE_POST_COMMANDS | List of bash commands to run after the linter| None | +| GO_REVIVE_CONFIG_FILE | revive configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `revive.toml` | +| GO_REVIVE_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| GO_REVIVE_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| GO_REVIVE_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use revive in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-revive](https://github.com/morphy2k/linter-revive) | [Visit Web Site](https://github.com/morphy2k/linter-revive){target=_blank} | -| | [vim](https://www.vim.org/) | [ale](https://github.com/dense-analysis/ale) | [Visit Web Site](https://github.com/dense-analysis/ale){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-revive](https://github.com/morphy2k/linter-revive) | [Visit Web Site](https://github.com/morphy2k/linter-revive){target=_blank} | +| | [vim](https://www.vim.org/) | [ale](https://github.com/dense-analysis/ale) | [Visit Web Site](https://github.com/dense-analysis/ale){target=_blank} | | | [Visual Studio Code](https://code.visualstudio.com/) | [vscode.Go](https://marketplace.visualstudio.com/items?itemName=ms-vscode.Go) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/ms-vscode.Go){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:--------------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | ## Behind the scenes diff --git a/docs/descriptors/graphql.md b/docs/descriptors/graphql.md index 0a859b31ed6..427f3dcb0d8 100644 --- a/docs/descriptors/graphql.md +++ b/docs/descriptors/graphql.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|-----------------------------------------------------------|-------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [graphql-schema-linter](graphql_graphql_schema_linter.md) | [GRAPHQL_GRAPHQL_SCHEMA_LINTER](graphql_graphql_schema_linter.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/cjoudrey/graphql-schema-linter)](https://github.com/cjoudrey/graphql-schema-linter/commits) | ## Linted files @@ -16,8 +16,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|------------------------------|-------------------------------|---------------| -| GRAPHQL_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| GRAPHQL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| GRAPHQL_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| GRAPHQL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/graphql_graphql_schema_linter.md b/docs/descriptors/graphql_graphql_schema_linter.md index 45cc0ab88ea..e2bea1ffbaf 100644 --- a/docs/descriptors/graphql_graphql_schema_linter.md +++ b/docs/descriptors/graphql_graphql_schema_linter.md @@ -17,40 +17,40 @@ - Enable graphql-schema-linter by adding `GRAPHQL_GRAPHQL_SCHEMA_LINTER` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable graphql-schema-linter by adding `GRAPHQL_GRAPHQL_SCHEMA_LINTER` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| GRAPHQL_GRAPHQL_SCHEMA_LINTER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| GRAPHQL_GRAPHQL_SCHEMA_LINTER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".graphql"]` | -| GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS | List of bash commands to run before the linter | None | -| GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS | List of bash commands to run after the linter | None | -| GRAPHQL_GRAPHQL_SCHEMA_LINTER_CONFIG_FILE | graphql-schema-linter configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.graphql-schema-linterrc` | -| GRAPHQL_GRAPHQL_SCHEMA_LINTER_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| GRAPHQL_GRAPHQL_SCHEMA_LINTER_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| GRAPHQL_GRAPHQL_SCHEMA_LINTER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| GRAPHQL_GRAPHQL_SCHEMA_LINTER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| GRAPHQL_GRAPHQL_SCHEMA_LINTER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".graphql"]` | +| GRAPHQL_GRAPHQL_SCHEMA_LINTER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| GRAPHQL_GRAPHQL_SCHEMA_LINTER_PRE_COMMANDS | List of bash commands to run before the linter| None | +| GRAPHQL_GRAPHQL_SCHEMA_LINTER_POST_COMMANDS | List of bash commands to run after the linter| None | +| GRAPHQL_GRAPHQL_SCHEMA_LINTER_CONFIG_FILE | graphql-schema-linter configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.graphql-schema-linterrc` | +| GRAPHQL_GRAPHQL_SCHEMA_LINTER_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| GRAPHQL_GRAPHQL_SCHEMA_LINTER_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| GRAPHQL_GRAPHQL_SCHEMA_LINTER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/groovy.md b/docs/descriptors/groovy.md index 05596a2a0b7..1bea30d23bd 100644 --- a/docs/descriptors/groovy.md +++ b/docs/descriptors/groovy.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|----------------------------------------------|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [npm-groovy-lint](groovy_npm_groovy_lint.md) | [GROOVY](groovy_npm_groovy_lint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/nvuillam/npm-groovy-lint)](https://github.com/nvuillam/npm-groovy-lint/commits) | ## Linted files @@ -22,8 +22,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|-----------------------------|-------------------------------|---------------| -| GROOVY_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| GROOVY_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| GROOVY_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| GROOVY_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/groovy_npm_groovy_lint.md b/docs/descriptors/groovy_npm_groovy_lint.md index e4e5267943a..018906be12a 100644 --- a/docs/descriptors/groovy_npm_groovy_lint.md +++ b/docs/descriptors/groovy_npm_groovy_lint.md @@ -20,49 +20,49 @@ - Enable **auto-fixes** by adding `GROOVY_NPM_GROOVY_LINT` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| GROOVY_NPM_GROOVY_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| GROOVY_NPM_GROOVY_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| GROOVY_NPM_GROOVY_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| GROOVY_NPM_GROOVY_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| GROOVY_NPM_GROOVY_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".groovy", ".gvy", ".gradle", ".nf"]` | -| GROOVY_NPM_GROOVY_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | `["Jenkinsfile"]` | -| GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| GROOVY_NPM_GROOVY_LINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| GROOVY_NPM_GROOVY_LINT_CONFIG_FILE | npm-groovy-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.groovylintrc.json` | -| GROOVY_NPM_GROOVY_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| GROOVY_NPM_GROOVY_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| GROOVY_NPM_GROOVY_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| GROOVY_NPM_GROOVY_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| GROOVY_NPM_GROOVY_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| GROOVY_NPM_GROOVY_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| GROOVY_NPM_GROOVY_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| GROOVY_NPM_GROOVY_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".groovy", ".gvy", ".gradle", ".nf"]` | +| GROOVY_NPM_GROOVY_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | `["Jenkinsfile"]` | +| GROOVY_NPM_GROOVY_LINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| GROOVY_NPM_GROOVY_LINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| GROOVY_NPM_GROOVY_LINT_CONFIG_FILE | npm-groovy-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.groovylintrc.json` | +| GROOVY_NPM_GROOVY_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| GROOVY_NPM_GROOVY_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| GROOVY_NPM_GROOVY_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use npm-groovy-lint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Visual Studio Code](https://code.visualstudio.com/) | [VsCode Groovy Lint](https://marketplace.visualstudio.com/items?itemName=NicolasVuillamy.vscode-groovy-lint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/NicolasVuillamy.vscode-groovy-lint){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/html.md b/docs/descriptors/html.md index 28b635d36cc..aa18eee3abd 100644 --- a/docs/descriptors/html.md +++ b/docs/descriptors/html.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|------------------------------|--------------------------|------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [htmlhint](html_htmlhint.md) | [HTML](html_htmlhint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/htmlhint/HTMLHint)](https://github.com/htmlhint/HTMLHint/commits) | ## Linted files @@ -17,8 +17,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|---------------------------|-------------------------------|---------------| -| HTML_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| HTML_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| HTML_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| HTML_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/html_htmlhint.md b/docs/descriptors/html_htmlhint.md index 69cfc9e8691..98159f7c60b 100644 --- a/docs/descriptors/html_htmlhint.md +++ b/docs/descriptors/html_htmlhint.md @@ -18,51 +18,51 @@ - Enable htmlhint by adding `HTML_HTMLHINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable htmlhint by adding `HTML_HTMLHINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| HTML_HTMLHINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| HTML_HTMLHINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| HTML_HTMLHINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| HTML_HTMLHINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| HTML_HTMLHINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".html", ".htm"]` | -| HTML_HTMLHINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| HTML_HTMLHINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| HTML_HTMLHINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| HTML_HTMLHINT_CONFIG_FILE | htmlhint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.htmlhintrc` | -| HTML_HTMLHINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| HTML_HTMLHINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| HTML_HTMLHINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| HTML_HTMLHINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| HTML_HTMLHINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| HTML_HTMLHINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| HTML_HTMLHINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| HTML_HTMLHINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".html", ".htm"]` | +| HTML_HTMLHINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| HTML_HTMLHINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| HTML_HTMLHINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| HTML_HTMLHINT_CONFIG_FILE | htmlhint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.htmlhintrc` | +| HTML_HTMLHINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| HTML_HTMLHINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| HTML_HTMLHINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use htmlhint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:---------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|----------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [atom-htmlhint](https://github.com/htmlhint/atom-htmlhint) | [Visit Web Site](https://github.com/htmlhint/atom-htmlhint){target=_blank} | -| | [Brackets](http://brackets.io/) | [brackets-htmlhint](https://github.com/htmlhint/brackets-htmlhint) | [Visit Web Site](https://github.com/htmlhint/brackets-htmlhint){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-htmlhint](https://github.com/htmlhint/SublimeLinter-contrib-htmlhint) | [Visit Web Site](https://github.com/htmlhint/SublimeLinter-contrib-htmlhint){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-htmlhint](https://marketplace.visualstudio.com/items?itemName=mkaufman.HTMLHint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/mkaufman.HTMLHint){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [atom-htmlhint](https://github.com/htmlhint/atom-htmlhint) | [Visit Web Site](https://github.com/htmlhint/atom-htmlhint){target=_blank} | +| | [Brackets](http://brackets.io/) | [brackets-htmlhint](https://github.com/htmlhint/brackets-htmlhint) | [Visit Web Site](https://github.com/htmlhint/brackets-htmlhint){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-htmlhint](https://github.com/htmlhint/SublimeLinter-contrib-htmlhint) | [Visit Web Site](https://github.com/htmlhint/SublimeLinter-contrib-htmlhint){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-htmlhint](https://marketplace.visualstudio.com/items?itemName=mkaufman.HTMLHint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/mkaufman.HTMLHint){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/java.md b/docs/descriptors/java.md index 969d3a0e560..be59aea4f4a 100644 --- a/docs/descriptors/java.md +++ b/docs/descriptors/java.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|----------------------------------|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [checkstyle](java_checkstyle.md) | [JAVA](java_checkstyle.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/checkstyle/checkstyle)](https://github.com/checkstyle/checkstyle/commits) | ## Linted files @@ -16,10 +16,10 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|---------------------------|-------------------------------|---------------| -| JAVA_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| JAVA_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| JAVA_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| JAVA_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | ## Behind the scenes diff --git a/docs/descriptors/java_checkstyle.md b/docs/descriptors/java_checkstyle.md index 3a4dd4fac54..5c7aa52eb59 100644 --- a/docs/descriptors/java_checkstyle.md +++ b/docs/descriptors/java_checkstyle.md @@ -25,39 +25,39 @@ - Enable checkstyle by adding `JAVA_CHECKSTYLE` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable checkstyle by adding `JAVA_CHECKSTYLE` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| JAVA_CHECKSTYLE_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| JAVA_CHECKSTYLE_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| JAVA_CHECKSTYLE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| JAVA_CHECKSTYLE_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| JAVA_CHECKSTYLE_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".java"]` | -| JAVA_CHECKSTYLE_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| JAVA_CHECKSTYLE_PRE_COMMANDS | List of bash commands to run before the linter | None | -| JAVA_CHECKSTYLE_POST_COMMANDS | List of bash commands to run after the linter | None | -| JAVA_CHECKSTYLE_CONFIG_FILE | checkstyle configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `sun_checks.xml` | -| JAVA_CHECKSTYLE_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| JAVA_CHECKSTYLE_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| JAVA_CHECKSTYLE_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| JAVA_CHECKSTYLE_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| JAVA_CHECKSTYLE_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| JAVA_CHECKSTYLE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| JAVA_CHECKSTYLE_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| JAVA_CHECKSTYLE_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".java"]` | +| JAVA_CHECKSTYLE_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| JAVA_CHECKSTYLE_PRE_COMMANDS | List of bash commands to run before the linter| None | +| JAVA_CHECKSTYLE_POST_COMMANDS | List of bash commands to run after the linter| None | +| JAVA_CHECKSTYLE_CONFIG_FILE | checkstyle configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `sun_checks.xml` | +| JAVA_CHECKSTYLE_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| JAVA_CHECKSTYLE_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| JAVA_CHECKSTYLE_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use checkstyle in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Eclipse](https://www.eclipse.org/) | [eclipse-cs](https://checkstyle.org/eclipse-cs/#!/) | [Visit Web Site](https://checkstyle.org/eclipse-cs/#!/){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [checkstyle-idea](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) | | -| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-checkstyle](https://marketplace.visualstudio.com/items?itemName=shengchen.vscode-checkstyle) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/shengchen.vscode-checkstyle){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Eclipse](https://www.eclipse.org/) | [eclipse-cs](https://checkstyle.org/eclipse-cs/#!/) | [Visit Web Site](https://checkstyle.org/eclipse-cs/#!/){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [checkstyle-idea](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) | | +| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-checkstyle](https://marketplace.visualstudio.com/items?itemName=shengchen.vscode-checkstyle) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/shengchen.vscode-checkstyle){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:----------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | ## Behind the scenes diff --git a/docs/descriptors/javascript.md b/docs/descriptors/javascript.md index c215e2a24e4..dfd0b556237 100644 --- a/docs/descriptors/javascript.md +++ b/docs/descriptors/javascript.md @@ -5,11 +5,11 @@ ## Linters -| Linter | Configuration key | Status | -|------------------------------------|-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------| -| [eslint](javascript_eslint.md) | [JAVASCRIPT_ES](javascript_eslint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/eslint/eslint)](https://github.com/eslint/eslint/commits) | +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | +| [eslint](javascript_eslint.md) | [JAVASCRIPT_ES](javascript_eslint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/eslint/eslint)](https://github.com/eslint/eslint/commits) | | [standard](javascript_standard.md) | [JAVASCRIPT_STANDARD](javascript_standard.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/standard/standard)](https://github.com/standard/standard/commits) | -| [prettier](javascript_prettier.md) | [JAVASCRIPT](javascript_prettier.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/prettier/prettier)](https://github.com/prettier/prettier/commits) | +| [prettier](javascript_prettier.md) | [JAVASCRIPT](javascript_prettier.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/prettier/prettier)](https://github.com/prettier/prettier/commits) | ## Linted files @@ -18,8 +18,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|---------------------------------|-------------------------------|---------------| -| JAVASCRIPT_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| JAVASCRIPT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| JAVASCRIPT_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| JAVASCRIPT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/javascript_eslint.md b/docs/descriptors/javascript_eslint.md index a7479a08f45..e3db5218bde 100644 --- a/docs/descriptors/javascript_eslint.md +++ b/docs/descriptors/javascript_eslint.md @@ -30,45 +30,45 @@ You can create it by typing `npx eslint --init` in the root of your repository - Enable **auto-fixes** by adding `JAVASCRIPT_ES` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| JAVASCRIPT_ES_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| JAVASCRIPT_ES_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| JAVASCRIPT_ES_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| JAVASCRIPT_ES_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| JAVASCRIPT_ES_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".js", ".vue"]` | -| JAVASCRIPT_ES_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| JAVASCRIPT_ES_PRE_COMMANDS | List of bash commands to run before the linter | None | -| JAVASCRIPT_ES_POST_COMMANDS | List of bash commands to run after the linter | None | -| JAVASCRIPT_ES_CONFIG_FILE | eslint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.eslintrc.json` | -| JAVASCRIPT_ES_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| JAVASCRIPT_ES_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| JAVASCRIPT_ES_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| JAVASCRIPT_ES_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| JAVASCRIPT_ES_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| JAVASCRIPT_ES_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| JAVASCRIPT_ES_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| JAVASCRIPT_ES_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".js", ".vue"]` | +| JAVASCRIPT_ES_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| JAVASCRIPT_ES_PRE_COMMANDS | List of bash commands to run before the linter| None | +| JAVASCRIPT_ES_POST_COMMANDS | List of bash commands to run after the linter| None | +| JAVASCRIPT_ES_CONFIG_FILE | eslint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.eslintrc.json` | +| JAVASCRIPT_ES_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| JAVASCRIPT_ES_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| JAVASCRIPT_ES_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use eslint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:---------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-eslint](https://atom.io/packages/linter-eslint) | [Visit Web Site](https://atom.io/packages/linter-eslint){target=_blank} | -| | [Brackets](http://brackets.io/) | [brackets-eslint](https://github.com/brackets-userland/brackets-eslint) | [Visit Web Site](https://github.com/brackets-userland/brackets-eslint){target=_blank} | -| | [Eclipse](https://www.eclipse.org/) | [Tern-Linter-ESLint](https://github.com/angelozerr/tern.java/wiki/Tern-Linter-ESLint) | [Visit Web Site](https://github.com/angelozerr/tern.java/wiki/Tern-Linter-ESLint){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](http://www.flycheck.org/en/latest/languages.html#javascript) | [Visit Web Site](http://www.flycheck.org/en/latest/languages.html#javascript){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [ESLint Plugin](https://plugins.jetbrains.com/plugin/7494-eslint) | | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-eslint](https://github.com/roadhump/SublimeLinter-eslint) | [Visit Web Site](https://github.com/roadhump/SublimeLinter-eslint){target=_blank} | -| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | -| | [vim](https://www.vim.org/) | [Syntastic](https://github.com/vim-syntastic/syntastic/tree/master/syntax_checkers/javascript) | [Visit Web Site](https://github.com/vim-syntastic/syntastic/tree/master/syntax_checkers/javascript){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/dbaeumer.vscode-eslint){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-eslint](https://atom.io/packages/linter-eslint) | [Visit Web Site](https://atom.io/packages/linter-eslint){target=_blank} | +| | [Brackets](http://brackets.io/) | [brackets-eslint](https://github.com/brackets-userland/brackets-eslint) | [Visit Web Site](https://github.com/brackets-userland/brackets-eslint){target=_blank} | +| | [Eclipse](https://www.eclipse.org/) | [Tern-Linter-ESLint](https://github.com/angelozerr/tern.java/wiki/Tern-Linter-ESLint) | [Visit Web Site](https://github.com/angelozerr/tern.java/wiki/Tern-Linter-ESLint){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](http://www.flycheck.org/en/latest/languages.html#javascript) | [Visit Web Site](http://www.flycheck.org/en/latest/languages.html#javascript){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [ESLint Plugin](https://plugins.jetbrains.com/plugin/7494-eslint) | | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-eslint](https://github.com/roadhump/SublimeLinter-eslint) | [Visit Web Site](https://github.com/roadhump/SublimeLinter-eslint){target=_blank} | +| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | +| | [vim](https://www.vim.org/) | [Syntastic](https://github.com/vim-syntastic/syntastic/tree/master/syntax_checkers/javascript) | [Visit Web Site](https://github.com/vim-syntastic/syntastic/tree/master/syntax_checkers/javascript){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/dbaeumer.vscode-eslint){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | ## Behind the scenes diff --git a/docs/descriptors/javascript_prettier.md b/docs/descriptors/javascript_prettier.md index 2a37b7670b4..9a60ecb3738 100644 --- a/docs/descriptors/javascript_prettier.md +++ b/docs/descriptors/javascript_prettier.md @@ -26,48 +26,48 @@ - Enable **auto-fixes** by adding `JAVASCRIPT_PRETTIER` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|-------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| JAVASCRIPT_DEFAULT_STYLE | For prettier to be active, JAVASCRIPT_DEFAULT_STYLE must be `prettier` | `standard` | -| JAVASCRIPT_PRETTIER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| JAVASCRIPT_PRETTIER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| JAVASCRIPT_PRETTIER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| JAVASCRIPT_PRETTIER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| JAVASCRIPT_PRETTIER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".js"]` | -| JAVASCRIPT_PRETTIER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| JAVASCRIPT_PRETTIER_PRE_COMMANDS | List of bash commands to run before the linter | None | -| JAVASCRIPT_PRETTIER_POST_COMMANDS | List of bash commands to run after the linter | None | -| JAVASCRIPT_PRETTIER_CONFIG_FILE | prettier configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.prettierrc.json` | -| JAVASCRIPT_PRETTIER_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| JAVASCRIPT_PRETTIER_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | -| JAVASCRIPT_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| JAVASCRIPT_DEFAULT_STYLE | For prettier to be active, JAVASCRIPT_DEFAULT_STYLE must be `prettier` | `standard` | +| JAVASCRIPT_PRETTIER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| JAVASCRIPT_PRETTIER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| JAVASCRIPT_PRETTIER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| JAVASCRIPT_PRETTIER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| JAVASCRIPT_PRETTIER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".js"]` | +| JAVASCRIPT_PRETTIER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| JAVASCRIPT_PRETTIER_PRE_COMMANDS | List of bash commands to run before the linter| None | +| JAVASCRIPT_PRETTIER_POST_COMMANDS | List of bash commands to run after the linter| None | +| JAVASCRIPT_PRETTIER_CONFIG_FILE | prettier configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.prettierrc.json` | +| JAVASCRIPT_PRETTIER_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| JAVASCRIPT_PRETTIER_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| JAVASCRIPT_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use prettier in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|-----------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [prettier-atom](https://github.com/prettier/prettier-atom) | [Visit Web Site](https://github.com/prettier/prettier-atom){target=_blank} | -| | [Atom](https://atom.io/) | [atom-mprettier](https://github.com/t9md/atom-mprettier) | [Visit Web Site](https://github.com/t9md/atom-mprettier){target=_blank} | -| | [Atom](https://atom.io/) | [atom-miniprettier](https://github.com/duailibe/atom-miniprettier) | [Visit Web Site](https://github.com/duailibe/atom-miniprettier){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [prettier-emacs](https://github.com/prettier/prettier-emacs) | [Visit Web Site](https://github.com/prettier/prettier-emacs){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [prettier.el](https://github.com/jscheid/prettier.el) | [Visit Web Site](https://github.com/jscheid/prettier.el){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [apheleia](https://github.com/raxod502/apheleia) | [Visit Web Site](https://github.com/raxod502/apheleia){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [native support](https://prettier.io/docs/en/webstorm.html) | [Visit Web Site](https://prettier.io/docs/en/webstorm.html){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [JsPrettier](https://packagecontrol.io/packages/JsPrettier) | [Visit Web Site](https://packagecontrol.io/packages/JsPrettier){target=_blank} | -| | [vim](https://www.vim.org/) | [vim-prettier](https://github.com/prettier/vim-prettier) | [Visit Web Site](https://github.com/prettier/vim-prettier){target=_blank} | -| | visual_studio | [JavaScriptPrettier](https://github.com/madskristensen/JavaScriptPrettier) | [Visit Web Site](https://github.com/madskristensen/JavaScriptPrettier){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [prettier-vscode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/esbenp.prettier-vscode){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [prettier-atom](https://github.com/prettier/prettier-atom) | [Visit Web Site](https://github.com/prettier/prettier-atom){target=_blank} | +| | [Atom](https://atom.io/) | [atom-mprettier](https://github.com/t9md/atom-mprettier) | [Visit Web Site](https://github.com/t9md/atom-mprettier){target=_blank} | +| | [Atom](https://atom.io/) | [atom-miniprettier](https://github.com/duailibe/atom-miniprettier) | [Visit Web Site](https://github.com/duailibe/atom-miniprettier){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [prettier-emacs](https://github.com/prettier/prettier-emacs) | [Visit Web Site](https://github.com/prettier/prettier-emacs){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [prettier.el](https://github.com/jscheid/prettier.el) | [Visit Web Site](https://github.com/jscheid/prettier.el){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [apheleia](https://github.com/raxod502/apheleia) | [Visit Web Site](https://github.com/raxod502/apheleia){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [native support](https://prettier.io/docs/en/webstorm.html) | [Visit Web Site](https://prettier.io/docs/en/webstorm.html){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [JsPrettier](https://packagecontrol.io/packages/JsPrettier) | [Visit Web Site](https://packagecontrol.io/packages/JsPrettier){target=_blank} | +| | [vim](https://www.vim.org/) | [vim-prettier](https://github.com/prettier/vim-prettier) | [Visit Web Site](https://github.com/prettier/vim-prettier){target=_blank} | +| | visual_studio | [JavaScriptPrettier](https://github.com/madskristensen/JavaScriptPrettier) | [Visit Web Site](https://github.com/madskristensen/JavaScriptPrettier){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [prettier-vscode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/esbenp.prettier-vscode){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | ## Behind the scenes diff --git a/docs/descriptors/javascript_standard.md b/docs/descriptors/javascript_standard.md index 8896f6c9310..d3f45cad3c2 100644 --- a/docs/descriptors/javascript_standard.md +++ b/docs/descriptors/javascript_standard.md @@ -24,43 +24,43 @@ - Enable **auto-fixes** by adding `JAVASCRIPT_STANDARD` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|-------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| JAVASCRIPT_DEFAULT_STYLE | For standard to be active, JAVASCRIPT_DEFAULT_STYLE must be `standard` | `standard` | -| JAVASCRIPT_STANDARD_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| JAVASCRIPT_STANDARD_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| JAVASCRIPT_STANDARD_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| JAVASCRIPT_STANDARD_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| JAVASCRIPT_STANDARD_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".js"]` | -| JAVASCRIPT_STANDARD_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| JAVASCRIPT_STANDARD_PRE_COMMANDS | List of bash commands to run before the linter | None | -| JAVASCRIPT_STANDARD_POST_COMMANDS | List of bash commands to run after the linter | None | -| JAVASCRIPT_STANDARD_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| JAVASCRIPT_STANDARD_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| JAVASCRIPT_DEFAULT_STYLE | For standard to be active, JAVASCRIPT_DEFAULT_STYLE must be `standard` | `standard` | +| JAVASCRIPT_STANDARD_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| JAVASCRIPT_STANDARD_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| JAVASCRIPT_STANDARD_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| JAVASCRIPT_STANDARD_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| JAVASCRIPT_STANDARD_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".js"]` | +| JAVASCRIPT_STANDARD_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| JAVASCRIPT_STANDARD_PRE_COMMANDS | List of bash commands to run before the linter| None | +| JAVASCRIPT_STANDARD_POST_COMMANDS | List of bash commands to run after the linter| None | +| JAVASCRIPT_STANDARD_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| JAVASCRIPT_STANDARD_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use standard in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:---------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|-----------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-js-standard](https://atom.io/packages/linter-js-standard) | [Visit Web Site](https://atom.io/packages/linter-js-standard){target=_blank} | -| | [Atom](https://atom.io/) | [linter-js-standard-engine](https://atom.io/packages/linter-js-standard-engine) | [Visit Web Site](https://atom.io/packages/linter-js-standard-engine){target=_blank} | -| | [Atom](https://atom.io/) | [standard-formatter](https://atom.io/packages/standard-formatter) | [Visit Web Site](https://atom.io/packages/standard-formatter){target=_blank} | -| | [Brackets](http://brackets.io/) | [brackets-standard](https://github.com/ishamf/brackets-standard/) | [Visit Web Site](https://github.com/ishamf/brackets-standard/){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [native support](https://blog.jetbrains.com/webstorm/2017/01/webstorm-2017-1-eap-171-2272/) | [Visit Web Site](https://blog.jetbrains.com/webstorm/2017/01/webstorm-2017-1-eap-171-2272/){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-standard](https://packagecontrol.io/packages/SublimeLinter-contrib-standard) | [Visit Web Site](https://packagecontrol.io/packages/SublimeLinter-contrib-standard){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [StandardFormat](https://packagecontrol.io/packages/StandardFormat) | [Visit Web Site](https://packagecontrol.io/packages/StandardFormat){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-standardjs](https://marketplace.visualstudio.com/items?itemName=chenxsan.vscode-standardjs) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/chenxsan.vscode-standardjs){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-js-standard](https://atom.io/packages/linter-js-standard) | [Visit Web Site](https://atom.io/packages/linter-js-standard){target=_blank} | +| | [Atom](https://atom.io/) | [linter-js-standard-engine](https://atom.io/packages/linter-js-standard-engine) | [Visit Web Site](https://atom.io/packages/linter-js-standard-engine){target=_blank} | +| | [Atom](https://atom.io/) | [standard-formatter](https://atom.io/packages/standard-formatter) | [Visit Web Site](https://atom.io/packages/standard-formatter){target=_blank} | +| | [Brackets](http://brackets.io/) | [brackets-standard](https://github.com/ishamf/brackets-standard/) | [Visit Web Site](https://github.com/ishamf/brackets-standard/){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [native support](https://blog.jetbrains.com/webstorm/2017/01/webstorm-2017-1-eap-171-2272/) | [Visit Web Site](https://blog.jetbrains.com/webstorm/2017/01/webstorm-2017-1-eap-171-2272/){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-standard](https://packagecontrol.io/packages/SublimeLinter-contrib-standard) | [Visit Web Site](https://packagecontrol.io/packages/SublimeLinter-contrib-standard){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [StandardFormat](https://packagecontrol.io/packages/StandardFormat) | [Visit Web Site](https://packagecontrol.io/packages/StandardFormat){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-standardjs](https://marketplace.visualstudio.com/items?itemName=chenxsan.vscode-standardjs) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/chenxsan.vscode-standardjs){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | ## Behind the scenes diff --git a/docs/descriptors/json.md b/docs/descriptors/json.md index c63ac82d002..9eeec17528d 100644 --- a/docs/descriptors/json.md +++ b/docs/descriptors/json.md @@ -5,12 +5,12 @@ ## Linters -| Linter | Configuration key | Status | -|----------------------------------------------------|-------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [jsonlint](json_jsonlint.md) | [JSON](json_jsonlint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/zaach/jsonlint)](https://github.com/zaach/jsonlint/commits) | +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | +| [jsonlint](json_jsonlint.md) | [JSON](json_jsonlint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/zaach/jsonlint)](https://github.com/zaach/jsonlint/commits) | | [eslint-plugin-jsonc](json_eslint_plugin_jsonc.md) | [JSON](json_eslint_plugin_jsonc.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/ota-meshi/eslint-plugin-jsonc)](https://github.com/ota-meshi/eslint-plugin-jsonc/commits) | -| [v8r](json_v8r.md) | [JSON](json_v8r.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/chris48s/v8r)](https://github.com/chris48s/v8r/commits) | -| [prettier](json_prettier.md) | [JSON](json_prettier.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/prettier/prettier)](https://github.com/prettier/prettier/commits) | +| [v8r](json_v8r.md) | [JSON](json_v8r.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/chris48s/v8r)](https://github.com/chris48s/v8r/commits) | +| [prettier](json_prettier.md) | [JSON](json_prettier.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/prettier/prettier)](https://github.com/prettier/prettier/commits) | ## Linted files @@ -19,8 +19,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|---------------------------|-------------------------------|---------------| -| JSON_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| JSON_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| JSON_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| JSON_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/json_eslint_plugin_jsonc.md b/docs/descriptors/json_eslint_plugin_jsonc.md index a557c8fd5a5..e7496325f5e 100644 --- a/docs/descriptors/json_eslint_plugin_jsonc.md +++ b/docs/descriptors/json_eslint_plugin_jsonc.md @@ -84,49 +84,49 @@ DISABLE_LINTERS: - Enable **auto-fixes** by adding `JSON_ESLINT_PLUGIN_JSONC` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| JSON_ESLINT_PLUGIN_JSONC_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| JSON_ESLINT_PLUGIN_JSONC_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| JSON_ESLINT_PLUGIN_JSONC_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| JSON_ESLINT_PLUGIN_JSONC_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| JSON_ESLINT_PLUGIN_JSONC_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".json", ".json5", ".jsonc"]` | -| JSON_ESLINT_PLUGIN_JSONC_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS | List of bash commands to run before the linter | None | -| JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS | List of bash commands to run after the linter | None | -| JSON_ESLINT_PLUGIN_JSONC_CONFIG_FILE | eslint-plugin-jsonc configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.eslintrc-json.json` | -| JSON_ESLINT_PLUGIN_JSONC_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| JSON_ESLINT_PLUGIN_JSONC_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| JSON_ESLINT_PLUGIN_JSONC_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| JSON_ESLINT_PLUGIN_JSONC_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| JSON_ESLINT_PLUGIN_JSONC_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| JSON_ESLINT_PLUGIN_JSONC_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| JSON_ESLINT_PLUGIN_JSONC_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| JSON_ESLINT_PLUGIN_JSONC_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".json", ".json5", ".jsonc"]` | +| JSON_ESLINT_PLUGIN_JSONC_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| JSON_ESLINT_PLUGIN_JSONC_PRE_COMMANDS | List of bash commands to run before the linter| None | +| JSON_ESLINT_PLUGIN_JSONC_POST_COMMANDS | List of bash commands to run after the linter| None | +| JSON_ESLINT_PLUGIN_JSONC_CONFIG_FILE | eslint-plugin-jsonc configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.eslintrc-json.json` | +| JSON_ESLINT_PLUGIN_JSONC_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| JSON_ESLINT_PLUGIN_JSONC_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| JSON_ESLINT_PLUGIN_JSONC_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use eslint-plugin-jsonc in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|--------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-eslint](https://github.com/ota-meshi/eslint-plugin-jsonc#visual-studio-code) | [Visit Web Site](https://github.com/ota-meshi/eslint-plugin-jsonc#visual-studio-code){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/json_jsonlint.md b/docs/descriptors/json_jsonlint.md index 576a8375a26..7c8f816e155 100644 --- a/docs/descriptors/json_jsonlint.md +++ b/docs/descriptors/json_jsonlint.md @@ -14,39 +14,39 @@ - Enable jsonlint by adding `JSON_JSONLINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable jsonlint by adding `JSON_JSONLINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| JSON_JSONLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| JSON_JSONLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| JSON_JSONLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| JSON_JSONLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| JSON_JSONLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".json"]` | -| JSON_JSONLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| JSON_JSONLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| JSON_JSONLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| JSON_JSONLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| JSON_JSONLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| JSON_JSONLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| JSON_JSONLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| JSON_JSONLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| JSON_JSONLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| JSON_JSONLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".json"]` | +| JSON_JSONLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| JSON_JSONLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| JSON_JSONLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| JSON_JSONLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| JSON_JSONLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/json_prettier.md b/docs/descriptors/json_prettier.md index 5c666a9ab83..12676024cf7 100644 --- a/docs/descriptors/json_prettier.md +++ b/docs/descriptors/json_prettier.md @@ -26,59 +26,59 @@ - Enable **auto-fixes** by adding `JSON_PRETTIER` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| JSON_PRETTIER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| JSON_PRETTIER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| JSON_PRETTIER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| JSON_PRETTIER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| JSON_PRETTIER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".json"]` | -| JSON_PRETTIER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| JSON_PRETTIER_PRE_COMMANDS | List of bash commands to run before the linter | None | -| JSON_PRETTIER_POST_COMMANDS | List of bash commands to run after the linter | None | -| JSON_PRETTIER_CONFIG_FILE | prettier configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.prettierrc.json` | -| JSON_PRETTIER_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| JSON_PRETTIER_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | -| JSON_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| JSON_PRETTIER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| JSON_PRETTIER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| JSON_PRETTIER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| JSON_PRETTIER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| JSON_PRETTIER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".json"]` | +| JSON_PRETTIER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| JSON_PRETTIER_PRE_COMMANDS | List of bash commands to run before the linter| None | +| JSON_PRETTIER_POST_COMMANDS | List of bash commands to run after the linter| None | +| JSON_PRETTIER_CONFIG_FILE | prettier configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.prettierrc.json` | +| JSON_PRETTIER_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| JSON_PRETTIER_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| JSON_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use prettier in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|-----------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [prettier-atom](https://github.com/prettier/prettier-atom) | [Visit Web Site](https://github.com/prettier/prettier-atom){target=_blank} | -| | [Atom](https://atom.io/) | [atom-mprettier](https://github.com/t9md/atom-mprettier) | [Visit Web Site](https://github.com/t9md/atom-mprettier){target=_blank} | -| | [Atom](https://atom.io/) | [atom-miniprettier](https://github.com/duailibe/atom-miniprettier) | [Visit Web Site](https://github.com/duailibe/atom-miniprettier){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [prettier-emacs](https://github.com/prettier/prettier-emacs) | [Visit Web Site](https://github.com/prettier/prettier-emacs){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [prettier.el](https://github.com/jscheid/prettier.el) | [Visit Web Site](https://github.com/jscheid/prettier.el){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [apheleia](https://github.com/raxod502/apheleia) | [Visit Web Site](https://github.com/raxod502/apheleia){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [native support](https://prettier.io/docs/en/webstorm.html) | [Visit Web Site](https://prettier.io/docs/en/webstorm.html){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [JsPrettier](https://packagecontrol.io/packages/JsPrettier) | [Visit Web Site](https://packagecontrol.io/packages/JsPrettier){target=_blank} | -| | [vim](https://www.vim.org/) | [vim-prettier](https://github.com/prettier/vim-prettier) | [Visit Web Site](https://github.com/prettier/vim-prettier){target=_blank} | -| | visual_studio | [JavaScriptPrettier](https://github.com/madskristensen/JavaScriptPrettier) | [Visit Web Site](https://github.com/madskristensen/JavaScriptPrettier){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [prettier-vscode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/esbenp.prettier-vscode){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [prettier-atom](https://github.com/prettier/prettier-atom) | [Visit Web Site](https://github.com/prettier/prettier-atom){target=_blank} | +| | [Atom](https://atom.io/) | [atom-mprettier](https://github.com/t9md/atom-mprettier) | [Visit Web Site](https://github.com/t9md/atom-mprettier){target=_blank} | +| | [Atom](https://atom.io/) | [atom-miniprettier](https://github.com/duailibe/atom-miniprettier) | [Visit Web Site](https://github.com/duailibe/atom-miniprettier){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [prettier-emacs](https://github.com/prettier/prettier-emacs) | [Visit Web Site](https://github.com/prettier/prettier-emacs){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [prettier.el](https://github.com/jscheid/prettier.el) | [Visit Web Site](https://github.com/jscheid/prettier.el){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [apheleia](https://github.com/raxod502/apheleia) | [Visit Web Site](https://github.com/raxod502/apheleia){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [native support](https://prettier.io/docs/en/webstorm.html) | [Visit Web Site](https://prettier.io/docs/en/webstorm.html){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [JsPrettier](https://packagecontrol.io/packages/JsPrettier) | [Visit Web Site](https://packagecontrol.io/packages/JsPrettier){target=_blank} | +| | [vim](https://www.vim.org/) | [vim-prettier](https://github.com/prettier/vim-prettier) | [Visit Web Site](https://github.com/prettier/vim-prettier){target=_blank} | +| | visual_studio | [JavaScriptPrettier](https://github.com/madskristensen/JavaScriptPrettier) | [Visit Web Site](https://github.com/madskristensen/JavaScriptPrettier){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [prettier-vscode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/esbenp.prettier-vscode){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/json_v8r.md b/docs/descriptors/json_v8r.md index 93811fb03a9..80eeae0815d 100644 --- a/docs/descriptors/json_v8r.md +++ b/docs/descriptors/json_v8r.md @@ -17,50 +17,50 @@ v8r checks the validity of JSON/YAML files if they have a matching schema define - Enable v8r by adding `JSON_V8R` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable v8r by adding `JSON_V8R` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| JSON_V8R_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| JSON_V8R_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| JSON_V8R_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| JSON_V8R_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| JSON_V8R_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".json"]` | -| JSON_V8R_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| JSON_V8R_PRE_COMMANDS | List of bash commands to run before the linter | None | -| JSON_V8R_POST_COMMANDS | List of bash commands to run after the linter | None | -| JSON_V8R_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| JSON_V8R_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| JSON_V8R_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| JSON_V8R_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| JSON_V8R_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| JSON_V8R_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| JSON_V8R_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".json"]` | +| JSON_V8R_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| JSON_V8R_PRE_COMMANDS | List of bash commands to run before the linter| None | +| JSON_V8R_POST_COMMANDS | List of bash commands to run after the linter| None | +| JSON_V8R_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| JSON_V8R_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use v8r in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|----------------------------------------------------------------|:-----------------------------------------------------------------------------:| -| | [Eclipse](https://www.eclipse.org/) | [native support](https://www.eclipse.org/) | [Visit Web Site](https://www.eclipse.org/){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [native support](https://www.jetbrains.com/products/#type=ide) | [Visit Web Site](https://www.jetbrains.com/products/#type=ide){target=_blank} | -| | [vim](https://www.vim.org/) | [vison](https://github.com/Quramy/vison) | [Visit Web Site](https://github.com/Quramy/vison){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [native support](https://code.visualstudio.com/) | [Visit Web Site](https://code.visualstudio.com/){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Eclipse](https://www.eclipse.org/) | [native support](https://www.eclipse.org/) | [Visit Web Site](https://www.eclipse.org/){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [native support](https://www.jetbrains.com/products/#type=ide) | [Visit Web Site](https://www.jetbrains.com/products/#type=ide){target=_blank} | +| | [vim](https://www.vim.org/) | [vison](https://github.com/Quramy/vison) | [Visit Web Site](https://github.com/Quramy/vison){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [native support](https://code.visualstudio.com/) | [Visit Web Site](https://code.visualstudio.com/){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/jsx.md b/docs/descriptors/jsx.md index bd93d727026..1ebf05d2161 100644 --- a/docs/descriptors/jsx.md +++ b/docs/descriptors/jsx.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|-------------------------|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [eslint](jsx_eslint.md) | [JSX](jsx_eslint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/yannickcr/eslint-plugin-react)](https://github.com/yannickcr/eslint-plugin-react/commits) | ## Linted files @@ -16,8 +16,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|--------------------------|-------------------------------|---------------| -| JSX_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| JSX_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| JSX_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| JSX_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/jsx_eslint.md b/docs/descriptors/jsx_eslint.md index c239d791a25..65ed329775d 100644 --- a/docs/descriptors/jsx_eslint.md +++ b/docs/descriptors/jsx_eslint.md @@ -29,45 +29,45 @@ You can create it by typing `npx eslint --init` in the root of your repository - Enable **auto-fixes** by adding `JSX_ESLINT` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| JSX_ESLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| JSX_ESLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| JSX_ESLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| JSX_ESLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| JSX_ESLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".jsx"]` | -| JSX_ESLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| JSX_ESLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| JSX_ESLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| JSX_ESLINT_CONFIG_FILE | eslint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.eslintrc.json` | -| JSX_ESLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| JSX_ESLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| JSX_ESLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| JSX_ESLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| JSX_ESLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| JSX_ESLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| JSX_ESLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| JSX_ESLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".jsx"]` | +| JSX_ESLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| JSX_ESLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| JSX_ESLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| JSX_ESLINT_CONFIG_FILE | eslint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.eslintrc.json` | +| JSX_ESLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| JSX_ESLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| JSX_ESLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use eslint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:---------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-eslint](https://atom.io/packages/linter-eslint) | [Visit Web Site](https://atom.io/packages/linter-eslint){target=_blank} | -| | [Brackets](http://brackets.io/) | [brackets-eslint](https://github.com/brackets-userland/brackets-eslint) | [Visit Web Site](https://github.com/brackets-userland/brackets-eslint){target=_blank} | -| | [Eclipse](https://www.eclipse.org/) | [Tern-Linter-ESLint](https://github.com/angelozerr/tern.java/wiki/Tern-Linter-ESLint) | [Visit Web Site](https://github.com/angelozerr/tern.java/wiki/Tern-Linter-ESLint){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](http://www.flycheck.org/en/latest/languages.html#javascript) | [Visit Web Site](http://www.flycheck.org/en/latest/languages.html#javascript){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [ESLint Plugin](https://plugins.jetbrains.com/plugin/7494-eslint) | | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-eslint](https://github.com/roadhump/SublimeLinter-eslint) | [Visit Web Site](https://github.com/roadhump/SublimeLinter-eslint){target=_blank} | -| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | -| | [vim](https://www.vim.org/) | [Syntastic](https://github.com/vim-syntastic/syntastic/tree/master/syntax_checkers/javascript) | [Visit Web Site](https://github.com/vim-syntastic/syntastic/tree/master/syntax_checkers/javascript){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/dbaeumer.vscode-eslint){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-eslint](https://atom.io/packages/linter-eslint) | [Visit Web Site](https://atom.io/packages/linter-eslint){target=_blank} | +| | [Brackets](http://brackets.io/) | [brackets-eslint](https://github.com/brackets-userland/brackets-eslint) | [Visit Web Site](https://github.com/brackets-userland/brackets-eslint){target=_blank} | +| | [Eclipse](https://www.eclipse.org/) | [Tern-Linter-ESLint](https://github.com/angelozerr/tern.java/wiki/Tern-Linter-ESLint) | [Visit Web Site](https://github.com/angelozerr/tern.java/wiki/Tern-Linter-ESLint){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](http://www.flycheck.org/en/latest/languages.html#javascript) | [Visit Web Site](http://www.flycheck.org/en/latest/languages.html#javascript){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [ESLint Plugin](https://plugins.jetbrains.com/plugin/7494-eslint) | | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-eslint](https://github.com/roadhump/SublimeLinter-eslint) | [Visit Web Site](https://github.com/roadhump/SublimeLinter-eslint){target=_blank} | +| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | +| | [vim](https://www.vim.org/) | [Syntastic](https://github.com/vim-syntastic/syntastic/tree/master/syntax_checkers/javascript) | [Visit Web Site](https://github.com/vim-syntastic/syntastic/tree/master/syntax_checkers/javascript){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/dbaeumer.vscode-eslint){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | ## Behind the scenes diff --git a/docs/descriptors/kotlin.md b/docs/descriptors/kotlin.md index a13b36dd9c2..8631948530d 100644 --- a/docs/descriptors/kotlin.md +++ b/docs/descriptors/kotlin.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|----------------------------|----------------------------|----------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [ktlint](kotlin_ktlint.md) | [KOTLIN](kotlin_ktlint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/pinterest/ktlint)](https://github.com/pinterest/ktlint/commits) | ## Linted files @@ -17,10 +17,10 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|-----------------------------|-------------------------------|---------------| -| KOTLIN_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| KOTLIN_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| KOTLIN_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| KOTLIN_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | ## Behind the scenes diff --git a/docs/descriptors/kotlin_ktlint.md b/docs/descriptors/kotlin_ktlint.md index 1e7fdeb575d..0bfa39e00b1 100644 --- a/docs/descriptors/kotlin_ktlint.md +++ b/docs/descriptors/kotlin_ktlint.md @@ -24,47 +24,47 @@ - Enable **auto-fixes** by adding `KOTLIN_KTLINT` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| KOTLIN_KTLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| KOTLIN_KTLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| KOTLIN_KTLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| KOTLIN_KTLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| KOTLIN_KTLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".kt", ".kts"]` | -| KOTLIN_KTLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| KOTLIN_KTLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| KOTLIN_KTLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| KOTLIN_KTLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| KOTLIN_KTLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| KOTLIN_KTLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| KOTLIN_KTLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| KOTLIN_KTLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| KOTLIN_KTLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| KOTLIN_KTLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".kt", ".kts"]` | +| KOTLIN_KTLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| KOTLIN_KTLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| KOTLIN_KTLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| KOTLIN_KTLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| KOTLIN_KTLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use ktlint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------|-------------------------------------------------------------|:-------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck-kotlin](https://github.com/whirm/flycheck-kotlin) | [Visit Web Site](https://github.com/whirm/flycheck-kotlin){target=_blank} | -| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | +| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/kubernetes.md b/docs/descriptors/kubernetes.md index d7dd163fbd5..3cc5c1502f2 100644 --- a/docs/descriptors/kubernetes.md +++ b/docs/descriptors/kubernetes.md @@ -5,10 +5,10 @@ ## Linters -| Linter | Configuration key | Status | -|------------------------------------------|-----------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| -| [kubeval](kubernetes_kubeval.md) | [KUBERNETES_KUBEVAL](kubernetes_kubeval.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/instrumenta/kubeval)](https://github.com/instrumenta/kubeval/commits) | -| [kubeconform](kubernetes_kubeconform.md) | [KUBERNETES_KUBECONFORM](kubernetes_kubeconform.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/yannh/kubeconform)](https://github.com/yannh/kubeconform/commits) | +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | +| [kubeval](kubernetes_kubeval.md) | [KUBERNETES_KUBEVAL](kubernetes_kubeval.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/instrumenta/kubeval)](https://github.com/instrumenta/kubeval/commits) | +| [kubeconform](kubernetes_kubeconform.md) | [KUBERNETES_KUBECONFORM](kubernetes_kubeconform.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/yannh/kubeconform)](https://github.com/yannh/kubeconform/commits) | ## Linted files @@ -24,8 +24,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|---------------------------------|-------------------------------|---------------| -| KUBERNETES_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| KUBERNETES_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| KUBERNETES_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| KUBERNETES_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/kubernetes_kubeconform.md b/docs/descriptors/kubernetes_kubeconform.md index 9bab680c3e9..a43bd78e44d 100644 --- a/docs/descriptors/kubernetes_kubeconform.md +++ b/docs/descriptors/kubernetes_kubeconform.md @@ -23,40 +23,40 @@ - Enable kubeconform by adding `KUBERNETES_KUBECONFORM` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable kubeconform by adding `KUBERNETES_KUBECONFORM` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| -| KUBERNETES_KUBECONFORM_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| KUBERNETES_KUBECONFORM_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| KUBERNETES_KUBECONFORM_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| KUBERNETES_KUBECONFORM_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| KUBERNETES_KUBECONFORM_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml", ".json"]` | -| KUBERNETES_KUBECONFORM_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| KUBERNETES_KUBECONFORM_PRE_COMMANDS | List of bash commands to run before the linter | None | -| KUBERNETES_KUBECONFORM_POST_COMMANDS | List of bash commands to run after the linter | None | -| KUBERNETES_KUBECONFORM_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| KUBERNETES_KUBECONFORM_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | -| KUBERNETES_DIRECTORY | Directory containing KUBERNETES files | `kubernetes` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| KUBERNETES_KUBECONFORM_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| KUBERNETES_KUBECONFORM_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| KUBERNETES_KUBECONFORM_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| KUBERNETES_KUBECONFORM_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| KUBERNETES_KUBECONFORM_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml", ".json"]` | +| KUBERNETES_KUBECONFORM_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| KUBERNETES_KUBECONFORM_PRE_COMMANDS | List of bash commands to run before the linter| None | +| KUBERNETES_KUBECONFORM_POST_COMMANDS | List of bash commands to run after the linter| None | +| KUBERNETES_KUBECONFORM_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| KUBERNETES_KUBECONFORM_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| KUBERNETES_DIRECTORY | Directory containing KUBERNETES files | `kubernetes` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/kubernetes_kubeval.md b/docs/descriptors/kubernetes_kubeval.md index 284f3a3f318..c2cd904f4d6 100644 --- a/docs/descriptors/kubernetes_kubeval.md +++ b/docs/descriptors/kubernetes_kubeval.md @@ -14,40 +14,40 @@ - Enable kubeval by adding `KUBERNETES_KUBEVAL` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable kubeval by adding `KUBERNETES_KUBEVAL` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| -| KUBERNETES_KUBEVAL_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| KUBERNETES_KUBEVAL_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| KUBERNETES_KUBEVAL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| KUBERNETES_KUBEVAL_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| KUBERNETES_KUBEVAL_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml", ".json"]` | -| KUBERNETES_KUBEVAL_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| KUBERNETES_KUBEVAL_PRE_COMMANDS | List of bash commands to run before the linter | None | -| KUBERNETES_KUBEVAL_POST_COMMANDS | List of bash commands to run after the linter | None | -| KUBERNETES_KUBEVAL_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| KUBERNETES_KUBEVAL_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | -| KUBERNETES_DIRECTORY | Directory containing KUBERNETES files | `kubernetes` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| KUBERNETES_KUBEVAL_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| KUBERNETES_KUBEVAL_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| KUBERNETES_KUBEVAL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| KUBERNETES_KUBEVAL_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| KUBERNETES_KUBEVAL_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml", ".json"]` | +| KUBERNETES_KUBEVAL_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| KUBERNETES_KUBEVAL_PRE_COMMANDS | List of bash commands to run before the linter| None | +| KUBERNETES_KUBEVAL_POST_COMMANDS | List of bash commands to run after the linter| None | +| KUBERNETES_KUBEVAL_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| KUBERNETES_KUBEVAL_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| KUBERNETES_DIRECTORY | Directory containing KUBERNETES files | `kubernetes` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/latex.md b/docs/descriptors/latex.md index 006d14c5bad..ac9659288de 100644 --- a/docs/descriptors/latex.md +++ b/docs/descriptors/latex.md @@ -5,9 +5,9 @@ ## Linters -| Linter | Configuration key | Status | -|---------------------------|--------------------------|--------| -| [chktex](latex_chktex.md) | [LATEX](latex_chktex.md) | | +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | +| [chktex](latex_chktex.md) | [LATEX](latex_chktex.md) | | ## Linted files @@ -16,8 +16,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|----------------------------|-------------------------------|---------------| -| LATEX_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| LATEX_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| LATEX_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| LATEX_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/latex_chktex.md b/docs/descriptors/latex_chktex.md index c3db3ca8b3e..e7b4e06ed82 100644 --- a/docs/descriptors/latex_chktex.md +++ b/docs/descriptors/latex_chktex.md @@ -14,37 +14,37 @@ - Enable chktex by adding `LATEX_CHKTEX` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable chktex by adding `LATEX_CHKTEX` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| LATEX_CHKTEX_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| LATEX_CHKTEX_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| LATEX_CHKTEX_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| LATEX_CHKTEX_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| LATEX_CHKTEX_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".tex"]` | -| LATEX_CHKTEX_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| LATEX_CHKTEX_PRE_COMMANDS | List of bash commands to run before the linter | None | -| LATEX_CHKTEX_POST_COMMANDS | List of bash commands to run after the linter | None | -| LATEX_CHKTEX_CONFIG_FILE | chktex configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.chktexrc` | -| LATEX_CHKTEX_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| LATEX_CHKTEX_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| LATEX_CHKTEX_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| LATEX_CHKTEX_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| LATEX_CHKTEX_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| LATEX_CHKTEX_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| LATEX_CHKTEX_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| LATEX_CHKTEX_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".tex"]` | +| LATEX_CHKTEX_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| LATEX_CHKTEX_PRE_COMMANDS | List of bash commands to run before the linter| None | +| LATEX_CHKTEX_POST_COMMANDS | List of bash commands to run after the linter| None | +| LATEX_CHKTEX_CONFIG_FILE | chktex configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.chktexrc` | +| LATEX_CHKTEX_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| LATEX_CHKTEX_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| LATEX_CHKTEX_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use chktex in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-----------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-chktex](https://atom.io/packages/linter-chktex) | [Visit Web Site](https://atom.io/packages/linter-chktex){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-chktex](https://atom.io/packages/linter-chktex) | [Visit Web Site](https://atom.io/packages/linter-chktex){target=_blank} | | | [Visual Studio Code](https://code.visualstudio.com/) | [latex-workshop](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/James-Yu.latex-workshop){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:--------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | ## Behind the scenes diff --git a/docs/descriptors/lua.md b/docs/descriptors/lua.md index ef3f61d60e2..d39c32a510b 100644 --- a/docs/descriptors/lua.md +++ b/docs/descriptors/lua.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|-----------------------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [luacheck](lua_luacheck.md) | [LUA](lua_luacheck.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/luarocks/luacheck)](https://github.com/luarocks/luacheck/commits) | ## Linted files @@ -16,8 +16,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|--------------------------|-------------------------------|---------------| -| LUA_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| LUA_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| LUA_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| LUA_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/lua_luacheck.md b/docs/descriptors/lua_luacheck.md index d008a5e18e6..907cf09a573 100644 --- a/docs/descriptors/lua_luacheck.md +++ b/docs/descriptors/lua_luacheck.md @@ -18,41 +18,41 @@ - Enable luacheck by adding `LUA_LUACHECK` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable luacheck by adding `LUA_LUACHECK` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| LUA_LUACHECK_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| LUA_LUACHECK_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| LUA_LUACHECK_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| LUA_LUACHECK_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| LUA_LUACHECK_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".lua"]` | -| LUA_LUACHECK_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| LUA_LUACHECK_PRE_COMMANDS | List of bash commands to run before the linter | None | -| LUA_LUACHECK_POST_COMMANDS | List of bash commands to run after the linter | None | -| LUA_LUACHECK_CONFIG_FILE | luacheck configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.luacheckrc` | -| LUA_LUACHECK_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| LUA_LUACHECK_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| LUA_LUACHECK_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| LUA_LUACHECK_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| LUA_LUACHECK_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| LUA_LUACHECK_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| LUA_LUACHECK_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| LUA_LUACHECK_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".lua"]` | +| LUA_LUACHECK_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| LUA_LUACHECK_PRE_COMMANDS | List of bash commands to run before the linter| None | +| LUA_LUACHECK_POST_COMMANDS | List of bash commands to run after the linter| None | +| LUA_LUACHECK_CONFIG_FILE | luacheck configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.luacheckrc` | +| LUA_LUACHECK_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| LUA_LUACHECK_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| LUA_LUACHECK_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use luacheck in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:---------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-luacheck](https://atom.io/packages/linter-luacheck) | [Visit Web Site](https://atom.io/packages/linter-luacheck){target=_blank} | -| | [Brackets](http://brackets.io/) | [brackets-luacheck](https://github.com/Malcolm3141/brackets-luacheck) | [Visit Web Site](https://github.com/Malcolm3141/brackets-luacheck){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](http://www.flycheck.org/en/latest/languages.html#lua) | [Visit Web Site](http://www.flycheck.org/en/latest/languages.html#lua){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-luacheck](https://packagecontrol.io/packages/SublimeLinter-luacheck) | [Visit Web Site](https://packagecontrol.io/packages/SublimeLinter-luacheck){target=_blank} | -| | [vim](https://www.vim.org/) | [Syntastic](https://github.com/vim-syntastic/syntastic/wiki/Lua%3A---luacheck) | [Visit Web Site](https://github.com/vim-syntastic/syntastic/wiki/Lua%3A---luacheck){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-luacheck](https://marketplace.visualstudio.com/items?itemName=dwenegar.vscode-luacheck) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/dwenegar.vscode-luacheck){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-luacheck](https://atom.io/packages/linter-luacheck) | [Visit Web Site](https://atom.io/packages/linter-luacheck){target=_blank} | +| | [Brackets](http://brackets.io/) | [brackets-luacheck](https://github.com/Malcolm3141/brackets-luacheck) | [Visit Web Site](https://github.com/Malcolm3141/brackets-luacheck){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](http://www.flycheck.org/en/latest/languages.html#lua) | [Visit Web Site](http://www.flycheck.org/en/latest/languages.html#lua){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-luacheck](https://packagecontrol.io/packages/SublimeLinter-luacheck) | [Visit Web Site](https://packagecontrol.io/packages/SublimeLinter-luacheck){target=_blank} | +| | [vim](https://www.vim.org/) | [Syntastic](https://github.com/vim-syntastic/syntastic/wiki/Lua%3A---luacheck) | [Visit Web Site](https://github.com/vim-syntastic/syntastic/wiki/Lua%3A---luacheck){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-luacheck](https://marketplace.visualstudio.com/items?itemName=dwenegar.vscode-luacheck) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/dwenegar.vscode-luacheck){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:--------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | ## Behind the scenes diff --git a/docs/descriptors/markdown.md b/docs/descriptors/markdown.md index 4741a882422..635d4c6ad8d 100644 --- a/docs/descriptors/markdown.md +++ b/docs/descriptors/markdown.md @@ -5,11 +5,11 @@ ## Linters -| Linter | Configuration key | Status | -|------------------------------------------------------------------|--------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [markdownlint](markdown_markdownlint.md) | [MARKDOWN](markdown_markdownlint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/DavidAnson/markdownlint)](https://github.com/DavidAnson/markdownlint/commits) | -| [remark-lint](markdown_remark_lint.md) | [MARKDOWN](markdown_remark_lint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/remarkjs/remark-lint)](https://github.com/remarkjs/remark-lint/commits) | -| [markdown-link-check](markdown_markdown_link_check.md) | [MARKDOWN](markdown_markdown_link_check.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/tcort/markdown-link-check)](https://github.com/tcort/markdown-link-check/commits) | +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | +| [markdownlint](markdown_markdownlint.md) | [MARKDOWN](markdown_markdownlint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/DavidAnson/markdownlint)](https://github.com/DavidAnson/markdownlint/commits) | +| [remark-lint](markdown_remark_lint.md) | [MARKDOWN](markdown_remark_lint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/remarkjs/remark-lint)](https://github.com/remarkjs/remark-lint/commits) | +| [markdown-link-check](markdown_markdown_link_check.md) | [MARKDOWN](markdown_markdown_link_check.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/tcort/markdown-link-check)](https://github.com/tcort/markdown-link-check/commits) | | [markdown-table-formatter](markdown_markdown_table_formatter.md) | [MARKDOWN](markdown_markdown_table_formatter.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/nvuillam/markdown-table-formatter)](https://github.com/nvuillam/markdown-table-formatter/commits) | ## Linted files @@ -19,8 +19,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|-------------------------------|-------------------------------|---------------| -| MARKDOWN_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| MARKDOWN_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| MARKDOWN_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| MARKDOWN_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/markdown_markdown_link_check.md b/docs/descriptors/markdown_markdown_link_check.md index b2d2b7b9c53..450ef63d812 100644 --- a/docs/descriptors/markdown_markdown_link_check.md +++ b/docs/descriptors/markdown_markdown_link_check.md @@ -17,40 +17,40 @@ - Enable markdown-link-check by adding `MARKDOWN_MARKDOWN_LINK_CHECK` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable markdown-link-check by adding `MARKDOWN_MARKDOWN_LINK_CHECK` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| MARKDOWN_MARKDOWN_LINK_CHECK_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| MARKDOWN_MARKDOWN_LINK_CHECK_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| MARKDOWN_MARKDOWN_LINK_CHECK_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| MARKDOWN_MARKDOWN_LINK_CHECK_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| MARKDOWN_MARKDOWN_LINK_CHECK_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".md"]` | -| MARKDOWN_MARKDOWN_LINK_CHECK_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| MARKDOWN_MARKDOWN_LINK_CHECK_PRE_COMMANDS | List of bash commands to run before the linter | None | -| MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS | List of bash commands to run after the linter | None | -| MARKDOWN_MARKDOWN_LINK_CHECK_CONFIG_FILE | markdown-link-check configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.markdown-link-check.json` | -| MARKDOWN_MARKDOWN_LINK_CHECK_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| MARKDOWN_MARKDOWN_LINK_CHECK_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| MARKDOWN_MARKDOWN_LINK_CHECK_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| MARKDOWN_MARKDOWN_LINK_CHECK_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| MARKDOWN_MARKDOWN_LINK_CHECK_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| MARKDOWN_MARKDOWN_LINK_CHECK_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| MARKDOWN_MARKDOWN_LINK_CHECK_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| MARKDOWN_MARKDOWN_LINK_CHECK_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".md"]` | +| MARKDOWN_MARKDOWN_LINK_CHECK_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| MARKDOWN_MARKDOWN_LINK_CHECK_PRE_COMMANDS | List of bash commands to run before the linter| None | +| MARKDOWN_MARKDOWN_LINK_CHECK_POST_COMMANDS | List of bash commands to run after the linter| None | +| MARKDOWN_MARKDOWN_LINK_CHECK_CONFIG_FILE | markdown-link-check configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.markdown-link-check.json` | +| MARKDOWN_MARKDOWN_LINK_CHECK_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| MARKDOWN_MARKDOWN_LINK_CHECK_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| MARKDOWN_MARKDOWN_LINK_CHECK_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/markdown_markdown_table_formatter.md b/docs/descriptors/markdown_markdown_table_formatter.md index 8ae4336c9c9..ed9a8ae7036 100644 --- a/docs/descriptors/markdown_markdown_table_formatter.md +++ b/docs/descriptors/markdown_markdown_table_formatter.md @@ -18,46 +18,46 @@ markdown-table-formatter detects wrongly formatted markdown tables and can autom - Enable **auto-fixes** by adding `MARKDOWN_MARKDOWN_TABLE_FORMATTER` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|---------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| MARKDOWN_MARKDOWN_TABLE_FORMATTER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| MARKDOWN_MARKDOWN_TABLE_FORMATTER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".md"]` | -| MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS | List of bash commands to run before the linter | None | -| MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS | List of bash commands to run after the linter | None | -| MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | -| MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| MARKDOWN_MARKDOWN_TABLE_FORMATTER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| MARKDOWN_MARKDOWN_TABLE_FORMATTER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".md"]` | +| MARKDOWN_MARKDOWN_TABLE_FORMATTER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| MARKDOWN_MARKDOWN_TABLE_FORMATTER_PRE_COMMANDS | List of bash commands to run before the linter| None | +| MARKDOWN_MARKDOWN_TABLE_FORMATTER_POST_COMMANDS | List of bash commands to run after the linter| None | +| MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use markdown-table-formatter in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|----------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Visual Studio Code](https://code.visualstudio.com/) | [Markdown Table Prettify Extension](https://github.com/darkriszty/MarkdownTablePrettify-VSCodeExt) | [Visit Web Site](https://github.com/darkriszty/MarkdownTablePrettify-VSCodeExt){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/markdown_markdownlint.md b/docs/descriptors/markdown_markdownlint.md index b235e4fb7dc..40d09d69691 100644 --- a/docs/descriptors/markdown_markdownlint.md +++ b/docs/descriptors/markdown_markdownlint.md @@ -20,52 +20,52 @@ - Enable **auto-fixes** by adding `MARKDOWN_MARKDOWNLINT` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| MARKDOWN_DEFAULT_STYLE | For markdownlint to be active, MARKDOWN_DEFAULT_STYLE must be `markdownlint` | `markdownlint` | -| MARKDOWN_MARKDOWNLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| MARKDOWN_MARKDOWNLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| MARKDOWN_MARKDOWNLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| MARKDOWN_MARKDOWNLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| MARKDOWN_MARKDOWNLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".md"]` | -| MARKDOWN_MARKDOWNLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| MARKDOWN_MARKDOWNLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| MARKDOWN_MARKDOWNLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| MARKDOWN_MARKDOWNLINT_CONFIG_FILE | markdownlint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.markdownlint.json` | -| MARKDOWN_MARKDOWNLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| MARKDOWN_MARKDOWNLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | -| MARKDOWN_MARKDOWNLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| MARKDOWN_DEFAULT_STYLE | For markdownlint to be active, MARKDOWN_DEFAULT_STYLE must be `markdownlint` | `markdownlint` | +| MARKDOWN_MARKDOWNLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| MARKDOWN_MARKDOWNLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| MARKDOWN_MARKDOWNLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| MARKDOWN_MARKDOWNLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| MARKDOWN_MARKDOWNLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".md"]` | +| MARKDOWN_MARKDOWNLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| MARKDOWN_MARKDOWNLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| MARKDOWN_MARKDOWNLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| MARKDOWN_MARKDOWNLINT_CONFIG_FILE | markdownlint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.markdownlint.json` | +| MARKDOWN_MARKDOWNLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| MARKDOWN_MARKDOWNLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| MARKDOWN_MARKDOWNLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use markdownlint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-node-markdownlint](https://atom.io/packages/linter-node-markdownlint) | [Visit Web Site](https://atom.io/packages/linter-node-markdownlint){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-markdownlint](https://packagecontrol.io/packages/SublimeLinter-contrib-markdownlint) | [Visit Web Site](https://packagecontrol.io/packages/SublimeLinter-contrib-markdownlint){target=_blank} | -| | [vim](https://www.vim.org/) | [coc-markdownlint](https://github.com/fannheyward/coc-markdownlint) | [Visit Web Site](https://github.com/fannheyward/coc-markdownlint){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-markdownlint](https://marketplace.visualstudio.com/items/DavidAnson.vscode-markdownlint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/DavidAnson.vscode-markdownlint){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-node-markdownlint](https://atom.io/packages/linter-node-markdownlint) | [Visit Web Site](https://atom.io/packages/linter-node-markdownlint){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-markdownlint](https://packagecontrol.io/packages/SublimeLinter-contrib-markdownlint) | [Visit Web Site](https://packagecontrol.io/packages/SublimeLinter-contrib-markdownlint){target=_blank} | +| | [vim](https://www.vim.org/) | [coc-markdownlint](https://github.com/fannheyward/coc-markdownlint) | [Visit Web Site](https://github.com/fannheyward/coc-markdownlint){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-markdownlint](https://marketplace.visualstudio.com/items/DavidAnson.vscode-markdownlint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/DavidAnson.vscode-markdownlint){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/markdown_remark_lint.md b/docs/descriptors/markdown_remark_lint.md index 9c338eac06d..e6589d686f1 100644 --- a/docs/descriptors/markdown_remark_lint.md +++ b/docs/descriptors/markdown_remark_lint.md @@ -22,40 +22,40 @@ _This linter has been temporary disabled in this version_ - Enable **auto-fixes** by adding `MARKDOWN_REMARK_LINT` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| MARKDOWN_DEFAULT_STYLE | For remark-lint to be active, MARKDOWN_DEFAULT_STYLE must be `remark-lint` | `markdownlint` | -| MARKDOWN_REMARK_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| MARKDOWN_REMARK_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| MARKDOWN_REMARK_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| MARKDOWN_REMARK_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| MARKDOWN_REMARK_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".md"]` | -| MARKDOWN_REMARK_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| MARKDOWN_REMARK_LINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| MARKDOWN_REMARK_LINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| MARKDOWN_REMARK_LINT_CONFIG_FILE | remark-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.remarkrc` | -| MARKDOWN_REMARK_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| MARKDOWN_REMARK_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | -| MARKDOWN_REMARK_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| MARKDOWN_DEFAULT_STYLE | For remark-lint to be active, MARKDOWN_DEFAULT_STYLE must be `remark-lint` | `markdownlint` | +| MARKDOWN_REMARK_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| MARKDOWN_REMARK_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| MARKDOWN_REMARK_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| MARKDOWN_REMARK_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| MARKDOWN_REMARK_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".md"]` | +| MARKDOWN_REMARK_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| MARKDOWN_REMARK_LINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| MARKDOWN_REMARK_LINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| MARKDOWN_REMARK_LINT_CONFIG_FILE | remark-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.remarkrc` | +| MARKDOWN_REMARK_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| MARKDOWN_REMARK_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| MARKDOWN_REMARK_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use remark-lint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-remark](https://github.com/wooorm/linter-remark) | [Visit Web Site](https://github.com/wooorm/linter-remark){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-remark-lint](https://packagecontrol.io/packages/SublimeLinter-contrib-remark-lint) | [Visit Web Site](https://packagecontrol.io/packages/SublimeLinter-contrib-remark-lint){target=_blank} | -| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-remark-lint](https://github.com/drewbourne/vscode-remark-lint) | [Visit Web Site](https://github.com/drewbourne/vscode-remark-lint){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-remark](https://github.com/wooorm/linter-remark) | [Visit Web Site](https://github.com/wooorm/linter-remark){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-remark-lint](https://packagecontrol.io/packages/SublimeLinter-contrib-remark-lint) | [Visit Web Site](https://packagecontrol.io/packages/SublimeLinter-contrib-remark-lint){target=_blank} | +| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-remark-lint](https://github.com/drewbourne/vscode-remark-lint) | [Visit Web Site](https://github.com/drewbourne/vscode-remark-lint){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:--------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | ## Behind the scenes diff --git a/docs/descriptors/openapi.md b/docs/descriptors/openapi.md index ecbecf6b67f..6502b35c31e 100644 --- a/docs/descriptors/openapi.md +++ b/docs/descriptors/openapi.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|---------------------------------|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [spectral](openapi_spectral.md) | [OPENAPI](openapi_spectral.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/stoplightio/spectral)](https://github.com/stoplightio/spectral/commits) | ## Linted files @@ -24,8 +24,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|------------------------------|-------------------------------|---------------| -| OPENAPI_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| OPENAPI_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| OPENAPI_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| OPENAPI_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/openapi_spectral.md b/docs/descriptors/openapi_spectral.md index 1523bfe9a4c..99e3856c5d2 100644 --- a/docs/descriptors/openapi_spectral.md +++ b/docs/descriptors/openapi_spectral.md @@ -24,49 +24,49 @@ - Enable spectral by adding `OPENAPI_SPECTRAL` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable spectral by adding `OPENAPI_SPECTRAL` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| OPENAPI_SPECTRAL_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| OPENAPI_SPECTRAL_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| OPENAPI_SPECTRAL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| OPENAPI_SPECTRAL_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| OPENAPI_SPECTRAL_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml", ".json"]` | -| OPENAPI_SPECTRAL_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| OPENAPI_SPECTRAL_PRE_COMMANDS | List of bash commands to run before the linter | None | -| OPENAPI_SPECTRAL_POST_COMMANDS | List of bash commands to run after the linter | None | -| OPENAPI_SPECTRAL_CONFIG_FILE | spectral configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.openapirc.yml` | -| OPENAPI_SPECTRAL_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| OPENAPI_SPECTRAL_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| OPENAPI_SPECTRAL_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| OPENAPI_SPECTRAL_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| OPENAPI_SPECTRAL_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| OPENAPI_SPECTRAL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| OPENAPI_SPECTRAL_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| OPENAPI_SPECTRAL_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml", ".json"]` | +| OPENAPI_SPECTRAL_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| OPENAPI_SPECTRAL_PRE_COMMANDS | List of bash commands to run before the linter| None | +| OPENAPI_SPECTRAL_POST_COMMANDS | List of bash commands to run after the linter| None | +| OPENAPI_SPECTRAL_CONFIG_FILE | spectral configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.openapirc.yml` | +| OPENAPI_SPECTRAL_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| OPENAPI_SPECTRAL_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| OPENAPI_SPECTRAL_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use spectral in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-------------------------------------------------------------------|:-------------------------------------------------------------------------------:| -| | stoplight | [Native integration](https://stoplight.io/studio) | [Visit Web Site](https://stoplight.io/studio){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-spectral](https://github.com/stoplightio/vscode-spectral) | [Visit Web Site](https://github.com/stoplightio/vscode-spectral){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | stoplight | [Native integration](https://stoplight.io/studio) | [Visit Web Site](https://stoplight.io/studio){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-spectral](https://github.com/stoplightio/vscode-spectral) | [Visit Web Site](https://github.com/stoplightio/vscode-spectral){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/perl.md b/docs/descriptors/perl.md index 852d0c64ddb..4d0e56db1cd 100644 --- a/docs/descriptors/perl.md +++ b/docs/descriptors/perl.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|----------------------------------|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [perlcritic](perl_perlcritic.md) | [PERL](perl_perlcritic.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/Perl-Critic/Perl-Critic)](https://github.com/Perl-Critic/Perl-Critic/commits) | ## Linted files @@ -23,10 +23,10 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|---------------------------|-------------------------------|---------------| -| PERL_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| PERL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PERL_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| PERL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | ## Behind the scenes diff --git a/docs/descriptors/perl_perlcritic.md b/docs/descriptors/perl_perlcritic.md index 9e23e0933c5..0b0482be7a3 100644 --- a/docs/descriptors/perl_perlcritic.md +++ b/docs/descriptors/perl_perlcritic.md @@ -24,26 +24,26 @@ - Enable perlcritic by adding `PERL_PERLCRITIC` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable perlcritic by adding `PERL_PERLCRITIC` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| -| PERL_PERLCRITIC_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| PERL_PERLCRITIC_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| PERL_PERLCRITIC_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| PERL_PERLCRITIC_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| PERL_PERLCRITIC_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".pl", ".pm", ".t", ""]` | -| PERL_PERLCRITIC_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| PERL_PERLCRITIC_PRE_COMMANDS | List of bash commands to run before the linter | None | -| PERL_PERLCRITIC_POST_COMMANDS | List of bash commands to run after the linter | None | -| PERL_PERLCRITIC_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| PERL_PERLCRITIC_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PERL_PERLCRITIC_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| PERL_PERLCRITIC_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| PERL_PERLCRITIC_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| PERL_PERLCRITIC_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| PERL_PERLCRITIC_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".pl", ".pm", ".t", ""]` | +| PERL_PERLCRITIC_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| PERL_PERLCRITIC_PRE_COMMANDS | List of bash commands to run before the linter| None | +| PERL_PERLCRITIC_POST_COMMANDS | List of bash commands to run after the linter| None | +| PERL_PERLCRITIC_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| PERL_PERLCRITIC_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:--------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | ## Behind the scenes diff --git a/docs/descriptors/php.md b/docs/descriptors/php.md index 41f819fad00..334db343ef1 100644 --- a/docs/descriptors/php.md +++ b/docs/descriptors/php.md @@ -5,12 +5,12 @@ ## Linters -| Linter | Configuration key | Status | -|---------------------------|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| -| [phpcs](php_phpcs.md) | [PHP_PHPCS](php_phpcs.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/squizlabs/PHP_CodeSniffer)](https://github.com/squizlabs/PHP_CodeSniffer/commits) | -| [phpstan](php_phpstan.md) | [PHP_PHPSTAN](php_phpstan.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/phpstan/phpstan)](https://github.com/phpstan/phpstan/commits) | -| [psalm](php_psalm.md) | [PHP_PSALM](php_psalm.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/vimeo/psalm)](https://github.com/vimeo/psalm/commits) | -| [phplint](php_phplint.md) | [PHP](php_phplint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/overtrue/phplint)](https://github.com/overtrue/phplint/commits) | +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | +| [phpcs](php_phpcs.md) | [PHP_PHPCS](php_phpcs.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/squizlabs/PHP_CodeSniffer)](https://github.com/squizlabs/PHP_CodeSniffer/commits) | +| [phpstan](php_phpstan.md) | [PHP_PHPSTAN](php_phpstan.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/phpstan/phpstan)](https://github.com/phpstan/phpstan/commits) | +| [psalm](php_psalm.md) | [PHP_PSALM](php_psalm.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/vimeo/psalm)](https://github.com/vimeo/psalm/commits) | +| [phplint](php_phplint.md) | [PHP](php_phplint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/overtrue/phplint)](https://github.com/overtrue/phplint/commits) | ## Linted files @@ -19,10 +19,10 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|--------------------------|-------------------------------|---------------| -| PHP_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| PHP_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PHP_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| PHP_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | ## Behind the scenes diff --git a/docs/descriptors/php_phpcs.md b/docs/descriptors/php_phpcs.md index 23bafe28909..61c145a46d3 100644 --- a/docs/descriptors/php_phpcs.md +++ b/docs/descriptors/php_phpcs.md @@ -17,42 +17,42 @@ - Enable phpcs by adding `PHP_PHPCS` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable phpcs by adding `PHP_PHPCS` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| PHP_PHPCS_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| PHP_PHPCS_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| PHP_PHPCS_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| PHP_PHPCS_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| PHP_PHPCS_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".php"]` | -| PHP_PHPCS_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| PHP_PHPCS_PRE_COMMANDS | List of bash commands to run before the linter | None | -| PHP_PHPCS_POST_COMMANDS | List of bash commands to run after the linter | None | -| PHP_PHPCS_CONFIG_FILE | phpcs configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `phpcs.xml` | -| PHP_PHPCS_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| PHP_PHPCS_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| PHP_PHPCS_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PHP_PHPCS_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| PHP_PHPCS_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| PHP_PHPCS_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| PHP_PHPCS_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| PHP_PHPCS_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".php"]` | +| PHP_PHPCS_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| PHP_PHPCS_PRE_COMMANDS | List of bash commands to run before the linter| None | +| PHP_PHPCS_POST_COMMANDS | List of bash commands to run after the linter| None | +| PHP_PHPCS_CONFIG_FILE | phpcs configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `phpcs.xml` | +| PHP_PHPCS_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| PHP_PHPCS_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| PHP_PHPCS_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use phpcs in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|-------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-phpcs](https://atom.io/packages/linter-phpcs) | [Visit Web Site](https://atom.io/packages/linter-phpcs){target=_blank} | -| | [Atom](https://atom.io/) | [atom-phpcs](https://github.com/bpearson/atom-phpcs) | [Visit Web Site](https://github.com/bpearson/atom-phpcs){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [phpcs](https://www.jetbrains.com/help/phpstorm/2019.1/using-php-code-sniffer.html) | [Visit Web Site](https://www.jetbrains.com/help/phpstorm/2019.1/using-php-code-sniffer.html){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [sublime-phpcs](https://github.com/benmatselby/sublime-phpcs) | [Visit Web Site](https://github.com/benmatselby/sublime-phpcs){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-phpcs](https://github.com/SublimeLinter/SublimeLinter-phpcs) | [Visit Web Site](https://github.com/SublimeLinter/SublimeLinter-phpcs){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-phpcs](https://marketplace.visualstudio.com/items?itemName=ikappas.phpcs) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/ikappas.phpcs){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-phpcs](https://atom.io/packages/linter-phpcs) | [Visit Web Site](https://atom.io/packages/linter-phpcs){target=_blank} | +| | [Atom](https://atom.io/) | [atom-phpcs](https://github.com/bpearson/atom-phpcs) | [Visit Web Site](https://github.com/bpearson/atom-phpcs){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [phpcs](https://www.jetbrains.com/help/phpstorm/2019.1/using-php-code-sniffer.html) | [Visit Web Site](https://www.jetbrains.com/help/phpstorm/2019.1/using-php-code-sniffer.html){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [sublime-phpcs](https://github.com/benmatselby/sublime-phpcs) | [Visit Web Site](https://github.com/benmatselby/sublime-phpcs){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-phpcs](https://github.com/SublimeLinter/SublimeLinter-phpcs) | [Visit Web Site](https://github.com/SublimeLinter/SublimeLinter-phpcs){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-phpcs](https://marketplace.visualstudio.com/items?itemName=ikappas.phpcs) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/ikappas.phpcs){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:---------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | ## Behind the scenes diff --git a/docs/descriptors/php_phplint.md b/docs/descriptors/php_phplint.md index 6dc55763287..71f77830262 100644 --- a/docs/descriptors/php_phplint.md +++ b/docs/descriptors/php_phplint.md @@ -15,29 +15,29 @@ - Enable phplint by adding `PHP_PHPLINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable phplint by adding `PHP_PHPLINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| PHP_PHPLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| PHP_PHPLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| PHP_PHPLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| PHP_PHPLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| PHP_PHPLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".php"]` | -| PHP_PHPLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| PHP_PHPLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| PHP_PHPLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| PHP_PHPLINT_CONFIG_FILE | phplint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.phplint.yml` | -| PHP_PHPLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| PHP_PHPLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| PHP_PHPLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PHP_PHPLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| PHP_PHPLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| PHP_PHPLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| PHP_PHPLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| PHP_PHPLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".php"]` | +| PHP_PHPLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| PHP_PHPLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| PHP_PHPLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| PHP_PHPLINT_CONFIG_FILE | phplint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.phplint.yml` | +| PHP_PHPLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| PHP_PHPLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| PHP_PHPLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:---------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | ## Behind the scenes diff --git a/docs/descriptors/php_phpstan.md b/docs/descriptors/php_phpstan.md index b6ffe8baf59..3d4897bf73a 100644 --- a/docs/descriptors/php_phpstan.md +++ b/docs/descriptors/php_phpstan.md @@ -17,38 +17,38 @@ - Enable phpstan by adding `PHP_PHPSTAN` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable phpstan by adding `PHP_PHPSTAN` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| PHP_PHPSTAN_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| PHP_PHPSTAN_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| PHP_PHPSTAN_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| PHP_PHPSTAN_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| PHP_PHPSTAN_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".php"]` | -| PHP_PHPSTAN_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| PHP_PHPSTAN_PRE_COMMANDS | List of bash commands to run before the linter | None | -| PHP_PHPSTAN_POST_COMMANDS | List of bash commands to run after the linter | None | -| PHP_PHPSTAN_CONFIG_FILE | phpstan configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `phpstan.neon.dist` | -| PHP_PHPSTAN_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| PHP_PHPSTAN_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| PHP_PHPSTAN_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PHP_PHPSTAN_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| PHP_PHPSTAN_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| PHP_PHPSTAN_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| PHP_PHPSTAN_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| PHP_PHPSTAN_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".php"]` | +| PHP_PHPSTAN_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| PHP_PHPSTAN_PRE_COMMANDS | List of bash commands to run before the linter| None | +| PHP_PHPSTAN_POST_COMMANDS | List of bash commands to run after the linter| None | +| PHP_PHPSTAN_CONFIG_FILE | phpstan configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `phpstan.neon.dist` | +| PHP_PHPSTAN_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| PHP_PHPSTAN_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| PHP_PHPSTAN_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use phpstan in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|---------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [PHPStan / Psalm / Generics](https://plugins.jetbrains.com/plugin/12754-phpstan--psalm--generics) | | -| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-phpstan](https://marketplace.visualstudio.com/items?itemName=calsmurf2904.vscode-phpstan) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/calsmurf2904.vscode-phpstan){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [PHPStan / Psalm / Generics](https://plugins.jetbrains.com/plugin/12754-phpstan--psalm--generics) | | +| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-phpstan](https://marketplace.visualstudio.com/items?itemName=calsmurf2904.vscode-phpstan) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/calsmurf2904.vscode-phpstan){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:---------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | ## Behind the scenes diff --git a/docs/descriptors/php_psalm.md b/docs/descriptors/php_psalm.md index a1b49bb99c9..774436c9faa 100644 --- a/docs/descriptors/php_psalm.md +++ b/docs/descriptors/php_psalm.md @@ -25,38 +25,38 @@ - Enable psalm by adding `PHP_PSALM` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable psalm by adding `PHP_PSALM` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| PHP_PSALM_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| PHP_PSALM_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| PHP_PSALM_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| PHP_PSALM_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| PHP_PSALM_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".php"]` | -| PHP_PSALM_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| PHP_PSALM_PRE_COMMANDS | List of bash commands to run before the linter | None | -| PHP_PSALM_POST_COMMANDS | List of bash commands to run after the linter | None | -| PHP_PSALM_CONFIG_FILE | psalm configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `psalm.xml` | -| PHP_PSALM_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| PHP_PSALM_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| PHP_PSALM_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PHP_PSALM_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| PHP_PSALM_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| PHP_PSALM_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| PHP_PSALM_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| PHP_PSALM_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".php"]` | +| PHP_PSALM_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| PHP_PSALM_PRE_COMMANDS | List of bash commands to run before the linter| None | +| PHP_PSALM_POST_COMMANDS | List of bash commands to run after the linter| None | +| PHP_PSALM_CONFIG_FILE | psalm configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `psalm.xml` | +| PHP_PSALM_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| PHP_PSALM_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| PHP_PSALM_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use psalm in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|---------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [PHPStan / Psalm / Generics](https://plugins.jetbrains.com/plugin/12754-phpstan--psalm--generics) | | -| | [Visual Studio Code](https://code.visualstudio.com/) | [Psalm VsCode Plugin](https://marketplace.visualstudio.com/items?itemName=getpsalm.psalm-vscode-plugin) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/getpsalm.psalm-vscode-plugin){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [PHPStan / Psalm / Generics](https://plugins.jetbrains.com/plugin/12754-phpstan--psalm--generics) | | +| | [Visual Studio Code](https://code.visualstudio.com/) | [Psalm VsCode Plugin](https://marketplace.visualstudio.com/items?itemName=getpsalm.psalm-vscode-plugin) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/getpsalm.psalm-vscode-plugin){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:---------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | ## Behind the scenes diff --git a/docs/descriptors/powershell.md b/docs/descriptors/powershell.md index 054773960c3..8334583376c 100644 --- a/docs/descriptors/powershell.md +++ b/docs/descriptors/powershell.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|----------------------------------------|----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [powershell](powershell_powershell.md) | [POWERSHELL](powershell_powershell.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/PowerShell/PSScriptAnalyzer)](https://github.com/PowerShell/PSScriptAnalyzer/commits) | ## Linted files @@ -22,10 +22,10 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|---------------------------------|-------------------------------|---------------| -| POWERSHELL_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| POWERSHELL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| POWERSHELL_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| POWERSHELL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | ## Behind the scenes diff --git a/docs/descriptors/powershell_powershell.md b/docs/descriptors/powershell_powershell.md index 1faf2c42711..6be52c0a8d4 100644 --- a/docs/descriptors/powershell_powershell.md +++ b/docs/descriptors/powershell_powershell.md @@ -17,37 +17,37 @@ - Enable powershell by adding `POWERSHELL_POWERSHELL` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable powershell by adding `POWERSHELL_POWERSHELL` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------| -| POWERSHELL_POWERSHELL_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| POWERSHELL_POWERSHELL_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| POWERSHELL_POWERSHELL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| POWERSHELL_POWERSHELL_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| POWERSHELL_POWERSHELL_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".ps1", ".psm1", ".psd1", ".ps1xml", ".pssc", ".psrc", ".cdxml"]` | -| POWERSHELL_POWERSHELL_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| POWERSHELL_POWERSHELL_PRE_COMMANDS | List of bash commands to run before the linter | None | -| POWERSHELL_POWERSHELL_POST_COMMANDS | List of bash commands to run after the linter | None | -| POWERSHELL_POWERSHELL_CONFIG_FILE | powershell configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.powershell-psscriptanalyzer.psd1` | -| POWERSHELL_POWERSHELL_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| POWERSHELL_POWERSHELL_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| POWERSHELL_POWERSHELL_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| POWERSHELL_POWERSHELL_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| POWERSHELL_POWERSHELL_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| POWERSHELL_POWERSHELL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| POWERSHELL_POWERSHELL_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| POWERSHELL_POWERSHELL_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".ps1", ".psm1", ".psd1", ".ps1xml", ".pssc", ".psrc", ".cdxml"]` | +| POWERSHELL_POWERSHELL_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| POWERSHELL_POWERSHELL_PRE_COMMANDS | List of bash commands to run before the linter| None | +| POWERSHELL_POWERSHELL_POST_COMMANDS | List of bash commands to run after the linter| None | +| POWERSHELL_POWERSHELL_CONFIG_FILE | powershell configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.powershell-psscriptanalyzer.psd1` | +| POWERSHELL_POWERSHELL_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| POWERSHELL_POWERSHELL_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| POWERSHELL_POWERSHELL_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use powershell in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|---------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Visual Studio Code](https://code.visualstudio.com/) | [VsCode PowerShell extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.PowerShell) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/ms-vscode.PowerShell){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:----------------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | ## Behind the scenes diff --git a/docs/descriptors/protobuf.md b/docs/descriptors/protobuf.md index 4a030c943e7..6ff4d74a874 100644 --- a/docs/descriptors/protobuf.md +++ b/docs/descriptors/protobuf.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|------------------------------------|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [protolint](protobuf_protolint.md) | [PROTOBUF](protobuf_protolint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/yoheimuta/protolint)](https://github.com/yoheimuta/protolint/commits) | ## Linted files @@ -16,8 +16,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|-------------------------------|-------------------------------|---------------| -| PROTOBUF_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| PROTOBUF_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PROTOBUF_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| PROTOBUF_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/protobuf_protolint.md b/docs/descriptors/protobuf_protolint.md index 67045cc09c1..202af2d20d4 100644 --- a/docs/descriptors/protobuf_protolint.md +++ b/docs/descriptors/protobuf_protolint.md @@ -19,49 +19,49 @@ - Enable **auto-fixes** by adding `PROTOBUF_PROTOLINT` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| PROTOBUF_PROTOLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| PROTOBUF_PROTOLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| PROTOBUF_PROTOLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| PROTOBUF_PROTOLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| PROTOBUF_PROTOLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".proto"]` | -| PROTOBUF_PROTOLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| PROTOBUF_PROTOLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| PROTOBUF_PROTOLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| PROTOBUF_PROTOLINT_CONFIG_FILE | protolint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.protolintrc.yml` | -| PROTOBUF_PROTOLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| PROTOBUF_PROTOLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| PROTOBUF_PROTOLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PROTOBUF_PROTOLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| PROTOBUF_PROTOLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| PROTOBUF_PROTOLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| PROTOBUF_PROTOLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| PROTOBUF_PROTOLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".proto"]` | +| PROTOBUF_PROTOLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| PROTOBUF_PROTOLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| PROTOBUF_PROTOLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| PROTOBUF_PROTOLINT_CONFIG_FILE | protolint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.protolintrc.yml` | +| PROTOBUF_PROTOLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| PROTOBUF_PROTOLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| PROTOBUF_PROTOLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use protolint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|-----------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [Protocol Buffer Linter](https://plugins.jetbrains.com/plugin/12641-protocol-buffer-linter) | | -| | [Visual Studio Code](https://code.visualstudio.com/) | [VsCode Protolint](https://marketplace.visualstudio.com/items?itemName=Plex.vscode-protolint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/Plex.vscode-protolint){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [Protocol Buffer Linter](https://plugins.jetbrains.com/plugin/12641-protocol-buffer-linter) | | +| | [Visual Studio Code](https://code.visualstudio.com/) | [VsCode Protolint](https://marketplace.visualstudio.com/items?itemName=Plex.vscode-protolint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/Plex.vscode-protolint){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/puppet.md b/docs/descriptors/puppet.md index 844f000335a..d34fcc4ea44 100644 --- a/docs/descriptors/puppet.md +++ b/docs/descriptors/puppet.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|--------------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [puppet-lint](puppet_puppet_lint.md) | [PUPPET](puppet_puppet_lint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/rodjek/puppet-lint)](https://github.com/rodjek/puppet-lint/commits) | ## Linted files @@ -16,8 +16,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|-----------------------------|-------------------------------|---------------| -| PUPPET_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| PUPPET_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PUPPET_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| PUPPET_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/puppet_puppet_lint.md b/docs/descriptors/puppet_puppet_lint.md index 9b76a540fb4..b821c22bf0b 100644 --- a/docs/descriptors/puppet_puppet_lint.md +++ b/docs/descriptors/puppet_puppet_lint.md @@ -19,36 +19,36 @@ - Enable **auto-fixes** by adding `PUPPET_PUPPET_LINT` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| PUPPET_PUPPET_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| PUPPET_PUPPET_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| PUPPET_PUPPET_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| PUPPET_PUPPET_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| PUPPET_PUPPET_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".pp"]` | -| PUPPET_PUPPET_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| PUPPET_PUPPET_LINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| PUPPET_PUPPET_LINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| PUPPET_PUPPET_LINT_CONFIG_FILE | puppet-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.puppet-lint.rc` | -| PUPPET_PUPPET_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| PUPPET_PUPPET_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| PUPPET_PUPPET_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PUPPET_PUPPET_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| PUPPET_PUPPET_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| PUPPET_PUPPET_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| PUPPET_PUPPET_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| PUPPET_PUPPET_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".pp"]` | +| PUPPET_PUPPET_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| PUPPET_PUPPET_LINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| PUPPET_PUPPET_LINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| PUPPET_PUPPET_LINT_CONFIG_FILE | puppet-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.puppet-lint.rc` | +| PUPPET_PUPPET_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| PUPPET_PUPPET_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| PUPPET_PUPPET_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use puppet-lint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-----------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Visual Studio Code](https://code.visualstudio.com/) | [Puppet VsCode Extension](https://puppet-vscode.github.io/docs/features/linting/) | [Visit Web Site](https://puppet-vscode.github.io/docs/features/linting/){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:--------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | ## Behind the scenes diff --git a/docs/descriptors/python.md b/docs/descriptors/python.md index 2ec63766b6c..bc2b0ba60a7 100644 --- a/docs/descriptors/python.md +++ b/docs/descriptors/python.md @@ -5,14 +5,14 @@ ## Linters -| Linter | Configuration key | Status | -|----------------------------|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [pylint](python_pylint.md) | [PYTHON_PYLINT](python_pylint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/PyCQA/pylint)](https://github.com/PyCQA/pylint/commits) | -| [black](python_black.md) | [PYTHON_BLACK](python_black.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/psf/black)](https://github.com/psf/black/commits) | +| [black](python_black.md) | [PYTHON_BLACK](python_black.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/psf/black)](https://github.com/psf/black/commits) | | [flake8](python_flake8.md) | [PYTHON_FLAKE8](python_flake8.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/PyCQA/flake8)](https://github.com/PyCQA/flake8/commits) | -| [isort](python_isort.md) | [PYTHON_ISORT](python_isort.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/PyCQA/isort)](https://github.com/PyCQA/isort/commits) | +| [isort](python_isort.md) | [PYTHON_ISORT](python_isort.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/PyCQA/isort)](https://github.com/PyCQA/isort/commits) | | [bandit](python_bandit.md) | [PYTHON_BANDIT](python_bandit.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/PyCQA/bandit)](https://github.com/PyCQA/bandit/commits) | -| [mypy](python_mypy.md) | [PYTHON_MYPY](python_mypy.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/python/mypy)](https://github.com/python/mypy/commits) | +| [mypy](python_mypy.md) | [PYTHON_MYPY](python_mypy.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/python/mypy)](https://github.com/python/mypy/commits) | ## Linted files @@ -21,8 +21,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|-----------------------------|-------------------------------|---------------| -| PYTHON_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| PYTHON_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PYTHON_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| PYTHON_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/python_bandit.md b/docs/descriptors/python_bandit.md index 9fa1c586b33..027fcec0d57 100644 --- a/docs/descriptors/python_bandit.md +++ b/docs/descriptors/python_bandit.md @@ -29,40 +29,40 @@ If you find it too harsh, you may define `PYTHON_BANDIT_DISABLE_ERRORS: true` in - Enable bandit by adding `PYTHON_BANDIT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable bandit by adding `PYTHON_BANDIT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| PYTHON_BANDIT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| PYTHON_BANDIT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| PYTHON_BANDIT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| PYTHON_BANDIT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| PYTHON_BANDIT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".py"]` | -| PYTHON_BANDIT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| PYTHON_BANDIT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| PYTHON_BANDIT_POST_COMMANDS | List of bash commands to run after the linter | None | -| PYTHON_BANDIT_CONFIG_FILE | bandit configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.bandit.yml` | -| PYTHON_BANDIT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| PYTHON_BANDIT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| PYTHON_BANDIT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PYTHON_BANDIT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| PYTHON_BANDIT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| PYTHON_BANDIT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| PYTHON_BANDIT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| PYTHON_BANDIT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".py"]` | +| PYTHON_BANDIT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| PYTHON_BANDIT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| PYTHON_BANDIT_POST_COMMANDS | List of bash commands to run after the linter| None | +| PYTHON_BANDIT_CONFIG_FILE | bandit configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.bandit.yml` | +| PYTHON_BANDIT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| PYTHON_BANDIT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| PYTHON_BANDIT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use bandit in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [bandit-lint](https://atom.io/packages/bandit-lint) | [Visit Web Site](https://atom.io/packages/bandit-lint){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-bandit](https://github.com/SublimeLinter/SublimeLinter-bandit) | [Visit Web Site](https://github.com/SublimeLinter/SublimeLinter-bandit){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [Native Support](https://code.visualstudio.com/docs/python/linting#_bandit) | [Visit Web Site](https://code.visualstudio.com/docs/python/linting#_bandit){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [bandit-lint](https://atom.io/packages/bandit-lint) | [Visit Web Site](https://atom.io/packages/bandit-lint){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-bandit](https://github.com/SublimeLinter/SublimeLinter-bandit) | [Visit Web Site](https://github.com/SublimeLinter/SublimeLinter-bandit){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [Native Support](https://code.visualstudio.com/docs/python/linting#_bandit) | [Visit Web Site](https://code.visualstudio.com/docs/python/linting#_bandit){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------|:------------------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | ## Behind the scenes diff --git a/docs/descriptors/python_black.md b/docs/descriptors/python_black.md index c6e99310664..6a1b2fe34c0 100644 --- a/docs/descriptors/python_black.md +++ b/docs/descriptors/python_black.md @@ -25,43 +25,43 @@ - Enable **auto-fixes** by adding `PYTHON_BLACK` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| PYTHON_BLACK_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| PYTHON_BLACK_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| PYTHON_BLACK_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| PYTHON_BLACK_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| PYTHON_BLACK_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".py"]` | -| PYTHON_BLACK_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| PYTHON_BLACK_PRE_COMMANDS | List of bash commands to run before the linter | None | -| PYTHON_BLACK_POST_COMMANDS | List of bash commands to run after the linter | None | -| PYTHON_BLACK_CONFIG_FILE | black configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `pyproject.toml` | -| PYTHON_BLACK_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| PYTHON_BLACK_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | -| PYTHON_BLACK_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PYTHON_BLACK_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| PYTHON_BLACK_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| PYTHON_BLACK_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| PYTHON_BLACK_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| PYTHON_BLACK_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".py"]` | +| PYTHON_BLACK_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| PYTHON_BLACK_PRE_COMMANDS | List of bash commands to run before the linter| None | +| PYTHON_BLACK_POST_COMMANDS | List of bash commands to run after the linter| None | +| PYTHON_BLACK_CONFIG_FILE | black configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `pyproject.toml` | +| PYTHON_BLACK_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| PYTHON_BLACK_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| PYTHON_BLACK_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use black in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|-------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [python-black](https://atom.io/packages/python-black) | [Visit Web Site](https://atom.io/packages/python-black){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [blacken](https://github.com/pythonic-emacs/blacken) | [Visit Web Site](https://github.com/pythonic-emacs/blacken){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [reformatter.el](https://github.com/purcell/reformatter.el) | [Visit Web Site](https://github.com/purcell/reformatter.el){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [elpy](https://github.com/jorgenschaefer/elpy) | [Visit Web Site](https://github.com/jorgenschaefer/elpy){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [black](https://black.readthedocs.io/en/stable/editor_integration.html#pycharm-intellij-idea) | [Visit Web Site](https://black.readthedocs.io/en/stable/editor_integration.html#pycharm-intellij-idea){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [sublack](https://github.com/jgirardet/sublack) | [Visit Web Site](https://github.com/jgirardet/sublack){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [VsCode Python Extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/ms-python.python){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [python-black](https://atom.io/packages/python-black) | [Visit Web Site](https://atom.io/packages/python-black){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [blacken](https://github.com/pythonic-emacs/blacken) | [Visit Web Site](https://github.com/pythonic-emacs/blacken){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [reformatter.el](https://github.com/purcell/reformatter.el) | [Visit Web Site](https://github.com/purcell/reformatter.el){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [elpy](https://github.com/jorgenschaefer/elpy) | [Visit Web Site](https://github.com/jorgenschaefer/elpy){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [black](https://black.readthedocs.io/en/stable/editor_integration.html#pycharm-intellij-idea) | [Visit Web Site](https://black.readthedocs.io/en/stable/editor_integration.html#pycharm-intellij-idea){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [sublack](https://github.com/jgirardet/sublack) | [Visit Web Site](https://github.com/jgirardet/sublack){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [VsCode Python Extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/ms-python.python){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | ## Behind the scenes @@ -114,8 +114,8 @@ Options: input). --python-cell-magics TEXT When processing Jupyter Notebooks, add the given magic to the list of known python- - magics (pypy, python3, capture, prun, - timeit, python, time). Useful for formatting + magics (python, prun, pypy, time, python3, + capture, timeit). Useful for formatting cells with custom python magics. -S, --skip-string-normalization Don't normalize string quotes or prefixes. diff --git a/docs/descriptors/python_flake8.md b/docs/descriptors/python_flake8.md index 3a024c6ee3a..20f8a2ef4cb 100644 --- a/docs/descriptors/python_flake8.md +++ b/docs/descriptors/python_flake8.md @@ -18,39 +18,39 @@ - Enable flake8 by adding `PYTHON_FLAKE8` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable flake8 by adding `PYTHON_FLAKE8` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| PYTHON_FLAKE8_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| PYTHON_FLAKE8_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| PYTHON_FLAKE8_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| PYTHON_FLAKE8_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| PYTHON_FLAKE8_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".py"]` | -| PYTHON_FLAKE8_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| PYTHON_FLAKE8_PRE_COMMANDS | List of bash commands to run before the linter | None | -| PYTHON_FLAKE8_POST_COMMANDS | List of bash commands to run after the linter | None | -| PYTHON_FLAKE8_CONFIG_FILE | flake8 configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.flake8` | -| PYTHON_FLAKE8_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| PYTHON_FLAKE8_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| PYTHON_FLAKE8_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PYTHON_FLAKE8_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| PYTHON_FLAKE8_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| PYTHON_FLAKE8_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| PYTHON_FLAKE8_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| PYTHON_FLAKE8_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".py"]` | +| PYTHON_FLAKE8_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| PYTHON_FLAKE8_PRE_COMMANDS | List of bash commands to run before the linter| None | +| PYTHON_FLAKE8_POST_COMMANDS | List of bash commands to run after the linter| None | +| PYTHON_FLAKE8_CONFIG_FILE | flake8 configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.flake8` | +| PYTHON_FLAKE8_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| PYTHON_FLAKE8_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| PYTHON_FLAKE8_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use flake8 in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|-----------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-flake8](https://atom.io/packages/linter-flake8) | [Visit Web Site](https://atom.io/packages/linter-flake8){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [flake8-support](https://plugins.jetbrains.com/plugin/11563-flake8-support) | | -| | [Visual Studio Code](https://code.visualstudio.com/) | [Native Support](https://code.visualstudio.com/docs/python/linting#_flake8) | [Visit Web Site](https://code.visualstudio.com/docs/python/linting#_flake8){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-flake8](https://atom.io/packages/linter-flake8) | [Visit Web Site](https://atom.io/packages/linter-flake8){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [flake8-support](https://plugins.jetbrains.com/plugin/11563-flake8-support) | | +| | [Visual Studio Code](https://code.visualstudio.com/) | [Native Support](https://code.visualstudio.com/docs/python/linting#_flake8) | [Visit Web Site](https://code.visualstudio.com/docs/python/linting#_flake8){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | ## Behind the scenes @@ -124,8 +124,8 @@ options: of opening bracket's line. --ignore errors Comma-separated list of errors and warnings to ignore (or skip). For example, ``--ignore=E4,E51,W234``. - (Default: ['E704', 'W504', 'E123', 'E121', 'W503', - 'E226', 'E126', 'E24']) + (Default: ['E126', 'W503', 'E121', 'E123', 'E704', + 'W504', 'E24', 'E226']) --extend-ignore errors Comma-separated list of errors and warnings to add to the list of ignored ones. For example, ``--extend- diff --git a/docs/descriptors/python_isort.md b/docs/descriptors/python_isort.md index 9df4aad77b5..eae247673fb 100644 --- a/docs/descriptors/python_isort.md +++ b/docs/descriptors/python_isort.md @@ -26,43 +26,43 @@ - Enable **auto-fixes** by adding `PYTHON_ISORT` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| PYTHON_ISORT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| PYTHON_ISORT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| PYTHON_ISORT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| PYTHON_ISORT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| PYTHON_ISORT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".py"]` | -| PYTHON_ISORT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| PYTHON_ISORT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| PYTHON_ISORT_POST_COMMANDS | List of bash commands to run after the linter | None | -| PYTHON_ISORT_CONFIG_FILE | isort configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.isort.cfg` | -| PYTHON_ISORT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| PYTHON_ISORT_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | -| PYTHON_ISORT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PYTHON_ISORT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| PYTHON_ISORT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| PYTHON_ISORT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| PYTHON_ISORT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| PYTHON_ISORT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".py"]` | +| PYTHON_ISORT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| PYTHON_ISORT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| PYTHON_ISORT_POST_COMMANDS | List of bash commands to run after the linter| None | +| PYTHON_ISORT_CONFIG_FILE | isort configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.isort.cfg` | +| PYTHON_ISORT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| PYTHON_ISORT_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| PYTHON_ISORT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use isort in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-----------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [atom-python-isort](https://github.com/bh/atom-python-isort) | [Visit Web Site](https://github.com/bh/atom-python-isort){target=_blank} | -| | [Atom](https://atom.io/) | [atom-isort](https://atom.io/packages/atom-isort) | [Visit Web Site](https://atom.io/packages/atom-isort){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [py-isort.el](https://github.com/paetzke/py-isort.el) | [Visit Web Site](https://github.com/paetzke/py-isort.el){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [isort plugin](https://github.com/jcugat/sublime-text-isort-plugin#install) | [Visit Web Site](https://github.com/jcugat/sublime-text-isort-plugin#install){target=_blank} | -| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | -| | [vim](https://www.vim.org/) | [vim-isort](https://github.com/fisadev/vim-isort#installation) | [Visit Web Site](https://github.com/fisadev/vim-isort#installation){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [VsCode Python Extension](https://github.com/Microsoft/vscode-python) | [Visit Web Site](https://github.com/Microsoft/vscode-python){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [atom-python-isort](https://github.com/bh/atom-python-isort) | [Visit Web Site](https://github.com/bh/atom-python-isort){target=_blank} | +| | [Atom](https://atom.io/) | [atom-isort](https://atom.io/packages/atom-isort) | [Visit Web Site](https://atom.io/packages/atom-isort){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [py-isort.el](https://github.com/paetzke/py-isort.el) | [Visit Web Site](https://github.com/paetzke/py-isort.el){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [isort plugin](https://github.com/jcugat/sublime-text-isort-plugin#install) | [Visit Web Site](https://github.com/jcugat/sublime-text-isort-plugin#install){target=_blank} | +| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | +| | [vim](https://www.vim.org/) | [vim-isort](https://github.com/fisadev/vim-isort#installation) | [Visit Web Site](https://github.com/fisadev/vim-isort#installation){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [VsCode Python Extension](https://github.com/Microsoft/vscode-python) | [Visit Web Site](https://github.com/Microsoft/vscode-python){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | ## Behind the scenes diff --git a/docs/descriptors/python_mypy.md b/docs/descriptors/python_mypy.md index 66693637bf9..941ae587159 100644 --- a/docs/descriptors/python_mypy.md +++ b/docs/descriptors/python_mypy.md @@ -28,43 +28,43 @@ If you don't use python static typing, you should disable this linter by adding - Enable mypy by adding `PYTHON_MYPY` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable mypy by adding `PYTHON_MYPY` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| PYTHON_MYPY_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| PYTHON_MYPY_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| PYTHON_MYPY_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| PYTHON_MYPY_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| PYTHON_MYPY_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".py"]` | -| PYTHON_MYPY_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| PYTHON_MYPY_PRE_COMMANDS | List of bash commands to run before the linter | None | -| PYTHON_MYPY_POST_COMMANDS | List of bash commands to run after the linter | None | -| PYTHON_MYPY_CONFIG_FILE | mypy configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.mypy.ini` | -| PYTHON_MYPY_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| PYTHON_MYPY_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| PYTHON_MYPY_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PYTHON_MYPY_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| PYTHON_MYPY_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| PYTHON_MYPY_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| PYTHON_MYPY_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| PYTHON_MYPY_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".py"]` | +| PYTHON_MYPY_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| PYTHON_MYPY_PRE_COMMANDS | List of bash commands to run before the linter| None | +| PYTHON_MYPY_POST_COMMANDS | List of bash commands to run after the linter| None | +| PYTHON_MYPY_CONFIG_FILE | mypy configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.mypy.ini` | +| PYTHON_MYPY_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| PYTHON_MYPY_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| PYTHON_MYPY_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use mypy in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-mypy](https://atom.io/packages/linter-mypy) | [Visit Web Site](https://atom.io/packages/linter-mypy){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [Flycheck mypy](https://github.com/lbolla/emacs-flycheck-mypy) | [Visit Web Site](https://github.com/lbolla/emacs-flycheck-mypy){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [mypy-official](https://plugins.jetbrains.com/plugin/13348-mypy-official-/) | [Visit Web Site](https://plugins.jetbrains.com/plugin/13348-mypy-official-/){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-mypy](https://github.com/fredcallaway/SublimeLinter-contrib-mypy) | [Visit Web Site](https://github.com/fredcallaway/SublimeLinter-contrib-mypy){target=_blank} | -| | [vim](https://www.vim.org/) | [Ale](https://github.com/dense-analysis/ale) | [Visit Web Site](https://github.com/dense-analysis/ale){target=_blank} | -| | [vim](https://www.vim.org/) | [Syntastic](https://github.com/vim-syntastic/syntastic) | [Visit Web Site](https://github.com/vim-syntastic/syntastic){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [Mypy](https://marketplace.visualstudio.com/items?itemName=matangover.mypy) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/matangover.mypy){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-mypy](https://atom.io/packages/linter-mypy) | [Visit Web Site](https://atom.io/packages/linter-mypy){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [Flycheck mypy](https://github.com/lbolla/emacs-flycheck-mypy) | [Visit Web Site](https://github.com/lbolla/emacs-flycheck-mypy){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [mypy-official](https://plugins.jetbrains.com/plugin/13348-mypy-official-/) | [Visit Web Site](https://plugins.jetbrains.com/plugin/13348-mypy-official-/){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-mypy](https://github.com/fredcallaway/SublimeLinter-contrib-mypy) | [Visit Web Site](https://github.com/fredcallaway/SublimeLinter-contrib-mypy){target=_blank} | +| | [vim](https://www.vim.org/) | [Ale](https://github.com/dense-analysis/ale) | [Visit Web Site](https://github.com/dense-analysis/ale){target=_blank} | +| | [vim](https://www.vim.org/) | [Syntastic](https://github.com/vim-syntastic/syntastic) | [Visit Web Site](https://github.com/vim-syntastic/syntastic){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [Mypy](https://marketplace.visualstudio.com/items?itemName=matangover.mypy) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/matangover.mypy){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | ## Behind the scenes diff --git a/docs/descriptors/python_pylint.md b/docs/descriptors/python_pylint.md index cc19716cbfe..243dd9adab7 100644 --- a/docs/descriptors/python_pylint.md +++ b/docs/descriptors/python_pylint.md @@ -25,41 +25,41 @@ - Enable pylint by adding `PYTHON_PYLINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable pylint by adding `PYTHON_PYLINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| PYTHON_PYLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| PYTHON_PYLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| PYTHON_PYLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| PYTHON_PYLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| PYTHON_PYLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".py"]` | -| PYTHON_PYLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| PYTHON_PYLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| PYTHON_PYLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| PYTHON_PYLINT_CONFIG_FILE | pylint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.pylintrc` | -| PYTHON_PYLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| PYTHON_PYLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| PYTHON_PYLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| PYTHON_PYLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| PYTHON_PYLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| PYTHON_PYLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| PYTHON_PYLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| PYTHON_PYLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".py"]` | +| PYTHON_PYLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| PYTHON_PYLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| PYTHON_PYLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| PYTHON_PYLINT_CONFIG_FILE | pylint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.pylintrc` | +| PYTHON_PYLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| PYTHON_PYLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| PYTHON_PYLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use pylint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|---------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------:| -| | [Eclipse](https://www.eclipse.org/) | [PyLint](https://pydev.org/manual_adv_pylint.html) | [Visit Web Site](https://pydev.org/manual_adv_pylint.html){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [PyCharm (Native Support)](https://www.jetbrains.com/pycharm/) | [Visit Web Site](https://www.jetbrains.com/pycharm/){target=_blank} | -| | [vim](https://www.vim.org/) | [pylint.vim](https://www.vim.org/scripts/script.php?script_id=891) | [Visit Web Site](https://www.vim.org/scripts/script.php?script_id=891){target=_blank} | -| | visual_studio | [Native Support](https://docs.microsoft.com/fr-fr/visualstudio/python/linting-python-code?view=vs-2019) | [Visit Web Site](https://docs.microsoft.com/fr-fr/visualstudio/python/linting-python-code?view=vs-2019){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [Native Support](https://code.visualstudio.com/docs/python/linting#_pylint) | [Visit Web Site](https://code.visualstudio.com/docs/python/linting#_pylint){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Eclipse](https://www.eclipse.org/) | [PyLint](https://pydev.org/manual_adv_pylint.html) | [Visit Web Site](https://pydev.org/manual_adv_pylint.html){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [PyCharm (Native Support)](https://www.jetbrains.com/pycharm/) | [Visit Web Site](https://www.jetbrains.com/pycharm/){target=_blank} | +| | [vim](https://www.vim.org/) | [pylint.vim](https://www.vim.org/scripts/script.php?script_id=891) | [Visit Web Site](https://www.vim.org/scripts/script.php?script_id=891){target=_blank} | +| | visual_studio | [Native Support](https://docs.microsoft.com/fr-fr/visualstudio/python/linting-python-code?view=vs-2019) | [Visit Web Site](https://docs.microsoft.com/fr-fr/visualstudio/python/linting-python-code?view=vs-2019){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [Native Support](https://code.visualstudio.com/docs/python/linting#_pylint) | [Visit Web Site](https://code.visualstudio.com/docs/python/linting#_pylint){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | ## Behind the scenes @@ -270,41 +270,6 @@ Messages control: Warning level messages displayed, use "--disable=all --enable=classes --disable=W". -String: - Check string literals. - - --check-str-concat-over-line-jumps - This flag controls whether the implicit-str-concat - should generate a warning on implicit string - concatenation in sequences defined over several lines. - (default: False) - --check-quote-consistency - This flag controls whether inconsistent-quotes - generates a warning when the character used as a quote - delimiter is used inconsistently within a module. - (default: False) - -Exceptions: - Exception related checks. - - --overgeneral-exceptions - Exceptions that will emit a warning when caught. - (default: ('BaseException', 'Exception')) - -Refactoring: - Looks for code which can be refactored. - - --max-nested-blocks - Maximum number of nested blocks for function / method - body (default: 5) - --never-returning-functions - Complete name of functions that never returns. When - checking for inconsistent-return-statements if a never - returning function is called then it will be - considered as an explicit return statement and no - message will be printed. (default: ('sys.exit', - 'argparse.parse_error')) - Format: Formatting checker. @@ -333,183 +298,12 @@ Format: Expected format of line ending, e.g. empty (any line ending), LF or CRLF. (default: ) -Typecheck: - Try to find bugs in the code using type inference. - - --ignore-on-opaque-inference - This flag controls whether pylint should warn about - no-member and similar checks whenever an opaque object - is returned when inferring. The inference can return - multiple potential results while evaluating a Python - object, but some branches might not be evaluated, - which results in partial inference. In that case, it - might be useful to still emit no-member and other - checks for the rest of the inferred objects. (default: - True) - --mixin-class-rgx - Regex pattern to define which classes are considered - mixins. (default: .*[Mm]ixin) - --ignore-mixin-members - Tells whether missing members accessed in mixin class - should be ignored. A class is considered mixin if its - name matches the mixin-class-rgx option. (default: - True) - --ignored-checks-for-mixins - List of symbolic message names to ignore for Mixin - members. (default: ['no-member', 'not-async-context- - manager', 'not-context-manager', 'attribute-defined- - outside-init']) - --ignore-none - Tells whether to warn about missing members when the - owner of the attribute is inferred to be None. - (default: True) - --ignored-classes - List of class names for which member attributes should - not be checked (useful for classes with dynamically - set attributes). This supports the use of qualified - names. (default: ('optparse.Values', 'thread._local', - '_thread._local', 'argparse.Namespace')) - --generated-members - List of members which are set dynamically and missed - by pylint inference system, and so shouldn't trigger - E1101 when accessed. Python regular expressions are - accepted. (default: ()) - --contextmanager-decorators - List of decorators that produce context managers, such - as contextlib.contextmanager. Add to this list to - register other decorators that produce valid context - managers. (default: ['contextlib.contextmanager']) - --missing-member-hint-distance - The minimum edit distance a name should have in order - to be considered a similar match for a missing member - name. (default: 1) - --missing-member-max-choices - The total number of similar names that should be taken - in consideration when showing a hint for a missing - member. (default: 1) - --missing-member-hint - Show a hint with possible names when a member name was - not found. The aspect of finding the hint is based on - edit distance. (default: True) - --signature-mutators - List of decorators that change the signature of a - decorated function. (default: []) - -Variables: - BaseChecker for variables. - - --init-import - Tells whether we should check for unused import in - __init__ files. (default: False) - --dummy-variables-rgx - A regular expression matching the name of dummy - variables (i.e. expected to not be used). (default: _+ - $|(_[a-zA-Z0-9_]*[a-zA-Z0- - 9]+?$)|dummy|^ignored_|^unused_) - --additional-builtins - List of additional names supposed to be defined in - builtins. Remember that you should avoid defining new - builtins when possible. (default: ()) - --callbacks - List of strings which can identify a callback function - by name. A callback name must start or end with one of - those strings. (default: ('cb_', '_cb')) - --redefining-builtins-modules - List of qualified module names which can have objects - that can redefine builtins. (default: ('six.moves', - 'past.builtins', 'future.builtins', 'builtins', 'io')) - --ignored-argument-names - Argument names that match this expression will be - ignored. Default to name with leading underscore. - (default: re.compile('_.*|^ignored_|^unused_')) - --allow-global-unused-variables - Tells whether unused global variables should be - treated as a violation. (default: True) - --allowed-redefined-builtins - List of names allowed to shadow builtins (default: ()) - -Spelling: - Check spelling in comments and docstrings. - - --spelling-dict - Spelling dictionary name. Available dictionaries: - none. To make it work, install the 'python-enchant' - package. (default: ) - --spelling-ignore-words - List of comma separated words that should not be - checked. (default: ) - --spelling-private-dict-file - A path to a file that contains the private dictionary; - one word per line. (default: ) - --spelling-store-unknown-words - Tells whether to store unknown words to the private - dictionary (see the --spelling-private-dict-file - option) instead of raising a message. (default: n) - --max-spelling-suggestions N - Limits count of emitted suggestions for spelling - mistakes. (default: 4) - --spelling-ignore-comment-directives - List of comma separated words that should be - considered directives if they appear at the beginning - of a comment and should not be checked. (default: fmt: - on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:) - -Classes: - Checker for class nodes. - - --defining-attr-methods - List of method names used to declare (i.e. assign) - instance attributes. (default: ('__init__', '__new__', - 'setUp', '__post_init__')) - --valid-classmethod-first-arg - List of valid names for the first argument in a class - method. (default: ('cls',)) - --valid-metaclass-classmethod-first-arg - List of valid names for the first argument in a - metaclass class method. (default: ('cls',)) - --exclude-protected - List of member names, which should be excluded from - the protected access warning. (default: ('_asdict', - '_fields', '_replace', '_source', '_make')) - --check-protected-access-in-special-methods - Warn about protected attribute access inside special - methods (default: False) - -Design: - Checker of potential misdesigns. +Exceptions: + Exception related checks. - --max-args Maximum number of arguments for function / method. - (default: 5) - --max-locals Maximum number of locals for function / method body. - (default: 15) - --max-returns Maximum number of return / yield for function / method - body. (default: 6) - --max-branches Maximum number of branch for function / method body. - (default: 12) - --max-statements - Maximum number of statements in function / method - body. (default: 50) - --max-parents Maximum number of parents for a class (see R0901). - (default: 7) - --ignored-parents - List of qualified class names to ignore when counting - class parents (see R0901) (default: ()) - --max-attributes - Maximum number of attributes for a class (see R0902). - (default: 7) - --min-public-methods - Minimum number of public methods for a class (see - R0903). (default: 2) - --max-public-methods - Maximum number of public methods for a class (see - R0904). (default: 20) - --max-bool-expr - Maximum number of boolean expressions in an if - statement (see R0916). (default: 5) - --exclude-too-few-public-methods [,...] - List of regular expressions of class ancestor names to - ignore when counting public methods (see R0903) - (default: []) + --overgeneral-exceptions + Exceptions that will emit a warning when caught. + (default: ('BaseException', 'Exception')) Basic: --good-names Good variable names which should always be accepted, @@ -636,14 +430,67 @@ Basic: Minimum line length for functions/classes that require docstrings, shorter ones are exempt. (default: -1) -Miscellaneous: - BaseChecker for encoding issues. +Typecheck: + Try to find bugs in the code using type inference. - --notes - List of note tags to take in consideration, separated - by a comma. (default: ('FIXME', 'XXX', 'TODO')) - --notes-rgx Regular expression of note tags to take in - consideration. (default: ) + --ignore-on-opaque-inference + This flag controls whether pylint should warn about + no-member and similar checks whenever an opaque object + is returned when inferring. The inference can return + multiple potential results while evaluating a Python + object, but some branches might not be evaluated, + which results in partial inference. In that case, it + might be useful to still emit no-member and other + checks for the rest of the inferred objects. (default: + True) + --mixin-class-rgx + Regex pattern to define which classes are considered + mixins. (default: .*[Mm]ixin) + --ignore-mixin-members + Tells whether missing members accessed in mixin class + should be ignored. A class is considered mixin if its + name matches the mixin-class-rgx option. (default: + True) + --ignored-checks-for-mixins + List of symbolic message names to ignore for Mixin + members. (default: ['no-member', 'not-async-context- + manager', 'not-context-manager', 'attribute-defined- + outside-init']) + --ignore-none + Tells whether to warn about missing members when the + owner of the attribute is inferred to be None. + (default: True) + --ignored-classes + List of class names for which member attributes should + not be checked (useful for classes with dynamically + set attributes). This supports the use of qualified + names. (default: ('optparse.Values', 'thread._local', + '_thread._local', 'argparse.Namespace')) + --generated-members + List of members which are set dynamically and missed + by pylint inference system, and so shouldn't trigger + E1101 when accessed. Python regular expressions are + accepted. (default: ()) + --contextmanager-decorators + List of decorators that produce context managers, such + as contextlib.contextmanager. Add to this list to + register other decorators that produce valid context + managers. (default: ['contextlib.contextmanager']) + --missing-member-hint-distance + The minimum edit distance a name should have in order + to be considered a similar match for a missing member + name. (default: 1) + --missing-member-max-choices + The total number of similar names that should be taken + in consideration when showing a hint for a missing + member. (default: 1) + --missing-member-hint + Show a hint with possible names when a member name was + not found. The aspect of finding the hint is based on + edit distance. (default: True) + --signature-mutators + List of decorators that change the signature of a + decorated function. (default: []) Similarities: Checks for similarities and duplicated code. @@ -663,18 +510,6 @@ Similarities: Signatures are removed from the similarity computation (default: True) -Logging: - Checks use of the logging module. - - --logging-modules - Logging modules to check that the string format - arguments are in logging function parameter format. - (default: ('logging',)) - --logging-format-style - The type of string formatting that logging methods do. - `old` means using % formatting, `new` is for `{}` - formatting. (default: old) - Imports: BaseChecker for import statements. @@ -709,6 +544,171 @@ Imports: --allow-wildcard-with-all Allow wildcard imports from modules that define __all__. (default: False) + +Refactoring: + Looks for code which can be refactored. + + --max-nested-blocks + Maximum number of nested blocks for function / method + body (default: 5) + --never-returning-functions + Complete name of functions that never returns. When + checking for inconsistent-return-statements if a never + returning function is called then it will be + considered as an explicit return statement and no + message will be printed. (default: ('sys.exit', + 'argparse.parse_error')) + +Variables: + BaseChecker for variables. + + --init-import + Tells whether we should check for unused import in + __init__ files. (default: False) + --dummy-variables-rgx + A regular expression matching the name of dummy + variables (i.e. expected to not be used). (default: _+ + $|(_[a-zA-Z0-9_]*[a-zA-Z0- + 9]+?$)|dummy|^ignored_|^unused_) + --additional-builtins + List of additional names supposed to be defined in + builtins. Remember that you should avoid defining new + builtins when possible. (default: ()) + --callbacks + List of strings which can identify a callback function + by name. A callback name must start or end with one of + those strings. (default: ('cb_', '_cb')) + --redefining-builtins-modules + List of qualified module names which can have objects + that can redefine builtins. (default: ('six.moves', + 'past.builtins', 'future.builtins', 'builtins', 'io')) + --ignored-argument-names + Argument names that match this expression will be + ignored. Default to name with leading underscore. + (default: re.compile('_.*|^ignored_|^unused_')) + --allow-global-unused-variables + Tells whether unused global variables should be + treated as a violation. (default: True) + --allowed-redefined-builtins + List of names allowed to shadow builtins (default: ()) + +Miscellaneous: + BaseChecker for encoding issues. + + --notes + List of note tags to take in consideration, separated + by a comma. (default: ('FIXME', 'XXX', 'TODO')) + --notes-rgx Regular expression of note tags to take in + consideration. (default: ) + +Logging: + Checks use of the logging module. + + --logging-modules + Logging modules to check that the string format + arguments are in logging function parameter format. + (default: ('logging',)) + --logging-format-style + The type of string formatting that logging methods do. + `old` means using % formatting, `new` is for `{}` + formatting. (default: old) + +Spelling: + Check spelling in comments and docstrings. + + --spelling-dict + Spelling dictionary name. Available dictionaries: + none. To make it work, install the 'python-enchant' + package. (default: ) + --spelling-ignore-words + List of comma separated words that should not be + checked. (default: ) + --spelling-private-dict-file + A path to a file that contains the private dictionary; + one word per line. (default: ) + --spelling-store-unknown-words + Tells whether to store unknown words to the private + dictionary (see the --spelling-private-dict-file + option) instead of raising a message. (default: n) + --max-spelling-suggestions N + Limits count of emitted suggestions for spelling + mistakes. (default: 4) + --spelling-ignore-comment-directives + List of comma separated words that should be + considered directives if they appear at the beginning + of a comment and should not be checked. (default: fmt: + on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:) + +Design: + Checker of potential misdesigns. + + --max-args Maximum number of arguments for function / method. + (default: 5) + --max-locals Maximum number of locals for function / method body. + (default: 15) + --max-returns Maximum number of return / yield for function / method + body. (default: 6) + --max-branches Maximum number of branch for function / method body. + (default: 12) + --max-statements + Maximum number of statements in function / method + body. (default: 50) + --max-parents Maximum number of parents for a class (see R0901). + (default: 7) + --ignored-parents + List of qualified class names to ignore when counting + class parents (see R0901) (default: ()) + --max-attributes + Maximum number of attributes for a class (see R0902). + (default: 7) + --min-public-methods + Minimum number of public methods for a class (see + R0903). (default: 2) + --max-public-methods + Maximum number of public methods for a class (see + R0904). (default: 20) + --max-bool-expr + Maximum number of boolean expressions in an if + statement (see R0916). (default: 5) + --exclude-too-few-public-methods [,...] + List of regular expressions of class ancestor names to + ignore when counting public methods (see R0903) + (default: []) + +String: + Check string literals. + + --check-str-concat-over-line-jumps + This flag controls whether the implicit-str-concat + should generate a warning on implicit string + concatenation in sequences defined over several lines. + (default: False) + --check-quote-consistency + This flag controls whether inconsistent-quotes + generates a warning when the character used as a quote + delimiter is used inconsistently within a module. + (default: False) + +Classes: + Checker for class nodes. + + --defining-attr-methods + List of method names used to declare (i.e. assign) + instance attributes. (default: ('__init__', '__new__', + 'setUp', '__post_init__')) + --valid-classmethod-first-arg + List of valid names for the first argument in a class + method. (default: ('cls',)) + --valid-metaclass-classmethod-first-arg + List of valid names for the first argument in a + metaclass class method. (default: ('cls',)) + --exclude-protected + List of member names, which should be excluded from + the protected access warning. (default: ('_asdict', + '_fields', '_replace', '_source', '_make')) + --check-protected-access-in-special-methods + Warn about protected attribute access inside special + methods (default: False) ``` ### Installation on mega-linter Docker image diff --git a/docs/descriptors/r.md b/docs/descriptors/r.md index 069a21c0617..d857b5b8582 100644 --- a/docs/descriptors/r.md +++ b/docs/descriptors/r.md @@ -5,9 +5,9 @@ ## Linters -| Linter | Configuration key | Status | -|---------------------|-------------------|--------| -| [lintr](r_lintr.md) | [R](r_lintr.md) | | +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | +| [lintr](r_lintr.md) | [R](r_lintr.md) | | ## Linted files @@ -19,8 +19,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|------------------------|-------------------------------|---------------| -| R_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| R_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| R_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| R_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/r_lintr.md b/docs/descriptors/r_lintr.md index 8809f491f2c..bdfd2d182a8 100644 --- a/docs/descriptors/r_lintr.md +++ b/docs/descriptors/r_lintr.md @@ -14,41 +14,41 @@ - Enable lintr by adding `R_LINTR` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable lintr by adding `R_LINTR` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| R_LINTR_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| R_LINTR_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| R_LINTR_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| R_LINTR_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| R_LINTR_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".r", ".R", ".Rmd", ".RMD"]` | -| R_LINTR_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| R_LINTR_PRE_COMMANDS | List of bash commands to run before the linter | None | -| R_LINTR_POST_COMMANDS | List of bash commands to run after the linter | None | -| R_LINTR_CONFIG_FILE | lintr configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.lintr` | -| R_LINTR_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| R_LINTR_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| R_LINTR_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| R_LINTR_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| R_LINTR_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| R_LINTR_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| R_LINTR_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| R_LINTR_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".r", ".R", ".Rmd", ".RMD"]` | +| R_LINTR_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| R_LINTR_PRE_COMMANDS | List of bash commands to run before the linter| None | +| R_LINTR_POST_COMMANDS | List of bash commands to run after the linter| None | +| R_LINTR_CONFIG_FILE | lintr configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.lintr` | +| R_LINTR_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| R_LINTR_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| R_LINTR_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use lintr in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-----------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [Atom lintr](https://github.com/AtomLinter/linter-lintr) | [Visit Web Site](https://github.com/AtomLinter/linter-lintr){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](http://www.flycheck.org/en/latest/languages.html#r) | [Visit Web Site](http://www.flycheck.org/en/latest/languages.html#r){target=_blank} | -| | rstudio | [Native Support](https://rstudio.com/) | [Visit Web Site](https://rstudio.com/){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-lintr](https://github.com/jimhester/SublimeLinter-contrib-lintr) | [Visit Web Site](https://github.com/jimhester/SublimeLinter-contrib-lintr){target=_blank} | -| | [vim](https://www.vim.org/) | [ale](https://github.com/dense-analysis/ale) | [Visit Web Site](https://github.com/dense-analysis/ale){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [VsCode R LSP](https://marketplace.visualstudio.com/items?itemName=REditorSupport.r) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/REditorSupport.r){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [Atom lintr](https://github.com/AtomLinter/linter-lintr) | [Visit Web Site](https://github.com/AtomLinter/linter-lintr){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](http://www.flycheck.org/en/latest/languages.html#r) | [Visit Web Site](http://www.flycheck.org/en/latest/languages.html#r){target=_blank} | +| | rstudio | [Native Support](https://rstudio.com/) | [Visit Web Site](https://rstudio.com/){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-lintr](https://github.com/jimhester/SublimeLinter-contrib-lintr) | [Visit Web Site](https://github.com/jimhester/SublimeLinter-contrib-lintr){target=_blank} | +| | [vim](https://www.vim.org/) | [ale](https://github.com/dense-analysis/ale) | [Visit Web Site](https://github.com/dense-analysis/ale){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [VsCode R LSP](https://marketplace.visualstudio.com/items?itemName=REditorSupport.r) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/REditorSupport.r){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:--------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | ## Behind the scenes diff --git a/docs/descriptors/raku.md b/docs/descriptors/raku.md index e6edf6e0d39..45b75d3ab7a 100644 --- a/docs/descriptors/raku.md +++ b/docs/descriptors/raku.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|----------------------|----------------------|----------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [raku](raku_raku.md) | [RAKU](raku_raku.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/rakudo/rakudo)](https://github.com/rakudo/rakudo/commits) | ## Linted files @@ -21,8 +21,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|---------------------------|-------------------------------|---------------| -| RAKU_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| RAKU_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| RAKU_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| RAKU_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/raku_raku.md b/docs/descriptors/raku_raku.md index c244183a4ad..968a24d905c 100644 --- a/docs/descriptors/raku_raku.md +++ b/docs/descriptors/raku_raku.md @@ -14,38 +14,38 @@ - Enable raku by adding `RAKU_RAKU` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable raku by adding `RAKU_RAKU` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------| -| RAKU_RAKU_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| RAKU_RAKU_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| RAKU_RAKU_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| RAKU_RAKU_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| RAKU_RAKU_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".raku", ".rakumod", ".rakutest", ".pm6", ".pl6", ".p6"]` | -| RAKU_RAKU_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| RAKU_RAKU_PRE_COMMANDS | List of bash commands to run before the linter | None | -| RAKU_RAKU_POST_COMMANDS | List of bash commands to run after the linter | None | -| RAKU_RAKU_CONFIG_FILE | raku configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `META6.json` | -| RAKU_RAKU_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| RAKU_RAKU_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| RAKU_RAKU_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| RAKU_RAKU_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| RAKU_RAKU_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| RAKU_RAKU_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| RAKU_RAKU_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| RAKU_RAKU_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".raku", ".rakumod", ".rakutest", ".pm6", ".pl6", ".p6"]` | +| RAKU_RAKU_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| RAKU_RAKU_PRE_COMMANDS | List of bash commands to run before the linter| None | +| RAKU_RAKU_POST_COMMANDS | List of bash commands to run after the linter| None | +| RAKU_RAKU_CONFIG_FILE | raku configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `META6.json` | +| RAKU_RAKU_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| RAKU_RAKU_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| RAKU_RAKU_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use raku in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|--------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [language-perl6](https://atom.io/packages/language-perl6) | [Visit Web Site](https://atom.io/packages/language-perl6){target=_blank} | -| | comma | [Native Support](https://commaide.com/) | [Visit Web Site](https://commaide.com/){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [Perl6 Language Support](https://marketplace.visualstudio.com/items?itemName=scriplit.perl6-lsp) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/scriplit.perl6-lsp){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [language-perl6](https://atom.io/packages/language-perl6) | [Visit Web Site](https://atom.io/packages/language-perl6){target=_blank} | +| | comma | [Native Support](https://commaide.com/) | [Visit Web Site](https://commaide.com/){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [Perl6 Language Support](https://marketplace.visualstudio.com/items?itemName=scriplit.perl6-lsp) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/scriplit.perl6-lsp){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:--------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | ## Behind the scenes diff --git a/docs/descriptors/repository.md b/docs/descriptors/repository.md index d53ed6bb8fa..a331ce3a0ac 100644 --- a/docs/descriptors/repository.md +++ b/docs/descriptors/repository.md @@ -5,24 +5,24 @@ ## Linters -| Linter | Configuration key | Status | -|----------------------------------------|----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| -| [devskim](repository_devskim.md) | [REPOSITORY](repository_devskim.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/microsoft/DevSkim)](https://github.com/microsoft/DevSkim/commits) | -| [dustilock](repository_dustilock.md) | [REPOSITORY](repository_dustilock.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/Checkmarx/dustilock)](https://github.com/Checkmarx/dustilock/commits) | -| [git_diff](repository_git_diff.md) | [REPOSITORY](repository_git_diff.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/git/git)](https://github.com/git/git/commits) | -| [gitleaks](repository_gitleaks.md) | [REPOSITORY](repository_gitleaks.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/zricethezav/gitleaks)](https://github.com/zricethezav/gitleaks/commits) | -| [goodcheck](repository_goodcheck.md) | [REPOSITORY](repository_goodcheck.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/sider/goodcheck)](https://github.com/sider/goodcheck/commits) | +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | +| [devskim](repository_devskim.md) | [REPOSITORY](repository_devskim.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/microsoft/DevSkim)](https://github.com/microsoft/DevSkim/commits) | +| [dustilock](repository_dustilock.md) | [REPOSITORY](repository_dustilock.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/Checkmarx/dustilock)](https://github.com/Checkmarx/dustilock/commits) | +| [git_diff](repository_git_diff.md) | [REPOSITORY](repository_git_diff.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/git/git)](https://github.com/git/git/commits) | +| [gitleaks](repository_gitleaks.md) | [REPOSITORY](repository_gitleaks.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/zricethezav/gitleaks)](https://github.com/zricethezav/gitleaks/commits) | +| [goodcheck](repository_goodcheck.md) | [REPOSITORY](repository_goodcheck.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/sider/goodcheck)](https://github.com/sider/goodcheck/commits) | | [secretlint](repository_secretlint.md) | [REPOSITORY](repository_secretlint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/secretlint/secretlint)](https://github.com/secretlint/secretlint/commits) | -| [semgrep](repository_semgrep.md) | [REPOSITORY](repository_semgrep.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/returntocorp/semgrep)](https://github.com/returntocorp/semgrep/commits) | -| [syft](repository_syft.md) | [REPOSITORY](repository_syft.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/anchore/syft)](https://github.com/anchore/syft/commits) | -| [trivy](repository_trivy.md) | [REPOSITORY](repository_trivy.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/aquasecurity/trivy)](https://github.com/aquasecurity/trivy/commits) | +| [semgrep](repository_semgrep.md) | [REPOSITORY](repository_semgrep.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/returntocorp/semgrep)](https://github.com/returntocorp/semgrep/commits) | +| [syft](repository_syft.md) | [REPOSITORY](repository_syft.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/anchore/syft)](https://github.com/anchore/syft/commits) | +| [trivy](repository_trivy.md) | [REPOSITORY](repository_trivy.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/aquasecurity/trivy)](https://github.com/aquasecurity/trivy/commits) | ## Linted files ## Configuration in MegaLinter -| Variable | Description | Default value | -|---------------------------------|-------------------------------|---------------| -| REPOSITORY_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| REPOSITORY_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| REPOSITORY_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| REPOSITORY_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/repository_devskim.md b/docs/descriptors/repository_devskim.md index 5c9c1b98cfe..15b2be88403 100644 --- a/docs/descriptors/repository_devskim.md +++ b/docs/descriptors/repository_devskim.md @@ -14,32 +14,32 @@ - Enable devskim by adding `REPOSITORY_DEVSKIM` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable devskim by adding `REPOSITORY_DEVSKIM` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| REPOSITORY_DEVSKIM_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| REPOSITORY_DEVSKIM_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | -| REPOSITORY_DEVSKIM_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| REPOSITORY_DEVSKIM_PRE_COMMANDS | List of bash commands to run before the linter | None | -| REPOSITORY_DEVSKIM_POST_COMMANDS | List of bash commands to run after the linter | None | -| REPOSITORY_DEVSKIM_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| REPOSITORY_DEVSKIM_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| REPOSITORY_DEVSKIM_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| REPOSITORY_DEVSKIM_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | +| REPOSITORY_DEVSKIM_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| REPOSITORY_DEVSKIM_PRE_COMMANDS | List of bash commands to run before the linter| None | +| REPOSITORY_DEVSKIM_POST_COMMANDS | List of bash commands to run after the linter| None | +| REPOSITORY_DEVSKIM_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| REPOSITORY_DEVSKIM_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use devskim in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-----------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Visual Studio Code](https://code.visualstudio.com/) | [VsCode DevSkim](https://marketplace.visualstudio.com/items?itemName=MS-CST-E.vscode-devskim) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/MS-CST-E.vscode-devskim){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------|:--------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | ## Behind the scenes diff --git a/docs/descriptors/repository_dustilock.md b/docs/descriptors/repository_dustilock.md index 10869aba384..fd49b7ce596 100644 --- a/docs/descriptors/repository_dustilock.md +++ b/docs/descriptors/repository_dustilock.md @@ -20,24 +20,24 @@ - Enable dustilock by adding `REPOSITORY_DUSTILOCK` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable dustilock by adding `REPOSITORY_DUSTILOCK` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| REPOSITORY_DUSTILOCK_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| REPOSITORY_DUSTILOCK_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | -| REPOSITORY_DUSTILOCK_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| REPOSITORY_DUSTILOCK_PRE_COMMANDS | List of bash commands to run before the linter | None | -| REPOSITORY_DUSTILOCK_POST_COMMANDS | List of bash commands to run after the linter | None | -| REPOSITORY_DUSTILOCK_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| REPOSITORY_DUSTILOCK_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| REPOSITORY_DUSTILOCK_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| REPOSITORY_DUSTILOCK_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | +| REPOSITORY_DUSTILOCK_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| REPOSITORY_DUSTILOCK_PRE_COMMANDS | List of bash commands to run before the linter| None | +| REPOSITORY_DUSTILOCK_POST_COMMANDS | List of bash commands to run after the linter| None | +| REPOSITORY_DUSTILOCK_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| REPOSITORY_DUSTILOCK_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------|:--------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | ## Behind the scenes diff --git a/docs/descriptors/repository_git_diff.md b/docs/descriptors/repository_git_diff.md index f93c4e6cb3b..850fc1e28b7 100644 --- a/docs/descriptors/repository_git_diff.md +++ b/docs/descriptors/repository_git_diff.md @@ -16,36 +16,36 @@ Git diff checks for git conflicts markers in files - Enable git_diff by adding `REPOSITORY_GIT_DIFF` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable git_diff by adding `REPOSITORY_GIT_DIFF` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| REPOSITORY_GIT_DIFF_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| REPOSITORY_GIT_DIFF_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | -| REPOSITORY_GIT_DIFF_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| REPOSITORY_GIT_DIFF_PRE_COMMANDS | List of bash commands to run before the linter | None | -| REPOSITORY_GIT_DIFF_POST_COMMANDS | List of bash commands to run after the linter | None | -| REPOSITORY_GIT_DIFF_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| REPOSITORY_GIT_DIFF_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| REPOSITORY_GIT_DIFF_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| REPOSITORY_GIT_DIFF_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | +| REPOSITORY_GIT_DIFF_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| REPOSITORY_GIT_DIFF_PRE_COMMANDS | List of bash commands to run before the linter| None | +| REPOSITORY_GIT_DIFF_POST_COMMANDS | List of bash commands to run after the linter| None | +| REPOSITORY_GIT_DIFF_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| REPOSITORY_GIT_DIFF_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/repository_gitleaks.md b/docs/descriptors/repository_gitleaks.md index a9f64609fbb..7f86803c796 100644 --- a/docs/descriptors/repository_gitleaks.md +++ b/docs/descriptors/repository_gitleaks.md @@ -15,39 +15,39 @@ - Enable gitleaks by adding `REPOSITORY_GITLEAKS` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable gitleaks by adding `REPOSITORY_GITLEAKS` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| REPOSITORY_GITLEAKS_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| REPOSITORY_GITLEAKS_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | -| REPOSITORY_GITLEAKS_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| REPOSITORY_GITLEAKS_PRE_COMMANDS | List of bash commands to run before the linter | None | -| REPOSITORY_GITLEAKS_POST_COMMANDS | List of bash commands to run after the linter | None | -| REPOSITORY_GITLEAKS_CONFIG_FILE | gitleaks configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.gitleaks.toml` | -| REPOSITORY_GITLEAKS_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| REPOSITORY_GITLEAKS_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| REPOSITORY_GITLEAKS_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| REPOSITORY_GITLEAKS_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| REPOSITORY_GITLEAKS_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | +| REPOSITORY_GITLEAKS_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| REPOSITORY_GITLEAKS_PRE_COMMANDS | List of bash commands to run before the linter| None | +| REPOSITORY_GITLEAKS_POST_COMMANDS | List of bash commands to run after the linter| None | +| REPOSITORY_GITLEAKS_CONFIG_FILE | gitleaks configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.gitleaks.toml` | +| REPOSITORY_GITLEAKS_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| REPOSITORY_GITLEAKS_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| REPOSITORY_GITLEAKS_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/repository_goodcheck.md b/docs/descriptors/repository_goodcheck.md index af8273ac746..1e70aaee658 100644 --- a/docs/descriptors/repository_goodcheck.md +++ b/docs/descriptors/repository_goodcheck.md @@ -17,38 +17,38 @@ - Enable goodcheck by adding `REPOSITORY_GOODCHECK` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable goodcheck by adding `REPOSITORY_GOODCHECK` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| REPOSITORY_GOODCHECK_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| REPOSITORY_GOODCHECK_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | -| REPOSITORY_GOODCHECK_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| REPOSITORY_GOODCHECK_PRE_COMMANDS | List of bash commands to run before the linter | None | -| REPOSITORY_GOODCHECK_POST_COMMANDS | List of bash commands to run after the linter | None | -| REPOSITORY_GOODCHECK_CONFIG_FILE | goodcheck configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `goodcheck.yml` | -| REPOSITORY_GOODCHECK_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| REPOSITORY_GOODCHECK_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| REPOSITORY_GOODCHECK_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| REPOSITORY_GOODCHECK_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| REPOSITORY_GOODCHECK_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | +| REPOSITORY_GOODCHECK_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| REPOSITORY_GOODCHECK_PRE_COMMANDS | List of bash commands to run before the linter| None | +| REPOSITORY_GOODCHECK_POST_COMMANDS | List of bash commands to run after the linter| None | +| REPOSITORY_GOODCHECK_CONFIG_FILE | goodcheck configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `goodcheck.yml` | +| REPOSITORY_GOODCHECK_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| REPOSITORY_GOODCHECK_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| REPOSITORY_GOODCHECK_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/repository_secretlint.md b/docs/descriptors/repository_secretlint.md index f3dc92de0ac..19bd6fae740 100644 --- a/docs/descriptors/repository_secretlint.md +++ b/docs/descriptors/repository_secretlint.md @@ -24,39 +24,39 @@ - Enable secretlint by adding `REPOSITORY_SECRETLINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable secretlint by adding `REPOSITORY_SECRETLINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|---------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| REPOSITORY_SECRETLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| REPOSITORY_SECRETLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | -| REPOSITORY_SECRETLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| REPOSITORY_SECRETLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| REPOSITORY_SECRETLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| REPOSITORY_SECRETLINT_CONFIG_FILE | secretlint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.secretlintrc.json` | -| REPOSITORY_SECRETLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| REPOSITORY_SECRETLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| REPOSITORY_SECRETLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| REPOSITORY_SECRETLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| REPOSITORY_SECRETLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | +| REPOSITORY_SECRETLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| REPOSITORY_SECRETLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| REPOSITORY_SECRETLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| REPOSITORY_SECRETLINT_CONFIG_FILE | secretlint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.secretlintrc.json` | +| REPOSITORY_SECRETLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| REPOSITORY_SECRETLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| REPOSITORY_SECRETLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/repository_semgrep.md b/docs/descriptors/repository_semgrep.md index 928c0e90f66..bab667fcca8 100644 --- a/docs/descriptors/repository_semgrep.md +++ b/docs/descriptors/repository_semgrep.md @@ -28,46 +28,46 @@ Example: `REPOSITORY_SEMGREP_ARGUMENTS: ["--config","p/ruleset1","p/ruleset2"]` - Enable semgrep by adding `REPOSITORY_SEMGREP` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable semgrep by adding `REPOSITORY_SEMGREP` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| REPOSITORY_SEMGREP_RULESETS | List of semgrep rulesets identifiers that you want to enforce | `auto` | -| REPOSITORY_SEMGREP_RULESETS_TYPE | MegaLinter semgrep ruleset list preset id . Available values: security | `` | -| REPOSITORY_SEMGREP_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| REPOSITORY_SEMGREP_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | -| REPOSITORY_SEMGREP_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| REPOSITORY_SEMGREP_PRE_COMMANDS | List of bash commands to run before the linter | None | -| REPOSITORY_SEMGREP_POST_COMMANDS | List of bash commands to run after the linter | None | -| REPOSITORY_SEMGREP_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| REPOSITORY_SEMGREP_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| REPOSITORY_SEMGREP_RULESETS | List of semgrep rulesets identifiers that you want to enforce | `auto` | +| REPOSITORY_SEMGREP_RULESETS_TYPE | MegaLinter semgrep ruleset list preset id . Available values: security | `` | +| REPOSITORY_SEMGREP_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| REPOSITORY_SEMGREP_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | +| REPOSITORY_SEMGREP_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| REPOSITORY_SEMGREP_PRE_COMMANDS | List of bash commands to run before the linter| None | +| REPOSITORY_SEMGREP_POST_COMMANDS | List of bash commands to run after the linter| None | +| REPOSITORY_SEMGREP_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| REPOSITORY_SEMGREP_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use semgrep in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|---------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Visual Studio Code](https://code.visualstudio.com/) | [VsCode SemGrep](https://marketplace.visualstudio.com/items?itemName=semgrep.semgrep) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/semgrep.semgrep){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/repository_syft.md b/docs/descriptors/repository_syft.md index 169c223932b..c66f5b656ec 100644 --- a/docs/descriptors/repository_syft.md +++ b/docs/descriptors/repository_syft.md @@ -13,7 +13,7 @@ Builds a SBOM (Software Build Of Materials) from your repository ## syft documentation -- Version in MegaLinter: **0.50.0** +- Version in MegaLinter: **0.51.0** - Visit [Official Web Site](https://github.com/anchore/syft#readme){target=_blank} [![syft - GitHub](https://gh-card.dev/repos/anchore/syft.svg?fullname=)](https://github.com/anchore/syft){target=_blank} @@ -23,26 +23,26 @@ Builds a SBOM (Software Build Of Materials) from your repository - Enable syft by adding `REPOSITORY_SYFT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable syft by adding `REPOSITORY_SYFT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|---------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| REPOSITORY_SYFT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| REPOSITORY_SYFT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | -| REPOSITORY_SYFT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| REPOSITORY_SYFT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| REPOSITORY_SYFT_POST_COMMANDS | List of bash commands to run after the linter | None | -| REPOSITORY_SYFT_CONFIG_FILE | syft configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.syft.yaml` | -| REPOSITORY_SYFT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| REPOSITORY_SYFT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| REPOSITORY_SYFT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| REPOSITORY_SYFT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| REPOSITORY_SYFT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | +| REPOSITORY_SYFT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| REPOSITORY_SYFT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| REPOSITORY_SYFT_POST_COMMANDS | List of bash commands to run after the linter| None | +| REPOSITORY_SYFT_CONFIG_FILE | syft configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.syft.yaml` | +| REPOSITORY_SYFT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| REPOSITORY_SYFT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| REPOSITORY_SYFT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------|:--------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | ## Behind the scenes diff --git a/docs/descriptors/repository_trivy.md b/docs/descriptors/repository_trivy.md index b186fc4b756..9f4ff12c079 100644 --- a/docs/descriptors/repository_trivy.md +++ b/docs/descriptors/repository_trivy.md @@ -21,45 +21,45 @@ - Enable trivy by adding `REPOSITORY_TRIVY` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable trivy by adding `REPOSITORY_TRIVY` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| REPOSITORY_TRIVY_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| REPOSITORY_TRIVY_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | -| REPOSITORY_TRIVY_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| REPOSITORY_TRIVY_PRE_COMMANDS | List of bash commands to run before the linter | None | -| REPOSITORY_TRIVY_POST_COMMANDS | List of bash commands to run after the linter | None | -| REPOSITORY_TRIVY_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| REPOSITORY_TRIVY_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| REPOSITORY_TRIVY_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| REPOSITORY_TRIVY_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | +| REPOSITORY_TRIVY_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| REPOSITORY_TRIVY_PRE_COMMANDS | List of bash commands to run before the linter| None | +| REPOSITORY_TRIVY_POST_COMMANDS | List of bash commands to run after the linter| None | +| REPOSITORY_TRIVY_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| REPOSITORY_TRIVY_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use trivy in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Visual Studio Code](https://code.visualstudio.com/) | [VsCode Trivy](https://marketplace.visualstudio.com/items?itemName=AquaSecurityOfficial.trivy-vulnerability-scanner) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/AquaSecurityOfficial.trivy-vulnerability-scanner){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/rst.md b/docs/descriptors/rst.md index c985329e266..f8e766865f9 100644 --- a/docs/descriptors/rst.md +++ b/docs/descriptors/rst.md @@ -5,10 +5,10 @@ ## Linters -| Linter | Configuration key | Status | -|-----------------------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [rst-lint](rst_rst_lint.md) | [RST](rst_rst_lint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/twolfson/restructuredtext-lint)](https://github.com/twolfson/restructuredtext-lint/commits) | -| [rstcheck](rst_rstcheck.md) | [RST](rst_rstcheck.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/myint/rstcheck)](https://github.com/myint/rstcheck/commits) | +| [rstcheck](rst_rstcheck.md) | [RST](rst_rstcheck.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/myint/rstcheck)](https://github.com/myint/rstcheck/commits) | ## Linted files @@ -17,8 +17,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|--------------------------|-------------------------------|---------------| -| RST_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| RST_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| RST_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| RST_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/rst_rst_lint.md b/docs/descriptors/rst_rst_lint.md index d0de75e7db7..1353f4d314f 100644 --- a/docs/descriptors/rst_rst_lint.md +++ b/docs/descriptors/rst_rst_lint.md @@ -14,27 +14,27 @@ - Enable rst-lint by adding `RST_RST_LINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable rst-lint by adding `RST_RST_LINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| RST_RST_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| RST_RST_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| RST_RST_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| RST_RST_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| RST_RST_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".rst"]` | -| RST_RST_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| RST_RST_LINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| RST_RST_LINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| RST_RST_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| RST_RST_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| RST_RST_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| RST_RST_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| RST_RST_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| RST_RST_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| RST_RST_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".rst"]` | +| RST_RST_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| RST_RST_LINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| RST_RST_LINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| RST_RST_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| RST_RST_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | ## Behind the scenes diff --git a/docs/descriptors/rst_rstcheck.md b/docs/descriptors/rst_rstcheck.md index ed3a7f4603d..0c26be18a02 100644 --- a/docs/descriptors/rst_rstcheck.md +++ b/docs/descriptors/rst_rstcheck.md @@ -16,37 +16,37 @@ - Enable rstcheck by adding `RST_RSTCHECK` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable rstcheck by adding `RST_RSTCHECK` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| RST_RSTCHECK_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| RST_RSTCHECK_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| RST_RSTCHECK_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| RST_RSTCHECK_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| RST_RSTCHECK_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".rst"]` | -| RST_RSTCHECK_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| RST_RSTCHECK_PRE_COMMANDS | List of bash commands to run before the linter | None | -| RST_RSTCHECK_POST_COMMANDS | List of bash commands to run after the linter | None | -| RST_RSTCHECK_CONFIG_FILE | rstcheck configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.rstcheck.cfg` | -| RST_RSTCHECK_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| RST_RSTCHECK_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| RST_RSTCHECK_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| RST_RSTCHECK_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| RST_RSTCHECK_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| RST_RSTCHECK_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| RST_RSTCHECK_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| RST_RSTCHECK_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".rst"]` | +| RST_RSTCHECK_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| RST_RSTCHECK_PRE_COMMANDS | List of bash commands to run before the linter| None | +| RST_RSTCHECK_POST_COMMANDS | List of bash commands to run after the linter| None | +| RST_RSTCHECK_CONFIG_FILE | rstcheck configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.rstcheck.cfg` | +| RST_RSTCHECK_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| RST_RSTCHECK_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| RST_RSTCHECK_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use rstcheck in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-restructuredtext](https://marketplace.visualstudio.com/items/lextudio.restructuredtext) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/lextudio.restructuredtext){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | ## Behind the scenes diff --git a/docs/descriptors/ruby.md b/docs/descriptors/ruby.md index 0ed3f7888d1..9c7caa7085b 100644 --- a/docs/descriptors/ruby.md +++ b/docs/descriptors/ruby.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|----------------------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [rubocop](ruby_rubocop.md) | [RUBY](ruby_rubocop.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/rubocop-hq/rubocop)](https://github.com/rubocop-hq/rubocop/commits) | ## Linted files @@ -16,8 +16,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|---------------------------|-------------------------------|---------------| -| RUBY_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| RUBY_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| RUBY_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| RUBY_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/ruby_rubocop.md b/docs/descriptors/ruby_rubocop.md index 704e04d21d2..e24b5259a25 100644 --- a/docs/descriptors/ruby_rubocop.md +++ b/docs/descriptors/ruby_rubocop.md @@ -27,45 +27,45 @@ - Enable **auto-fixes** by adding `RUBY_RUBOCOP` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| RUBY_RUBOCOP_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| RUBY_RUBOCOP_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| RUBY_RUBOCOP_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| RUBY_RUBOCOP_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| RUBY_RUBOCOP_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".rb"]` | -| RUBY_RUBOCOP_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| RUBY_RUBOCOP_PRE_COMMANDS | List of bash commands to run before the linter | None | -| RUBY_RUBOCOP_POST_COMMANDS | List of bash commands to run after the linter | None | -| RUBY_RUBOCOP_CONFIG_FILE | rubocop configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.ruby-lint.yml` | -| RUBY_RUBOCOP_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| RUBY_RUBOCOP_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| RUBY_RUBOCOP_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| RUBY_RUBOCOP_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| RUBY_RUBOCOP_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| RUBY_RUBOCOP_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| RUBY_RUBOCOP_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| RUBY_RUBOCOP_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".rb"]` | +| RUBY_RUBOCOP_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| RUBY_RUBOCOP_PRE_COMMANDS | List of bash commands to run before the linter| None | +| RUBY_RUBOCOP_POST_COMMANDS | List of bash commands to run after the linter| None | +| RUBY_RUBOCOP_CONFIG_FILE | rubocop configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.ruby-lint.yml` | +| RUBY_RUBOCOP_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| RUBY_RUBOCOP_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| RUBY_RUBOCOP_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use rubocop in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:---------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|--------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-rubocop](https://github.com/AtomLinter/linter-rubocop) | [Visit Web Site](https://github.com/AtomLinter/linter-rubocop){target=_blank} | -| | [Brackets](http://brackets.io/) | [brackets-rubocop](https://github.com/smockle-archive/brackets-rubocop) | [Visit Web Site](https://github.com/smockle-archive/brackets-rubocop){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [rubocop-emacs](https://github.com/rubocop-hq/rubocop-emacs) | [Visit Web Site](https://github.com/rubocop-hq/rubocop-emacs){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](https://github.com/flycheck/flycheck) | [Visit Web Site](https://github.com/flycheck/flycheck){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [RubyMine](https://www.jetbrains.com/help/idea/2017.1/rubocop.html) | [Visit Web Site](https://www.jetbrains.com/help/idea/2017.1/rubocop.html){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [sublime_rubocop](https://github.com/pderichs/sublime_rubocop) | [Visit Web Site](https://github.com/pderichs/sublime_rubocop){target=_blank} | -| | [vim](https://www.vim.org/) | [vim-rubocop](https://github.com/ngmy/vim-rubocop) | [Visit Web Site](https://github.com/ngmy/vim-rubocop){target=_blank} | -| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [VsCode Ruby Extension](https://marketplace.visualstudio.com/items?itemName=rebornix.Ruby) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/rebornix.Ruby){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-rubocop](https://github.com/AtomLinter/linter-rubocop) | [Visit Web Site](https://github.com/AtomLinter/linter-rubocop){target=_blank} | +| | [Brackets](http://brackets.io/) | [brackets-rubocop](https://github.com/smockle-archive/brackets-rubocop) | [Visit Web Site](https://github.com/smockle-archive/brackets-rubocop){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [rubocop-emacs](https://github.com/rubocop-hq/rubocop-emacs) | [Visit Web Site](https://github.com/rubocop-hq/rubocop-emacs){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](https://github.com/flycheck/flycheck) | [Visit Web Site](https://github.com/flycheck/flycheck){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [RubyMine](https://www.jetbrains.com/help/idea/2017.1/rubocop.html) | [Visit Web Site](https://www.jetbrains.com/help/idea/2017.1/rubocop.html){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [sublime_rubocop](https://github.com/pderichs/sublime_rubocop) | [Visit Web Site](https://github.com/pderichs/sublime_rubocop){target=_blank} | +| | [vim](https://www.vim.org/) | [vim-rubocop](https://github.com/ngmy/vim-rubocop) | [Visit Web Site](https://github.com/ngmy/vim-rubocop){target=_blank} | +| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [VsCode Ruby Extension](https://marketplace.visualstudio.com/items?itemName=rebornix.Ruby) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/rebornix.Ruby){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:----------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | ## Behind the scenes diff --git a/docs/descriptors/rust.md b/docs/descriptors/rust.md index 1fb15f5dcd4..2612003cf49 100644 --- a/docs/descriptors/rust.md +++ b/docs/descriptors/rust.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|--------------------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [clippy](rust_clippy.md) | [RUST](rust_clippy.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/rust-lang/rust-clippy)](https://github.com/rust-lang/rust-clippy/commits) | ## Linted files @@ -16,10 +16,10 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|---------------------------|-------------------------------|---------------| -| RUST_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| RUST_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| RUST_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| RUST_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | ## Behind the scenes diff --git a/docs/descriptors/rust_clippy.md b/docs/descriptors/rust_clippy.md index 09f9966e606..7e4eea3a5fd 100644 --- a/docs/descriptors/rust_clippy.md +++ b/docs/descriptors/rust_clippy.md @@ -17,34 +17,34 @@ - Enable clippy by adding `RUST_CLIPPY` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable clippy by adding `RUST_CLIPPY` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| RUST_CLIPPY_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| RUST_CLIPPY_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".rs"]` | -| RUST_CLIPPY_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| RUST_CLIPPY_PRE_COMMANDS | List of bash commands to run before the linter | None | -| RUST_CLIPPY_POST_COMMANDS | List of bash commands to run after the linter | None | -| RUST_CLIPPY_CONFIG_FILE | clippy configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.clippy.toml` | -| RUST_CLIPPY_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| RUST_CLIPPY_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| RUST_CLIPPY_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| RUST_CLIPPY_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| RUST_CLIPPY_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".rs"]` | +| RUST_CLIPPY_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| RUST_CLIPPY_PRE_COMMANDS | List of bash commands to run before the linter| None | +| RUST_CLIPPY_POST_COMMANDS | List of bash commands to run after the linter| None | +| RUST_CLIPPY_CONFIG_FILE | clippy configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.clippy.toml` | +| RUST_CLIPPY_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| RUST_CLIPPY_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| RUST_CLIPPY_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use clippy in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-----------------------------------------------------------------------------------------------------------------------------------------:|--------------------------|-------------------------------------------------------------|:---------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Atom](https://atom.io/) | [Atom IDE Rest](https://github.com/rust-lang/atom-ide-rust) | [Visit Web Site](https://github.com/rust-lang/atom-ide-rust){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:----------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | ## Behind the scenes diff --git a/docs/descriptors/salesforce.md b/docs/descriptors/salesforce.md index 0113b2d509d..83cc17afab4 100644 --- a/docs/descriptors/salesforce.md +++ b/docs/descriptors/salesforce.md @@ -5,20 +5,20 @@ ## Linters -| Linter | Configuration key | Status | -|------------------------------------------------------|-----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [sfdx-scanner-apex](salesforce_sfdx_scanner_apex.md) | [SALESFORCE_SFDX_SCANNER_APEX](salesforce_sfdx_scanner_apex.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/forcedotcom/sfdx-scanner)](https://github.com/forcedotcom/sfdx-scanner/commits) | | [sfdx-scanner-aura](salesforce_sfdx_scanner_aura.md) | [SALESFORCE_SFDX_SCANNER_AURA](salesforce_sfdx_scanner_aura.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/forcedotcom/sfdx-scanner)](https://github.com/forcedotcom/sfdx-scanner/commits) | -| [sfdx-scanner-lwc](salesforce_sfdx_scanner_lwc.md) | [SALESFORCE_SFDX_SCANNER_LWC](salesforce_sfdx_scanner_lwc.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/forcedotcom/sfdx-scanner)](https://github.com/forcedotcom/sfdx-scanner/commits) | +| [sfdx-scanner-lwc](salesforce_sfdx_scanner_lwc.md) | [SALESFORCE_SFDX_SCANNER_LWC](salesforce_sfdx_scanner_lwc.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/forcedotcom/sfdx-scanner)](https://github.com/forcedotcom/sfdx-scanner/commits) | ## Linted files ## Configuration in MegaLinter -| Variable | Description | Default value | -|---------------------------------|-------------------------------|---------------| -| SALESFORCE_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| SALESFORCE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SALESFORCE_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| SALESFORCE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | ## Behind the scenes diff --git a/docs/descriptors/salesforce_sfdx_scanner_apex.md b/docs/descriptors/salesforce_sfdx_scanner_apex.md index e2bc4800cd5..ac7035cdb5e 100644 --- a/docs/descriptors/salesforce_sfdx_scanner_apex.md +++ b/docs/descriptors/salesforce_sfdx_scanner_apex.md @@ -28,38 +28,38 @@ See more details in [Help](#help-content) - Enable sfdx-scanner-apex by adding `SALESFORCE_SFDX_SCANNER_APEX` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable sfdx-scanner-apex by adding `SALESFORCE_SFDX_SCANNER_APEX` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| SALESFORCE_SFDX_SCANNER_APEX_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| SALESFORCE_SFDX_SCANNER_APEX_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | -| SALESFORCE_SFDX_SCANNER_APEX_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS | List of bash commands to run before the linter | None | -| SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS | List of bash commands to run after the linter | None | -| SALESFORCE_SFDX_SCANNER_APEX_CONFIG_FILE | sfdx-scanner-apex configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `apex-pmd-ruleset.xml` | -| SALESFORCE_SFDX_SCANNER_APEX_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| SALESFORCE_SFDX_SCANNER_APEX_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| SALESFORCE_SFDX_SCANNER_APEX_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | -| SALESFORCE_DIRECTORY | Directory containing SALESFORCE files | `force-app` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SALESFORCE_SFDX_SCANNER_APEX_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| SALESFORCE_SFDX_SCANNER_APEX_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | +| SALESFORCE_SFDX_SCANNER_APEX_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| SALESFORCE_SFDX_SCANNER_APEX_PRE_COMMANDS | List of bash commands to run before the linter| None | +| SALESFORCE_SFDX_SCANNER_APEX_POST_COMMANDS | List of bash commands to run after the linter| None | +| SALESFORCE_SFDX_SCANNER_APEX_CONFIG_FILE | sfdx-scanner-apex configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `apex-pmd-ruleset.xml` | +| SALESFORCE_SFDX_SCANNER_APEX_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| SALESFORCE_SFDX_SCANNER_APEX_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| SALESFORCE_SFDX_SCANNER_APEX_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| SALESFORCE_DIRECTORY | Directory containing SALESFORCE files | `force-app` | ## IDE Integration Use sfdx-scanner-apex in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Eclipse](https://www.eclipse.org/) | [pmd-eclipse-plugin](https://github.com/pmd/pmd-eclipse-plugin) | [Visit Web Site](https://github.com/pmd/pmd-eclipse-plugin){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [pmd-emacs](https://github.com/pmd/pmd-emacs/) | [Visit Web Site](https://github.com/pmd/pmd-emacs/){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [PMD IntelliJ](https://plugins.jetbrains.com/plugin/1137-pmdplugin) | | -| | [Visual Studio Code](https://code.visualstudio.com/) | [Salesforce Extension Pack](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/salesforce.salesforcedx-vscode){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Eclipse](https://www.eclipse.org/) | [pmd-eclipse-plugin](https://github.com/pmd/pmd-eclipse-plugin) | [Visit Web Site](https://github.com/pmd/pmd-eclipse-plugin){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [pmd-emacs](https://github.com/pmd/pmd-emacs/) | [Visit Web Site](https://github.com/pmd/pmd-emacs/){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [PMD IntelliJ](https://plugins.jetbrains.com/plugin/1137-pmdplugin) | | +| | [Visual Studio Code](https://code.visualstudio.com/) | [Salesforce Extension Pack](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/salesforce.salesforcedx-vscode){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------|:----------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | ## Behind the scenes diff --git a/docs/descriptors/salesforce_sfdx_scanner_aura.md b/docs/descriptors/salesforce_sfdx_scanner_aura.md index b232fdf95ed..7dcf25d050d 100644 --- a/docs/descriptors/salesforce_sfdx_scanner_aura.md +++ b/docs/descriptors/salesforce_sfdx_scanner_aura.md @@ -27,35 +27,35 @@ See more details in [Help](#help-content) - Enable sfdx-scanner-aura by adding `SALESFORCE_SFDX_SCANNER_AURA` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable sfdx-scanner-aura by adding `SALESFORCE_SFDX_SCANNER_AURA` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| SALESFORCE_SFDX_SCANNER_AURA_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| SALESFORCE_SFDX_SCANNER_AURA_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | -| SALESFORCE_SFDX_SCANNER_AURA_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS | List of bash commands to run before the linter | None | -| SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS | List of bash commands to run after the linter | None | -| SALESFORCE_SFDX_SCANNER_AURA_CONFIG_FILE | sfdx-scanner-aura configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `--eslintconfig` | -| SALESFORCE_SFDX_SCANNER_AURA_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| SALESFORCE_SFDX_SCANNER_AURA_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| SALESFORCE_SFDX_SCANNER_AURA_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | -| SALESFORCE_DIRECTORY | Directory containing SALESFORCE files | `force-app` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SALESFORCE_SFDX_SCANNER_AURA_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| SALESFORCE_SFDX_SCANNER_AURA_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | +| SALESFORCE_SFDX_SCANNER_AURA_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| SALESFORCE_SFDX_SCANNER_AURA_PRE_COMMANDS | List of bash commands to run before the linter| None | +| SALESFORCE_SFDX_SCANNER_AURA_POST_COMMANDS | List of bash commands to run after the linter| None | +| SALESFORCE_SFDX_SCANNER_AURA_CONFIG_FILE | sfdx-scanner-aura configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `--eslintconfig` | +| SALESFORCE_SFDX_SCANNER_AURA_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| SALESFORCE_SFDX_SCANNER_AURA_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| SALESFORCE_SFDX_SCANNER_AURA_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| SALESFORCE_DIRECTORY | Directory containing SALESFORCE files | `force-app` | ## IDE Integration Use sfdx-scanner-aura in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Visual Studio Code](https://code.visualstudio.com/) | [Salesforce Extension Pack](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/salesforce.salesforcedx-vscode){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------|:----------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | ## Behind the scenes diff --git a/docs/descriptors/salesforce_sfdx_scanner_lwc.md b/docs/descriptors/salesforce_sfdx_scanner_lwc.md index 2dcb2a4758b..8e18dff10b1 100644 --- a/docs/descriptors/salesforce_sfdx_scanner_lwc.md +++ b/docs/descriptors/salesforce_sfdx_scanner_lwc.md @@ -27,35 +27,35 @@ See more details in [Help](#help-content) - Enable sfdx-scanner-lwc by adding `SALESFORCE_SFDX_SCANNER_LWC` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable sfdx-scanner-lwc by adding `SALESFORCE_SFDX_SCANNER_LWC` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|---------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| SALESFORCE_SFDX_SCANNER_LWC_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| SALESFORCE_SFDX_SCANNER_LWC_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | -| SALESFORCE_SFDX_SCANNER_LWC_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS | List of bash commands to run before the linter | None | -| SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS | List of bash commands to run after the linter | None | -| SALESFORCE_SFDX_SCANNER_LWC_CONFIG_FILE | sfdx-scanner-lwc configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `--eslintconfig` | -| SALESFORCE_SFDX_SCANNER_LWC_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| SALESFORCE_SFDX_SCANNER_LWC_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| SALESFORCE_SFDX_SCANNER_LWC_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | -| SALESFORCE_DIRECTORY | Directory containing SALESFORCE files | `force-app` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SALESFORCE_SFDX_SCANNER_LWC_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| SALESFORCE_SFDX_SCANNER_LWC_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | Exclude every file | +| SALESFORCE_SFDX_SCANNER_LWC_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| SALESFORCE_SFDX_SCANNER_LWC_PRE_COMMANDS | List of bash commands to run before the linter| None | +| SALESFORCE_SFDX_SCANNER_LWC_POST_COMMANDS | List of bash commands to run after the linter| None | +| SALESFORCE_SFDX_SCANNER_LWC_CONFIG_FILE | sfdx-scanner-lwc configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `--eslintconfig` | +| SALESFORCE_SFDX_SCANNER_LWC_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| SALESFORCE_SFDX_SCANNER_LWC_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| SALESFORCE_SFDX_SCANNER_LWC_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| SALESFORCE_DIRECTORY | Directory containing SALESFORCE files | `force-app` | ## IDE Integration Use sfdx-scanner-lwc in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Visual Studio Code](https://code.visualstudio.com/) | [Salesforce Extension Pack](https://marketplace.visualstudio.com/items?itemName=salesforce.salesforcedx-vscode) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/salesforce.salesforcedx-vscode){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------|:----------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | ## Behind the scenes diff --git a/docs/descriptors/scala.md b/docs/descriptors/scala.md index fbfac6ab0dc..7608f8471bb 100644 --- a/docs/descriptors/scala.md +++ b/docs/descriptors/scala.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|-------------------------------|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [scalafix](scala_scalafix.md) | [SCALA](scala_scalafix.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/scalacenter/scalafix)](https://github.com/scalacenter/scalafix/commits) | ## Linted files @@ -16,10 +16,10 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|----------------------------|-------------------------------|---------------| -| SCALA_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| SCALA_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SCALA_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| SCALA_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | ## Behind the scenes diff --git a/docs/descriptors/scala_scalafix.md b/docs/descriptors/scala_scalafix.md index f01de87993d..a15ca0eed5f 100644 --- a/docs/descriptors/scala_scalafix.md +++ b/docs/descriptors/scala_scalafix.md @@ -23,28 +23,28 @@ Scalafix lints and fixes scala files - Enable scalafix by adding `SCALA_SCALAFIX` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable scalafix by adding `SCALA_SCALAFIX` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| SCALA_SCALAFIX_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| SCALA_SCALAFIX_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| SCALA_SCALAFIX_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| SCALA_SCALAFIX_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| SCALA_SCALAFIX_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".scala"]` | -| SCALA_SCALAFIX_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| SCALA_SCALAFIX_PRE_COMMANDS | List of bash commands to run before the linter | None | -| SCALA_SCALAFIX_POST_COMMANDS | List of bash commands to run after the linter | None | -| SCALA_SCALAFIX_CONFIG_FILE | scalafix configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.scalafix.conf` | -| SCALA_SCALAFIX_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| SCALA_SCALAFIX_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| SCALA_SCALAFIX_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SCALA_SCALAFIX_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| SCALA_SCALAFIX_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| SCALA_SCALAFIX_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| SCALA_SCALAFIX_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| SCALA_SCALAFIX_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".scala"]` | +| SCALA_SCALAFIX_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| SCALA_SCALAFIX_PRE_COMMANDS | List of bash commands to run before the linter| None | +| SCALA_SCALAFIX_POST_COMMANDS | List of bash commands to run after the linter| None | +| SCALA_SCALAFIX_CONFIG_FILE | scalafix configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.scalafix.conf` | +| SCALA_SCALAFIX_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| SCALA_SCALAFIX_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| SCALA_SCALAFIX_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:--------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | ## Behind the scenes diff --git a/docs/descriptors/snakemake.md b/docs/descriptors/snakemake.md index 911acf05ca8..8c1c2f2ba00 100644 --- a/docs/descriptors/snakemake.md +++ b/docs/descriptors/snakemake.md @@ -5,10 +5,10 @@ ## Linters -| Linter | Configuration key | Status | -|-------------------------------------|---------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| -| [snakemake](snakemake_snakemake.md) | [SNAKEMAKE_LINT](snakemake_snakemake.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/snakemake/snakemake)](https://github.com/snakemake/snakemake/commits) | -| [snakefmt](snakemake_snakefmt.md) | [SNAKEMAKE_SNAKEFMT](snakemake_snakefmt.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/snakemake/snakefmt)](https://github.com/snakemake/snakefmt/commits) | +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | +| [snakemake](snakemake_snakemake.md) | [SNAKEMAKE_LINT](snakemake_snakemake.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/snakemake/snakemake)](https://github.com/snakemake/snakemake/commits) | +| [snakefmt](snakemake_snakefmt.md) | [SNAKEMAKE_SNAKEFMT](snakemake_snakefmt.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/snakemake/snakefmt)](https://github.com/snakemake/snakefmt/commits) | ## Linted files @@ -20,8 +20,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|--------------------------------|-------------------------------|---------------| -| SNAKEMAKE_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| SNAKEMAKE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SNAKEMAKE_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| SNAKEMAKE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/snakemake_snakefmt.md b/docs/descriptors/snakemake_snakefmt.md index 5ccb369c60e..a426d0ebb3c 100644 --- a/docs/descriptors/snakemake_snakefmt.md +++ b/docs/descriptors/snakemake_snakefmt.md @@ -20,28 +20,28 @@ _This linter has been temporary disabled in this version_ - Enable **auto-fixes** by adding `SNAKEMAKE_SNAKEFMT` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| SNAKEMAKE_SNAKEFMT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| SNAKEMAKE_SNAKEFMT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| SNAKEMAKE_SNAKEFMT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| SNAKEMAKE_SNAKEFMT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| SNAKEMAKE_SNAKEFMT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".smk"]` | -| SNAKEMAKE_SNAKEFMT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | `["Snakefile"]` | -| SNAKEMAKE_SNAKEFMT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| SNAKEMAKE_SNAKEFMT_POST_COMMANDS | List of bash commands to run after the linter | None | -| SNAKEMAKE_SNAKEFMT_CONFIG_FILE | snakefmt configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.snakefmt.toml` | -| SNAKEMAKE_SNAKEFMT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| SNAKEMAKE_SNAKEFMT_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | -| SNAKEMAKE_SNAKEFMT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SNAKEMAKE_SNAKEFMT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| SNAKEMAKE_SNAKEFMT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| SNAKEMAKE_SNAKEFMT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| SNAKEMAKE_SNAKEFMT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| SNAKEMAKE_SNAKEFMT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".smk"]` | +| SNAKEMAKE_SNAKEFMT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | `["Snakefile"]` | +| SNAKEMAKE_SNAKEFMT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| SNAKEMAKE_SNAKEFMT_POST_COMMANDS | List of bash commands to run after the linter| None | +| SNAKEMAKE_SNAKEFMT_CONFIG_FILE | snakefmt configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.snakefmt.toml` | +| SNAKEMAKE_SNAKEFMT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| SNAKEMAKE_SNAKEFMT_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| SNAKEMAKE_SNAKEFMT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:--------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | ## Behind the scenes diff --git a/docs/descriptors/snakemake_snakemake.md b/docs/descriptors/snakemake_snakemake.md index 76b484a8486..a986d24aba6 100644 --- a/docs/descriptors/snakemake_snakemake.md +++ b/docs/descriptors/snakemake_snakemake.md @@ -21,47 +21,47 @@ - Enable snakemake by adding `SNAKEMAKE_LINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable snakemake by adding `SNAKEMAKE_LINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| SNAKEMAKE_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| SNAKEMAKE_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| SNAKEMAKE_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| SNAKEMAKE_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| SNAKEMAKE_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".smk"]` | -| SNAKEMAKE_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | `["Snakefile"]` | -| SNAKEMAKE_LINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| SNAKEMAKE_LINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| SNAKEMAKE_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| SNAKEMAKE_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SNAKEMAKE_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| SNAKEMAKE_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| SNAKEMAKE_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| SNAKEMAKE_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| SNAKEMAKE_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".smk"]` | +| SNAKEMAKE_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | `["Snakefile"]` | +| SNAKEMAKE_LINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| SNAKEMAKE_LINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| SNAKEMAKE_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| SNAKEMAKE_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use snakemake in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|-------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [SnakeCharm](https://plugins.jetbrains.com/plugin/11947-snakecharm) | | -| | [Visual Studio Code](https://code.visualstudio.com/) | [VsCode SnakeMake](https://marketplace.visualstudio.com/items?itemName=alping.vscode-snakemake) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/alping.vscode-snakemake){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [SnakeCharm](https://plugins.jetbrains.com/plugin/11947-snakecharm) | | +| | [Visual Studio Code](https://code.visualstudio.com/) | [VsCode SnakeMake](https://marketplace.visualstudio.com/items?itemName=alping.vscode-snakemake) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/alping.vscode-snakemake){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/spell.md b/docs/descriptors/spell.md index dbdfa7d6fc0..e5513eb8100 100644 --- a/docs/descriptors/spell.md +++ b/docs/descriptors/spell.md @@ -5,10 +5,10 @@ ## Linters -| Linter | Configuration key | Status | -|-------------------------------|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| -| [misspell](spell_misspell.md) | [SPELL_MISSPELL](spell_misspell.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/client9/misspell)](https://github.com/client9/misspell/commits) | -| [cspell](spell_cspell.md) | [SPELL_CSPELL](spell_cspell.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/streetsidesoftware/cspell)](https://github.com/streetsidesoftware/cspell/commits) | +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | +| [misspell](spell_misspell.md) | [SPELL_MISSPELL](spell_misspell.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/client9/misspell)](https://github.com/client9/misspell/commits) | +| [cspell](spell_cspell.md) | [SPELL_CSPELL](spell_cspell.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/streetsidesoftware/cspell)](https://github.com/streetsidesoftware/cspell/commits) | ## Linted files @@ -17,8 +17,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|----------------------------|-------------------------------|---------------| -| SPELL_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| SPELL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SPELL_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| SPELL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/spell_cspell.md b/docs/descriptors/spell_cspell.md index b35b32958ae..069ee8546b3 100644 --- a/docs/descriptors/spell_cspell.md +++ b/docs/descriptors/spell_cspell.md @@ -19,48 +19,48 @@ Copy it at the root of your repository, read it, remove real spelling errors (af - Enable cspell by adding `SPELL_CSPELL` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable cspell by adding `SPELL_CSPELL` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| SPELL_CSPELL_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| SPELL_CSPELL_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| SPELL_CSPELL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| SPELL_CSPELL_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| SPELL_CSPELL_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `["*"]` | -| SPELL_CSPELL_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| SPELL_CSPELL_PRE_COMMANDS | List of bash commands to run before the linter | None | -| SPELL_CSPELL_POST_COMMANDS | List of bash commands to run after the linter | None | -| SPELL_CSPELL_CONFIG_FILE | cspell configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.cspell.json` | -| SPELL_CSPELL_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| SPELL_CSPELL_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| SPELL_CSPELL_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SPELL_CSPELL_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| SPELL_CSPELL_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| SPELL_CSPELL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| SPELL_CSPELL_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| SPELL_CSPELL_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `["*"]` | +| SPELL_CSPELL_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| SPELL_CSPELL_PRE_COMMANDS | List of bash commands to run before the linter| None | +| SPELL_CSPELL_POST_COMMANDS | List of bash commands to run after the linter| None | +| SPELL_CSPELL_CONFIG_FILE | cspell configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.cspell.json` | +| SPELL_CSPELL_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| SPELL_CSPELL_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| SPELL_CSPELL_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use cspell in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Visual Studio Code](https://code.visualstudio.com/) | [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/streetsidesoftware.code-spell-checker){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/spell_misspell.md b/docs/descriptors/spell_misspell.md index 6f06e7d9179..ab68a04e9a4 100644 --- a/docs/descriptors/spell_misspell.md +++ b/docs/descriptors/spell_misspell.md @@ -18,38 +18,38 @@ misspell detects and corrects commonly misspelled english words - Enable **auto-fixes** by adding `SPELL_MISSPELL` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| SPELL_MISSPELL_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| SPELL_MISSPELL_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| SPELL_MISSPELL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| SPELL_MISSPELL_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| SPELL_MISSPELL_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `["*"]` | -| SPELL_MISSPELL_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| SPELL_MISSPELL_PRE_COMMANDS | List of bash commands to run before the linter | None | -| SPELL_MISSPELL_POST_COMMANDS | List of bash commands to run after the linter | None | -| SPELL_MISSPELL_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| SPELL_MISSPELL_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SPELL_MISSPELL_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| SPELL_MISSPELL_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| SPELL_MISSPELL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| SPELL_MISSPELL_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| SPELL_MISSPELL_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `["*"]` | +| SPELL_MISSPELL_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| SPELL_MISSPELL_PRE_COMMANDS | List of bash commands to run before the linter| None | +| SPELL_MISSPELL_POST_COMMANDS | List of bash commands to run after the linter| None | +| SPELL_MISSPELL_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| SPELL_MISSPELL_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/sql.md b/docs/descriptors/sql.md index fc8df1ea887..c2060911c14 100644 --- a/docs/descriptors/sql.md +++ b/docs/descriptors/sql.md @@ -5,11 +5,11 @@ ## Linters -| Linter | Configuration key | Status | -|-----------------------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [sql-lint](sql_sql_lint.md) | [SQL](sql_sql_lint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/joereynolds/sql-lint)](https://github.com/joereynolds/sql-lint/commits) | -| [sqlfluff](sql_sqlfluff.md) | [SQL](sql_sqlfluff.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/sqlfluff/sqlfluff)](https://github.com/sqlfluff/sqlfluff/commits) | -| [tsqllint](sql_tsqllint.md) | [SQL](sql_tsqllint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/tsqllint/tsqllint)](https://github.com/tsqllint/tsqllint/commits) | +| [sqlfluff](sql_sqlfluff.md) | [SQL](sql_sqlfluff.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/sqlfluff/sqlfluff)](https://github.com/sqlfluff/sqlfluff/commits) | +| [tsqllint](sql_tsqllint.md) | [SQL](sql_tsqllint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/tsqllint/tsqllint)](https://github.com/tsqllint/tsqllint/commits) | ## Linted files @@ -18,8 +18,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|--------------------------|-------------------------------|---------------| -| SQL_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| SQL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SQL_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| SQL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/sql_sql_lint.md b/docs/descriptors/sql_sql_lint.md index b28b4db71e6..5f4300f3a08 100644 --- a/docs/descriptors/sql_sql_lint.md +++ b/docs/descriptors/sql_sql_lint.md @@ -17,48 +17,48 @@ - Enable sql-lint by adding `SQL_SQL_LINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable sql-lint by adding `SQL_SQL_LINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| SQL_SQL_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| SQL_SQL_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| SQL_SQL_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| SQL_SQL_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| SQL_SQL_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".sql"]` | -| SQL_SQL_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| SQL_SQL_LINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| SQL_SQL_LINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| SQL_SQL_LINT_CONFIG_FILE | sql-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.sql-config.json` | -| SQL_SQL_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| SQL_SQL_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| SQL_SQL_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SQL_SQL_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| SQL_SQL_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| SQL_SQL_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| SQL_SQL_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| SQL_SQL_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".sql"]` | +| SQL_SQL_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| SQL_SQL_LINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| SQL_SQL_LINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| SQL_SQL_LINT_CONFIG_FILE | sql-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.sql-config.json` | +| SQL_SQL_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| SQL_SQL_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| SQL_SQL_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use sql-lint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:----------------------------------------------------------------------------------------------------------------------------------------:|-----------------------------|-----------------------------------------------|:-----------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [vim](https://www.vim.org/) | [ale](https://github.com/dense-analysis/ale/) | [Visit Web Site](https://github.com/dense-analysis/ale/){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/sql_sqlfluff.md b/docs/descriptors/sql_sqlfluff.md index 74de42d9d15..114bb387d39 100644 --- a/docs/descriptors/sql_sqlfluff.md +++ b/docs/descriptors/sql_sqlfluff.md @@ -24,40 +24,40 @@ - Enable sqlfluff by adding `SQL_SQLFLUFF` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable sqlfluff by adding `SQL_SQLFLUFF` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| SQL_SQLFLUFF_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| SQL_SQLFLUFF_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| SQL_SQLFLUFF_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| SQL_SQLFLUFF_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| SQL_SQLFLUFF_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".sql"]` | -| SQL_SQLFLUFF_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| SQL_SQLFLUFF_PRE_COMMANDS | List of bash commands to run before the linter | None | -| SQL_SQLFLUFF_POST_COMMANDS | List of bash commands to run after the linter | None | -| SQL_SQLFLUFF_CONFIG_FILE | sqlfluff configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.sqlfluff` | -| SQL_SQLFLUFF_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| SQL_SQLFLUFF_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| SQL_SQLFLUFF_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SQL_SQLFLUFF_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| SQL_SQLFLUFF_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| SQL_SQLFLUFF_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| SQL_SQLFLUFF_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| SQL_SQLFLUFF_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".sql"]` | +| SQL_SQLFLUFF_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| SQL_SQLFLUFF_PRE_COMMANDS | List of bash commands to run before the linter| None | +| SQL_SQLFLUFF_POST_COMMANDS | List of bash commands to run after the linter| None | +| SQL_SQLFLUFF_CONFIG_FILE | sqlfluff configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.sqlfluff` | +| SQL_SQLFLUFF_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| SQL_SQLFLUFF_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| SQL_SQLFLUFF_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/sql_tsqllint.md b/docs/descriptors/sql_tsqllint.md index 2a2f9d49da2..44791efbd72 100644 --- a/docs/descriptors/sql_tsqllint.md +++ b/docs/descriptors/sql_tsqllint.md @@ -17,37 +17,37 @@ - Enable tsqllint by adding `SQL_TSQLLINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable tsqllint by adding `SQL_TSQLLINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| SQL_TSQLLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| SQL_TSQLLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| SQL_TSQLLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| SQL_TSQLLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| SQL_TSQLLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".sql"]` | -| SQL_TSQLLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| SQL_TSQLLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| SQL_TSQLLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| SQL_TSQLLINT_CONFIG_FILE | tsqllint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.tsqllintrc` | -| SQL_TSQLLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| SQL_TSQLLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| SQL_TSQLLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SQL_TSQLLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| SQL_TSQLLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| SQL_TSQLLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| SQL_TSQLLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| SQL_TSQLLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".sql"]` | +| SQL_TSQLLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| SQL_TSQLLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| SQL_TSQLLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| SQL_TSQLLINT_CONFIG_FILE | tsqllint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.tsqllintrc` | +| SQL_TSQLLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| SQL_TSQLLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| SQL_TSQLLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use tsqllint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Visual Studio Code](https://code.visualstudio.com/) | [TSQL Lint](https://marketplace.visualstudio.com/items?itemName=tsqllint.tsqllint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/tsqllint.tsqllint){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:----------------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | ## Behind the scenes diff --git a/docs/descriptors/swift.md b/docs/descriptors/swift.md index 2514b8135f3..d18ac1691a4 100644 --- a/docs/descriptors/swift.md +++ b/docs/descriptors/swift.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|---------------------------------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [swiftlint](swift_swiftlint.md) | [SWIFT](swift_swiftlint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/realm/SwiftLint)](https://github.com/realm/SwiftLint/commits) | ## Linted files @@ -16,8 +16,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|----------------------------|-------------------------------|---------------| -| SWIFT_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| SWIFT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SWIFT_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| SWIFT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/swift_swiftlint.md b/docs/descriptors/swift_swiftlint.md index 664be0b4518..23ac543c36c 100644 --- a/docs/descriptors/swift_swiftlint.md +++ b/docs/descriptors/swift_swiftlint.md @@ -21,37 +21,37 @@ - Enable **auto-fixes** by adding `SWIFT_SWIFTLINT` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|---------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| SWIFT_SWIFTLINT_DOCKER_IMAGE_VERSION | Docker image version | `latest` | -| SWIFT_SWIFTLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| SWIFT_SWIFTLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".swift"]` | -| SWIFT_SWIFTLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| SWIFT_SWIFTLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| SWIFT_SWIFTLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| SWIFT_SWIFTLINT_CONFIG_FILE | swiftlint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.swiftlint.yml` | -| SWIFT_SWIFTLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| SWIFT_SWIFTLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| SWIFT_SWIFTLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| SWIFT_SWIFTLINT_DOCKER_IMAGE_VERSION | Docker image version | `latest` | +| SWIFT_SWIFTLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| SWIFT_SWIFTLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".swift"]` | +| SWIFT_SWIFTLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| SWIFT_SWIFTLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| SWIFT_SWIFTLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| SWIFT_SWIFTLINT_CONFIG_FILE | swiftlint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.swiftlint.yml` | +| SWIFT_SWIFTLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| SWIFT_SWIFTLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| SWIFT_SWIFTLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use swiftlint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-swiftlint](https://atom.io/packages/linter-swiftlint) | [Visit Web Site](https://atom.io/packages/linter-swiftlint){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [swiftlint](https://plugins.jetbrains.com/plugin/9175-swiftlint) | | -| | xcode | [Configure manually](https://github.com/realm/SwiftLint#xcode) | [Visit Web Site](https://github.com/realm/SwiftLint#xcode){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-swiftlint](https://atom.io/packages/linter-swiftlint) | [Visit Web Site](https://atom.io/packages/linter-swiftlint){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [swiftlint](https://plugins.jetbrains.com/plugin/9175-swiftlint) | | +| | xcode | [Configure manually](https://github.com/realm/SwiftLint#xcode) | [Visit Web Site](https://github.com/realm/SwiftLint#xcode){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:-----------------------------------|:----------------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | ## Behind the scenes diff --git a/docs/descriptors/tekton.md b/docs/descriptors/tekton.md index f9239989e3e..7285f99fb2e 100644 --- a/docs/descriptors/tekton.md +++ b/docs/descriptors/tekton.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|--------------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [tekton-lint](tekton_tekton_lint.md) | [TEKTON](tekton_tekton_lint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/IBM/tekton-lint)](https://github.com/IBM/tekton-lint/commits) | ## Linted files @@ -20,8 +20,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|-----------------------------|-------------------------------|---------------| -| TEKTON_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| TEKTON_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| TEKTON_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| TEKTON_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/tekton_tekton_lint.md b/docs/descriptors/tekton_tekton_lint.md index cbd34cef0d5..abd34d7834f 100644 --- a/docs/descriptors/tekton_tekton_lint.md +++ b/docs/descriptors/tekton_tekton_lint.md @@ -16,40 +16,40 @@ - Enable tekton-lint by adding `TEKTON_TEKTON_LINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable tekton-lint by adding `TEKTON_TEKTON_LINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| TEKTON_TEKTON_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| TEKTON_TEKTON_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| TEKTON_TEKTON_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| TEKTON_TEKTON_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| TEKTON_TEKTON_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml"]` | -| TEKTON_TEKTON_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| TEKTON_TEKTON_LINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| TEKTON_TEKTON_LINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| TEKTON_TEKTON_LINT_CONFIG_FILE | tekton-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.tektonlintrc.yaml` | -| TEKTON_TEKTON_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| TEKTON_TEKTON_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| TEKTON_TEKTON_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| TEKTON_TEKTON_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| TEKTON_TEKTON_LINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| TEKTON_TEKTON_LINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| TEKTON_TEKTON_LINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| TEKTON_TEKTON_LINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml"]` | +| TEKTON_TEKTON_LINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| TEKTON_TEKTON_LINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| TEKTON_TEKTON_LINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| TEKTON_TEKTON_LINT_CONFIG_FILE | tekton-lint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.tektonlintrc.yaml` | +| TEKTON_TEKTON_LINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| TEKTON_TEKTON_LINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| TEKTON_TEKTON_LINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/terraform.md b/docs/descriptors/terraform.md index 816a78c0fc2..05f9f8452f7 100644 --- a/docs/descriptors/terraform.md +++ b/docs/descriptors/terraform.md @@ -5,14 +5,14 @@ ## Linters -| Linter | Configuration key | Status | -|---------------------------------------------|-------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| -| [tflint](terraform_tflint.md) | [TERRAFORM_TFLINT](terraform_tflint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/terraform-linters/tflint)](https://github.com/terraform-linters/tflint/commits) | -| [terrascan](terraform_terrascan.md) | [TERRAFORM_TERRASCAN](terraform_terrascan.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/accurics/terrascan)](https://github.com/accurics/terrascan/commits) | -| [terragrunt](terraform_terragrunt.md) | [TERRAFORM_TERRAGRUNT](terraform_terragrunt.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/gruntwork-io/terragrunt)](https://github.com/gruntwork-io/terragrunt/commits) | -| [terraform-fmt](terraform_terraform_fmt.md) | [TERRAFORM_TERRAFORM_FMT](terraform_terraform_fmt.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/hashicorp/terraform)](https://github.com/hashicorp/terraform/commits) | -| [checkov](terraform_checkov.md) | [TERRAFORM_CHECKOV](terraform_checkov.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/bridgecrewio/checkov)](https://github.com/bridgecrewio/checkov/commits) | -| [kics](terraform_kics.md) | [TERRAFORM_KICS](terraform_kics.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/checkmarx/kics)](https://github.com/checkmarx/kics/commits) | +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | +| [tflint](terraform_tflint.md) | [TERRAFORM_TFLINT](terraform_tflint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/terraform-linters/tflint)](https://github.com/terraform-linters/tflint/commits) | +| [terrascan](terraform_terrascan.md) | [TERRAFORM_TERRASCAN](terraform_terrascan.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/accurics/terrascan)](https://github.com/accurics/terrascan/commits) | +| [terragrunt](terraform_terragrunt.md) | [TERRAFORM_TERRAGRUNT](terraform_terragrunt.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/gruntwork-io/terragrunt)](https://github.com/gruntwork-io/terragrunt/commits) | +| [terraform-fmt](terraform_terraform_fmt.md) | [TERRAFORM_TERRAFORM_FMT](terraform_terraform_fmt.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/hashicorp/terraform)](https://github.com/hashicorp/terraform/commits) | +| [checkov](terraform_checkov.md) | [TERRAFORM_CHECKOV](terraform_checkov.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/bridgecrewio/checkov)](https://github.com/bridgecrewio/checkov/commits) | +| [kics](terraform_kics.md) | [TERRAFORM_KICS](terraform_kics.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/checkmarx/kics)](https://github.com/checkmarx/kics/commits) | ## Linted files @@ -21,8 +21,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|--------------------------------|-------------------------------|---------------| -| TERRAFORM_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| TERRAFORM_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| TERRAFORM_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| TERRAFORM_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/terraform_checkov.md b/docs/descriptors/terraform_checkov.md index 774cf06136c..c8817764f62 100644 --- a/docs/descriptors/terraform_checkov.md +++ b/docs/descriptors/terraform_checkov.md @@ -11,7 +11,7 @@ ## checkov documentation -- Version in MegaLinter: **2.1.43** +- Version in MegaLinter: **2.1.44** - Visit [Official Web Site](https://www.checkov.io/){target=_blank} - See [How to disable checkov rules in files](https://www.checkov.io/2.Basics/Suppressing%20and%20Skipping%20Policies.html){target=_blank} - See [Index of problems detected by checkov](https://www.checkov.io/5.Policy%20Index/all.html){target=_blank} @@ -23,36 +23,36 @@ - Enable checkov by adding `TERRAFORM_CHECKOV` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable checkov by adding `TERRAFORM_CHECKOV` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| TERRAFORM_CHECKOV_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| TERRAFORM_CHECKOV_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| TERRAFORM_CHECKOV_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| TERRAFORM_CHECKOV_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| TERRAFORM_CHECKOV_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".tf"]` | -| TERRAFORM_CHECKOV_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| TERRAFORM_CHECKOV_PRE_COMMANDS | List of bash commands to run before the linter | None | -| TERRAFORM_CHECKOV_POST_COMMANDS | List of bash commands to run after the linter | None | -| TERRAFORM_CHECKOV_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| TERRAFORM_CHECKOV_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| TERRAFORM_CHECKOV_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| TERRAFORM_CHECKOV_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| TERRAFORM_CHECKOV_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| TERRAFORM_CHECKOV_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| TERRAFORM_CHECKOV_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".tf"]` | +| TERRAFORM_CHECKOV_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| TERRAFORM_CHECKOV_PRE_COMMANDS | List of bash commands to run before the linter| None | +| TERRAFORM_CHECKOV_POST_COMMANDS | List of bash commands to run after the linter| None | +| TERRAFORM_CHECKOV_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| TERRAFORM_CHECKOV_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use checkov in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-----------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Visual Studio Code](https://code.visualstudio.com/) | [Checkov](https://marketplace.visualstudio.com/items?itemName=Bridgecrew.checkov) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/Bridgecrew.checkov){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------|:---------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/terraform_kics.md b/docs/descriptors/terraform_kics.md index 5d82d69489e..23ab9d2d496 100644 --- a/docs/descriptors/terraform_kics.md +++ b/docs/descriptors/terraform_kics.md @@ -23,28 +23,28 @@ - Enable kics by adding `TERRAFORM_KICS` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable kics by adding `TERRAFORM_KICS` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| TERRAFORM_KICS_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| TERRAFORM_KICS_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| TERRAFORM_KICS_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| TERRAFORM_KICS_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| TERRAFORM_KICS_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".tf"]` | -| TERRAFORM_KICS_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| TERRAFORM_KICS_PRE_COMMANDS | List of bash commands to run before the linter | None | -| TERRAFORM_KICS_POST_COMMANDS | List of bash commands to run after the linter | None | -| TERRAFORM_KICS_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| TERRAFORM_KICS_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| TERRAFORM_KICS_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| TERRAFORM_KICS_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| TERRAFORM_KICS_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| TERRAFORM_KICS_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| TERRAFORM_KICS_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".tf"]` | +| TERRAFORM_KICS_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| TERRAFORM_KICS_PRE_COMMANDS | List of bash commands to run before the linter| None | +| TERRAFORM_KICS_POST_COMMANDS | List of bash commands to run after the linter| None | +| TERRAFORM_KICS_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| TERRAFORM_KICS_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------|:---------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/terraform_terraform_fmt.md b/docs/descriptors/terraform_terraform_fmt.md index aa6ce351955..e731c04baf3 100644 --- a/docs/descriptors/terraform_terraform_fmt.md +++ b/docs/descriptors/terraform_terraform_fmt.md @@ -23,38 +23,38 @@ - Enable **auto-fixes** by adding `TERRAFORM_TERRAFORM_FMT` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|-----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| TERRAFORM_TERRAFORM_FMT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| TERRAFORM_TERRAFORM_FMT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| TERRAFORM_TERRAFORM_FMT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| TERRAFORM_TERRAFORM_FMT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| TERRAFORM_TERRAFORM_FMT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".tf"]` | -| TERRAFORM_TERRAFORM_FMT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| TERRAFORM_TERRAFORM_FMT_POST_COMMANDS | List of bash commands to run after the linter | None | -| TERRAFORM_TERRAFORM_FMT_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | -| TERRAFORM_TERRAFORM_FMT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| TERRAFORM_TERRAFORM_FMT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| TERRAFORM_TERRAFORM_FMT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| TERRAFORM_TERRAFORM_FMT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| TERRAFORM_TERRAFORM_FMT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| TERRAFORM_TERRAFORM_FMT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".tf"]` | +| TERRAFORM_TERRAFORM_FMT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| TERRAFORM_TERRAFORM_FMT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| TERRAFORM_TERRAFORM_FMT_POST_COMMANDS | List of bash commands to run after the linter| None | +| TERRAFORM_TERRAFORM_FMT_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| TERRAFORM_TERRAFORM_FMT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use terraform-fmt in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [terraform-fmt](https://atom.io/packages/terraform-fmt) | [Visit Web Site](https://atom.io/packages/terraform-fmt){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [HashiCorp Terraform / HCL language support](https://plugins.jetbrains.com/plugin/7808-hashicorp-terraform--hcl-language-support) | | -| | [Sublime Text](https://www.sublimetext.com/) | [Terrafmt](https://packagecontrol.io/packages/Terrafmt) | [Visit Web Site](https://packagecontrol.io/packages/Terrafmt){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [HashiCorp Terraform](https://marketplace.visualstudio.com/items?itemName=HashiCorp.terraform) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/HashiCorp.terraform){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [terraform-fmt](https://atom.io/packages/terraform-fmt) | [Visit Web Site](https://atom.io/packages/terraform-fmt){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [HashiCorp Terraform / HCL language support](https://plugins.jetbrains.com/plugin/7808-hashicorp-terraform--hcl-language-support) | | +| | [Sublime Text](https://www.sublimetext.com/) | [Terrafmt](https://packagecontrol.io/packages/Terrafmt) | [Visit Web Site](https://packagecontrol.io/packages/Terrafmt){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [HashiCorp Terraform](https://marketplace.visualstudio.com/items?itemName=HashiCorp.terraform) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/HashiCorp.terraform){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------|:---------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/terraform_terragrunt.md b/docs/descriptors/terraform_terragrunt.md index 03de62cc567..d85b521d262 100644 --- a/docs/descriptors/terraform_terragrunt.md +++ b/docs/descriptors/terraform_terragrunt.md @@ -17,30 +17,30 @@ - Enable **auto-fixes** by adding `TERRAFORM_TERRAGRUNT` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| TERRAFORM_TERRAGRUNT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| TERRAFORM_TERRAGRUNT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| TERRAFORM_TERRAGRUNT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| TERRAFORM_TERRAGRUNT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| TERRAFORM_TERRAGRUNT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".hcl"]` | -| TERRAFORM_TERRAGRUNT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| TERRAFORM_TERRAGRUNT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| TERRAFORM_TERRAGRUNT_POST_COMMANDS | List of bash commands to run after the linter | None | -| TERRAFORM_TERRAGRUNT_CONFIG_FILE | terragrunt configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `terragrunt.hcl` | -| TERRAFORM_TERRAGRUNT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| TERRAFORM_TERRAGRUNT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| TERRAFORM_TERRAGRUNT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| TERRAFORM_TERRAGRUNT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| TERRAFORM_TERRAGRUNT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| TERRAFORM_TERRAGRUNT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| TERRAFORM_TERRAGRUNT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| TERRAFORM_TERRAGRUNT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".hcl"]` | +| TERRAFORM_TERRAGRUNT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| TERRAFORM_TERRAGRUNT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| TERRAFORM_TERRAGRUNT_POST_COMMANDS | List of bash commands to run after the linter| None | +| TERRAFORM_TERRAGRUNT_CONFIG_FILE | terragrunt configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `terragrunt.hcl` | +| TERRAFORM_TERRAGRUNT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| TERRAFORM_TERRAGRUNT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| TERRAFORM_TERRAGRUNT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------|:---------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/terraform_terrascan.md b/docs/descriptors/terraform_terrascan.md index 95aa91cae86..3ff0baadd19 100644 --- a/docs/descriptors/terraform_terrascan.md +++ b/docs/descriptors/terraform_terrascan.md @@ -23,27 +23,27 @@ - Enable terrascan by adding `TERRAFORM_TERRASCAN` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable terrascan by adding `TERRAFORM_TERRASCAN` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| TERRAFORM_TERRASCAN_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| TERRAFORM_TERRASCAN_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".tf"]` | -| TERRAFORM_TERRASCAN_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| TERRAFORM_TERRASCAN_PRE_COMMANDS | List of bash commands to run before the linter | None | -| TERRAFORM_TERRASCAN_POST_COMMANDS | List of bash commands to run after the linter | None | -| TERRAFORM_TERRASCAN_CONFIG_FILE | terrascan configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `terrascan-config.toml` | -| TERRAFORM_TERRASCAN_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| TERRAFORM_TERRASCAN_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| TERRAFORM_TERRASCAN_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| TERRAFORM_TERRASCAN_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| TERRAFORM_TERRASCAN_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".tf"]` | +| TERRAFORM_TERRASCAN_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| TERRAFORM_TERRASCAN_PRE_COMMANDS | List of bash commands to run before the linter| None | +| TERRAFORM_TERRASCAN_POST_COMMANDS | List of bash commands to run after the linter| None | +| TERRAFORM_TERRASCAN_CONFIG_FILE | terrascan configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `terrascan-config.toml` | +| TERRAFORM_TERRASCAN_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| TERRAFORM_TERRASCAN_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| TERRAFORM_TERRASCAN_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------|:---------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/terraform_tflint.md b/docs/descriptors/terraform_tflint.md index 307a9dbb16f..2319410e40a 100644 --- a/docs/descriptors/terraform_tflint.md +++ b/docs/descriptors/terraform_tflint.md @@ -18,30 +18,30 @@ - Enable tflint by adding `TERRAFORM_TFLINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable tflint by adding `TERRAFORM_TFLINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| TERRAFORM_TFLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| TERRAFORM_TFLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| TERRAFORM_TFLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| TERRAFORM_TFLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| TERRAFORM_TFLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".tf"]` | -| TERRAFORM_TFLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| TERRAFORM_TFLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| TERRAFORM_TFLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| TERRAFORM_TFLINT_CONFIG_FILE | tflint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.tflint.hcl` | -| TERRAFORM_TFLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| TERRAFORM_TFLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| TERRAFORM_TFLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| TERRAFORM_TFLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| TERRAFORM_TFLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| TERRAFORM_TFLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| TERRAFORM_TFLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| TERRAFORM_TFLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".tf"]` | +| TERRAFORM_TFLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| TERRAFORM_TFLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| TERRAFORM_TFLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| TERRAFORM_TFLINT_CONFIG_FILE | tflint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.tflint.hcl` | +| TERRAFORM_TFLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| TERRAFORM_TFLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| TERRAFORM_TFLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------|:---------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [security](https://oxsecurity.github.io/megalinter/latest/flavors/security/) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/tsx.md b/docs/descriptors/tsx.md index afee467099b..9c21209c0be 100644 --- a/docs/descriptors/tsx.md +++ b/docs/descriptors/tsx.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|-------------------------|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [eslint](tsx_eslint.md) | [TSX](tsx_eslint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/yannickcr/eslint-plugin-react)](https://github.com/yannickcr/eslint-plugin-react/commits) | ## Linted files @@ -16,8 +16,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|--------------------------|-------------------------------|---------------| -| TSX_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| TSX_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| TSX_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| TSX_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/tsx_eslint.md b/docs/descriptors/tsx_eslint.md index f8b5d782b76..7dc441a7a0f 100644 --- a/docs/descriptors/tsx_eslint.md +++ b/docs/descriptors/tsx_eslint.md @@ -30,45 +30,45 @@ You can create it by typing `npx eslint --init` in the root of your repository - Enable **auto-fixes** by adding `TSX_ESLINT` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| TSX_ESLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| TSX_ESLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| TSX_ESLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| TSX_ESLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| TSX_ESLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".tsx"]` | -| TSX_ESLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| TSX_ESLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| TSX_ESLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| TSX_ESLINT_CONFIG_FILE | eslint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.eslintrc.json` | -| TSX_ESLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| TSX_ESLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| TSX_ESLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| TSX_ESLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| TSX_ESLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| TSX_ESLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| TSX_ESLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| TSX_ESLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".tsx"]` | +| TSX_ESLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| TSX_ESLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| TSX_ESLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| TSX_ESLINT_CONFIG_FILE | eslint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.eslintrc.json` | +| TSX_ESLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| TSX_ESLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| TSX_ESLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use eslint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:---------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-eslint](https://atom.io/packages/linter-eslint) | [Visit Web Site](https://atom.io/packages/linter-eslint){target=_blank} | -| | [Brackets](http://brackets.io/) | [brackets-eslint](https://github.com/brackets-userland/brackets-eslint) | [Visit Web Site](https://github.com/brackets-userland/brackets-eslint){target=_blank} | -| | [Eclipse](https://www.eclipse.org/) | [Tern-Linter-ESLint](https://github.com/angelozerr/tern.java/wiki/Tern-Linter-ESLint) | [Visit Web Site](https://github.com/angelozerr/tern.java/wiki/Tern-Linter-ESLint){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](http://www.flycheck.org/en/latest/languages.html#javascript) | [Visit Web Site](http://www.flycheck.org/en/latest/languages.html#javascript){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [ESLint Plugin](https://plugins.jetbrains.com/plugin/7494-eslint) | | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-eslint](https://github.com/roadhump/SublimeLinter-eslint) | [Visit Web Site](https://github.com/roadhump/SublimeLinter-eslint){target=_blank} | -| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | -| | [vim](https://www.vim.org/) | [Syntastic](https://github.com/vim-syntastic/syntastic/tree/master/syntax_checkers/javascript) | [Visit Web Site](https://github.com/vim-syntastic/syntastic/tree/master/syntax_checkers/javascript){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/dbaeumer.vscode-eslint){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-eslint](https://atom.io/packages/linter-eslint) | [Visit Web Site](https://atom.io/packages/linter-eslint){target=_blank} | +| | [Brackets](http://brackets.io/) | [brackets-eslint](https://github.com/brackets-userland/brackets-eslint) | [Visit Web Site](https://github.com/brackets-userland/brackets-eslint){target=_blank} | +| | [Eclipse](https://www.eclipse.org/) | [Tern-Linter-ESLint](https://github.com/angelozerr/tern.java/wiki/Tern-Linter-ESLint) | [Visit Web Site](https://github.com/angelozerr/tern.java/wiki/Tern-Linter-ESLint){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](http://www.flycheck.org/en/latest/languages.html#javascript) | [Visit Web Site](http://www.flycheck.org/en/latest/languages.html#javascript){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [ESLint Plugin](https://plugins.jetbrains.com/plugin/7494-eslint) | | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-eslint](https://github.com/roadhump/SublimeLinter-eslint) | [Visit Web Site](https://github.com/roadhump/SublimeLinter-eslint){target=_blank} | +| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | +| | [vim](https://www.vim.org/) | [Syntastic](https://github.com/vim-syntastic/syntastic/tree/master/syntax_checkers/javascript) | [Visit Web Site](https://github.com/vim-syntastic/syntastic/tree/master/syntax_checkers/javascript){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/dbaeumer.vscode-eslint){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | ## Behind the scenes diff --git a/docs/descriptors/typescript.md b/docs/descriptors/typescript.md index 792ecda2a32..e52e387fd4e 100644 --- a/docs/descriptors/typescript.md +++ b/docs/descriptors/typescript.md @@ -5,11 +5,11 @@ ## Linters -| Linter | Configuration key | Status | -|------------------------------------|-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------| -| [eslint](typescript_eslint.md) | [TYPESCRIPT_ES](typescript_eslint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/eslint/eslint)](https://github.com/eslint/eslint/commits) | +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | +| [eslint](typescript_eslint.md) | [TYPESCRIPT_ES](typescript_eslint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/eslint/eslint)](https://github.com/eslint/eslint/commits) | | [standard](typescript_standard.md) | [TYPESCRIPT_STANDARD](typescript_standard.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/standard/standard)](https://github.com/standard/standard/commits) | -| [prettier](typescript_prettier.md) | [TYPESCRIPT](typescript_prettier.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/prettier/prettier)](https://github.com/prettier/prettier/commits) | +| [prettier](typescript_prettier.md) | [TYPESCRIPT](typescript_prettier.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/prettier/prettier)](https://github.com/prettier/prettier/commits) | ## Linted files @@ -18,10 +18,10 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|---------------------------------|-------------------------------|---------------| -| TYPESCRIPT_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| TYPESCRIPT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| TYPESCRIPT_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| TYPESCRIPT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | ## Behind the scenes diff --git a/docs/descriptors/typescript_eslint.md b/docs/descriptors/typescript_eslint.md index c631af592f5..77710b00581 100644 --- a/docs/descriptors/typescript_eslint.md +++ b/docs/descriptors/typescript_eslint.md @@ -30,45 +30,45 @@ You can create it by typing `npx eslint --init` in the root of your repository - Enable **auto-fixes** by adding `TYPESCRIPT_ES` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| TYPESCRIPT_ES_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| TYPESCRIPT_ES_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| TYPESCRIPT_ES_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| TYPESCRIPT_ES_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| TYPESCRIPT_ES_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".ts"]` | -| TYPESCRIPT_ES_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| TYPESCRIPT_ES_PRE_COMMANDS | List of bash commands to run before the linter | None | -| TYPESCRIPT_ES_POST_COMMANDS | List of bash commands to run after the linter | None | -| TYPESCRIPT_ES_CONFIG_FILE | eslint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.eslintrc.json` | -| TYPESCRIPT_ES_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| TYPESCRIPT_ES_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| TYPESCRIPT_ES_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| TYPESCRIPT_ES_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| TYPESCRIPT_ES_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| TYPESCRIPT_ES_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| TYPESCRIPT_ES_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| TYPESCRIPT_ES_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".ts"]` | +| TYPESCRIPT_ES_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| TYPESCRIPT_ES_PRE_COMMANDS | List of bash commands to run before the linter| None | +| TYPESCRIPT_ES_POST_COMMANDS | List of bash commands to run after the linter| None | +| TYPESCRIPT_ES_CONFIG_FILE | eslint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.eslintrc.json` | +| TYPESCRIPT_ES_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| TYPESCRIPT_ES_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| TYPESCRIPT_ES_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use eslint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:---------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-eslint](https://atom.io/packages/linter-eslint) | [Visit Web Site](https://atom.io/packages/linter-eslint){target=_blank} | -| | [Brackets](http://brackets.io/) | [brackets-eslint](https://github.com/brackets-userland/brackets-eslint) | [Visit Web Site](https://github.com/brackets-userland/brackets-eslint){target=_blank} | -| | [Eclipse](https://www.eclipse.org/) | [Tern-Linter-ESLint](https://github.com/angelozerr/tern.java/wiki/Tern-Linter-ESLint) | [Visit Web Site](https://github.com/angelozerr/tern.java/wiki/Tern-Linter-ESLint){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](http://www.flycheck.org/en/latest/languages.html#javascript) | [Visit Web Site](http://www.flycheck.org/en/latest/languages.html#javascript){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [ESLint Plugin](https://plugins.jetbrains.com/plugin/7494-eslint) | | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-eslint](https://github.com/roadhump/SublimeLinter-eslint) | [Visit Web Site](https://github.com/roadhump/SublimeLinter-eslint){target=_blank} | -| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | -| | [vim](https://www.vim.org/) | [Syntastic](https://github.com/vim-syntastic/syntastic/tree/master/syntax_checkers/javascript) | [Visit Web Site](https://github.com/vim-syntastic/syntastic/tree/master/syntax_checkers/javascript){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/dbaeumer.vscode-eslint){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-eslint](https://atom.io/packages/linter-eslint) | [Visit Web Site](https://atom.io/packages/linter-eslint){target=_blank} | +| | [Brackets](http://brackets.io/) | [brackets-eslint](https://github.com/brackets-userland/brackets-eslint) | [Visit Web Site](https://github.com/brackets-userland/brackets-eslint){target=_blank} | +| | [Eclipse](https://www.eclipse.org/) | [Tern-Linter-ESLint](https://github.com/angelozerr/tern.java/wiki/Tern-Linter-ESLint) | [Visit Web Site](https://github.com/angelozerr/tern.java/wiki/Tern-Linter-ESLint){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](http://www.flycheck.org/en/latest/languages.html#javascript) | [Visit Web Site](http://www.flycheck.org/en/latest/languages.html#javascript){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [ESLint Plugin](https://plugins.jetbrains.com/plugin/7494-eslint) | | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-eslint](https://github.com/roadhump/SublimeLinter-eslint) | [Visit Web Site](https://github.com/roadhump/SublimeLinter-eslint){target=_blank} | +| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | +| | [vim](https://www.vim.org/) | [Syntastic](https://github.com/vim-syntastic/syntastic/tree/master/syntax_checkers/javascript) | [Visit Web Site](https://github.com/vim-syntastic/syntastic/tree/master/syntax_checkers/javascript){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/dbaeumer.vscode-eslint){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | ## Behind the scenes diff --git a/docs/descriptors/typescript_prettier.md b/docs/descriptors/typescript_prettier.md index b5db4cd99f4..37a4795db41 100644 --- a/docs/descriptors/typescript_prettier.md +++ b/docs/descriptors/typescript_prettier.md @@ -26,48 +26,48 @@ - Enable **auto-fixes** by adding `TYPESCRIPT_PRETTIER` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|-------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| TYPESCRIPT_DEFAULT_STYLE | For prettier to be active, TYPESCRIPT_DEFAULT_STYLE must be `prettier` | `standard` | -| TYPESCRIPT_PRETTIER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| TYPESCRIPT_PRETTIER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| TYPESCRIPT_PRETTIER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| TYPESCRIPT_PRETTIER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| TYPESCRIPT_PRETTIER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".ts"]` | -| TYPESCRIPT_PRETTIER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| TYPESCRIPT_PRETTIER_PRE_COMMANDS | List of bash commands to run before the linter | None | -| TYPESCRIPT_PRETTIER_POST_COMMANDS | List of bash commands to run after the linter | None | -| TYPESCRIPT_PRETTIER_CONFIG_FILE | prettier configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.prettierrc.json` | -| TYPESCRIPT_PRETTIER_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| TYPESCRIPT_PRETTIER_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | -| TYPESCRIPT_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| TYPESCRIPT_DEFAULT_STYLE | For prettier to be active, TYPESCRIPT_DEFAULT_STYLE must be `prettier` | `standard` | +| TYPESCRIPT_PRETTIER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| TYPESCRIPT_PRETTIER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| TYPESCRIPT_PRETTIER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| TYPESCRIPT_PRETTIER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| TYPESCRIPT_PRETTIER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".ts"]` | +| TYPESCRIPT_PRETTIER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| TYPESCRIPT_PRETTIER_PRE_COMMANDS | List of bash commands to run before the linter| None | +| TYPESCRIPT_PRETTIER_POST_COMMANDS | List of bash commands to run after the linter| None | +| TYPESCRIPT_PRETTIER_CONFIG_FILE | prettier configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.prettierrc.json` | +| TYPESCRIPT_PRETTIER_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| TYPESCRIPT_PRETTIER_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| TYPESCRIPT_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use prettier in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|-----------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [prettier-atom](https://github.com/prettier/prettier-atom) | [Visit Web Site](https://github.com/prettier/prettier-atom){target=_blank} | -| | [Atom](https://atom.io/) | [atom-mprettier](https://github.com/t9md/atom-mprettier) | [Visit Web Site](https://github.com/t9md/atom-mprettier){target=_blank} | -| | [Atom](https://atom.io/) | [atom-miniprettier](https://github.com/duailibe/atom-miniprettier) | [Visit Web Site](https://github.com/duailibe/atom-miniprettier){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [prettier-emacs](https://github.com/prettier/prettier-emacs) | [Visit Web Site](https://github.com/prettier/prettier-emacs){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [prettier.el](https://github.com/jscheid/prettier.el) | [Visit Web Site](https://github.com/jscheid/prettier.el){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [apheleia](https://github.com/raxod502/apheleia) | [Visit Web Site](https://github.com/raxod502/apheleia){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [native support](https://prettier.io/docs/en/webstorm.html) | [Visit Web Site](https://prettier.io/docs/en/webstorm.html){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [JsPrettier](https://packagecontrol.io/packages/JsPrettier) | [Visit Web Site](https://packagecontrol.io/packages/JsPrettier){target=_blank} | -| | [vim](https://www.vim.org/) | [vim-prettier](https://github.com/prettier/vim-prettier) | [Visit Web Site](https://github.com/prettier/vim-prettier){target=_blank} | -| | visual_studio | [JavaScriptPrettier](https://github.com/madskristensen/JavaScriptPrettier) | [Visit Web Site](https://github.com/madskristensen/JavaScriptPrettier){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [prettier-vscode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/esbenp.prettier-vscode){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [prettier-atom](https://github.com/prettier/prettier-atom) | [Visit Web Site](https://github.com/prettier/prettier-atom){target=_blank} | +| | [Atom](https://atom.io/) | [atom-mprettier](https://github.com/t9md/atom-mprettier) | [Visit Web Site](https://github.com/t9md/atom-mprettier){target=_blank} | +| | [Atom](https://atom.io/) | [atom-miniprettier](https://github.com/duailibe/atom-miniprettier) | [Visit Web Site](https://github.com/duailibe/atom-miniprettier){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [prettier-emacs](https://github.com/prettier/prettier-emacs) | [Visit Web Site](https://github.com/prettier/prettier-emacs){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [prettier.el](https://github.com/jscheid/prettier.el) | [Visit Web Site](https://github.com/jscheid/prettier.el){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [apheleia](https://github.com/raxod502/apheleia) | [Visit Web Site](https://github.com/raxod502/apheleia){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [native support](https://prettier.io/docs/en/webstorm.html) | [Visit Web Site](https://prettier.io/docs/en/webstorm.html){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [JsPrettier](https://packagecontrol.io/packages/JsPrettier) | [Visit Web Site](https://packagecontrol.io/packages/JsPrettier){target=_blank} | +| | [vim](https://www.vim.org/) | [vim-prettier](https://github.com/prettier/vim-prettier) | [Visit Web Site](https://github.com/prettier/vim-prettier){target=_blank} | +| | visual_studio | [JavaScriptPrettier](https://github.com/madskristensen/JavaScriptPrettier) | [Visit Web Site](https://github.com/madskristensen/JavaScriptPrettier){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [prettier-vscode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/esbenp.prettier-vscode){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | ## Behind the scenes diff --git a/docs/descriptors/typescript_standard.md b/docs/descriptors/typescript_standard.md index d2a66ac85f6..ad516e7a021 100644 --- a/docs/descriptors/typescript_standard.md +++ b/docs/descriptors/typescript_standard.md @@ -24,43 +24,43 @@ - Enable **auto-fixes** by adding `TYPESCRIPT_STANDARD` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|-------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| JAVASCRIPT_DEFAULT_STYLE | For standard to be active, JAVASCRIPT_DEFAULT_STYLE must be `standard` | `standard` | -| TYPESCRIPT_STANDARD_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| TYPESCRIPT_STANDARD_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| TYPESCRIPT_STANDARD_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| TYPESCRIPT_STANDARD_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| TYPESCRIPT_STANDARD_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".ts"]` | -| TYPESCRIPT_STANDARD_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| TYPESCRIPT_STANDARD_PRE_COMMANDS | List of bash commands to run before the linter | None | -| TYPESCRIPT_STANDARD_POST_COMMANDS | List of bash commands to run after the linter | None | -| TYPESCRIPT_STANDARD_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| TYPESCRIPT_STANDARD_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| JAVASCRIPT_DEFAULT_STYLE | For standard to be active, JAVASCRIPT_DEFAULT_STYLE must be `standard` | `standard` | +| TYPESCRIPT_STANDARD_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| TYPESCRIPT_STANDARD_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| TYPESCRIPT_STANDARD_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| TYPESCRIPT_STANDARD_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| TYPESCRIPT_STANDARD_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".ts"]` | +| TYPESCRIPT_STANDARD_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| TYPESCRIPT_STANDARD_PRE_COMMANDS | List of bash commands to run before the linter| None | +| TYPESCRIPT_STANDARD_POST_COMMANDS | List of bash commands to run after the linter| None | +| TYPESCRIPT_STANDARD_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| TYPESCRIPT_STANDARD_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use standard in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:---------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|-----------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [linter-js-standard](https://atom.io/packages/linter-js-standard) | [Visit Web Site](https://atom.io/packages/linter-js-standard){target=_blank} | -| | [Atom](https://atom.io/) | [linter-js-standard-engine](https://atom.io/packages/linter-js-standard-engine) | [Visit Web Site](https://atom.io/packages/linter-js-standard-engine){target=_blank} | -| | [Atom](https://atom.io/) | [standard-formatter](https://atom.io/packages/standard-formatter) | [Visit Web Site](https://atom.io/packages/standard-formatter){target=_blank} | -| | [Brackets](http://brackets.io/) | [brackets-standard](https://github.com/ishamf/brackets-standard/) | [Visit Web Site](https://github.com/ishamf/brackets-standard/){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [native support](https://blog.jetbrains.com/webstorm/2017/01/webstorm-2017-1-eap-171-2272/) | [Visit Web Site](https://blog.jetbrains.com/webstorm/2017/01/webstorm-2017-1-eap-171-2272/){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-standard](https://packagecontrol.io/packages/SublimeLinter-contrib-standard) | [Visit Web Site](https://packagecontrol.io/packages/SublimeLinter-contrib-standard){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [StandardFormat](https://packagecontrol.io/packages/StandardFormat) | [Visit Web Site](https://packagecontrol.io/packages/StandardFormat){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [https://marketplace.visualstudio.com/items?itemName=chenxsan.vscode-standardjs](vscode-standardjs) | [Visit Web Site](vscode-standardjs){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [linter-js-standard](https://atom.io/packages/linter-js-standard) | [Visit Web Site](https://atom.io/packages/linter-js-standard){target=_blank} | +| | [Atom](https://atom.io/) | [linter-js-standard-engine](https://atom.io/packages/linter-js-standard-engine) | [Visit Web Site](https://atom.io/packages/linter-js-standard-engine){target=_blank} | +| | [Atom](https://atom.io/) | [standard-formatter](https://atom.io/packages/standard-formatter) | [Visit Web Site](https://atom.io/packages/standard-formatter){target=_blank} | +| | [Brackets](http://brackets.io/) | [brackets-standard](https://github.com/ishamf/brackets-standard/) | [Visit Web Site](https://github.com/ishamf/brackets-standard/){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [native support](https://blog.jetbrains.com/webstorm/2017/01/webstorm-2017-1-eap-171-2272/) | [Visit Web Site](https://blog.jetbrains.com/webstorm/2017/01/webstorm-2017-1-eap-171-2272/){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [SublimeLinter-contrib-standard](https://packagecontrol.io/packages/SublimeLinter-contrib-standard) | [Visit Web Site](https://packagecontrol.io/packages/SublimeLinter-contrib-standard){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [StandardFormat](https://packagecontrol.io/packages/StandardFormat) | [Visit Web Site](https://packagecontrol.io/packages/StandardFormat){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [https://marketplace.visualstudio.com/items?itemName=chenxsan.vscode-standardjs](vscode-standardjs) | [Visit Web Site](vscode-standardjs){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------|:------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | ## Behind the scenes diff --git a/docs/descriptors/vbdotnet.md b/docs/descriptors/vbdotnet.md index 9f45813c915..b3738d240f7 100644 --- a/docs/descriptors/vbdotnet.md +++ b/docs/descriptors/vbdotnet.md @@ -5,8 +5,8 @@ ## Linters -| Linter | Configuration key | Status | -|--------------------------------------------|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | | [dotnet-format](vbdotnet_dotnet_format.md) | [VBDOTNET](vbdotnet_dotnet_format.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/dotnet/format)](https://github.com/dotnet/format/commits) | ## Linted files @@ -16,10 +16,10 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|-------------------------------|-------------------------------|---------------| -| VBDOTNET_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| VBDOTNET_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| VBDOTNET_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| VBDOTNET_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | ## Behind the scenes diff --git a/docs/descriptors/vbdotnet_dotnet_format.md b/docs/descriptors/vbdotnet_dotnet_format.md index af5acdaccf9..1053b84786a 100644 --- a/docs/descriptors/vbdotnet_dotnet_format.md +++ b/docs/descriptors/vbdotnet_dotnet_format.md @@ -16,27 +16,27 @@ - Enable **auto-fixes** by adding `VBDOTNET_DOTNET_FORMAT` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| VBDOTNET_DOTNET_FORMAT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| VBDOTNET_DOTNET_FORMAT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| VBDOTNET_DOTNET_FORMAT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| VBDOTNET_DOTNET_FORMAT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | -| VBDOTNET_DOTNET_FORMAT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".vb"]` | -| VBDOTNET_DOTNET_FORMAT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| VBDOTNET_DOTNET_FORMAT_POST_COMMANDS | List of bash commands to run after the linter | None | -| VBDOTNET_DOTNET_FORMAT_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | -| VBDOTNET_DOTNET_FORMAT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| VBDOTNET_DOTNET_FORMAT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| VBDOTNET_DOTNET_FORMAT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| VBDOTNET_DOTNET_FORMAT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| VBDOTNET_DOTNET_FORMAT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `file` | +| VBDOTNET_DOTNET_FORMAT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".vb"]` | +| VBDOTNET_DOTNET_FORMAT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| VBDOTNET_DOTNET_FORMAT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| VBDOTNET_DOTNET_FORMAT_POST_COMMANDS | List of bash commands to run after the linter| None | +| VBDOTNET_DOTNET_FORMAT_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| VBDOTNET_DOTNET_FORMAT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:----------------------------------------------|:----------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | ## Behind the scenes diff --git a/docs/descriptors/xml.md b/docs/descriptors/xml.md index 42593bf9f60..accc6462d8c 100644 --- a/docs/descriptors/xml.md +++ b/docs/descriptors/xml.md @@ -5,9 +5,9 @@ ## Linters -| Linter | Configuration key | Status | -|---------------------------|-----------------------|--------| -| [xmllint](xml_xmllint.md) | [XML](xml_xmllint.md) | | +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | +| [xmllint](xml_xmllint.md) | [XML](xml_xmllint.md) | | ## Linted files @@ -16,8 +16,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|--------------------------|-------------------------------|---------------| -| XML_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| XML_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| XML_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| XML_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/xml_xmllint.md b/docs/descriptors/xml_xmllint.md index ea94a0dd205..4f62b3451ca 100644 --- a/docs/descriptors/xml_xmllint.md +++ b/docs/descriptors/xml_xmllint.md @@ -13,39 +13,39 @@ - Enable xmllint by adding `XML_XMLLINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable xmllint by adding `XML_XMLLINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| -| XML_XMLLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| XML_XMLLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| XML_XMLLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| XML_XMLLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| XML_XMLLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".xml"]` | -| XML_XMLLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| XML_XMLLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| XML_XMLLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| XML_XMLLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| XML_XMLLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| XML_XMLLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| XML_XMLLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| XML_XMLLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| XML_XMLLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| XML_XMLLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".xml"]` | +| XML_XMLLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| XML_XMLLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| XML_XMLLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| XML_XMLLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| XML_XMLLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/yaml.md b/docs/descriptors/yaml.md index e024083136e..ca27705ea4b 100644 --- a/docs/descriptors/yaml.md +++ b/docs/descriptors/yaml.md @@ -5,11 +5,11 @@ ## Linters -| Linter | Configuration key | Status | -|------------------------------|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------| -| [prettier](yaml_prettier.md) | [YAML](yaml_prettier.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/prettier/prettier)](https://github.com/prettier/prettier/commits) | +| Linter | Configuration key | Status | +| ------ | ----------------- | ------ | +| [prettier](yaml_prettier.md) | [YAML](yaml_prettier.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/prettier/prettier)](https://github.com/prettier/prettier/commits) | | [yamllint](yaml_yamllint.md) | [YAML](yaml_yamllint.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/adrienverge/yamllint)](https://github.com/adrienverge/yamllint/commits) | -| [v8r](yaml_v8r.md) | [YAML](yaml_v8r.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/chris48s/v8r)](https://github.com/chris48s/v8r/commits) | +| [v8r](yaml_v8r.md) | [YAML](yaml_v8r.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/chris48s/v8r)](https://github.com/chris48s/v8r/commits) | ## Linted files @@ -19,8 +19,8 @@ ## Configuration in MegaLinter -| Variable | Description | Default value | -|---------------------------|-------------------------------|---------------| -| YAML_FILTER_REGEX_INCLUDE | Custom regex including filter | | -| YAML_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| YAML_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| YAML_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/yaml_prettier.md b/docs/descriptors/yaml_prettier.md index 75b0e3411a8..15b9f144c74 100644 --- a/docs/descriptors/yaml_prettier.md +++ b/docs/descriptors/yaml_prettier.md @@ -26,59 +26,59 @@ - Enable **auto-fixes** by adding `YAML_PRETTIER` in [APPLY_FIXES variable](https://oxsecurity.github.io/megalinter/latest/configuration/#apply-fixes) -| Variable | Description | Default value | -|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| YAML_PRETTIER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| YAML_PRETTIER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| YAML_PRETTIER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| YAML_PRETTIER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| YAML_PRETTIER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml"]` | -| YAML_PRETTIER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| YAML_PRETTIER_PRE_COMMANDS | List of bash commands to run before the linter | None | -| YAML_PRETTIER_POST_COMMANDS | List of bash commands to run after the linter | None | -| YAML_PRETTIER_CONFIG_FILE | prettier configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.prettierrc.json` | -| YAML_PRETTIER_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| YAML_PRETTIER_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | -| YAML_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| YAML_PRETTIER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| YAML_PRETTIER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| YAML_PRETTIER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| YAML_PRETTIER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| YAML_PRETTIER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml"]` | +| YAML_PRETTIER_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| YAML_PRETTIER_PRE_COMMANDS | List of bash commands to run before the linter| None | +| YAML_PRETTIER_POST_COMMANDS | List of bash commands to run after the linter| None | +| YAML_PRETTIER_CONFIG_FILE | prettier configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.prettierrc.json` | +| YAML_PRETTIER_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| YAML_PRETTIER_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| YAML_PRETTIER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use prettier in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|-----------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [Atom](https://atom.io/) | [prettier-atom](https://github.com/prettier/prettier-atom) | [Visit Web Site](https://github.com/prettier/prettier-atom){target=_blank} | -| | [Atom](https://atom.io/) | [atom-mprettier](https://github.com/t9md/atom-mprettier) | [Visit Web Site](https://github.com/t9md/atom-mprettier){target=_blank} | -| | [Atom](https://atom.io/) | [atom-miniprettier](https://github.com/duailibe/atom-miniprettier) | [Visit Web Site](https://github.com/duailibe/atom-miniprettier){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [prettier-emacs](https://github.com/prettier/prettier-emacs) | [Visit Web Site](https://github.com/prettier/prettier-emacs){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [prettier.el](https://github.com/jscheid/prettier.el) | [Visit Web Site](https://github.com/jscheid/prettier.el){target=_blank} | -| | [Emacs](https://www.gnu.org/software/emacs/) | [apheleia](https://github.com/raxod502/apheleia) | [Visit Web Site](https://github.com/raxod502/apheleia){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [native support](https://prettier.io/docs/en/webstorm.html) | [Visit Web Site](https://prettier.io/docs/en/webstorm.html){target=_blank} | -| | [Sublime Text](https://www.sublimetext.com/) | [JsPrettier](https://packagecontrol.io/packages/JsPrettier) | [Visit Web Site](https://packagecontrol.io/packages/JsPrettier){target=_blank} | -| | [vim](https://www.vim.org/) | [vim-prettier](https://github.com/prettier/vim-prettier) | [Visit Web Site](https://github.com/prettier/vim-prettier){target=_blank} | -| | visual_studio | [JavaScriptPrettier](https://github.com/madskristensen/JavaScriptPrettier) | [Visit Web Site](https://github.com/madskristensen/JavaScriptPrettier){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [prettier-vscode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/esbenp.prettier-vscode){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Atom](https://atom.io/) | [prettier-atom](https://github.com/prettier/prettier-atom) | [Visit Web Site](https://github.com/prettier/prettier-atom){target=_blank} | +| | [Atom](https://atom.io/) | [atom-mprettier](https://github.com/t9md/atom-mprettier) | [Visit Web Site](https://github.com/t9md/atom-mprettier){target=_blank} | +| | [Atom](https://atom.io/) | [atom-miniprettier](https://github.com/duailibe/atom-miniprettier) | [Visit Web Site](https://github.com/duailibe/atom-miniprettier){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [prettier-emacs](https://github.com/prettier/prettier-emacs) | [Visit Web Site](https://github.com/prettier/prettier-emacs){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [prettier.el](https://github.com/jscheid/prettier.el) | [Visit Web Site](https://github.com/jscheid/prettier.el){target=_blank} | +| | [Emacs](https://www.gnu.org/software/emacs/) | [apheleia](https://github.com/raxod502/apheleia) | [Visit Web Site](https://github.com/raxod502/apheleia){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [native support](https://prettier.io/docs/en/webstorm.html) | [Visit Web Site](https://prettier.io/docs/en/webstorm.html){target=_blank} | +| | [Sublime Text](https://www.sublimetext.com/) | [JsPrettier](https://packagecontrol.io/packages/JsPrettier) | [Visit Web Site](https://packagecontrol.io/packages/JsPrettier){target=_blank} | +| | [vim](https://www.vim.org/) | [vim-prettier](https://github.com/prettier/vim-prettier) | [Visit Web Site](https://github.com/prettier/vim-prettier){target=_blank} | +| | visual_studio | [JavaScriptPrettier](https://github.com/madskristensen/JavaScriptPrettier) | [Visit Web Site](https://github.com/madskristensen/JavaScriptPrettier){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [prettier-vscode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) | [![Install in VsCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/esbenp.prettier-vscode){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/yaml_v8r.md b/docs/descriptors/yaml_v8r.md index b8392ed06e1..11339bed753 100644 --- a/docs/descriptors/yaml_v8r.md +++ b/docs/descriptors/yaml_v8r.md @@ -17,50 +17,50 @@ v8r checks the validity of JSON/YAML files if they have a matching schema define - Enable v8r by adding `YAML_V8R` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable v8r by adding `YAML_V8R` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| -| YAML_V8R_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| YAML_V8R_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| YAML_V8R_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| YAML_V8R_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| YAML_V8R_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml"]` | -| YAML_V8R_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| YAML_V8R_PRE_COMMANDS | List of bash commands to run before the linter | None | -| YAML_V8R_POST_COMMANDS | List of bash commands to run after the linter | None | -| YAML_V8R_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| YAML_V8R_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| YAML_V8R_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| YAML_V8R_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| YAML_V8R_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| YAML_V8R_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| YAML_V8R_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml"]` | +| YAML_V8R_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| YAML_V8R_PRE_COMMANDS | List of bash commands to run before the linter| None | +| YAML_V8R_POST_COMMANDS | List of bash commands to run after the linter| None | +| YAML_V8R_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| YAML_V8R_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use v8r in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:--------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------|----------------------------------------------------------------|:-----------------------------------------------------------------------------:| -| | [Eclipse](https://www.eclipse.org/) | [native support](https://www.eclipse.org/) | [Visit Web Site](https://www.eclipse.org/){target=_blank} | -| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [native support](https://www.jetbrains.com/products/#type=ide) | [Visit Web Site](https://www.jetbrains.com/products/#type=ide){target=_blank} | -| | [vim](https://www.vim.org/) | [vison](https://github.com/Quramy/vison) | [Visit Web Site](https://github.com/Quramy/vison){target=_blank} | -| | [Visual Studio Code](https://code.visualstudio.com/) | [native support](https://code.visualstudio.com/) | [Visit Web Site](https://code.visualstudio.com/){target=_blank} | +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | +| | [Eclipse](https://www.eclipse.org/) | [native support](https://www.eclipse.org/) | [Visit Web Site](https://www.eclipse.org/){target=_blank} | +| | [IDEA](https://www.jetbrains.com/products.html#type=ide) | [native support](https://www.jetbrains.com/products/#type=ide) | [Visit Web Site](https://www.jetbrains.com/products/#type=ide){target=_blank} | +| | [vim](https://www.vim.org/) | [vison](https://github.com/Quramy/vison) | [Visit Web Site](https://github.com/Quramy/vison){target=_blank} | +| | [Visual Studio Code](https://code.visualstudio.com/) | [native support](https://code.visualstudio.com/) | [Visit Web Site](https://code.visualstudio.com/){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/descriptors/yaml_yamllint.md b/docs/descriptors/yaml_yamllint.md index a94f386d220..296375d2bcf 100644 --- a/docs/descriptors/yaml_yamllint.md +++ b/docs/descriptors/yaml_yamllint.md @@ -17,50 +17,50 @@ - Enable yamllint by adding `YAML_YAMLLINT` in [ENABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) - Disable yamllint by adding `YAML_YAMLLINT` in [DISABLE_LINTERS variable](https://oxsecurity.github.io/megalinter/latest/configuration/#activation-and-deactivation) -| Variable | Description | Default value | -|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| -| YAML_YAMLLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| YAML_YAMLLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| YAML_YAMLLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| YAML_YAMLLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | -| YAML_YAMLLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml"]` | -| YAML_YAMLLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | -| YAML_YAMLLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | -| YAML_YAMLLINT_POST_COMMANDS | List of bash commands to run after the linter | None | -| YAML_YAMLLINT_CONFIG_FILE | yamllint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.yamllint.yml` | -| YAML_YAMLLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | -| YAML_YAMLLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | -| YAML_YAMLLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| Variable | Description | Default value | +| ----------------- | -------------- | -------------- | +| YAML_YAMLLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| YAML_YAMLLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| YAML_YAMLLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| YAML_YAMLLINT_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `list_of_files`: Call the linter with the list of files as argument
- `project`: Call the linter from the root of the project | `list_of_files` | +| YAML_YAMLLINT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml"]` | +| YAML_YAMLLINT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file | +| YAML_YAMLLINT_PRE_COMMANDS | List of bash commands to run before the linter| None | +| YAML_YAMLLINT_POST_COMMANDS | List of bash commands to run after the linter| None | +| YAML_YAMLLINT_CONFIG_FILE | yamllint configuration file name
Use `LINTER_DEFAULT` to let the linter find it | `.yamllint.yml` | +| YAML_YAMLLINT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| YAML_YAMLLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| YAML_YAMLLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | ## IDE Integration Use yamllint in your favorite IDE to catch errors before MegaLinter ! -| | IDE | Extension Name | Install | -|:------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------|-------------------------------------------------------------------|:--------------------------------------------------------------------------------------:| +| | IDE | Extension Name | Install | +| :--: | ----------------- | -------------- | :------: | | | [Emacs](https://www.gnu.org/software/emacs/) | [flycheck](https://github.com/krzysztof-magosa/flycheck-yamllint) | [Visit Web Site](https://github.com/krzysztof-magosa/flycheck-yamllint){target=_blank} | -| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | +| | [vim](https://www.vim.org/) | [ale](https://github.com/w0rp/ale) | [Visit Web Site](https://github.com/w0rp/ale){target=_blank} | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](https://oxsecurity.github.io/megalinter/latest/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](https://oxsecurity.github.io/megalinter/latest/flavors/documentation/) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](https://oxsecurity.github.io/megalinter/latest/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](https://oxsecurity.github.io/megalinter/latest/flavors/go/) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](https://oxsecurity.github.io/megalinter/latest/flavors/java/) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](https://oxsecurity.github.io/megalinter/latest/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](https://oxsecurity.github.io/megalinter/latest/flavors/php/) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](https://oxsecurity.github.io/megalinter/latest/flavors/python/) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](https://oxsecurity.github.io/megalinter/latest/flavors/ruby/) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](https://oxsecurity.github.io/megalinter/latest/flavors/rust/) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](https://oxsecurity.github.io/megalinter/latest/flavors/salesforce/) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [swift](https://oxsecurity.github.io/megalinter/latest/flavors/swift/) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](https://oxsecurity.github.io/megalinter/latest/flavors/terraform/) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | ## Behind the scenes diff --git a/docs/flavors.md b/docs/flavors.md index d5b02a2916c..ea79590f4a4 100644 --- a/docs/flavors.md +++ b/docs/flavors.md @@ -12,23 +12,23 @@ To improve run performances, we generate **Flavored MegaLinter images** containi _The following table does not display docker pulls from [MegaLinter v4 images](https://hub.docker.com/r/nvuillam/mega-linter)._ -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | -| | [ci_light](flavors/ci_light.md#readme) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | -| | [documentation](flavors/documentation.md#readme) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | -| | [dotnet](flavors/dotnet.md#readme) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | -| | [go](flavors/go.md#readme) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | -| | [java](flavors/java.md#readme) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | -| | [javascript](flavors/javascript.md#readme) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | -| | [php](flavors/php.md#readme) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | -| | [python](flavors/python.md#readme) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | -| | [ruby](flavors/ruby.md#readme) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | -| | [rust](flavors/rust.md#readme) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | -| | [salesforce](flavors/salesforce.md#readme) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | -| | [security](flavors/security.md#readme) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | -| | [swift](flavors/swift.md#readme) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | -| | [terraform](flavors/terraform.md#readme) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | +| | Flavor | Description | Embedded linters | Info | +| :------: | :----- | :---------- | :--------------: | ---: | +| | [all](https://oxsecurity.github.io/megalinter/latest/supported-linters/) | Default MegaLinter Flavor | 101 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) | +| | [ci_light](flavors/ci_light.md#readme) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 18 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ci_light/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ci_light) | +| | [documentation](flavors/documentation.md#readme) | MegaLinter for documentation projects | 42 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-documentation/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-documentation) | +| | [dotnet](flavors/dotnet.md#readme) | Optimized for C, C++, C# or VB based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) | +| | [go](flavors/go.md#readme) | Optimized for GO based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-go/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-go) | +| | [java](flavors/java.md#readme) | Optimized for JAVA based projects | 44 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-java/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-java) | +| | [javascript](flavors/javascript.md#readme) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 51 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-javascript/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-javascript) | +| | [php](flavors/php.md#readme) | Optimized for PHP based projects | 46 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-php/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-php) | +| | [python](flavors/python.md#readme) | Optimized for PYTHON based projects | 50 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-python/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-python) | +| | [ruby](flavors/ruby.md#readme) | Optimized for RUBY based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-ruby/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-ruby) | +| | [rust](flavors/rust.md#readme) | Optimized for RUST based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-rust/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-rust) | +| | [salesforce](flavors/salesforce.md#readme) | Optimized for Salesforce based projects | 45 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-salesforce/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-salesforce) | +| | [security](flavors/security.md#readme) | Optimized for security | 20 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-security/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-security) | +| | [swift](flavors/swift.md#readme) | Optimized for SWIFT based projects | 43 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-swift/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-swift) | +| | [terraform](flavors/terraform.md#readme) | Optimized for TERRAFORM based projects | 48 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-terraform/v6) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-terraform) | If you need a new flavor, [post an issue](https://github.com/oxsecurity/megalinter/issues) :wink: diff --git a/docs/flavors/ci_light.md b/docs/flavors/ci_light.md index e41ec62c4ef..357c8261f27 100644 --- a/docs/flavors/ci_light.md +++ b/docs/flavors/ci_light.md @@ -17,39 +17,39 @@ Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML ### Languages -| | Language | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | ### Formats -| | Format | Linter | Configuration key | Additional | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | -| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | -| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | | -| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | Format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | +| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| | +| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | ### Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | ### Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-----------------------------:|----------------------|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | -| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | -| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | +| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | +| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | diff --git a/docs/flavors/documentation.md b/docs/flavors/documentation.md index 0d6ce83dc77..ad3aa1a74da 100644 --- a/docs/flavors/documentation.md +++ b/docs/flavors/documentation.md @@ -17,63 +17,63 @@ MegaLinter for documentation projects ### Languages -| | Language | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | | -| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | -| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| | +| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | +| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | ### Formats -| | Format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | -| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | -| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | -| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | -| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | -| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | -| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | | -| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | Format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | +| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | +| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | +| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | +| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| | +| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | ### Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | -| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | -| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | -| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | -| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | -| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | -| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | -| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | +| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | +| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | +| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | +| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | +| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | +| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | +| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | ### Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | -| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | -| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | -| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | +| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | +| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | +| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | diff --git a/docs/flavors/dotnet.md b/docs/flavors/dotnet.md index c4c4763331c..9ad65da0837 100644 --- a/docs/flavors/dotnet.md +++ b/docs/flavors/dotnet.md @@ -17,71 +17,71 @@ Optimized for C, C++, C# or VB based projects ### Languages -| | Language | Linter | Configuration key | Additional | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | | -| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**C**](https://oxsecurity.github.io/megalinter/latest/descriptors/c/) | [cpplint](https://oxsecurity.github.io/megalinter/latest/descriptors/c_cpplint/) | [C_CPPLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/c_cpplint/) | | -| | [**C++** (CPP)](https://oxsecurity.github.io/megalinter/latest/descriptors/cpp/) | [cpplint](https://oxsecurity.github.io/megalinter/latest/descriptors/cpp_cpplint/) | [CPP_CPPLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/cpp_cpplint/) | [![GitHub stars](https://img.shields.io/github/stars/cpplint/cpplint?cacheSeconds=3600)](https://github.com/cpplint/cpplint) | -| | [**C#** (CSHARP)](https://oxsecurity.github.io/megalinter/latest/descriptors/csharp/) | [dotnet-format](https://oxsecurity.github.io/megalinter/latest/descriptors/csharp_dotnet_format/) | [CSHARP_DOTNET_FORMAT](https://oxsecurity.github.io/megalinter/latest/descriptors/csharp_dotnet_format/) | [![GitHub stars](https://img.shields.io/github/stars/dotnet/format?cacheSeconds=3600)](https://github.com/dotnet/format) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**POWERSHELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/powershell/) | [powershell](https://oxsecurity.github.io/megalinter/latest/descriptors/powershell_powershell/) | [POWERSHELL_POWERSHELL](https://oxsecurity.github.io/megalinter/latest/descriptors/powershell_powershell/) | [![GitHub stars](https://img.shields.io/github/stars/PowerShell/PSScriptAnalyzer?cacheSeconds=3600)](https://github.com/PowerShell/PSScriptAnalyzer) | -| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | -| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | -| | | [tsqllint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_tsqllint/) | [SQL_TSQLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_tsqllint/) | [![GitHub stars](https://img.shields.io/github/stars/tsqllint/tsqllint?cacheSeconds=3600)](https://github.com/tsqllint/tsqllint) | -| | [**Visual Basic .NET** (VBDOTNET)](https://oxsecurity.github.io/megalinter/latest/descriptors/vbdotnet/) | [dotnet-format](https://oxsecurity.github.io/megalinter/latest/descriptors/vbdotnet_dotnet_format/) | [VBDOTNET_DOTNET_FORMAT](https://oxsecurity.github.io/megalinter/latest/descriptors/vbdotnet_dotnet_format/) | ![formatter](https://shields.io/badge/-format-yellow) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| | +| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**C**](https://oxsecurity.github.io/megalinter/latest/descriptors/c/) | [cpplint](https://oxsecurity.github.io/megalinter/latest/descriptors/c_cpplint/)| [C_CPPLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/c_cpplint/)| | +| | [**C++** (CPP)](https://oxsecurity.github.io/megalinter/latest/descriptors/cpp/) | [cpplint](https://oxsecurity.github.io/megalinter/latest/descriptors/cpp_cpplint/)| [CPP_CPPLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/cpp_cpplint/)| [![GitHub stars](https://img.shields.io/github/stars/cpplint/cpplint?cacheSeconds=3600)](https://github.com/cpplint/cpplint) | +| | [**C#** (CSHARP)](https://oxsecurity.github.io/megalinter/latest/descriptors/csharp/) | [dotnet-format](https://oxsecurity.github.io/megalinter/latest/descriptors/csharp_dotnet_format/)| [CSHARP_DOTNET_FORMAT](https://oxsecurity.github.io/megalinter/latest/descriptors/csharp_dotnet_format/)| [![GitHub stars](https://img.shields.io/github/stars/dotnet/format?cacheSeconds=3600)](https://github.com/dotnet/format) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**POWERSHELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/powershell/) | [powershell](https://oxsecurity.github.io/megalinter/latest/descriptors/powershell_powershell/)| [POWERSHELL_POWERSHELL](https://oxsecurity.github.io/megalinter/latest/descriptors/powershell_powershell/)| [![GitHub stars](https://img.shields.io/github/stars/PowerShell/PSScriptAnalyzer?cacheSeconds=3600)](https://github.com/PowerShell/PSScriptAnalyzer) | +| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | +| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | +| | | [tsqllint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_tsqllint/)| [SQL_TSQLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_tsqllint/)| [![GitHub stars](https://img.shields.io/github/stars/tsqllint/tsqllint?cacheSeconds=3600)](https://github.com/tsqllint/tsqllint) | +| | [**Visual Basic .NET** (VBDOTNET)](https://oxsecurity.github.io/megalinter/latest/descriptors/vbdotnet/) | [dotnet-format](https://oxsecurity.github.io/megalinter/latest/descriptors/vbdotnet_dotnet_format/)| [VBDOTNET_DOTNET_FORMAT](https://oxsecurity.github.io/megalinter/latest/descriptors/vbdotnet_dotnet_format/)| ![formatter](https://shields.io/badge/-format-yellow) | ### Formats -| | Format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | -| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | -| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | -| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | -| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | -| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | -| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | | -| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | Format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | +| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | +| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | +| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | +| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| | +| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | ### Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | -| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | -| | [**ARM**](https://oxsecurity.github.io/megalinter/latest/descriptors/arm/) | [arm-ttk](https://oxsecurity.github.io/megalinter/latest/descriptors/arm_arm_ttk/) | [ARM_ARM_TTK](https://oxsecurity.github.io/megalinter/latest/descriptors/arm_arm_ttk/) | | -| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | -| | [**GHERKIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/gherkin/) | [gherkin-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/gherkin_gherkin_lint/) | [GHERKIN_GHERKIN_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/gherkin_gherkin_lint/) | [![GitHub stars](https://img.shields.io/github/stars/vsiakka/gherkin-lint?cacheSeconds=3600)](https://github.com/vsiakka/gherkin-lint) | -| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | -| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | -| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | -| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | -| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | +| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | +| | [**ARM**](https://oxsecurity.github.io/megalinter/latest/descriptors/arm/) | [arm-ttk](https://oxsecurity.github.io/megalinter/latest/descriptors/arm_arm_ttk/)| [ARM_ARM_TTK](https://oxsecurity.github.io/megalinter/latest/descriptors/arm_arm_ttk/)| | +| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | +| | [**GHERKIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/gherkin/) | [gherkin-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/gherkin_gherkin_lint/)| [GHERKIN_GHERKIN_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/gherkin_gherkin_lint/)| [![GitHub stars](https://img.shields.io/github/stars/vsiakka/gherkin-lint?cacheSeconds=3600)](https://github.com/vsiakka/gherkin-lint) | +| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | +| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | +| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | +| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | +| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | ### Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | -| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | -| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | -| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | +| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | +| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | +| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | diff --git a/docs/flavors/go.md b/docs/flavors/go.md index ffb82d89631..ce14f2a530d 100644 --- a/docs/flavors/go.md +++ b/docs/flavors/go.md @@ -17,65 +17,65 @@ Optimized for GO based projects ### Languages -| | Language | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | | -| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**GO**](https://oxsecurity.github.io/megalinter/latest/descriptors/go/) | [golangci-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/go_golangci_lint/) | [GO_GOLANGCI_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/go_golangci_lint/) | [![GitHub stars](https://img.shields.io/github/stars/golangci/golangci-lint?cacheSeconds=3600)](https://github.com/golangci/golangci-lint) | -| | | [revive](https://oxsecurity.github.io/megalinter/latest/descriptors/go_revive/) | [GO_REVIVE](https://oxsecurity.github.io/megalinter/latest/descriptors/go_revive/) | [![GitHub stars](https://img.shields.io/github/stars/mgechev/revive?cacheSeconds=3600)](https://github.com/mgechev/revive) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | -| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| | +| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**GO**](https://oxsecurity.github.io/megalinter/latest/descriptors/go/) | [golangci-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/go_golangci_lint/)| [GO_GOLANGCI_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/go_golangci_lint/)| [![GitHub stars](https://img.shields.io/github/stars/golangci/golangci-lint?cacheSeconds=3600)](https://github.com/golangci/golangci-lint) | +| | | [revive](https://oxsecurity.github.io/megalinter/latest/descriptors/go_revive/)| [GO_REVIVE](https://oxsecurity.github.io/megalinter/latest/descriptors/go_revive/)| [![GitHub stars](https://img.shields.io/github/stars/mgechev/revive?cacheSeconds=3600)](https://github.com/mgechev/revive) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | +| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | ### Formats -| | Format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | -| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | -| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | -| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | -| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | -| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | -| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | | -| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | Format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | +| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | +| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | +| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | +| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| | +| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | ### Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | -| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | -| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | -| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | -| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | -| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | -| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | -| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | +| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | +| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | +| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | +| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | +| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | +| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | +| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | ### Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | -| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | -| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | -| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | +| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | +| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | +| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | diff --git a/docs/flavors/java.md b/docs/flavors/java.md index 68344004bb3..ddcf73c70d8 100644 --- a/docs/flavors/java.md +++ b/docs/flavors/java.md @@ -17,65 +17,65 @@ Optimized for JAVA based projects ### Languages -| | Language | Linter | Configuration key | Additional | -|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | | -| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**CLOJURE**](https://oxsecurity.github.io/megalinter/latest/descriptors/clojure/) | [clj-kondo](https://oxsecurity.github.io/megalinter/latest/descriptors/clojure_clj_kondo/) | [CLOJURE_CLJ_KONDO](https://oxsecurity.github.io/megalinter/latest/descriptors/clojure_clj_kondo/) | [![GitHub stars](https://img.shields.io/github/stars/borkdude/clj-kondo?cacheSeconds=3600)](https://github.com/borkdude/clj-kondo) | -| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**JAVA**](https://oxsecurity.github.io/megalinter/latest/descriptors/java/) | [checkstyle](https://oxsecurity.github.io/megalinter/latest/descriptors/java_checkstyle/) | [JAVA_CHECKSTYLE](https://oxsecurity.github.io/megalinter/latest/descriptors/java_checkstyle/) | [![GitHub stars](https://img.shields.io/github/stars/checkstyle/checkstyle?cacheSeconds=3600)](https://github.com/checkstyle/checkstyle) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | -| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| | +| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**CLOJURE**](https://oxsecurity.github.io/megalinter/latest/descriptors/clojure/) | [clj-kondo](https://oxsecurity.github.io/megalinter/latest/descriptors/clojure_clj_kondo/)| [CLOJURE_CLJ_KONDO](https://oxsecurity.github.io/megalinter/latest/descriptors/clojure_clj_kondo/)| [![GitHub stars](https://img.shields.io/github/stars/borkdude/clj-kondo?cacheSeconds=3600)](https://github.com/borkdude/clj-kondo) | +| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**JAVA**](https://oxsecurity.github.io/megalinter/latest/descriptors/java/) | [checkstyle](https://oxsecurity.github.io/megalinter/latest/descriptors/java_checkstyle/)| [JAVA_CHECKSTYLE](https://oxsecurity.github.io/megalinter/latest/descriptors/java_checkstyle/)| [![GitHub stars](https://img.shields.io/github/stars/checkstyle/checkstyle?cacheSeconds=3600)](https://github.com/checkstyle/checkstyle) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | +| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | ### Formats -| | Format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | -| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | -| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | -| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | -| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | -| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | -| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | | -| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | Format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | +| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | +| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | +| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | +| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| | +| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | ### Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | -| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | -| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | -| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | -| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | -| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | -| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | -| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | +| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | +| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | +| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | +| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | +| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | +| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | +| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | ### Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | -| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | -| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | -| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | +| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | +| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | +| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | diff --git a/docs/flavors/javascript.md b/docs/flavors/javascript.md index 59b5a48d6ba..8da27162b6e 100644 --- a/docs/flavors/javascript.md +++ b/docs/flavors/javascript.md @@ -17,72 +17,72 @@ Optimized for JAVASCRIPT or TYPESCRIPT based projects ### Languages -| | Language | Linter | Configuration key | Additional | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | | -| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**COFFEE**](https://oxsecurity.github.io/megalinter/latest/descriptors/coffee/) | [coffeelint](https://oxsecurity.github.io/megalinter/latest/descriptors/coffee_coffeelint/) | [COFFEE_COFFEELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/coffee_coffeelint/) | [![GitHub stars](https://img.shields.io/github/stars/clutchski/coffeelint?cacheSeconds=3600)](https://github.com/clutchski/coffeelint) | -| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**JAVASCRIPT**](https://oxsecurity.github.io/megalinter/latest/descriptors/javascript/) | [eslint](https://oxsecurity.github.io/megalinter/latest/descriptors/javascript_eslint/) | [JAVASCRIPT_ES](https://oxsecurity.github.io/megalinter/latest/descriptors/javascript_eslint/) | [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [standard](https://oxsecurity.github.io/megalinter/latest/descriptors/javascript_standard/) | [JAVASCRIPT_STANDARD](https://oxsecurity.github.io/megalinter/latest/descriptors/javascript_standard/) | [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/javascript_prettier/) | [JAVASCRIPT_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/javascript_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**JSX**](https://oxsecurity.github.io/megalinter/latest/descriptors/jsx/) | [eslint](https://oxsecurity.github.io/megalinter/latest/descriptors/jsx_eslint/) | [JSX_ESLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/jsx_eslint/) | ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | -| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | -| | [**TSX**](https://oxsecurity.github.io/megalinter/latest/descriptors/tsx/) | [eslint](https://oxsecurity.github.io/megalinter/latest/descriptors/tsx_eslint/) | [TSX_ESLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tsx_eslint/) | ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**TYPESCRIPT**](https://oxsecurity.github.io/megalinter/latest/descriptors/typescript/) | [eslint](https://oxsecurity.github.io/megalinter/latest/descriptors/typescript_eslint/) | [TYPESCRIPT_ES](https://oxsecurity.github.io/megalinter/latest/descriptors/typescript_eslint/) | [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [standard](https://oxsecurity.github.io/megalinter/latest/descriptors/typescript_standard/) | [TYPESCRIPT_STANDARD](https://oxsecurity.github.io/megalinter/latest/descriptors/typescript_standard/) | [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/typescript_prettier/) | [TYPESCRIPT_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/typescript_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| | +| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**COFFEE**](https://oxsecurity.github.io/megalinter/latest/descriptors/coffee/) | [coffeelint](https://oxsecurity.github.io/megalinter/latest/descriptors/coffee_coffeelint/)| [COFFEE_COFFEELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/coffee_coffeelint/)| [![GitHub stars](https://img.shields.io/github/stars/clutchski/coffeelint?cacheSeconds=3600)](https://github.com/clutchski/coffeelint) | +| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**JAVASCRIPT**](https://oxsecurity.github.io/megalinter/latest/descriptors/javascript/) | [eslint](https://oxsecurity.github.io/megalinter/latest/descriptors/javascript_eslint/)| [JAVASCRIPT_ES](https://oxsecurity.github.io/megalinter/latest/descriptors/javascript_eslint/)| [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [standard](https://oxsecurity.github.io/megalinter/latest/descriptors/javascript_standard/)| [JAVASCRIPT_STANDARD](https://oxsecurity.github.io/megalinter/latest/descriptors/javascript_standard/)| [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/javascript_prettier/)| [JAVASCRIPT_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/javascript_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**JSX**](https://oxsecurity.github.io/megalinter/latest/descriptors/jsx/) | [eslint](https://oxsecurity.github.io/megalinter/latest/descriptors/jsx_eslint/)| [JSX_ESLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/jsx_eslint/)| ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | +| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | +| | [**TSX**](https://oxsecurity.github.io/megalinter/latest/descriptors/tsx/) | [eslint](https://oxsecurity.github.io/megalinter/latest/descriptors/tsx_eslint/)| [TSX_ESLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tsx_eslint/)| ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**TYPESCRIPT**](https://oxsecurity.github.io/megalinter/latest/descriptors/typescript/) | [eslint](https://oxsecurity.github.io/megalinter/latest/descriptors/typescript_eslint/)| [TYPESCRIPT_ES](https://oxsecurity.github.io/megalinter/latest/descriptors/typescript_eslint/)| [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [standard](https://oxsecurity.github.io/megalinter/latest/descriptors/typescript_standard/)| [TYPESCRIPT_STANDARD](https://oxsecurity.github.io/megalinter/latest/descriptors/typescript_standard/)| [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/typescript_prettier/)| [TYPESCRIPT_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/typescript_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | ### Formats -| | Format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | -| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | -| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | -| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | -| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | -| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | -| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | | -| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | Format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | +| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | +| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | +| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | +| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| | +| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | ### Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | -| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | -| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | -| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | -| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | -| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | -| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | -| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | +| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | +| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | +| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | +| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | +| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | +| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | +| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | ### Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | -| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | -| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | -| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | +| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | +| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | +| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | diff --git a/docs/flavors/php.md b/docs/flavors/php.md index 94d6799ba91..cac3dd45dfb 100644 --- a/docs/flavors/php.md +++ b/docs/flavors/php.md @@ -17,67 +17,67 @@ Optimized for PHP based projects ### Languages -| | Language | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | | -| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**PHP**](https://oxsecurity.github.io/megalinter/latest/descriptors/php/) | [phpcs](https://oxsecurity.github.io/megalinter/latest/descriptors/php_phpcs/) | [PHP_PHPCS](https://oxsecurity.github.io/megalinter/latest/descriptors/php_phpcs/) | [![GitHub stars](https://img.shields.io/github/stars/squizlabs/PHP_CodeSniffer?cacheSeconds=3600)](https://github.com/squizlabs/PHP_CodeSniffer) | -| | | [phpstan](https://oxsecurity.github.io/megalinter/latest/descriptors/php_phpstan/) | [PHP_PHPSTAN](https://oxsecurity.github.io/megalinter/latest/descriptors/php_phpstan/) | [![GitHub stars](https://img.shields.io/github/stars/phpstan/phpstan?cacheSeconds=3600)](https://github.com/phpstan/phpstan) | -| | | [psalm](https://oxsecurity.github.io/megalinter/latest/descriptors/php_psalm/) | [PHP_PSALM](https://oxsecurity.github.io/megalinter/latest/descriptors/php_psalm/) | [![GitHub stars](https://img.shields.io/github/stars/vimeo/psalm?cacheSeconds=3600)](https://github.com/vimeo/psalm) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [phplint](https://oxsecurity.github.io/megalinter/latest/descriptors/php_phplint/) | [PHP_PHPLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/php_phplint/) | | -| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | -| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| | +| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**PHP**](https://oxsecurity.github.io/megalinter/latest/descriptors/php/) | [phpcs](https://oxsecurity.github.io/megalinter/latest/descriptors/php_phpcs/)| [PHP_PHPCS](https://oxsecurity.github.io/megalinter/latest/descriptors/php_phpcs/)| [![GitHub stars](https://img.shields.io/github/stars/squizlabs/PHP_CodeSniffer?cacheSeconds=3600)](https://github.com/squizlabs/PHP_CodeSniffer) | +| | | [phpstan](https://oxsecurity.github.io/megalinter/latest/descriptors/php_phpstan/)| [PHP_PHPSTAN](https://oxsecurity.github.io/megalinter/latest/descriptors/php_phpstan/)| [![GitHub stars](https://img.shields.io/github/stars/phpstan/phpstan?cacheSeconds=3600)](https://github.com/phpstan/phpstan) | +| | | [psalm](https://oxsecurity.github.io/megalinter/latest/descriptors/php_psalm/)| [PHP_PSALM](https://oxsecurity.github.io/megalinter/latest/descriptors/php_psalm/)| [![GitHub stars](https://img.shields.io/github/stars/vimeo/psalm?cacheSeconds=3600)](https://github.com/vimeo/psalm) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [phplint](https://oxsecurity.github.io/megalinter/latest/descriptors/php_phplint/)| [PHP_PHPLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/php_phplint/)| | +| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | +| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | ### Formats -| | Format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | -| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | -| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | -| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | -| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | -| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | -| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | | -| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | Format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | +| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | +| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | +| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | +| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| | +| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | ### Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | -| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | -| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | -| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | -| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | -| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | -| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | -| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | +| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | +| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | +| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | +| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | +| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | +| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | +| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | ### Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | -| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | -| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | -| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | +| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | +| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | +| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | diff --git a/docs/flavors/python.md b/docs/flavors/python.md index 8eac6e160cf..214e6c664cf 100644 --- a/docs/flavors/python.md +++ b/docs/flavors/python.md @@ -17,71 +17,71 @@ Optimized for PYTHON based projects ### Languages -| | Language | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | | -| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**PYTHON**](https://oxsecurity.github.io/megalinter/latest/descriptors/python/) | [pylint](https://oxsecurity.github.io/megalinter/latest/descriptors/python_pylint/) | [PYTHON_PYLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/python_pylint/) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/pylint?cacheSeconds=3600)](https://github.com/PyCQA/pylint) | -| | | [black](https://oxsecurity.github.io/megalinter/latest/descriptors/python_black/) | [PYTHON_BLACK](https://oxsecurity.github.io/megalinter/latest/descriptors/python_black/) | [![GitHub stars](https://img.shields.io/github/stars/psf/black?cacheSeconds=3600)](https://github.com/psf/black) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [flake8](https://oxsecurity.github.io/megalinter/latest/descriptors/python_flake8/) | [PYTHON_FLAKE8](https://oxsecurity.github.io/megalinter/latest/descriptors/python_flake8/) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/flake8?cacheSeconds=3600)](https://github.com/PyCQA/flake8) | -| | | [isort](https://oxsecurity.github.io/megalinter/latest/descriptors/python_isort/) | [PYTHON_ISORT](https://oxsecurity.github.io/megalinter/latest/descriptors/python_isort/) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/isort?cacheSeconds=3600)](https://github.com/PyCQA/isort) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [bandit](https://oxsecurity.github.io/megalinter/latest/descriptors/python_bandit/) | [PYTHON_BANDIT](https://oxsecurity.github.io/megalinter/latest/descriptors/python_bandit/) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/bandit?cacheSeconds=3600)](https://github.com/PyCQA/bandit) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [mypy](https://oxsecurity.github.io/megalinter/latest/descriptors/python_mypy/) | [PYTHON_MYPY](https://oxsecurity.github.io/megalinter/latest/descriptors/python_mypy/) | [![GitHub stars](https://img.shields.io/github/stars/python/mypy?cacheSeconds=3600)](https://github.com/python/mypy) | -| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | -| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| | +| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**PYTHON**](https://oxsecurity.github.io/megalinter/latest/descriptors/python/) | [pylint](https://oxsecurity.github.io/megalinter/latest/descriptors/python_pylint/)| [PYTHON_PYLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/python_pylint/)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/pylint?cacheSeconds=3600)](https://github.com/PyCQA/pylint) | +| | | [black](https://oxsecurity.github.io/megalinter/latest/descriptors/python_black/)| [PYTHON_BLACK](https://oxsecurity.github.io/megalinter/latest/descriptors/python_black/)| [![GitHub stars](https://img.shields.io/github/stars/psf/black?cacheSeconds=3600)](https://github.com/psf/black) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [flake8](https://oxsecurity.github.io/megalinter/latest/descriptors/python_flake8/)| [PYTHON_FLAKE8](https://oxsecurity.github.io/megalinter/latest/descriptors/python_flake8/)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/flake8?cacheSeconds=3600)](https://github.com/PyCQA/flake8) | +| | | [isort](https://oxsecurity.github.io/megalinter/latest/descriptors/python_isort/)| [PYTHON_ISORT](https://oxsecurity.github.io/megalinter/latest/descriptors/python_isort/)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/isort?cacheSeconds=3600)](https://github.com/PyCQA/isort) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [bandit](https://oxsecurity.github.io/megalinter/latest/descriptors/python_bandit/)| [PYTHON_BANDIT](https://oxsecurity.github.io/megalinter/latest/descriptors/python_bandit/)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/bandit?cacheSeconds=3600)](https://github.com/PyCQA/bandit) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [mypy](https://oxsecurity.github.io/megalinter/latest/descriptors/python_mypy/)| [PYTHON_MYPY](https://oxsecurity.github.io/megalinter/latest/descriptors/python_mypy/)| [![GitHub stars](https://img.shields.io/github/stars/python/mypy?cacheSeconds=3600)](https://github.com/python/mypy) | +| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | +| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | ### Formats -| | Format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | -| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | -| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | -| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | -| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | -| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | -| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**RST**](https://oxsecurity.github.io/megalinter/latest/descriptors/rst/) | [rst-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/rst_rst_lint/) | [RST_RST_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/rst_rst_lint/) | [![GitHub stars](https://img.shields.io/github/stars/twolfson/restructuredtext-lint?cacheSeconds=3600)](https://github.com/twolfson/restructuredtext-lint) | -| | | [rstcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/rst_rstcheck/) | [RST_RSTCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/rst_rstcheck/) | [![GitHub stars](https://img.shields.io/github/stars/myint/rstcheck?cacheSeconds=3600)](https://github.com/myint/rstcheck) | -| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | | -| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | Format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | +| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | +| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | +| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | +| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**RST**](https://oxsecurity.github.io/megalinter/latest/descriptors/rst/) | [rst-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/rst_rst_lint/)| [RST_RST_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/rst_rst_lint/)| [![GitHub stars](https://img.shields.io/github/stars/twolfson/restructuredtext-lint?cacheSeconds=3600)](https://github.com/twolfson/restructuredtext-lint) | +| | | [rstcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/rst_rstcheck/)| [RST_RSTCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/rst_rstcheck/)| [![GitHub stars](https://img.shields.io/github/stars/myint/rstcheck?cacheSeconds=3600)](https://github.com/myint/rstcheck) | +| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| | +| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | ### Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | -| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | -| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | -| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | -| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | -| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | -| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | -| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | +| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | +| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | +| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | +| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | +| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | +| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | +| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | ### Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | -| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | -| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | -| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | +| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | +| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | +| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | diff --git a/docs/flavors/ruby.md b/docs/flavors/ruby.md index 6471b0f47b6..5853afe9633 100644 --- a/docs/flavors/ruby.md +++ b/docs/flavors/ruby.md @@ -17,64 +17,64 @@ Optimized for RUBY based projects ### Languages -| | Language | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | | -| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**RUBY**](https://oxsecurity.github.io/megalinter/latest/descriptors/ruby/) | [rubocop](https://oxsecurity.github.io/megalinter/latest/descriptors/ruby_rubocop/) | [RUBY_RUBOCOP](https://oxsecurity.github.io/megalinter/latest/descriptors/ruby_rubocop/) | [![GitHub stars](https://img.shields.io/github/stars/rubocop-hq/rubocop?cacheSeconds=3600)](https://github.com/rubocop-hq/rubocop) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | -| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| | +| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**RUBY**](https://oxsecurity.github.io/megalinter/latest/descriptors/ruby/) | [rubocop](https://oxsecurity.github.io/megalinter/latest/descriptors/ruby_rubocop/)| [RUBY_RUBOCOP](https://oxsecurity.github.io/megalinter/latest/descriptors/ruby_rubocop/)| [![GitHub stars](https://img.shields.io/github/stars/rubocop-hq/rubocop?cacheSeconds=3600)](https://github.com/rubocop-hq/rubocop) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | +| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | ### Formats -| | Format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | -| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | -| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | -| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | -| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | -| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | -| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | | -| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | Format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | +| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | +| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | +| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | +| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| | +| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | ### Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | -| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | -| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | -| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | -| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | -| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | -| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | -| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | +| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | +| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | +| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | +| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | +| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | +| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | +| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | ### Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | -| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | -| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | -| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | +| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | +| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | +| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | diff --git a/docs/flavors/rust.md b/docs/flavors/rust.md index 3d2099c7e66..0a131f9e2dd 100644 --- a/docs/flavors/rust.md +++ b/docs/flavors/rust.md @@ -17,64 +17,64 @@ Optimized for RUST based projects ### Languages -| | Language | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | | -| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**RUST**](https://oxsecurity.github.io/megalinter/latest/descriptors/rust/) | [clippy](https://oxsecurity.github.io/megalinter/latest/descriptors/rust_clippy/) | [RUST_CLIPPY](https://oxsecurity.github.io/megalinter/latest/descriptors/rust_clippy/) | [![GitHub stars](https://img.shields.io/github/stars/rust-lang/rust-clippy?cacheSeconds=3600)](https://github.com/rust-lang/rust-clippy) | -| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | -| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| | +| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**RUST**](https://oxsecurity.github.io/megalinter/latest/descriptors/rust/) | [clippy](https://oxsecurity.github.io/megalinter/latest/descriptors/rust_clippy/)| [RUST_CLIPPY](https://oxsecurity.github.io/megalinter/latest/descriptors/rust_clippy/)| [![GitHub stars](https://img.shields.io/github/stars/rust-lang/rust-clippy?cacheSeconds=3600)](https://github.com/rust-lang/rust-clippy) | +| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | +| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | ### Formats -| | Format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | -| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | -| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | -| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | -| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | -| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | -| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | | -| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | Format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | +| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | +| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | +| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | +| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| | +| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | ### Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | -| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | -| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | -| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | -| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | -| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | -| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | -| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | +| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | +| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | +| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | +| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | +| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | +| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | +| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | ### Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | -| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | -| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | -| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | +| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | +| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | +| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | diff --git a/docs/flavors/salesforce.md b/docs/flavors/salesforce.md index 0549f137ca4..56693f84efc 100644 --- a/docs/flavors/salesforce.md +++ b/docs/flavors/salesforce.md @@ -17,66 +17,66 @@ Optimized for Salesforce based projects ### Languages -| | Language | Linter | Configuration key | Additional | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | | -| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SALESFORCE**](https://oxsecurity.github.io/megalinter/latest/descriptors/salesforce/) | [sfdx-scanner-apex](https://oxsecurity.github.io/megalinter/latest/descriptors/salesforce_sfdx_scanner_apex/) | [SALESFORCE_SFDX_SCANNER_APEX](https://oxsecurity.github.io/megalinter/latest/descriptors/salesforce_sfdx_scanner_apex/) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | -| | | [sfdx-scanner-aura](https://oxsecurity.github.io/megalinter/latest/descriptors/salesforce_sfdx_scanner_aura/) | [SALESFORCE_SFDX_SCANNER_AURA](https://oxsecurity.github.io/megalinter/latest/descriptors/salesforce_sfdx_scanner_aura/) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | -| | | [sfdx-scanner-lwc](https://oxsecurity.github.io/megalinter/latest/descriptors/salesforce_sfdx_scanner_lwc/) | [SALESFORCE_SFDX_SCANNER_LWC](https://oxsecurity.github.io/megalinter/latest/descriptors/salesforce_sfdx_scanner_lwc/) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | -| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | -| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| | +| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SALESFORCE**](https://oxsecurity.github.io/megalinter/latest/descriptors/salesforce/) | [sfdx-scanner-apex](https://oxsecurity.github.io/megalinter/latest/descriptors/salesforce_sfdx_scanner_apex/)| [SALESFORCE_SFDX_SCANNER_APEX](https://oxsecurity.github.io/megalinter/latest/descriptors/salesforce_sfdx_scanner_apex/)| [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | +| | | [sfdx-scanner-aura](https://oxsecurity.github.io/megalinter/latest/descriptors/salesforce_sfdx_scanner_aura/)| [SALESFORCE_SFDX_SCANNER_AURA](https://oxsecurity.github.io/megalinter/latest/descriptors/salesforce_sfdx_scanner_aura/)| [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | +| | | [sfdx-scanner-lwc](https://oxsecurity.github.io/megalinter/latest/descriptors/salesforce_sfdx_scanner_lwc/)| [SALESFORCE_SFDX_SCANNER_LWC](https://oxsecurity.github.io/megalinter/latest/descriptors/salesforce_sfdx_scanner_lwc/)| [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | +| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | +| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | ### Formats -| | Format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | -| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | -| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | -| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | -| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | -| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | -| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | | -| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | Format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | +| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | +| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | +| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | +| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| | +| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | ### Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | -| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | -| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | -| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | -| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | -| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | -| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | -| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | +| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | +| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | +| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | +| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | +| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | +| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | +| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | ### Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | -| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | -| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | -| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | +| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | +| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | +| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | diff --git a/docs/flavors/security.md b/docs/flavors/security.md index 77594770802..c8915ed607e 100644 --- a/docs/flavors/security.md +++ b/docs/flavors/security.md @@ -17,11 +17,11 @@ Optimized for security ### Languages -| | Language | Linter | Configuration key | Additional | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | | -| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [bandit](https://oxsecurity.github.io/megalinter/latest/descriptors/python_bandit/) | [PYTHON_BANDIT](https://oxsecurity.github.io/megalinter/latest/descriptors/python_bandit/) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/bandit?cacheSeconds=3600)](https://github.com/PyCQA/bandit) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| | +| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [bandit](https://oxsecurity.github.io/megalinter/latest/descriptors/python_bandit/)| [PYTHON_BANDIT](https://oxsecurity.github.io/megalinter/latest/descriptors/python_bandit/)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/bandit?cacheSeconds=3600)](https://github.com/PyCQA/bandit) ![sarif](https://shields.io/badge/-SARIF-orange) | ### Formats @@ -30,28 +30,28 @@ Optimized for security ### Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | -| | [**CLOUDFORMATION**](https://oxsecurity.github.io/megalinter/latest/descriptors/cloudformation/) | [cfn-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/cloudformation_cfn_lint/) | [CLOUDFORMATION_CFN_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/cloudformation_cfn_lint/) | [![GitHub stars](https://img.shields.io/github/stars/aws-cloudformation/cfn-lint?cacheSeconds=3600)](https://github.com/aws-cloudformation/cfn-lint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | -| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | -| | [**TERRAFORM**](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform/) | [tflint](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_tflint/) | [TERRAFORM_TFLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_tflint/) | [![GitHub stars](https://img.shields.io/github/stars/terraform-linters/tflint?cacheSeconds=3600)](https://github.com/terraform-linters/tflint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [terrascan](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terrascan/) | [TERRAFORM_TERRASCAN](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terrascan/) | [![GitHub stars](https://img.shields.io/github/stars/accurics/terrascan?cacheSeconds=3600)](https://github.com/accurics/terrascan) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [terragrunt](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terragrunt/) | [TERRAFORM_TERRAGRUNT](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terragrunt/) | [![GitHub stars](https://img.shields.io/github/stars/gruntwork-io/terragrunt?cacheSeconds=3600)](https://github.com/gruntwork-io/terragrunt) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [checkov](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_checkov/) | [TERRAFORM_CHECKOV](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_checkov/) | [![GitHub stars](https://img.shields.io/github/stars/bridgecrewio/checkov?cacheSeconds=3600)](https://github.com/bridgecrewio/checkov) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [kics](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_kics/) | [TERRAFORM_KICS](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_kics/) | [![GitHub stars](https://img.shields.io/github/stars/checkmarx/kics?cacheSeconds=3600)](https://github.com/checkmarx/kics) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | +| | [**CLOUDFORMATION**](https://oxsecurity.github.io/megalinter/latest/descriptors/cloudformation/) | [cfn-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/cloudformation_cfn_lint/)| [CLOUDFORMATION_CFN_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/cloudformation_cfn_lint/)| [![GitHub stars](https://img.shields.io/github/stars/aws-cloudformation/cfn-lint?cacheSeconds=3600)](https://github.com/aws-cloudformation/cfn-lint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | +| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | +| | [**TERRAFORM**](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform/) | [tflint](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_tflint/)| [TERRAFORM_TFLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_tflint/)| [![GitHub stars](https://img.shields.io/github/stars/terraform-linters/tflint?cacheSeconds=3600)](https://github.com/terraform-linters/tflint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [terrascan](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terrascan/)| [TERRAFORM_TERRASCAN](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terrascan/)| [![GitHub stars](https://img.shields.io/github/stars/accurics/terrascan?cacheSeconds=3600)](https://github.com/accurics/terrascan) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [terragrunt](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terragrunt/)| [TERRAFORM_TERRAGRUNT](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terragrunt/)| [![GitHub stars](https://img.shields.io/github/stars/gruntwork-io/terragrunt?cacheSeconds=3600)](https://github.com/gruntwork-io/terragrunt) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [checkov](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_checkov/)| [TERRAFORM_CHECKOV](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_checkov/)| [![GitHub stars](https://img.shields.io/github/stars/bridgecrewio/checkov?cacheSeconds=3600)](https://github.com/bridgecrewio/checkov) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [kics](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_kics/)| [TERRAFORM_KICS](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_kics/)| [![GitHub stars](https://img.shields.io/github/stars/checkmarx/kics?cacheSeconds=3600)](https://github.com/checkmarx/kics) | ### Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**REPOSITORY**](https://oxsecurity.github.io/megalinter/latest/descriptors/repository/) | [devskim](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_devskim/) | [REPOSITORY_DEVSKIM](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_devskim/) | [![GitHub stars](https://img.shields.io/github/stars/microsoft/DevSkim?cacheSeconds=3600)](https://github.com/microsoft/DevSkim) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [dustilock](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_dustilock/) | [REPOSITORY_DUSTILOCK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_dustilock/) | [![GitHub stars](https://img.shields.io/github/stars/Checkmarx/dustilock?cacheSeconds=3600)](https://github.com/Checkmarx/dustilock) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [syft](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_syft/) | [REPOSITORY_SYFT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_syft/) | [![GitHub stars](https://img.shields.io/github/stars/anchore/syft?cacheSeconds=3600)](https://github.com/anchore/syft) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**REPOSITORY**](https://oxsecurity.github.io/megalinter/latest/descriptors/repository/) | [devskim](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_devskim/)| [REPOSITORY_DEVSKIM](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_devskim/)| [![GitHub stars](https://img.shields.io/github/stars/microsoft/DevSkim?cacheSeconds=3600)](https://github.com/microsoft/DevSkim) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [dustilock](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_dustilock/)| [REPOSITORY_DUSTILOCK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_dustilock/)| [![GitHub stars](https://img.shields.io/github/stars/Checkmarx/dustilock?cacheSeconds=3600)](https://github.com/Checkmarx/dustilock) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [syft](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_syft/)| [REPOSITORY_SYFT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_syft/)| [![GitHub stars](https://img.shields.io/github/stars/anchore/syft?cacheSeconds=3600)](https://github.com/anchore/syft) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | diff --git a/docs/flavors/swift.md b/docs/flavors/swift.md index bbf31b81c39..e05b28053e8 100644 --- a/docs/flavors/swift.md +++ b/docs/flavors/swift.md @@ -17,64 +17,64 @@ Optimized for SWIFT based projects ### Languages -| | Language | Linter | Configuration key | Additional | -|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | | -| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | -| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | -| | [**SWIFT**](https://oxsecurity.github.io/megalinter/latest/descriptors/swift/) | [swiftlint](https://oxsecurity.github.io/megalinter/latest/descriptors/swift_swiftlint/) | [SWIFT_SWIFTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/swift_swiftlint/) | [![GitHub stars](https://img.shields.io/github/stars/realm/SwiftLint?cacheSeconds=3600)](https://github.com/realm/SwiftLint) ![autofix](https://shields.io/badge/-autofix-green) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| | +| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | +| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | +| | [**SWIFT**](https://oxsecurity.github.io/megalinter/latest/descriptors/swift/) | [swiftlint](https://oxsecurity.github.io/megalinter/latest/descriptors/swift_swiftlint/)| [SWIFT_SWIFTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/swift_swiftlint/)| [![GitHub stars](https://img.shields.io/github/stars/realm/SwiftLint?cacheSeconds=3600)](https://github.com/realm/SwiftLint) ![autofix](https://shields.io/badge/-autofix-green) | ### Formats -| | Format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | -| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | -| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | -| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | -| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | -| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | -| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | | -| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | Format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | +| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | +| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | +| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | +| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| | +| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | ### Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | -| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | -| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | -| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | -| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | -| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | -| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | -| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | +| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | +| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | +| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | +| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | +| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | +| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | +| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | ### Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | -| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | -| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | -| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | +| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | +| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | +| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | diff --git a/docs/flavors/terraform.md b/docs/flavors/terraform.md index 89193946f20..c91cfe674e9 100644 --- a/docs/flavors/terraform.md +++ b/docs/flavors/terraform.md @@ -17,69 +17,69 @@ Optimized for TERRAFORM based projects ### Languages -| | Language | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/) | | -| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/) | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/) | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | -| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**BASH**](https://oxsecurity.github.io/megalinter/latest/descriptors/bash/) | [bash-exec](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| [BASH_EXEC](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_bash_exec/)| | +| | | [shellcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [BASH_SHELLCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shellcheck/)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [shfmt](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [BASH_SHFMT](https://oxsecurity.github.io/megalinter/latest/descriptors/bash_shfmt/)| [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**GROOVY**](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy/) | [npm-groovy-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [GROOVY_NPM_GROOVY_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/groovy_npm_groovy_lint/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**KOTLIN**](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin/) | [ktlint](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [KOTLIN_KTLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/kotlin_ktlint/)| [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/sql/) | [sql-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [SQL_SQL_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sql_lint/)| [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | +| | | [sqlfluff](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [SQL_SQLFLUFF](https://oxsecurity.github.io/megalinter/latest/descriptors/sql_sqlfluff/)| [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | ### Formats -| | Format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/) | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | -| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | -| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | -| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/) | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | -| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | -| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/) | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | -| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/) | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/) | | -| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | -| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | Format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**CSS**](https://oxsecurity.github.io/megalinter/latest/descriptors/css/) | [stylelint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [CSS_STYLELINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_stylelint/)| [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [scss-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [CSS_SCSS_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/css_scss_lint/)| [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | +| | [**ENV**](https://oxsecurity.github.io/megalinter/latest/descriptors/env/) | [dotenv-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [ENV_DOTENV_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/env_dotenv_linter/)| [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**GRAPHQL**](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql/) | [graphql-schema-linter](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://oxsecurity.github.io/megalinter/latest/descriptors/graphql_graphql_schema_linter/)| [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**HTML**](https://oxsecurity.github.io/megalinter/latest/descriptors/html/) | [htmlhint](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [HTML_HTMLHINT](https://oxsecurity.github.io/megalinter/latest/descriptors/html_htmlhint/)| [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | +| | [**JSON**](https://oxsecurity.github.io/megalinter/latest/descriptors/json/) | [jsonlint](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [JSON_JSONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/json_jsonlint/)| [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | +| | | [eslint-plugin-jsonc](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [JSON_ESLINT_PLUGIN_JSONC](https://oxsecurity.github.io/megalinter/latest/descriptors/json_eslint_plugin_jsonc/)| [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [JSON_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/json_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [JSON_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/json_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**MARKDOWN**](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown/) | [markdownlint](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [MARKDOWN_MARKDOWNLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdownlint/)| [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [markdown-link-check](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [MARKDOWN_MARKDOWN_LINK_CHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_link_check/)| [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | +| | | [markdown-table-formatter](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://oxsecurity.github.io/megalinter/latest/descriptors/markdown_markdown_table_formatter/)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**PROTOBUF**](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf/) | [protolint](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [PROTOBUF_PROTOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/protobuf_protolint/)| [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**XML**](https://oxsecurity.github.io/megalinter/latest/descriptors/xml/) | [xmllint](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| [XML_XMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/xml_xmllint/)| | +| | [**YAML**](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml/) | [prettier](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [YAML_PRETTIER](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_prettier/)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [yamllint](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [YAML_YAMLLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_yamllint/)| [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | +| | | [v8r](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [YAML_V8R](https://oxsecurity.github.io/megalinter/latest/descriptors/yaml_v8r/)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | ### Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | -| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | -| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | -| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | -| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | -| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | -| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | -| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/) | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | -| | [**TERRAFORM**](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform/) | [tflint](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_tflint/) | [TERRAFORM_TFLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_tflint/) | [![GitHub stars](https://img.shields.io/github/stars/terraform-linters/tflint?cacheSeconds=3600)](https://github.com/terraform-linters/tflint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [terrascan](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terrascan/) | [TERRAFORM_TERRASCAN](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terrascan/) | [![GitHub stars](https://img.shields.io/github/stars/accurics/terrascan?cacheSeconds=3600)](https://github.com/accurics/terrascan) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [terragrunt](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terragrunt/) | [TERRAFORM_TERRAGRUNT](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terragrunt/) | [![GitHub stars](https://img.shields.io/github/stars/gruntwork-io/terragrunt?cacheSeconds=3600)](https://github.com/gruntwork-io/terragrunt) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [terraform-fmt](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terraform_fmt/) | [TERRAFORM_TERRAFORM_FMT](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terraform_fmt/) | [![GitHub stars](https://img.shields.io/github/stars/hashicorp/terraform?cacheSeconds=3600)](https://github.com/hashicorp/terraform) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [checkov](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_checkov/) | [TERRAFORM_CHECKOV](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_checkov/) | [![GitHub stars](https://img.shields.io/github/stars/bridgecrewio/checkov?cacheSeconds=3600)](https://github.com/bridgecrewio/checkov) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [kics](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_kics/) | [TERRAFORM_KICS](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_kics/) | [![GitHub stars](https://img.shields.io/github/stars/checkmarx/kics?cacheSeconds=3600)](https://github.com/checkmarx/kics) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ACTION**](https://oxsecurity.github.io/megalinter/latest/descriptors/action/) | [actionlint](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [ACTION_ACTIONLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/action_actionlint/)| [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | +| | [**ANSIBLE**](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible/) | [ansible-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [ANSIBLE_ANSIBLE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/ansible_ansible_lint/)| [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | +| | [**DOCKERFILE**](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile/) | [hadolint](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [DOCKERFILE_HADOLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/dockerfile_hadolint/)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**EDITORCONFIG**](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig/) | [editorconfig-checker](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [EDITORCONFIG_EDITORCONFIG_CHECKER](https://oxsecurity.github.io/megalinter/latest/descriptors/editorconfig_editorconfig_checker/)| [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | +| | [**KUBERNETES**](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes/) | [kubeval](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [KUBERNETES_KUBEVAL](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeval/)| [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | +| | | [kubeconform](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [KUBERNETES_KUBECONFORM](https://oxsecurity.github.io/megalinter/latest/descriptors/kubernetes_kubeconform/)| [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | +| | [**OPENAPI**](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi/) | [spectral](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [OPENAPI_SPECTRAL](https://oxsecurity.github.io/megalinter/latest/descriptors/openapi_spectral/)| [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | +| | [**SNAKEMAKE**](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake/) | [snakemake](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [SNAKEMAKE_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/snakemake_snakemake/)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | +| | [**TEKTON**](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton/) | [tekton-lint](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [TEKTON_TEKTON_LINT](https://oxsecurity.github.io/megalinter/latest/descriptors/tekton_tekton_lint/)| [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | +| | [**TERRAFORM**](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform/) | [tflint](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_tflint/)| [TERRAFORM_TFLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_tflint/)| [![GitHub stars](https://img.shields.io/github/stars/terraform-linters/tflint?cacheSeconds=3600)](https://github.com/terraform-linters/tflint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [terrascan](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terrascan/)| [TERRAFORM_TERRASCAN](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terrascan/)| [![GitHub stars](https://img.shields.io/github/stars/accurics/terrascan?cacheSeconds=3600)](https://github.com/accurics/terrascan) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [terragrunt](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terragrunt/)| [TERRAFORM_TERRAGRUNT](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terragrunt/)| [![GitHub stars](https://img.shields.io/github/stars/gruntwork-io/terragrunt?cacheSeconds=3600)](https://github.com/gruntwork-io/terragrunt) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [terraform-fmt](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terraform_fmt/)| [TERRAFORM_TERRAFORM_FMT](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_terraform_fmt/)| [![GitHub stars](https://img.shields.io/github/stars/hashicorp/terraform?cacheSeconds=3600)](https://github.com/hashicorp/terraform) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [checkov](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_checkov/)| [TERRAFORM_CHECKOV](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_checkov/)| [![GitHub stars](https://img.shields.io/github/stars/bridgecrewio/checkov?cacheSeconds=3600)](https://github.com/bridgecrewio/checkov) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [kics](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_kics/)| [TERRAFORM_KICS](https://oxsecurity.github.io/megalinter/latest/descriptors/terraform_kics/)| [![GitHub stars](https://img.shields.io/github/stars/checkmarx/kics?cacheSeconds=3600)](https://github.com/checkmarx/kics) | ### Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | -| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | -| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | -| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/) | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/) | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**COPYPASTE**](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste/) | [jscpd](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [COPYPASTE_JSCPD](https://oxsecurity.github.io/megalinter/latest/descriptors/copypaste_jscpd/)| [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | +| | | [git_diff](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [REPOSITORY_GIT_DIFF](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_git_diff/)| [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | +| | | [gitleaks](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [REPOSITORY_GITLEAKS](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_gitleaks/)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [goodcheck](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [REPOSITORY_GOODCHECK](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_goodcheck/)| [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | +| | | [secretlint](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [REPOSITORY_SECRETLINT](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_secretlint/)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [semgrep](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [REPOSITORY_SEMGREP](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_semgrep/)| [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [REPOSITORY_TRIVY](https://oxsecurity.github.io/megalinter/latest/descriptors/repository_trivy/)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SPELL**](https://oxsecurity.github.io/megalinter/latest/descriptors/spell/) | [misspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [SPELL_MISSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_misspell/)| [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [cspell](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [SPELL_CSPELL](https://oxsecurity.github.io/megalinter/latest/descriptors/spell_cspell/)| [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | diff --git a/docs/index.md b/docs/index.md index 519734dbd46..b6f5ca43132 100644 --- a/docs/index.md +++ b/docs/index.md @@ -94,124 +94,124 @@ All linters are integrated in the [MegaLinter docker image](https://hub.docker.c ### Languages -| | Language | Linter | Configuration key | Additional | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------|-------------------------------------------------------------------------|------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**BASH**](descriptors/bash.md#readme) | [bash-exec](descriptors/bash_bash_exec.md#readme) | [BASH_EXEC](descriptors/bash_bash_exec.md#readme) | | -| | | [shellcheck](descriptors/bash_shellcheck.md#readme) | [BASH_SHELLCHECK](descriptors/bash_shellcheck.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [shfmt](descriptors/bash_shfmt.md#readme) | [BASH_SHFMT](descriptors/bash_shfmt.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**C**](descriptors/c.md#readme) | [cpplint](descriptors/c_cpplint.md#readme) | [C_CPPLINT](descriptors/c_cpplint.md#readme) | | -| | [**CLOJURE**](descriptors/clojure.md#readme) | [clj-kondo](descriptors/clojure_clj_kondo.md#readme) | [CLOJURE_CLJ_KONDO](descriptors/clojure_clj_kondo.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/borkdude/clj-kondo?cacheSeconds=3600)](https://github.com/borkdude/clj-kondo) | -| | [**COFFEE**](descriptors/coffee.md#readme) | [coffeelint](descriptors/coffee_coffeelint.md#readme) | [COFFEE_COFFEELINT](descriptors/coffee_coffeelint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/clutchski/coffeelint?cacheSeconds=3600)](https://github.com/clutchski/coffeelint) | -| | [**C++** (CPP)](descriptors/cpp.md#readme) | [cpplint](descriptors/cpp_cpplint.md#readme) | [CPP_CPPLINT](descriptors/cpp_cpplint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/cpplint/cpplint?cacheSeconds=3600)](https://github.com/cpplint/cpplint) | -| | [**C#** (CSHARP)](descriptors/csharp.md#readme) | [dotnet-format](descriptors/csharp_dotnet_format.md#readme) | [CSHARP_DOTNET_FORMAT](descriptors/csharp_dotnet_format.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/dotnet/format?cacheSeconds=3600)](https://github.com/dotnet/format) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**DART**](descriptors/dart.md#readme) | [dartanalyzer](descriptors/dart_dartanalyzer.md#readme) | [DART_DARTANALYZER](descriptors/dart_dartanalyzer.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/dart-lang/sdk?cacheSeconds=3600)](https://github.com/dart-lang/sdk) | -| | [**GO**](descriptors/go.md#readme) | [golangci-lint](descriptors/go_golangci_lint.md#readme) | [GO_GOLANGCI_LINT](descriptors/go_golangci_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/golangci/golangci-lint?cacheSeconds=3600)](https://github.com/golangci/golangci-lint) | -| | | [revive](descriptors/go_revive.md#readme) | [GO_REVIVE](descriptors/go_revive.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/mgechev/revive?cacheSeconds=3600)](https://github.com/mgechev/revive) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**GROOVY**](descriptors/groovy.md#readme) | [npm-groovy-lint](descriptors/groovy_npm_groovy_lint.md#readme) | [GROOVY_NPM_GROOVY_LINT](descriptors/groovy_npm_groovy_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**JAVA**](descriptors/java.md#readme) | [checkstyle](descriptors/java_checkstyle.md#readme) | [JAVA_CHECKSTYLE](descriptors/java_checkstyle.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/checkstyle/checkstyle?cacheSeconds=3600)](https://github.com/checkstyle/checkstyle) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**JAVASCRIPT**](descriptors/javascript.md#readme) | [eslint](descriptors/javascript_eslint.md#readme) | [JAVASCRIPT_ES](descriptors/javascript_eslint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [standard](descriptors/javascript_standard.md#readme) | [JAVASCRIPT_STANDARD](descriptors/javascript_standard.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [prettier](descriptors/javascript_prettier.md#readme) | [JAVASCRIPT_PRETTIER](descriptors/javascript_prettier.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**JSX**](descriptors/jsx.md#readme) | [eslint](descriptors/jsx_eslint.md#readme) | [JSX_ESLINT](descriptors/jsx_eslint.md#readme) | ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**KOTLIN**](descriptors/kotlin.md#readme) | [ktlint](descriptors/kotlin_ktlint.md#readme) | [KOTLIN_KTLINT](descriptors/kotlin_ktlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**LUA**](descriptors/lua.md#readme) | [luacheck](descriptors/lua_luacheck.md#readme) | [LUA_LUACHECK](descriptors/lua_luacheck.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/luarocks/luacheck?cacheSeconds=3600)](https://github.com/luarocks/luacheck) | -| | [**PERL**](descriptors/perl.md#readme) | [perlcritic](descriptors/perl_perlcritic.md#readme) | [PERL_PERLCRITIC](descriptors/perl_perlcritic.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/Perl-Critic/Perl-Critic?cacheSeconds=3600)](https://github.com/Perl-Critic/Perl-Critic) | -| | [**PHP**](descriptors/php.md#readme) | [phpcs](descriptors/php_phpcs.md#readme) | [PHP_PHPCS](descriptors/php_phpcs.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/squizlabs/PHP_CodeSniffer?cacheSeconds=3600)](https://github.com/squizlabs/PHP_CodeSniffer) | -| | | [phpstan](descriptors/php_phpstan.md#readme) | [PHP_PHPSTAN](descriptors/php_phpstan.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/phpstan/phpstan?cacheSeconds=3600)](https://github.com/phpstan/phpstan) | -| | | [psalm](descriptors/php_psalm.md#readme) | [PHP_PSALM](descriptors/php_psalm.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/vimeo/psalm?cacheSeconds=3600)](https://github.com/vimeo/psalm) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [phplint](descriptors/php_phplint.md#readme) | [PHP_PHPLINT](descriptors/php_phplint.md#readme) | | -| | [**POWERSHELL**](descriptors/powershell.md#readme) | [powershell](descriptors/powershell_powershell.md#readme) | [POWERSHELL_POWERSHELL](descriptors/powershell_powershell.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PowerShell/PSScriptAnalyzer?cacheSeconds=3600)](https://github.com/PowerShell/PSScriptAnalyzer) | -| | [**PYTHON**](descriptors/python.md#readme) | [pylint](descriptors/python_pylint.md#readme) | [PYTHON_PYLINT](descriptors/python_pylint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/pylint?cacheSeconds=3600)](https://github.com/PyCQA/pylint) | -| | | [black](descriptors/python_black.md#readme) | [PYTHON_BLACK](descriptors/python_black.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/psf/black?cacheSeconds=3600)](https://github.com/psf/black) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [flake8](descriptors/python_flake8.md#readme) | [PYTHON_FLAKE8](descriptors/python_flake8.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/flake8?cacheSeconds=3600)](https://github.com/PyCQA/flake8) | -| | | [isort](descriptors/python_isort.md#readme) | [PYTHON_ISORT](descriptors/python_isort.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/isort?cacheSeconds=3600)](https://github.com/PyCQA/isort) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [bandit](descriptors/python_bandit.md#readme) | [PYTHON_BANDIT](descriptors/python_bandit.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/bandit?cacheSeconds=3600)](https://github.com/PyCQA/bandit) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [mypy](descriptors/python_mypy.md#readme) | [PYTHON_MYPY](descriptors/python_mypy.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/python/mypy?cacheSeconds=3600)](https://github.com/python/mypy) | -| | [**R**](descriptors/r.md#readme) | [lintr](descriptors/r_lintr.md#readme) | [R_LINTR](descriptors/r_lintr.md#readme) | | -| | [**RAKU**](descriptors/raku.md#readme) | [raku](descriptors/raku_raku.md#readme) | [RAKU_RAKU](descriptors/raku_raku.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rakudo/rakudo?cacheSeconds=3600)](https://github.com/rakudo/rakudo) | -| | [**RUBY**](descriptors/ruby.md#readme) | [rubocop](descriptors/ruby_rubocop.md#readme) | [RUBY_RUBOCOP](descriptors/ruby_rubocop.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rubocop-hq/rubocop?cacheSeconds=3600)](https://github.com/rubocop-hq/rubocop) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**RUST**](descriptors/rust.md#readme) | [clippy](descriptors/rust_clippy.md#readme) | [RUST_CLIPPY](descriptors/rust_clippy.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rust-lang/rust-clippy?cacheSeconds=3600)](https://github.com/rust-lang/rust-clippy) | -| | [**SALESFORCE**](descriptors/salesforce.md#readme) | [sfdx-scanner-apex](descriptors/salesforce_sfdx_scanner_apex.md#readme) | [SALESFORCE_SFDX_SCANNER_APEX](descriptors/salesforce_sfdx_scanner_apex.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | -| | | [sfdx-scanner-aura](descriptors/salesforce_sfdx_scanner_aura.md#readme) | [SALESFORCE_SFDX_SCANNER_AURA](descriptors/salesforce_sfdx_scanner_aura.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | -| | | [sfdx-scanner-lwc](descriptors/salesforce_sfdx_scanner_lwc.md#readme) | [SALESFORCE_SFDX_SCANNER_LWC](descriptors/salesforce_sfdx_scanner_lwc.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | -| | [**SCALA**](descriptors/scala.md#readme) | [scalafix](descriptors/scala_scalafix.md#readme) | [SCALA_SCALAFIX](descriptors/scala_scalafix.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/scalacenter/scalafix?cacheSeconds=3600)](https://github.com/scalacenter/scalafix) | -| | [**SQL**](descriptors/sql.md#readme) | [sql-lint](descriptors/sql_sql_lint.md#readme) | [SQL_SQL_LINT](descriptors/sql_sql_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | -| | | [sqlfluff](descriptors/sql_sqlfluff.md#readme) | [SQL_SQLFLUFF](descriptors/sql_sqlfluff.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | -| | | [tsqllint](descriptors/sql_tsqllint.md#readme) | [SQL_TSQLLINT](descriptors/sql_tsqllint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/tsqllint/tsqllint?cacheSeconds=3600)](https://github.com/tsqllint/tsqllint) | -| | [**SWIFT**](descriptors/swift.md#readme) | [swiftlint](descriptors/swift_swiftlint.md#readme) | [SWIFT_SWIFTLINT](descriptors/swift_swiftlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/realm/SwiftLint?cacheSeconds=3600)](https://github.com/realm/SwiftLint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**TSX**](descriptors/tsx.md#readme) | [eslint](descriptors/tsx_eslint.md#readme) | [TSX_ESLINT](descriptors/tsx_eslint.md#readme) | ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**TYPESCRIPT**](descriptors/typescript.md#readme) | [eslint](descriptors/typescript_eslint.md#readme) | [TYPESCRIPT_ES](descriptors/typescript_eslint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [standard](descriptors/typescript_standard.md#readme) | [TYPESCRIPT_STANDARD](descriptors/typescript_standard.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [prettier](descriptors/typescript_prettier.md#readme) | [TYPESCRIPT_PRETTIER](descriptors/typescript_prettier.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**Visual Basic .NET** (VBDOTNET)](descriptors/vbdotnet.md#readme) | [dotnet-format](descriptors/vbdotnet_dotnet_format.md#readme) | [VBDOTNET_DOTNET_FORMAT](descriptors/vbdotnet_dotnet_format.md#readme) | ![formatter](https://shields.io/badge/-format-yellow) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**BASH**](descriptors/bash.md#readme) | [bash-exec](descriptors/bash_bash_exec.md#readme)| [BASH_EXEC](descriptors/bash_bash_exec.md#readme)| | +| | | [shellcheck](descriptors/bash_shellcheck.md#readme)| [BASH_SHELLCHECK](descriptors/bash_shellcheck.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [shfmt](descriptors/bash_shfmt.md#readme)| [BASH_SHFMT](descriptors/bash_shfmt.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**C**](descriptors/c.md#readme) | [cpplint](descriptors/c_cpplint.md#readme)| [C_CPPLINT](descriptors/c_cpplint.md#readme)| | +| | [**CLOJURE**](descriptors/clojure.md#readme) | [clj-kondo](descriptors/clojure_clj_kondo.md#readme)| [CLOJURE_CLJ_KONDO](descriptors/clojure_clj_kondo.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/borkdude/clj-kondo?cacheSeconds=3600)](https://github.com/borkdude/clj-kondo) | +| | [**COFFEE**](descriptors/coffee.md#readme) | [coffeelint](descriptors/coffee_coffeelint.md#readme)| [COFFEE_COFFEELINT](descriptors/coffee_coffeelint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/clutchski/coffeelint?cacheSeconds=3600)](https://github.com/clutchski/coffeelint) | +| | [**C++** (CPP)](descriptors/cpp.md#readme) | [cpplint](descriptors/cpp_cpplint.md#readme)| [CPP_CPPLINT](descriptors/cpp_cpplint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/cpplint/cpplint?cacheSeconds=3600)](https://github.com/cpplint/cpplint) | +| | [**C#** (CSHARP)](descriptors/csharp.md#readme) | [dotnet-format](descriptors/csharp_dotnet_format.md#readme)| [CSHARP_DOTNET_FORMAT](descriptors/csharp_dotnet_format.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/dotnet/format?cacheSeconds=3600)](https://github.com/dotnet/format) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**DART**](descriptors/dart.md#readme) | [dartanalyzer](descriptors/dart_dartanalyzer.md#readme)| [DART_DARTANALYZER](descriptors/dart_dartanalyzer.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/dart-lang/sdk?cacheSeconds=3600)](https://github.com/dart-lang/sdk) | +| | [**GO**](descriptors/go.md#readme) | [golangci-lint](descriptors/go_golangci_lint.md#readme)| [GO_GOLANGCI_LINT](descriptors/go_golangci_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/golangci/golangci-lint?cacheSeconds=3600)](https://github.com/golangci/golangci-lint) | +| | | [revive](descriptors/go_revive.md#readme)| [GO_REVIVE](descriptors/go_revive.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/mgechev/revive?cacheSeconds=3600)](https://github.com/mgechev/revive) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**GROOVY**](descriptors/groovy.md#readme) | [npm-groovy-lint](descriptors/groovy_npm_groovy_lint.md#readme)| [GROOVY_NPM_GROOVY_LINT](descriptors/groovy_npm_groovy_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**JAVA**](descriptors/java.md#readme) | [checkstyle](descriptors/java_checkstyle.md#readme)| [JAVA_CHECKSTYLE](descriptors/java_checkstyle.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/checkstyle/checkstyle?cacheSeconds=3600)](https://github.com/checkstyle/checkstyle) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**JAVASCRIPT**](descriptors/javascript.md#readme) | [eslint](descriptors/javascript_eslint.md#readme)| [JAVASCRIPT_ES](descriptors/javascript_eslint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [standard](descriptors/javascript_standard.md#readme)| [JAVASCRIPT_STANDARD](descriptors/javascript_standard.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [prettier](descriptors/javascript_prettier.md#readme)| [JAVASCRIPT_PRETTIER](descriptors/javascript_prettier.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**JSX**](descriptors/jsx.md#readme) | [eslint](descriptors/jsx_eslint.md#readme)| [JSX_ESLINT](descriptors/jsx_eslint.md#readme)| ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**KOTLIN**](descriptors/kotlin.md#readme) | [ktlint](descriptors/kotlin_ktlint.md#readme)| [KOTLIN_KTLINT](descriptors/kotlin_ktlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**LUA**](descriptors/lua.md#readme) | [luacheck](descriptors/lua_luacheck.md#readme)| [LUA_LUACHECK](descriptors/lua_luacheck.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/luarocks/luacheck?cacheSeconds=3600)](https://github.com/luarocks/luacheck) | +| | [**PERL**](descriptors/perl.md#readme) | [perlcritic](descriptors/perl_perlcritic.md#readme)| [PERL_PERLCRITIC](descriptors/perl_perlcritic.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/Perl-Critic/Perl-Critic?cacheSeconds=3600)](https://github.com/Perl-Critic/Perl-Critic) | +| | [**PHP**](descriptors/php.md#readme) | [phpcs](descriptors/php_phpcs.md#readme)| [PHP_PHPCS](descriptors/php_phpcs.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/squizlabs/PHP_CodeSniffer?cacheSeconds=3600)](https://github.com/squizlabs/PHP_CodeSniffer) | +| | | [phpstan](descriptors/php_phpstan.md#readme)| [PHP_PHPSTAN](descriptors/php_phpstan.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/phpstan/phpstan?cacheSeconds=3600)](https://github.com/phpstan/phpstan) | +| | | [psalm](descriptors/php_psalm.md#readme)| [PHP_PSALM](descriptors/php_psalm.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/vimeo/psalm?cacheSeconds=3600)](https://github.com/vimeo/psalm) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [phplint](descriptors/php_phplint.md#readme)| [PHP_PHPLINT](descriptors/php_phplint.md#readme)| | +| | [**POWERSHELL**](descriptors/powershell.md#readme) | [powershell](descriptors/powershell_powershell.md#readme)| [POWERSHELL_POWERSHELL](descriptors/powershell_powershell.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PowerShell/PSScriptAnalyzer?cacheSeconds=3600)](https://github.com/PowerShell/PSScriptAnalyzer) | +| | [**PYTHON**](descriptors/python.md#readme) | [pylint](descriptors/python_pylint.md#readme)| [PYTHON_PYLINT](descriptors/python_pylint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/pylint?cacheSeconds=3600)](https://github.com/PyCQA/pylint) | +| | | [black](descriptors/python_black.md#readme)| [PYTHON_BLACK](descriptors/python_black.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/psf/black?cacheSeconds=3600)](https://github.com/psf/black) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [flake8](descriptors/python_flake8.md#readme)| [PYTHON_FLAKE8](descriptors/python_flake8.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/flake8?cacheSeconds=3600)](https://github.com/PyCQA/flake8) | +| | | [isort](descriptors/python_isort.md#readme)| [PYTHON_ISORT](descriptors/python_isort.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/isort?cacheSeconds=3600)](https://github.com/PyCQA/isort) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [bandit](descriptors/python_bandit.md#readme)| [PYTHON_BANDIT](descriptors/python_bandit.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/bandit?cacheSeconds=3600)](https://github.com/PyCQA/bandit) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [mypy](descriptors/python_mypy.md#readme)| [PYTHON_MYPY](descriptors/python_mypy.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/python/mypy?cacheSeconds=3600)](https://github.com/python/mypy) | +| | [**R**](descriptors/r.md#readme) | [lintr](descriptors/r_lintr.md#readme)| [R_LINTR](descriptors/r_lintr.md#readme)| | +| | [**RAKU**](descriptors/raku.md#readme) | [raku](descriptors/raku_raku.md#readme)| [RAKU_RAKU](descriptors/raku_raku.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rakudo/rakudo?cacheSeconds=3600)](https://github.com/rakudo/rakudo) | +| | [**RUBY**](descriptors/ruby.md#readme) | [rubocop](descriptors/ruby_rubocop.md#readme)| [RUBY_RUBOCOP](descriptors/ruby_rubocop.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rubocop-hq/rubocop?cacheSeconds=3600)](https://github.com/rubocop-hq/rubocop) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**RUST**](descriptors/rust.md#readme) | [clippy](descriptors/rust_clippy.md#readme)| [RUST_CLIPPY](descriptors/rust_clippy.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rust-lang/rust-clippy?cacheSeconds=3600)](https://github.com/rust-lang/rust-clippy) | +| | [**SALESFORCE**](descriptors/salesforce.md#readme) | [sfdx-scanner-apex](descriptors/salesforce_sfdx_scanner_apex.md#readme)| [SALESFORCE_SFDX_SCANNER_APEX](descriptors/salesforce_sfdx_scanner_apex.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | +| | | [sfdx-scanner-aura](descriptors/salesforce_sfdx_scanner_aura.md#readme)| [SALESFORCE_SFDX_SCANNER_AURA](descriptors/salesforce_sfdx_scanner_aura.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | +| | | [sfdx-scanner-lwc](descriptors/salesforce_sfdx_scanner_lwc.md#readme)| [SALESFORCE_SFDX_SCANNER_LWC](descriptors/salesforce_sfdx_scanner_lwc.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | +| | [**SCALA**](descriptors/scala.md#readme) | [scalafix](descriptors/scala_scalafix.md#readme)| [SCALA_SCALAFIX](descriptors/scala_scalafix.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/scalacenter/scalafix?cacheSeconds=3600)](https://github.com/scalacenter/scalafix) | +| | [**SQL**](descriptors/sql.md#readme) | [sql-lint](descriptors/sql_sql_lint.md#readme)| [SQL_SQL_LINT](descriptors/sql_sql_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | +| | | [sqlfluff](descriptors/sql_sqlfluff.md#readme)| [SQL_SQLFLUFF](descriptors/sql_sqlfluff.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | +| | | [tsqllint](descriptors/sql_tsqllint.md#readme)| [SQL_TSQLLINT](descriptors/sql_tsqllint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/tsqllint/tsqllint?cacheSeconds=3600)](https://github.com/tsqllint/tsqllint) | +| | [**SWIFT**](descriptors/swift.md#readme) | [swiftlint](descriptors/swift_swiftlint.md#readme)| [SWIFT_SWIFTLINT](descriptors/swift_swiftlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/realm/SwiftLint?cacheSeconds=3600)](https://github.com/realm/SwiftLint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**TSX**](descriptors/tsx.md#readme) | [eslint](descriptors/tsx_eslint.md#readme)| [TSX_ESLINT](descriptors/tsx_eslint.md#readme)| ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**TYPESCRIPT**](descriptors/typescript.md#readme) | [eslint](descriptors/typescript_eslint.md#readme)| [TYPESCRIPT_ES](descriptors/typescript_eslint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [standard](descriptors/typescript_standard.md#readme)| [TYPESCRIPT_STANDARD](descriptors/typescript_standard.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [prettier](descriptors/typescript_prettier.md#readme)| [TYPESCRIPT_PRETTIER](descriptors/typescript_prettier.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**Visual Basic .NET** (VBDOTNET)](descriptors/vbdotnet.md#readme) | [dotnet-format](descriptors/vbdotnet_dotnet_format.md#readme)| [VBDOTNET_DOTNET_FORMAT](descriptors/vbdotnet_dotnet_format.md#readme)| ![formatter](https://shields.io/badge/-format-yellow) | ### Formats -| | Format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------|-------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**CSS**](descriptors/css.md#readme) | [stylelint](descriptors/css_stylelint.md#readme) | [CSS_STYLELINT](descriptors/css_stylelint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [scss-lint](descriptors/css_scss_lint.md#readme) | [CSS_SCSS_LINT](descriptors/css_scss_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | -| | [**ENV**](descriptors/env.md#readme) | [dotenv-linter](descriptors/env_dotenv_linter.md#readme) | [ENV_DOTENV_LINTER](descriptors/env_dotenv_linter.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](descriptors/graphql.md#readme) | [graphql-schema-linter](descriptors/graphql_graphql_schema_linter.md#readme) | [GRAPHQL_GRAPHQL_SCHEMA_LINTER](descriptors/graphql_graphql_schema_linter.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | -| | [**HTML**](descriptors/html.md#readme) | [htmlhint](descriptors/html_htmlhint.md#readme) | [HTML_HTMLHINT](descriptors/html_htmlhint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | -| | [**JSON**](descriptors/json.md#readme) | [jsonlint](descriptors/json_jsonlint.md#readme) | [JSON_JSONLINT](descriptors/json_jsonlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | -| | | [eslint-plugin-jsonc](descriptors/json_eslint_plugin_jsonc.md#readme) | [JSON_ESLINT_PLUGIN_JSONC](descriptors/json_eslint_plugin_jsonc.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [v8r](descriptors/json_v8r.md#readme) | [JSON_V8R](descriptors/json_v8r.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | -| | | [prettier](descriptors/json_prettier.md#readme) | [JSON_PRETTIER](descriptors/json_prettier.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**LATEX**](descriptors/latex.md#readme) | [chktex](descriptors/latex_chktex.md#readme) | [LATEX_CHKTEX](descriptors/latex_chktex.md#readme) | | -| | [**MARKDOWN**](descriptors/markdown.md#readme) | [markdownlint](descriptors/markdown_markdownlint.md#readme) | [MARKDOWN_MARKDOWNLINT](descriptors/markdown_markdownlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [remark-lint](descriptors/markdown_remark_lint.md#readme) | [MARKDOWN_REMARK_LINT](descriptors/markdown_remark_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/remarkjs/remark-lint?cacheSeconds=3600)](https://github.com/remarkjs/remark-lint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [markdown-link-check](descriptors/markdown_markdown_link_check.md#readme) | [MARKDOWN_MARKDOWN_LINK_CHECK](descriptors/markdown_markdown_link_check.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | -| | | [markdown-table-formatter](descriptors/markdown_markdown_table_formatter.md#readme) | [MARKDOWN_MARKDOWN_TABLE_FORMATTER](descriptors/markdown_markdown_table_formatter.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**PROTOBUF**](descriptors/protobuf.md#readme) | [protolint](descriptors/protobuf_protolint.md#readme) | [PROTOBUF_PROTOLINT](descriptors/protobuf_protolint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**RST**](descriptors/rst.md#readme) | [rst-lint](descriptors/rst_rst_lint.md#readme) | [RST_RST_LINT](descriptors/rst_rst_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/twolfson/restructuredtext-lint?cacheSeconds=3600)](https://github.com/twolfson/restructuredtext-lint) | -| | | [rstcheck](descriptors/rst_rstcheck.md#readme) | [RST_RSTCHECK](descriptors/rst_rstcheck.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/myint/rstcheck?cacheSeconds=3600)](https://github.com/myint/rstcheck) | -| | [**XML**](descriptors/xml.md#readme) | [xmllint](descriptors/xml_xmllint.md#readme) | [XML_XMLLINT](descriptors/xml_xmllint.md#readme) | | -| | [**YAML**](descriptors/yaml.md#readme) | [prettier](descriptors/yaml_prettier.md#readme) | [YAML_PRETTIER](descriptors/yaml_prettier.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [yamllint](descriptors/yaml_yamllint.md#readme) | [YAML_YAMLLINT](descriptors/yaml_yamllint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | -| | | [v8r](descriptors/yaml_v8r.md#readme) | [YAML_V8R](descriptors/yaml_v8r.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | Format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**CSS**](descriptors/css.md#readme) | [stylelint](descriptors/css_stylelint.md#readme)| [CSS_STYLELINT](descriptors/css_stylelint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [scss-lint](descriptors/css_scss_lint.md#readme)| [CSS_SCSS_LINT](descriptors/css_scss_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | +| | [**ENV**](descriptors/env.md#readme) | [dotenv-linter](descriptors/env_dotenv_linter.md#readme)| [ENV_DOTENV_LINTER](descriptors/env_dotenv_linter.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**GRAPHQL**](descriptors/graphql.md#readme) | [graphql-schema-linter](descriptors/graphql_graphql_schema_linter.md#readme)| [GRAPHQL_GRAPHQL_SCHEMA_LINTER](descriptors/graphql_graphql_schema_linter.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**HTML**](descriptors/html.md#readme) | [htmlhint](descriptors/html_htmlhint.md#readme)| [HTML_HTMLHINT](descriptors/html_htmlhint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | +| | [**JSON**](descriptors/json.md#readme) | [jsonlint](descriptors/json_jsonlint.md#readme)| [JSON_JSONLINT](descriptors/json_jsonlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | +| | | [eslint-plugin-jsonc](descriptors/json_eslint_plugin_jsonc.md#readme)| [JSON_ESLINT_PLUGIN_JSONC](descriptors/json_eslint_plugin_jsonc.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [v8r](descriptors/json_v8r.md#readme)| [JSON_V8R](descriptors/json_v8r.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | | [prettier](descriptors/json_prettier.md#readme)| [JSON_PRETTIER](descriptors/json_prettier.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**LATEX**](descriptors/latex.md#readme) | [chktex](descriptors/latex_chktex.md#readme)| [LATEX_CHKTEX](descriptors/latex_chktex.md#readme)| | +| | [**MARKDOWN**](descriptors/markdown.md#readme) | [markdownlint](descriptors/markdown_markdownlint.md#readme)| [MARKDOWN_MARKDOWNLINT](descriptors/markdown_markdownlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [remark-lint](descriptors/markdown_remark_lint.md#readme)| [MARKDOWN_REMARK_LINT](descriptors/markdown_remark_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/remarkjs/remark-lint?cacheSeconds=3600)](https://github.com/remarkjs/remark-lint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [markdown-link-check](descriptors/markdown_markdown_link_check.md#readme)| [MARKDOWN_MARKDOWN_LINK_CHECK](descriptors/markdown_markdown_link_check.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | +| | | [markdown-table-formatter](descriptors/markdown_markdown_table_formatter.md#readme)| [MARKDOWN_MARKDOWN_TABLE_FORMATTER](descriptors/markdown_markdown_table_formatter.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**PROTOBUF**](descriptors/protobuf.md#readme) | [protolint](descriptors/protobuf_protolint.md#readme)| [PROTOBUF_PROTOLINT](descriptors/protobuf_protolint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**RST**](descriptors/rst.md#readme) | [rst-lint](descriptors/rst_rst_lint.md#readme)| [RST_RST_LINT](descriptors/rst_rst_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/twolfson/restructuredtext-lint?cacheSeconds=3600)](https://github.com/twolfson/restructuredtext-lint) | +| | | [rstcheck](descriptors/rst_rstcheck.md#readme)| [RST_RSTCHECK](descriptors/rst_rstcheck.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/myint/rstcheck?cacheSeconds=3600)](https://github.com/myint/rstcheck) | +| | [**XML**](descriptors/xml.md#readme) | [xmllint](descriptors/xml_xmllint.md#readme)| [XML_XMLLINT](descriptors/xml_xmllint.md#readme)| | +| | [**YAML**](descriptors/yaml.md#readme) | [prettier](descriptors/yaml_prettier.md#readme)| [YAML_PRETTIER](descriptors/yaml_prettier.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [yamllint](descriptors/yaml_yamllint.md#readme)| [YAML_YAMLLINT](descriptors/yaml_yamllint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | +| | | [v8r](descriptors/yaml_v8r.md#readme)| [YAML_V8R](descriptors/yaml_v8r.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | ### Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------|---------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ACTION**](descriptors/action.md#readme) | [actionlint](descriptors/action_actionlint.md#readme) | [ACTION_ACTIONLINT](descriptors/action_actionlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | -| | [**ANSIBLE**](descriptors/ansible.md#readme) | [ansible-lint](descriptors/ansible_ansible_lint.md#readme) | [ANSIBLE_ANSIBLE_LINT](descriptors/ansible_ansible_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | -| | [**ARM**](descriptors/arm.md#readme) | [arm-ttk](descriptors/arm_arm_ttk.md#readme) | [ARM_ARM_TTK](descriptors/arm_arm_ttk.md#readme) | | -| | [**CLOUDFORMATION**](descriptors/cloudformation.md#readme) | [cfn-lint](descriptors/cloudformation_cfn_lint.md#readme) | [CLOUDFORMATION_CFN_LINT](descriptors/cloudformation_cfn_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/aws-cloudformation/cfn-lint?cacheSeconds=3600)](https://github.com/aws-cloudformation/cfn-lint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**DOCKERFILE**](descriptors/dockerfile.md#readme) | [hadolint](descriptors/dockerfile_hadolint.md#readme) | [DOCKERFILE_HADOLINT](descriptors/dockerfile_hadolint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**EDITORCONFIG**](descriptors/editorconfig.md#readme) | [editorconfig-checker](descriptors/editorconfig_editorconfig_checker.md#readme) | [EDITORCONFIG_EDITORCONFIG_CHECKER](descriptors/editorconfig_editorconfig_checker.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | -| | [**GHERKIN**](descriptors/gherkin.md#readme) | [gherkin-lint](descriptors/gherkin_gherkin_lint.md#readme) | [GHERKIN_GHERKIN_LINT](descriptors/gherkin_gherkin_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/vsiakka/gherkin-lint?cacheSeconds=3600)](https://github.com/vsiakka/gherkin-lint) | -| | [**KUBERNETES**](descriptors/kubernetes.md#readme) | [kubeval](descriptors/kubernetes_kubeval.md#readme) | [KUBERNETES_KUBEVAL](descriptors/kubernetes_kubeval.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | -| | | [kubeconform](descriptors/kubernetes_kubeconform.md#readme) | [KUBERNETES_KUBECONFORM](descriptors/kubernetes_kubeconform.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | -| | [**OPENAPI**](descriptors/openapi.md#readme) | [spectral](descriptors/openapi_spectral.md#readme) | [OPENAPI_SPECTRAL](descriptors/openapi_spectral.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | -| | [**PUPPET**](descriptors/puppet.md#readme) | [puppet-lint](descriptors/puppet_puppet_lint.md#readme) | [PUPPET_PUPPET_LINT](descriptors/puppet_puppet_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rodjek/puppet-lint?cacheSeconds=3600)](https://github.com/rodjek/puppet-lint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**SNAKEMAKE**](descriptors/snakemake.md#readme) | [snakemake](descriptors/snakemake_snakemake.md#readme) | [SNAKEMAKE_LINT](descriptors/snakemake_snakemake.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | -| | | [snakefmt](descriptors/snakemake_snakefmt.md#readme) | [SNAKEMAKE_SNAKEFMT](descriptors/snakemake_snakefmt.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakefmt?cacheSeconds=3600)](https://github.com/snakemake/snakefmt) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**TEKTON**](descriptors/tekton.md#readme) | [tekton-lint](descriptors/tekton_tekton_lint.md#readme) | [TEKTON_TEKTON_LINT](descriptors/tekton_tekton_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | -| | [**TERRAFORM**](descriptors/terraform.md#readme) | [tflint](descriptors/terraform_tflint.md#readme) | [TERRAFORM_TFLINT](descriptors/terraform_tflint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/terraform-linters/tflint?cacheSeconds=3600)](https://github.com/terraform-linters/tflint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [terrascan](descriptors/terraform_terrascan.md#readme) | [TERRAFORM_TERRASCAN](descriptors/terraform_terrascan.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/accurics/terrascan?cacheSeconds=3600)](https://github.com/accurics/terrascan) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [terragrunt](descriptors/terraform_terragrunt.md#readme) | [TERRAFORM_TERRAGRUNT](descriptors/terraform_terragrunt.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/gruntwork-io/terragrunt?cacheSeconds=3600)](https://github.com/gruntwork-io/terragrunt) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [terraform-fmt](descriptors/terraform_terraform_fmt.md#readme) | [TERRAFORM_TERRAFORM_FMT](descriptors/terraform_terraform_fmt.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/hashicorp/terraform?cacheSeconds=3600)](https://github.com/hashicorp/terraform) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [checkov](descriptors/terraform_checkov.md#readme) | [TERRAFORM_CHECKOV](descriptors/terraform_checkov.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/bridgecrewio/checkov?cacheSeconds=3600)](https://github.com/bridgecrewio/checkov) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [kics](descriptors/terraform_kics.md#readme) | [TERRAFORM_KICS](descriptors/terraform_kics.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/checkmarx/kics?cacheSeconds=3600)](https://github.com/checkmarx/kics) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ACTION**](descriptors/action.md#readme) | [actionlint](descriptors/action_actionlint.md#readme)| [ACTION_ACTIONLINT](descriptors/action_actionlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | +| | [**ANSIBLE**](descriptors/ansible.md#readme) | [ansible-lint](descriptors/ansible_ansible_lint.md#readme)| [ANSIBLE_ANSIBLE_LINT](descriptors/ansible_ansible_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | +| | [**ARM**](descriptors/arm.md#readme) | [arm-ttk](descriptors/arm_arm_ttk.md#readme)| [ARM_ARM_TTK](descriptors/arm_arm_ttk.md#readme)| | +| | [**CLOUDFORMATION**](descriptors/cloudformation.md#readme) | [cfn-lint](descriptors/cloudformation_cfn_lint.md#readme)| [CLOUDFORMATION_CFN_LINT](descriptors/cloudformation_cfn_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/aws-cloudformation/cfn-lint?cacheSeconds=3600)](https://github.com/aws-cloudformation/cfn-lint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**DOCKERFILE**](descriptors/dockerfile.md#readme) | [hadolint](descriptors/dockerfile_hadolint.md#readme)| [DOCKERFILE_HADOLINT](descriptors/dockerfile_hadolint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**EDITORCONFIG**](descriptors/editorconfig.md#readme) | [editorconfig-checker](descriptors/editorconfig_editorconfig_checker.md#readme)| [EDITORCONFIG_EDITORCONFIG_CHECKER](descriptors/editorconfig_editorconfig_checker.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | +| | [**GHERKIN**](descriptors/gherkin.md#readme) | [gherkin-lint](descriptors/gherkin_gherkin_lint.md#readme)| [GHERKIN_GHERKIN_LINT](descriptors/gherkin_gherkin_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/vsiakka/gherkin-lint?cacheSeconds=3600)](https://github.com/vsiakka/gherkin-lint) | +| | [**KUBERNETES**](descriptors/kubernetes.md#readme) | [kubeval](descriptors/kubernetes_kubeval.md#readme)| [KUBERNETES_KUBEVAL](descriptors/kubernetes_kubeval.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | +| | | [kubeconform](descriptors/kubernetes_kubeconform.md#readme)| [KUBERNETES_KUBECONFORM](descriptors/kubernetes_kubeconform.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | +| | [**OPENAPI**](descriptors/openapi.md#readme) | [spectral](descriptors/openapi_spectral.md#readme)| [OPENAPI_SPECTRAL](descriptors/openapi_spectral.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | +| | [**PUPPET**](descriptors/puppet.md#readme) | [puppet-lint](descriptors/puppet_puppet_lint.md#readme)| [PUPPET_PUPPET_LINT](descriptors/puppet_puppet_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rodjek/puppet-lint?cacheSeconds=3600)](https://github.com/rodjek/puppet-lint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**SNAKEMAKE**](descriptors/snakemake.md#readme) | [snakemake](descriptors/snakemake_snakemake.md#readme)| [SNAKEMAKE_LINT](descriptors/snakemake_snakemake.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | +| | | [snakefmt](descriptors/snakemake_snakefmt.md#readme)| [SNAKEMAKE_SNAKEFMT](descriptors/snakemake_snakefmt.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakefmt?cacheSeconds=3600)](https://github.com/snakemake/snakefmt) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**TEKTON**](descriptors/tekton.md#readme) | [tekton-lint](descriptors/tekton_tekton_lint.md#readme)| [TEKTON_TEKTON_LINT](descriptors/tekton_tekton_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | +| | [**TERRAFORM**](descriptors/terraform.md#readme) | [tflint](descriptors/terraform_tflint.md#readme)| [TERRAFORM_TFLINT](descriptors/terraform_tflint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/terraform-linters/tflint?cacheSeconds=3600)](https://github.com/terraform-linters/tflint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [terrascan](descriptors/terraform_terrascan.md#readme)| [TERRAFORM_TERRASCAN](descriptors/terraform_terrascan.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/accurics/terrascan?cacheSeconds=3600)](https://github.com/accurics/terrascan) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [terragrunt](descriptors/terraform_terragrunt.md#readme)| [TERRAFORM_TERRAGRUNT](descriptors/terraform_terragrunt.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/gruntwork-io/terragrunt?cacheSeconds=3600)](https://github.com/gruntwork-io/terragrunt) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [terraform-fmt](descriptors/terraform_terraform_fmt.md#readme)| [TERRAFORM_TERRAFORM_FMT](descriptors/terraform_terraform_fmt.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/hashicorp/terraform?cacheSeconds=3600)](https://github.com/hashicorp/terraform) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [checkov](descriptors/terraform_checkov.md#readme)| [TERRAFORM_CHECKOV](descriptors/terraform_checkov.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/bridgecrewio/checkov?cacheSeconds=3600)](https://github.com/bridgecrewio/checkov) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [kics](descriptors/terraform_kics.md#readme)| [TERRAFORM_KICS](descriptors/terraform_kics.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/checkmarx/kics?cacheSeconds=3600)](https://github.com/checkmarx/kics) | ### Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------|-----------------------------------------------------------|----------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**COPYPASTE**](descriptors/copypaste.md#readme) | [jscpd](descriptors/copypaste_jscpd.md#readme) | [COPYPASTE_JSCPD](descriptors/copypaste_jscpd.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | -| | [**REPOSITORY**](descriptors/repository.md#readme) | [devskim](descriptors/repository_devskim.md#readme) | [REPOSITORY_DEVSKIM](descriptors/repository_devskim.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/microsoft/DevSkim?cacheSeconds=3600)](https://github.com/microsoft/DevSkim) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [dustilock](descriptors/repository_dustilock.md#readme) | [REPOSITORY_DUSTILOCK](descriptors/repository_dustilock.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/Checkmarx/dustilock?cacheSeconds=3600)](https://github.com/Checkmarx/dustilock) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [git_diff](descriptors/repository_git_diff.md#readme) | [REPOSITORY_GIT_DIFF](descriptors/repository_git_diff.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | -| | | [gitleaks](descriptors/repository_gitleaks.md#readme) | [REPOSITORY_GITLEAKS](descriptors/repository_gitleaks.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [goodcheck](descriptors/repository_goodcheck.md#readme) | [REPOSITORY_GOODCHECK](descriptors/repository_goodcheck.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | -| | | [secretlint](descriptors/repository_secretlint.md#readme) | [REPOSITORY_SECRETLINT](descriptors/repository_secretlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [semgrep](descriptors/repository_semgrep.md#readme) | [REPOSITORY_SEMGREP](descriptors/repository_semgrep.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [syft](descriptors/repository_syft.md#readme) | [REPOSITORY_SYFT](descriptors/repository_syft.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/anchore/syft?cacheSeconds=3600)](https://github.com/anchore/syft) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](descriptors/repository_trivy.md#readme) | [REPOSITORY_TRIVY](descriptors/repository_trivy.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SPELL**](descriptors/spell.md#readme) | [misspell](descriptors/spell_misspell.md#readme) | [SPELL_MISSPELL](descriptors/spell_misspell.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [cspell](descriptors/spell_cspell.md#readme) | [SPELL_CSPELL](descriptors/spell_cspell.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**COPYPASTE**](descriptors/copypaste.md#readme) | [jscpd](descriptors/copypaste_jscpd.md#readme)| [COPYPASTE_JSCPD](descriptors/copypaste_jscpd.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | +| | [**REPOSITORY**](descriptors/repository.md#readme) | [devskim](descriptors/repository_devskim.md#readme)| [REPOSITORY_DEVSKIM](descriptors/repository_devskim.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/microsoft/DevSkim?cacheSeconds=3600)](https://github.com/microsoft/DevSkim) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [dustilock](descriptors/repository_dustilock.md#readme)| [REPOSITORY_DUSTILOCK](descriptors/repository_dustilock.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/Checkmarx/dustilock?cacheSeconds=3600)](https://github.com/Checkmarx/dustilock) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [git_diff](descriptors/repository_git_diff.md#readme)| [REPOSITORY_GIT_DIFF](descriptors/repository_git_diff.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | +| | | [gitleaks](descriptors/repository_gitleaks.md#readme)| [REPOSITORY_GITLEAKS](descriptors/repository_gitleaks.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [goodcheck](descriptors/repository_goodcheck.md#readme)| [REPOSITORY_GOODCHECK](descriptors/repository_goodcheck.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | +| | | [secretlint](descriptors/repository_secretlint.md#readme)| [REPOSITORY_SECRETLINT](descriptors/repository_secretlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [semgrep](descriptors/repository_semgrep.md#readme)| [REPOSITORY_SEMGREP](descriptors/repository_semgrep.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [syft](descriptors/repository_syft.md#readme)| [REPOSITORY_SYFT](descriptors/repository_syft.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/anchore/syft?cacheSeconds=3600)](https://github.com/anchore/syft) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](descriptors/repository_trivy.md#readme)| [REPOSITORY_TRIVY](descriptors/repository_trivy.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SPELL**](descriptors/spell.md#readme) | [misspell](descriptors/spell_misspell.md#readme)| [SPELL_MISSPELL](descriptors/spell_misspell.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [cspell](descriptors/spell_cspell.md#readme)| [SPELL_CSPELL](descriptors/spell_cspell.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | diff --git a/docs/reporters.md b/docs/reporters.md index 723a99a7a7e..13a8c8d1519 100644 --- a/docs/reporters.md +++ b/docs/reporters.md @@ -6,8 +6,8 @@ MegaLinter can generate various reports that you can activate / deactivate and customize -| Reporter | Description | Default | -|---------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|-------------------------| +| Reporter | Description | Default | +|-----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|-------------------------| | [Text files](reporters/TextReporter.md) | Generates **One log file by linter** + suggestions for fixes that can not be automated | Active | | [GitHub Pull Request comments](reporters/GitHubCommentReporter.md) | MegaLinter posts a comment on the PR with a summary of lint results, and links to detailed logs | Active if GitHub Action | | [Gitlab Merge Request comments](reporters/GitlabCommentReporter.md) | Mega-Linter posts a comment on the MR with a summary of lint results, and links to detailed logs | Active if in Gitlab CI | diff --git a/docs/standalone-linters.md b/docs/standalone-linters.md index 7f8a71cb123..87f53a5993a 100644 --- a/docs/standalone-linters.md +++ b/docs/standalone-linters.md @@ -1,28 +1,28 @@ # Standalone linter docker images -| Linter key | Docker image | Size | -|:-------------------------|:-------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------:| -| CLOUDFORMATION_CFN_LINT | oxsecurity/megalinter-only-cloudformation_cfn_lint:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-cloudformation_cfn_lint/v6) | -| DOCKERFILE_HADOLINT | oxsecurity/megalinter-only-dockerfile_hadolint:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-dockerfile_hadolint/v6) | -| GO_REVIVE | oxsecurity/megalinter-only-go_revive:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-go_revive/v6) | -| GROOVY_NPM_GROOVY_LINT | oxsecurity/megalinter-only-groovy_npm_groovy_lint:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-groovy_npm_groovy_lint/v6) | -| JAVA_CHECKSTYLE | oxsecurity/megalinter-only-java_checkstyle:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-java_checkstyle/v6) | -| JAVASCRIPT_ES | oxsecurity/megalinter-only-javascript_es:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-javascript_es/v6) | -| JSON_ESLINT_PLUGIN_JSONC | oxsecurity/megalinter-only-json_eslint_plugin_jsonc:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-json_eslint_plugin_jsonc/v6) | -| JSX_ESLINT | oxsecurity/megalinter-only-jsx_eslint:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-jsx_eslint/v6) | -| KOTLIN_KTLINT | oxsecurity/megalinter-only-kotlin_ktlint:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-kotlin_ktlint/v6) | -| PHP_PSALM | oxsecurity/megalinter-only-php_psalm:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-php_psalm/v6) | -| PYTHON_BANDIT | oxsecurity/megalinter-only-python_bandit:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-python_bandit/v6) | -| REPOSITORY_DEVSKIM | oxsecurity/megalinter-only-repository_devskim:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-repository_devskim/v6) | -| REPOSITORY_DUSTILOCK | oxsecurity/megalinter-only-repository_dustilock:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-repository_dustilock/v6) | -| REPOSITORY_GITLEAKS | oxsecurity/megalinter-only-repository_gitleaks:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-repository_gitleaks/v6) | -| REPOSITORY_SECRETLINT | oxsecurity/megalinter-only-repository_secretlint:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-repository_secretlint/v6) | -| REPOSITORY_SEMGREP | oxsecurity/megalinter-only-repository_semgrep:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-repository_semgrep/v6) | -| REPOSITORY_SYFT | oxsecurity/megalinter-only-repository_syft:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-repository_syft/v6) | -| REPOSITORY_TRIVY | oxsecurity/megalinter-only-repository_trivy:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-repository_trivy/v6) | -| TERRAFORM_TFLINT | oxsecurity/megalinter-only-terraform_tflint:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-terraform_tflint/v6) | -| TERRAFORM_TERRASCAN | oxsecurity/megalinter-only-terraform_terrascan:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-terraform_terrascan/v6) | -| TERRAFORM_CHECKOV | oxsecurity/megalinter-only-terraform_checkov:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-terraform_checkov/v6) | -| TSX_ESLINT | oxsecurity/megalinter-only-tsx_eslint:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-tsx_eslint/v6) | -| TYPESCRIPT_ES | oxsecurity/megalinter-only-typescript_es:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-typescript_es/v6) | +| Linter key | Docker image | Size | +| :----------| :----------- | :--: | +| CLOUDFORMATION_CFN_LINT | oxsecurity/megalinter-only-cloudformation_cfn_lint:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-cloudformation_cfn_lint/v6) | +| DOCKERFILE_HADOLINT | oxsecurity/megalinter-only-dockerfile_hadolint:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-dockerfile_hadolint/v6) | +| GO_REVIVE | oxsecurity/megalinter-only-go_revive:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-go_revive/v6) | +| GROOVY_NPM_GROOVY_LINT | oxsecurity/megalinter-only-groovy_npm_groovy_lint:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-groovy_npm_groovy_lint/v6) | +| JAVA_CHECKSTYLE | oxsecurity/megalinter-only-java_checkstyle:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-java_checkstyle/v6) | +| JAVASCRIPT_ES | oxsecurity/megalinter-only-javascript_es:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-javascript_es/v6) | +| JSON_ESLINT_PLUGIN_JSONC | oxsecurity/megalinter-only-json_eslint_plugin_jsonc:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-json_eslint_plugin_jsonc/v6) | +| JSX_ESLINT | oxsecurity/megalinter-only-jsx_eslint:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-jsx_eslint/v6) | +| KOTLIN_KTLINT | oxsecurity/megalinter-only-kotlin_ktlint:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-kotlin_ktlint/v6) | +| PHP_PSALM | oxsecurity/megalinter-only-php_psalm:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-php_psalm/v6) | +| PYTHON_BANDIT | oxsecurity/megalinter-only-python_bandit:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-python_bandit/v6) | +| REPOSITORY_DEVSKIM | oxsecurity/megalinter-only-repository_devskim:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-repository_devskim/v6) | +| REPOSITORY_DUSTILOCK | oxsecurity/megalinter-only-repository_dustilock:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-repository_dustilock/v6) | +| REPOSITORY_GITLEAKS | oxsecurity/megalinter-only-repository_gitleaks:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-repository_gitleaks/v6) | +| REPOSITORY_SECRETLINT | oxsecurity/megalinter-only-repository_secretlint:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-repository_secretlint/v6) | +| REPOSITORY_SEMGREP | oxsecurity/megalinter-only-repository_semgrep:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-repository_semgrep/v6) | +| REPOSITORY_SYFT | oxsecurity/megalinter-only-repository_syft:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-repository_syft/v6) | +| REPOSITORY_TRIVY | oxsecurity/megalinter-only-repository_trivy:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-repository_trivy/v6) | +| TERRAFORM_TFLINT | oxsecurity/megalinter-only-terraform_tflint:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-terraform_tflint/v6) | +| TERRAFORM_TERRASCAN | oxsecurity/megalinter-only-terraform_terrascan:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-terraform_terrascan/v6) | +| TERRAFORM_CHECKOV | oxsecurity/megalinter-only-terraform_checkov:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-terraform_checkov/v6) | +| TSX_ESLINT | oxsecurity/megalinter-only-tsx_eslint:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-tsx_eslint/v6) | +| TYPESCRIPT_ES | oxsecurity/megalinter-only-typescript_es:v6 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-only-typescript_es/v6) | diff --git a/docs/supported-linters.md b/docs/supported-linters.md index d09e7c7625f..66d6e3d0bae 100644 --- a/docs/supported-linters.md +++ b/docs/supported-linters.md @@ -10,124 +10,124 @@ All linters are integrated in the [MegaLinter docker image](https://hub.docker.c ## Languages -| | Language | Linter | Configuration key | Additional | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------|-------------------------------------------------------------------------|------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**BASH**](descriptors/bash.md#readme) | [bash-exec](descriptors/bash_bash_exec.md#readme) | [BASH_EXEC](descriptors/bash_bash_exec.md#readme) | | -| | | [shellcheck](descriptors/bash_shellcheck.md#readme) | [BASH_SHELLCHECK](descriptors/bash_shellcheck.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [shfmt](descriptors/bash_shfmt.md#readme) | [BASH_SHFMT](descriptors/bash_shfmt.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**C**](descriptors/c.md#readme) | [cpplint](descriptors/c_cpplint.md#readme) | [C_CPPLINT](descriptors/c_cpplint.md#readme) | | -| | [**CLOJURE**](descriptors/clojure.md#readme) | [clj-kondo](descriptors/clojure_clj_kondo.md#readme) | [CLOJURE_CLJ_KONDO](descriptors/clojure_clj_kondo.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/borkdude/clj-kondo?cacheSeconds=3600)](https://github.com/borkdude/clj-kondo) | -| | [**COFFEE**](descriptors/coffee.md#readme) | [coffeelint](descriptors/coffee_coffeelint.md#readme) | [COFFEE_COFFEELINT](descriptors/coffee_coffeelint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/clutchski/coffeelint?cacheSeconds=3600)](https://github.com/clutchski/coffeelint) | -| | [**C++** (CPP)](descriptors/cpp.md#readme) | [cpplint](descriptors/cpp_cpplint.md#readme) | [CPP_CPPLINT](descriptors/cpp_cpplint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/cpplint/cpplint?cacheSeconds=3600)](https://github.com/cpplint/cpplint) | -| | [**C#** (CSHARP)](descriptors/csharp.md#readme) | [dotnet-format](descriptors/csharp_dotnet_format.md#readme) | [CSHARP_DOTNET_FORMAT](descriptors/csharp_dotnet_format.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/dotnet/format?cacheSeconds=3600)](https://github.com/dotnet/format) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**DART**](descriptors/dart.md#readme) | [dartanalyzer](descriptors/dart_dartanalyzer.md#readme) | [DART_DARTANALYZER](descriptors/dart_dartanalyzer.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/dart-lang/sdk?cacheSeconds=3600)](https://github.com/dart-lang/sdk) | -| | [**GO**](descriptors/go.md#readme) | [golangci-lint](descriptors/go_golangci_lint.md#readme) | [GO_GOLANGCI_LINT](descriptors/go_golangci_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/golangci/golangci-lint?cacheSeconds=3600)](https://github.com/golangci/golangci-lint) | -| | | [revive](descriptors/go_revive.md#readme) | [GO_REVIVE](descriptors/go_revive.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/mgechev/revive?cacheSeconds=3600)](https://github.com/mgechev/revive) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**GROOVY**](descriptors/groovy.md#readme) | [npm-groovy-lint](descriptors/groovy_npm_groovy_lint.md#readme) | [GROOVY_NPM_GROOVY_LINT](descriptors/groovy_npm_groovy_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**JAVA**](descriptors/java.md#readme) | [checkstyle](descriptors/java_checkstyle.md#readme) | [JAVA_CHECKSTYLE](descriptors/java_checkstyle.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/checkstyle/checkstyle?cacheSeconds=3600)](https://github.com/checkstyle/checkstyle) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**JAVASCRIPT**](descriptors/javascript.md#readme) | [eslint](descriptors/javascript_eslint.md#readme) | [JAVASCRIPT_ES](descriptors/javascript_eslint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [standard](descriptors/javascript_standard.md#readme) | [JAVASCRIPT_STANDARD](descriptors/javascript_standard.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [prettier](descriptors/javascript_prettier.md#readme) | [JAVASCRIPT_PRETTIER](descriptors/javascript_prettier.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**JSX**](descriptors/jsx.md#readme) | [eslint](descriptors/jsx_eslint.md#readme) | [JSX_ESLINT](descriptors/jsx_eslint.md#readme) | ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**KOTLIN**](descriptors/kotlin.md#readme) | [ktlint](descriptors/kotlin_ktlint.md#readme) | [KOTLIN_KTLINT](descriptors/kotlin_ktlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**LUA**](descriptors/lua.md#readme) | [luacheck](descriptors/lua_luacheck.md#readme) | [LUA_LUACHECK](descriptors/lua_luacheck.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/luarocks/luacheck?cacheSeconds=3600)](https://github.com/luarocks/luacheck) | -| | [**PERL**](descriptors/perl.md#readme) | [perlcritic](descriptors/perl_perlcritic.md#readme) | [PERL_PERLCRITIC](descriptors/perl_perlcritic.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/Perl-Critic/Perl-Critic?cacheSeconds=3600)](https://github.com/Perl-Critic/Perl-Critic) | -| | [**PHP**](descriptors/php.md#readme) | [phpcs](descriptors/php_phpcs.md#readme) | [PHP_PHPCS](descriptors/php_phpcs.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/squizlabs/PHP_CodeSniffer?cacheSeconds=3600)](https://github.com/squizlabs/PHP_CodeSniffer) | -| | | [phpstan](descriptors/php_phpstan.md#readme) | [PHP_PHPSTAN](descriptors/php_phpstan.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/phpstan/phpstan?cacheSeconds=3600)](https://github.com/phpstan/phpstan) | -| | | [psalm](descriptors/php_psalm.md#readme) | [PHP_PSALM](descriptors/php_psalm.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/vimeo/psalm?cacheSeconds=3600)](https://github.com/vimeo/psalm) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [phplint](descriptors/php_phplint.md#readme) | [PHP_PHPLINT](descriptors/php_phplint.md#readme) | | -| | [**POWERSHELL**](descriptors/powershell.md#readme) | [powershell](descriptors/powershell_powershell.md#readme) | [POWERSHELL_POWERSHELL](descriptors/powershell_powershell.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PowerShell/PSScriptAnalyzer?cacheSeconds=3600)](https://github.com/PowerShell/PSScriptAnalyzer) | -| | [**PYTHON**](descriptors/python.md#readme) | [pylint](descriptors/python_pylint.md#readme) | [PYTHON_PYLINT](descriptors/python_pylint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/pylint?cacheSeconds=3600)](https://github.com/PyCQA/pylint) | -| | | [black](descriptors/python_black.md#readme) | [PYTHON_BLACK](descriptors/python_black.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/psf/black?cacheSeconds=3600)](https://github.com/psf/black) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [flake8](descriptors/python_flake8.md#readme) | [PYTHON_FLAKE8](descriptors/python_flake8.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/flake8?cacheSeconds=3600)](https://github.com/PyCQA/flake8) | -| | | [isort](descriptors/python_isort.md#readme) | [PYTHON_ISORT](descriptors/python_isort.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/isort?cacheSeconds=3600)](https://github.com/PyCQA/isort) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [bandit](descriptors/python_bandit.md#readme) | [PYTHON_BANDIT](descriptors/python_bandit.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/bandit?cacheSeconds=3600)](https://github.com/PyCQA/bandit) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [mypy](descriptors/python_mypy.md#readme) | [PYTHON_MYPY](descriptors/python_mypy.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/python/mypy?cacheSeconds=3600)](https://github.com/python/mypy) | -| | [**R**](descriptors/r.md#readme) | [lintr](descriptors/r_lintr.md#readme) | [R_LINTR](descriptors/r_lintr.md#readme) | | -| | [**RAKU**](descriptors/raku.md#readme) | [raku](descriptors/raku_raku.md#readme) | [RAKU_RAKU](descriptors/raku_raku.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rakudo/rakudo?cacheSeconds=3600)](https://github.com/rakudo/rakudo) | -| | [**RUBY**](descriptors/ruby.md#readme) | [rubocop](descriptors/ruby_rubocop.md#readme) | [RUBY_RUBOCOP](descriptors/ruby_rubocop.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rubocop-hq/rubocop?cacheSeconds=3600)](https://github.com/rubocop-hq/rubocop) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**RUST**](descriptors/rust.md#readme) | [clippy](descriptors/rust_clippy.md#readme) | [RUST_CLIPPY](descriptors/rust_clippy.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rust-lang/rust-clippy?cacheSeconds=3600)](https://github.com/rust-lang/rust-clippy) | -| | [**SALESFORCE**](descriptors/salesforce.md#readme) | [sfdx-scanner-apex](descriptors/salesforce_sfdx_scanner_apex.md#readme) | [SALESFORCE_SFDX_SCANNER_APEX](descriptors/salesforce_sfdx_scanner_apex.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | -| | | [sfdx-scanner-aura](descriptors/salesforce_sfdx_scanner_aura.md#readme) | [SALESFORCE_SFDX_SCANNER_AURA](descriptors/salesforce_sfdx_scanner_aura.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | -| | | [sfdx-scanner-lwc](descriptors/salesforce_sfdx_scanner_lwc.md#readme) | [SALESFORCE_SFDX_SCANNER_LWC](descriptors/salesforce_sfdx_scanner_lwc.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | -| | [**SCALA**](descriptors/scala.md#readme) | [scalafix](descriptors/scala_scalafix.md#readme) | [SCALA_SCALAFIX](descriptors/scala_scalafix.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/scalacenter/scalafix?cacheSeconds=3600)](https://github.com/scalacenter/scalafix) | -| | [**SQL**](descriptors/sql.md#readme) | [sql-lint](descriptors/sql_sql_lint.md#readme) | [SQL_SQL_LINT](descriptors/sql_sql_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | -| | | [sqlfluff](descriptors/sql_sqlfluff.md#readme) | [SQL_SQLFLUFF](descriptors/sql_sqlfluff.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | -| | | [tsqllint](descriptors/sql_tsqllint.md#readme) | [SQL_TSQLLINT](descriptors/sql_tsqllint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/tsqllint/tsqllint?cacheSeconds=3600)](https://github.com/tsqllint/tsqllint) | -| | [**SWIFT**](descriptors/swift.md#readme) | [swiftlint](descriptors/swift_swiftlint.md#readme) | [SWIFT_SWIFTLINT](descriptors/swift_swiftlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/realm/SwiftLint?cacheSeconds=3600)](https://github.com/realm/SwiftLint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**TSX**](descriptors/tsx.md#readme) | [eslint](descriptors/tsx_eslint.md#readme) | [TSX_ESLINT](descriptors/tsx_eslint.md#readme) | ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**TYPESCRIPT**](descriptors/typescript.md#readme) | [eslint](descriptors/typescript_eslint.md#readme) | [TYPESCRIPT_ES](descriptors/typescript_eslint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [standard](descriptors/typescript_standard.md#readme) | [TYPESCRIPT_STANDARD](descriptors/typescript_standard.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [prettier](descriptors/typescript_prettier.md#readme) | [TYPESCRIPT_PRETTIER](descriptors/typescript_prettier.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**Visual Basic .NET** (VBDOTNET)](descriptors/vbdotnet.md#readme) | [dotnet-format](descriptors/vbdotnet_dotnet_format.md#readme) | [VBDOTNET_DOTNET_FORMAT](descriptors/vbdotnet_dotnet_format.md#readme) | ![formatter](https://shields.io/badge/-format-yellow) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**BASH**](descriptors/bash.md#readme) | [bash-exec](descriptors/bash_bash_exec.md#readme)| [BASH_EXEC](descriptors/bash_bash_exec.md#readme)| | +| | | [shellcheck](descriptors/bash_shellcheck.md#readme)| [BASH_SHELLCHECK](descriptors/bash_shellcheck.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [shfmt](descriptors/bash_shfmt.md#readme)| [BASH_SHFMT](descriptors/bash_shfmt.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**C**](descriptors/c.md#readme) | [cpplint](descriptors/c_cpplint.md#readme)| [C_CPPLINT](descriptors/c_cpplint.md#readme)| | +| | [**CLOJURE**](descriptors/clojure.md#readme) | [clj-kondo](descriptors/clojure_clj_kondo.md#readme)| [CLOJURE_CLJ_KONDO](descriptors/clojure_clj_kondo.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/borkdude/clj-kondo?cacheSeconds=3600)](https://github.com/borkdude/clj-kondo) | +| | [**COFFEE**](descriptors/coffee.md#readme) | [coffeelint](descriptors/coffee_coffeelint.md#readme)| [COFFEE_COFFEELINT](descriptors/coffee_coffeelint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/clutchski/coffeelint?cacheSeconds=3600)](https://github.com/clutchski/coffeelint) | +| | [**C++** (CPP)](descriptors/cpp.md#readme) | [cpplint](descriptors/cpp_cpplint.md#readme)| [CPP_CPPLINT](descriptors/cpp_cpplint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/cpplint/cpplint?cacheSeconds=3600)](https://github.com/cpplint/cpplint) | +| | [**C#** (CSHARP)](descriptors/csharp.md#readme) | [dotnet-format](descriptors/csharp_dotnet_format.md#readme)| [CSHARP_DOTNET_FORMAT](descriptors/csharp_dotnet_format.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/dotnet/format?cacheSeconds=3600)](https://github.com/dotnet/format) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**DART**](descriptors/dart.md#readme) | [dartanalyzer](descriptors/dart_dartanalyzer.md#readme)| [DART_DARTANALYZER](descriptors/dart_dartanalyzer.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/dart-lang/sdk?cacheSeconds=3600)](https://github.com/dart-lang/sdk) | +| | [**GO**](descriptors/go.md#readme) | [golangci-lint](descriptors/go_golangci_lint.md#readme)| [GO_GOLANGCI_LINT](descriptors/go_golangci_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/golangci/golangci-lint?cacheSeconds=3600)](https://github.com/golangci/golangci-lint) | +| | | [revive](descriptors/go_revive.md#readme)| [GO_REVIVE](descriptors/go_revive.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/mgechev/revive?cacheSeconds=3600)](https://github.com/mgechev/revive) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**GROOVY**](descriptors/groovy.md#readme) | [npm-groovy-lint](descriptors/groovy_npm_groovy_lint.md#readme)| [GROOVY_NPM_GROOVY_LINT](descriptors/groovy_npm_groovy_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**JAVA**](descriptors/java.md#readme) | [checkstyle](descriptors/java_checkstyle.md#readme)| [JAVA_CHECKSTYLE](descriptors/java_checkstyle.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/checkstyle/checkstyle?cacheSeconds=3600)](https://github.com/checkstyle/checkstyle) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**JAVASCRIPT**](descriptors/javascript.md#readme) | [eslint](descriptors/javascript_eslint.md#readme)| [JAVASCRIPT_ES](descriptors/javascript_eslint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [standard](descriptors/javascript_standard.md#readme)| [JAVASCRIPT_STANDARD](descriptors/javascript_standard.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [prettier](descriptors/javascript_prettier.md#readme)| [JAVASCRIPT_PRETTIER](descriptors/javascript_prettier.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**JSX**](descriptors/jsx.md#readme) | [eslint](descriptors/jsx_eslint.md#readme)| [JSX_ESLINT](descriptors/jsx_eslint.md#readme)| ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**KOTLIN**](descriptors/kotlin.md#readme) | [ktlint](descriptors/kotlin_ktlint.md#readme)| [KOTLIN_KTLINT](descriptors/kotlin_ktlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**LUA**](descriptors/lua.md#readme) | [luacheck](descriptors/lua_luacheck.md#readme)| [LUA_LUACHECK](descriptors/lua_luacheck.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/luarocks/luacheck?cacheSeconds=3600)](https://github.com/luarocks/luacheck) | +| | [**PERL**](descriptors/perl.md#readme) | [perlcritic](descriptors/perl_perlcritic.md#readme)| [PERL_PERLCRITIC](descriptors/perl_perlcritic.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/Perl-Critic/Perl-Critic?cacheSeconds=3600)](https://github.com/Perl-Critic/Perl-Critic) | +| | [**PHP**](descriptors/php.md#readme) | [phpcs](descriptors/php_phpcs.md#readme)| [PHP_PHPCS](descriptors/php_phpcs.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/squizlabs/PHP_CodeSniffer?cacheSeconds=3600)](https://github.com/squizlabs/PHP_CodeSniffer) | +| | | [phpstan](descriptors/php_phpstan.md#readme)| [PHP_PHPSTAN](descriptors/php_phpstan.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/phpstan/phpstan?cacheSeconds=3600)](https://github.com/phpstan/phpstan) | +| | | [psalm](descriptors/php_psalm.md#readme)| [PHP_PSALM](descriptors/php_psalm.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/vimeo/psalm?cacheSeconds=3600)](https://github.com/vimeo/psalm) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [phplint](descriptors/php_phplint.md#readme)| [PHP_PHPLINT](descriptors/php_phplint.md#readme)| | +| | [**POWERSHELL**](descriptors/powershell.md#readme) | [powershell](descriptors/powershell_powershell.md#readme)| [POWERSHELL_POWERSHELL](descriptors/powershell_powershell.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PowerShell/PSScriptAnalyzer?cacheSeconds=3600)](https://github.com/PowerShell/PSScriptAnalyzer) | +| | [**PYTHON**](descriptors/python.md#readme) | [pylint](descriptors/python_pylint.md#readme)| [PYTHON_PYLINT](descriptors/python_pylint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/pylint?cacheSeconds=3600)](https://github.com/PyCQA/pylint) | +| | | [black](descriptors/python_black.md#readme)| [PYTHON_BLACK](descriptors/python_black.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/psf/black?cacheSeconds=3600)](https://github.com/psf/black) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [flake8](descriptors/python_flake8.md#readme)| [PYTHON_FLAKE8](descriptors/python_flake8.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/flake8?cacheSeconds=3600)](https://github.com/PyCQA/flake8) | +| | | [isort](descriptors/python_isort.md#readme)| [PYTHON_ISORT](descriptors/python_isort.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/isort?cacheSeconds=3600)](https://github.com/PyCQA/isort) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [bandit](descriptors/python_bandit.md#readme)| [PYTHON_BANDIT](descriptors/python_bandit.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/bandit?cacheSeconds=3600)](https://github.com/PyCQA/bandit) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [mypy](descriptors/python_mypy.md#readme)| [PYTHON_MYPY](descriptors/python_mypy.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/python/mypy?cacheSeconds=3600)](https://github.com/python/mypy) | +| | [**R**](descriptors/r.md#readme) | [lintr](descriptors/r_lintr.md#readme)| [R_LINTR](descriptors/r_lintr.md#readme)| | +| | [**RAKU**](descriptors/raku.md#readme) | [raku](descriptors/raku_raku.md#readme)| [RAKU_RAKU](descriptors/raku_raku.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rakudo/rakudo?cacheSeconds=3600)](https://github.com/rakudo/rakudo) | +| | [**RUBY**](descriptors/ruby.md#readme) | [rubocop](descriptors/ruby_rubocop.md#readme)| [RUBY_RUBOCOP](descriptors/ruby_rubocop.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rubocop-hq/rubocop?cacheSeconds=3600)](https://github.com/rubocop-hq/rubocop) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**RUST**](descriptors/rust.md#readme) | [clippy](descriptors/rust_clippy.md#readme)| [RUST_CLIPPY](descriptors/rust_clippy.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rust-lang/rust-clippy?cacheSeconds=3600)](https://github.com/rust-lang/rust-clippy) | +| | [**SALESFORCE**](descriptors/salesforce.md#readme) | [sfdx-scanner-apex](descriptors/salesforce_sfdx_scanner_apex.md#readme)| [SALESFORCE_SFDX_SCANNER_APEX](descriptors/salesforce_sfdx_scanner_apex.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | +| | | [sfdx-scanner-aura](descriptors/salesforce_sfdx_scanner_aura.md#readme)| [SALESFORCE_SFDX_SCANNER_AURA](descriptors/salesforce_sfdx_scanner_aura.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | +| | | [sfdx-scanner-lwc](descriptors/salesforce_sfdx_scanner_lwc.md#readme)| [SALESFORCE_SFDX_SCANNER_LWC](descriptors/salesforce_sfdx_scanner_lwc.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | +| | [**SCALA**](descriptors/scala.md#readme) | [scalafix](descriptors/scala_scalafix.md#readme)| [SCALA_SCALAFIX](descriptors/scala_scalafix.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/scalacenter/scalafix?cacheSeconds=3600)](https://github.com/scalacenter/scalafix) | +| | [**SQL**](descriptors/sql.md#readme) | [sql-lint](descriptors/sql_sql_lint.md#readme)| [SQL_SQL_LINT](descriptors/sql_sql_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | +| | | [sqlfluff](descriptors/sql_sqlfluff.md#readme)| [SQL_SQLFLUFF](descriptors/sql_sqlfluff.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | +| | | [tsqllint](descriptors/sql_tsqllint.md#readme)| [SQL_TSQLLINT](descriptors/sql_tsqllint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/tsqllint/tsqllint?cacheSeconds=3600)](https://github.com/tsqllint/tsqllint) | +| | [**SWIFT**](descriptors/swift.md#readme) | [swiftlint](descriptors/swift_swiftlint.md#readme)| [SWIFT_SWIFTLINT](descriptors/swift_swiftlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/realm/SwiftLint?cacheSeconds=3600)](https://github.com/realm/SwiftLint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**TSX**](descriptors/tsx.md#readme) | [eslint](descriptors/tsx_eslint.md#readme)| [TSX_ESLINT](descriptors/tsx_eslint.md#readme)| ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**TYPESCRIPT**](descriptors/typescript.md#readme) | [eslint](descriptors/typescript_eslint.md#readme)| [TYPESCRIPT_ES](descriptors/typescript_eslint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [standard](descriptors/typescript_standard.md#readme)| [TYPESCRIPT_STANDARD](descriptors/typescript_standard.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [prettier](descriptors/typescript_prettier.md#readme)| [TYPESCRIPT_PRETTIER](descriptors/typescript_prettier.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**Visual Basic .NET** (VBDOTNET)](descriptors/vbdotnet.md#readme) | [dotnet-format](descriptors/vbdotnet_dotnet_format.md#readme)| [VBDOTNET_DOTNET_FORMAT](descriptors/vbdotnet_dotnet_format.md#readme)| ![formatter](https://shields.io/badge/-format-yellow) | ## Formats -| | Format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------|-------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**CSS**](descriptors/css.md#readme) | [stylelint](descriptors/css_stylelint.md#readme) | [CSS_STYLELINT](descriptors/css_stylelint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [scss-lint](descriptors/css_scss_lint.md#readme) | [CSS_SCSS_LINT](descriptors/css_scss_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | -| | [**ENV**](descriptors/env.md#readme) | [dotenv-linter](descriptors/env_dotenv_linter.md#readme) | [ENV_DOTENV_LINTER](descriptors/env_dotenv_linter.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](descriptors/graphql.md#readme) | [graphql-schema-linter](descriptors/graphql_graphql_schema_linter.md#readme) | [GRAPHQL_GRAPHQL_SCHEMA_LINTER](descriptors/graphql_graphql_schema_linter.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | -| | [**HTML**](descriptors/html.md#readme) | [htmlhint](descriptors/html_htmlhint.md#readme) | [HTML_HTMLHINT](descriptors/html_htmlhint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | -| | [**JSON**](descriptors/json.md#readme) | [jsonlint](descriptors/json_jsonlint.md#readme) | [JSON_JSONLINT](descriptors/json_jsonlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | -| | | [eslint-plugin-jsonc](descriptors/json_eslint_plugin_jsonc.md#readme) | [JSON_ESLINT_PLUGIN_JSONC](descriptors/json_eslint_plugin_jsonc.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [v8r](descriptors/json_v8r.md#readme) | [JSON_V8R](descriptors/json_v8r.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | -| | | [prettier](descriptors/json_prettier.md#readme) | [JSON_PRETTIER](descriptors/json_prettier.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**LATEX**](descriptors/latex.md#readme) | [chktex](descriptors/latex_chktex.md#readme) | [LATEX_CHKTEX](descriptors/latex_chktex.md#readme) | | -| | [**MARKDOWN**](descriptors/markdown.md#readme) | [markdownlint](descriptors/markdown_markdownlint.md#readme) | [MARKDOWN_MARKDOWNLINT](descriptors/markdown_markdownlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [remark-lint](descriptors/markdown_remark_lint.md#readme) | [MARKDOWN_REMARK_LINT](descriptors/markdown_remark_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/remarkjs/remark-lint?cacheSeconds=3600)](https://github.com/remarkjs/remark-lint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [markdown-link-check](descriptors/markdown_markdown_link_check.md#readme) | [MARKDOWN_MARKDOWN_LINK_CHECK](descriptors/markdown_markdown_link_check.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | -| | | [markdown-table-formatter](descriptors/markdown_markdown_table_formatter.md#readme) | [MARKDOWN_MARKDOWN_TABLE_FORMATTER](descriptors/markdown_markdown_table_formatter.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**PROTOBUF**](descriptors/protobuf.md#readme) | [protolint](descriptors/protobuf_protolint.md#readme) | [PROTOBUF_PROTOLINT](descriptors/protobuf_protolint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**RST**](descriptors/rst.md#readme) | [rst-lint](descriptors/rst_rst_lint.md#readme) | [RST_RST_LINT](descriptors/rst_rst_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/twolfson/restructuredtext-lint?cacheSeconds=3600)](https://github.com/twolfson/restructuredtext-lint) | -| | | [rstcheck](descriptors/rst_rstcheck.md#readme) | [RST_RSTCHECK](descriptors/rst_rstcheck.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/myint/rstcheck?cacheSeconds=3600)](https://github.com/myint/rstcheck) | -| | [**XML**](descriptors/xml.md#readme) | [xmllint](descriptors/xml_xmllint.md#readme) | [XML_XMLLINT](descriptors/xml_xmllint.md#readme) | | -| | [**YAML**](descriptors/yaml.md#readme) | [prettier](descriptors/yaml_prettier.md#readme) | [YAML_PRETTIER](descriptors/yaml_prettier.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [yamllint](descriptors/yaml_yamllint.md#readme) | [YAML_YAMLLINT](descriptors/yaml_yamllint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | -| | | [v8r](descriptors/yaml_v8r.md#readme) | [YAML_V8R](descriptors/yaml_v8r.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | Format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**CSS**](descriptors/css.md#readme) | [stylelint](descriptors/css_stylelint.md#readme)| [CSS_STYLELINT](descriptors/css_stylelint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [scss-lint](descriptors/css_scss_lint.md#readme)| [CSS_SCSS_LINT](descriptors/css_scss_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | +| | [**ENV**](descriptors/env.md#readme) | [dotenv-linter](descriptors/env_dotenv_linter.md#readme)| [ENV_DOTENV_LINTER](descriptors/env_dotenv_linter.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**GRAPHQL**](descriptors/graphql.md#readme) | [graphql-schema-linter](descriptors/graphql_graphql_schema_linter.md#readme)| [GRAPHQL_GRAPHQL_SCHEMA_LINTER](descriptors/graphql_graphql_schema_linter.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**HTML**](descriptors/html.md#readme) | [htmlhint](descriptors/html_htmlhint.md#readme)| [HTML_HTMLHINT](descriptors/html_htmlhint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | +| | [**JSON**](descriptors/json.md#readme) | [jsonlint](descriptors/json_jsonlint.md#readme)| [JSON_JSONLINT](descriptors/json_jsonlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | +| | | [eslint-plugin-jsonc](descriptors/json_eslint_plugin_jsonc.md#readme)| [JSON_ESLINT_PLUGIN_JSONC](descriptors/json_eslint_plugin_jsonc.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [v8r](descriptors/json_v8r.md#readme)| [JSON_V8R](descriptors/json_v8r.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | | [prettier](descriptors/json_prettier.md#readme)| [JSON_PRETTIER](descriptors/json_prettier.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**LATEX**](descriptors/latex.md#readme) | [chktex](descriptors/latex_chktex.md#readme)| [LATEX_CHKTEX](descriptors/latex_chktex.md#readme)| | +| | [**MARKDOWN**](descriptors/markdown.md#readme) | [markdownlint](descriptors/markdown_markdownlint.md#readme)| [MARKDOWN_MARKDOWNLINT](descriptors/markdown_markdownlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [remark-lint](descriptors/markdown_remark_lint.md#readme)| [MARKDOWN_REMARK_LINT](descriptors/markdown_remark_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/remarkjs/remark-lint?cacheSeconds=3600)](https://github.com/remarkjs/remark-lint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [markdown-link-check](descriptors/markdown_markdown_link_check.md#readme)| [MARKDOWN_MARKDOWN_LINK_CHECK](descriptors/markdown_markdown_link_check.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | +| | | [markdown-table-formatter](descriptors/markdown_markdown_table_formatter.md#readme)| [MARKDOWN_MARKDOWN_TABLE_FORMATTER](descriptors/markdown_markdown_table_formatter.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**PROTOBUF**](descriptors/protobuf.md#readme) | [protolint](descriptors/protobuf_protolint.md#readme)| [PROTOBUF_PROTOLINT](descriptors/protobuf_protolint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**RST**](descriptors/rst.md#readme) | [rst-lint](descriptors/rst_rst_lint.md#readme)| [RST_RST_LINT](descriptors/rst_rst_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/twolfson/restructuredtext-lint?cacheSeconds=3600)](https://github.com/twolfson/restructuredtext-lint) | +| | | [rstcheck](descriptors/rst_rstcheck.md#readme)| [RST_RSTCHECK](descriptors/rst_rstcheck.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/myint/rstcheck?cacheSeconds=3600)](https://github.com/myint/rstcheck) | +| | [**XML**](descriptors/xml.md#readme) | [xmllint](descriptors/xml_xmllint.md#readme)| [XML_XMLLINT](descriptors/xml_xmllint.md#readme)| | +| | [**YAML**](descriptors/yaml.md#readme) | [prettier](descriptors/yaml_prettier.md#readme)| [YAML_PRETTIER](descriptors/yaml_prettier.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [yamllint](descriptors/yaml_yamllint.md#readme)| [YAML_YAMLLINT](descriptors/yaml_yamllint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | +| | | [v8r](descriptors/yaml_v8r.md#readme)| [YAML_V8R](descriptors/yaml_v8r.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | ## Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------|---------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ACTION**](descriptors/action.md#readme) | [actionlint](descriptors/action_actionlint.md#readme) | [ACTION_ACTIONLINT](descriptors/action_actionlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | -| | [**ANSIBLE**](descriptors/ansible.md#readme) | [ansible-lint](descriptors/ansible_ansible_lint.md#readme) | [ANSIBLE_ANSIBLE_LINT](descriptors/ansible_ansible_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | -| | [**ARM**](descriptors/arm.md#readme) | [arm-ttk](descriptors/arm_arm_ttk.md#readme) | [ARM_ARM_TTK](descriptors/arm_arm_ttk.md#readme) | | -| | [**CLOUDFORMATION**](descriptors/cloudformation.md#readme) | [cfn-lint](descriptors/cloudformation_cfn_lint.md#readme) | [CLOUDFORMATION_CFN_LINT](descriptors/cloudformation_cfn_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/aws-cloudformation/cfn-lint?cacheSeconds=3600)](https://github.com/aws-cloudformation/cfn-lint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**DOCKERFILE**](descriptors/dockerfile.md#readme) | [hadolint](descriptors/dockerfile_hadolint.md#readme) | [DOCKERFILE_HADOLINT](descriptors/dockerfile_hadolint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**EDITORCONFIG**](descriptors/editorconfig.md#readme) | [editorconfig-checker](descriptors/editorconfig_editorconfig_checker.md#readme) | [EDITORCONFIG_EDITORCONFIG_CHECKER](descriptors/editorconfig_editorconfig_checker.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | -| | [**GHERKIN**](descriptors/gherkin.md#readme) | [gherkin-lint](descriptors/gherkin_gherkin_lint.md#readme) | [GHERKIN_GHERKIN_LINT](descriptors/gherkin_gherkin_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/vsiakka/gherkin-lint?cacheSeconds=3600)](https://github.com/vsiakka/gherkin-lint) | -| | [**KUBERNETES**](descriptors/kubernetes.md#readme) | [kubeval](descriptors/kubernetes_kubeval.md#readme) | [KUBERNETES_KUBEVAL](descriptors/kubernetes_kubeval.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | -| | | [kubeconform](descriptors/kubernetes_kubeconform.md#readme) | [KUBERNETES_KUBECONFORM](descriptors/kubernetes_kubeconform.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | -| | [**OPENAPI**](descriptors/openapi.md#readme) | [spectral](descriptors/openapi_spectral.md#readme) | [OPENAPI_SPECTRAL](descriptors/openapi_spectral.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | -| | [**PUPPET**](descriptors/puppet.md#readme) | [puppet-lint](descriptors/puppet_puppet_lint.md#readme) | [PUPPET_PUPPET_LINT](descriptors/puppet_puppet_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rodjek/puppet-lint?cacheSeconds=3600)](https://github.com/rodjek/puppet-lint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**SNAKEMAKE**](descriptors/snakemake.md#readme) | [snakemake](descriptors/snakemake_snakemake.md#readme) | [SNAKEMAKE_LINT](descriptors/snakemake_snakemake.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | -| | | [snakefmt](descriptors/snakemake_snakefmt.md#readme) | [SNAKEMAKE_SNAKEFMT](descriptors/snakemake_snakefmt.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakefmt?cacheSeconds=3600)](https://github.com/snakemake/snakefmt) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**TEKTON**](descriptors/tekton.md#readme) | [tekton-lint](descriptors/tekton_tekton_lint.md#readme) | [TEKTON_TEKTON_LINT](descriptors/tekton_tekton_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | -| | [**TERRAFORM**](descriptors/terraform.md#readme) | [tflint](descriptors/terraform_tflint.md#readme) | [TERRAFORM_TFLINT](descriptors/terraform_tflint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/terraform-linters/tflint?cacheSeconds=3600)](https://github.com/terraform-linters/tflint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [terrascan](descriptors/terraform_terrascan.md#readme) | [TERRAFORM_TERRASCAN](descriptors/terraform_terrascan.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/accurics/terrascan?cacheSeconds=3600)](https://github.com/accurics/terrascan) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [terragrunt](descriptors/terraform_terragrunt.md#readme) | [TERRAFORM_TERRAGRUNT](descriptors/terraform_terragrunt.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/gruntwork-io/terragrunt?cacheSeconds=3600)](https://github.com/gruntwork-io/terragrunt) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [terraform-fmt](descriptors/terraform_terraform_fmt.md#readme) | [TERRAFORM_TERRAFORM_FMT](descriptors/terraform_terraform_fmt.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/hashicorp/terraform?cacheSeconds=3600)](https://github.com/hashicorp/terraform) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [checkov](descriptors/terraform_checkov.md#readme) | [TERRAFORM_CHECKOV](descriptors/terraform_checkov.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/bridgecrewio/checkov?cacheSeconds=3600)](https://github.com/bridgecrewio/checkov) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [kics](descriptors/terraform_kics.md#readme) | [TERRAFORM_KICS](descriptors/terraform_kics.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/checkmarx/kics?cacheSeconds=3600)](https://github.com/checkmarx/kics) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ACTION**](descriptors/action.md#readme) | [actionlint](descriptors/action_actionlint.md#readme)| [ACTION_ACTIONLINT](descriptors/action_actionlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | +| | [**ANSIBLE**](descriptors/ansible.md#readme) | [ansible-lint](descriptors/ansible_ansible_lint.md#readme)| [ANSIBLE_ANSIBLE_LINT](descriptors/ansible_ansible_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | +| | [**ARM**](descriptors/arm.md#readme) | [arm-ttk](descriptors/arm_arm_ttk.md#readme)| [ARM_ARM_TTK](descriptors/arm_arm_ttk.md#readme)| | +| | [**CLOUDFORMATION**](descriptors/cloudformation.md#readme) | [cfn-lint](descriptors/cloudformation_cfn_lint.md#readme)| [CLOUDFORMATION_CFN_LINT](descriptors/cloudformation_cfn_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/aws-cloudformation/cfn-lint?cacheSeconds=3600)](https://github.com/aws-cloudformation/cfn-lint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**DOCKERFILE**](descriptors/dockerfile.md#readme) | [hadolint](descriptors/dockerfile_hadolint.md#readme)| [DOCKERFILE_HADOLINT](descriptors/dockerfile_hadolint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**EDITORCONFIG**](descriptors/editorconfig.md#readme) | [editorconfig-checker](descriptors/editorconfig_editorconfig_checker.md#readme)| [EDITORCONFIG_EDITORCONFIG_CHECKER](descriptors/editorconfig_editorconfig_checker.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | +| | [**GHERKIN**](descriptors/gherkin.md#readme) | [gherkin-lint](descriptors/gherkin_gherkin_lint.md#readme)| [GHERKIN_GHERKIN_LINT](descriptors/gherkin_gherkin_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/vsiakka/gherkin-lint?cacheSeconds=3600)](https://github.com/vsiakka/gherkin-lint) | +| | [**KUBERNETES**](descriptors/kubernetes.md#readme) | [kubeval](descriptors/kubernetes_kubeval.md#readme)| [KUBERNETES_KUBEVAL](descriptors/kubernetes_kubeval.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | +| | | [kubeconform](descriptors/kubernetes_kubeconform.md#readme)| [KUBERNETES_KUBECONFORM](descriptors/kubernetes_kubeconform.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | +| | [**OPENAPI**](descriptors/openapi.md#readme) | [spectral](descriptors/openapi_spectral.md#readme)| [OPENAPI_SPECTRAL](descriptors/openapi_spectral.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | +| | [**PUPPET**](descriptors/puppet.md#readme) | [puppet-lint](descriptors/puppet_puppet_lint.md#readme)| [PUPPET_PUPPET_LINT](descriptors/puppet_puppet_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rodjek/puppet-lint?cacheSeconds=3600)](https://github.com/rodjek/puppet-lint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**SNAKEMAKE**](descriptors/snakemake.md#readme) | [snakemake](descriptors/snakemake_snakemake.md#readme)| [SNAKEMAKE_LINT](descriptors/snakemake_snakemake.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | +| | | [snakefmt](descriptors/snakemake_snakefmt.md#readme)| [SNAKEMAKE_SNAKEFMT](descriptors/snakemake_snakefmt.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakefmt?cacheSeconds=3600)](https://github.com/snakemake/snakefmt) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**TEKTON**](descriptors/tekton.md#readme) | [tekton-lint](descriptors/tekton_tekton_lint.md#readme)| [TEKTON_TEKTON_LINT](descriptors/tekton_tekton_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | +| | [**TERRAFORM**](descriptors/terraform.md#readme) | [tflint](descriptors/terraform_tflint.md#readme)| [TERRAFORM_TFLINT](descriptors/terraform_tflint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/terraform-linters/tflint?cacheSeconds=3600)](https://github.com/terraform-linters/tflint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [terrascan](descriptors/terraform_terrascan.md#readme)| [TERRAFORM_TERRASCAN](descriptors/terraform_terrascan.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/accurics/terrascan?cacheSeconds=3600)](https://github.com/accurics/terrascan) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [terragrunt](descriptors/terraform_terragrunt.md#readme)| [TERRAFORM_TERRAGRUNT](descriptors/terraform_terragrunt.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/gruntwork-io/terragrunt?cacheSeconds=3600)](https://github.com/gruntwork-io/terragrunt) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [terraform-fmt](descriptors/terraform_terraform_fmt.md#readme)| [TERRAFORM_TERRAFORM_FMT](descriptors/terraform_terraform_fmt.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/hashicorp/terraform?cacheSeconds=3600)](https://github.com/hashicorp/terraform) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [checkov](descriptors/terraform_checkov.md#readme)| [TERRAFORM_CHECKOV](descriptors/terraform_checkov.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/bridgecrewio/checkov?cacheSeconds=3600)](https://github.com/bridgecrewio/checkov) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [kics](descriptors/terraform_kics.md#readme)| [TERRAFORM_KICS](descriptors/terraform_kics.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/checkmarx/kics?cacheSeconds=3600)](https://github.com/checkmarx/kics) | ## Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------|-----------------------------------------------------------|----------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**COPYPASTE**](descriptors/copypaste.md#readme) | [jscpd](descriptors/copypaste_jscpd.md#readme) | [COPYPASTE_JSCPD](descriptors/copypaste_jscpd.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | -| | [**REPOSITORY**](descriptors/repository.md#readme) | [devskim](descriptors/repository_devskim.md#readme) | [REPOSITORY_DEVSKIM](descriptors/repository_devskim.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/microsoft/DevSkim?cacheSeconds=3600)](https://github.com/microsoft/DevSkim) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [dustilock](descriptors/repository_dustilock.md#readme) | [REPOSITORY_DUSTILOCK](descriptors/repository_dustilock.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/Checkmarx/dustilock?cacheSeconds=3600)](https://github.com/Checkmarx/dustilock) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [git_diff](descriptors/repository_git_diff.md#readme) | [REPOSITORY_GIT_DIFF](descriptors/repository_git_diff.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | -| | | [gitleaks](descriptors/repository_gitleaks.md#readme) | [REPOSITORY_GITLEAKS](descriptors/repository_gitleaks.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [goodcheck](descriptors/repository_goodcheck.md#readme) | [REPOSITORY_GOODCHECK](descriptors/repository_goodcheck.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | -| | | [secretlint](descriptors/repository_secretlint.md#readme) | [REPOSITORY_SECRETLINT](descriptors/repository_secretlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [semgrep](descriptors/repository_semgrep.md#readme) | [REPOSITORY_SEMGREP](descriptors/repository_semgrep.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [syft](descriptors/repository_syft.md#readme) | [REPOSITORY_SYFT](descriptors/repository_syft.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/anchore/syft?cacheSeconds=3600)](https://github.com/anchore/syft) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](descriptors/repository_trivy.md#readme) | [REPOSITORY_TRIVY](descriptors/repository_trivy.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SPELL**](descriptors/spell.md#readme) | [misspell](descriptors/spell_misspell.md#readme) | [SPELL_MISSPELL](descriptors/spell_misspell.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [cspell](descriptors/spell_cspell.md#readme) | [SPELL_CSPELL](descriptors/spell_cspell.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**COPYPASTE**](descriptors/copypaste.md#readme) | [jscpd](descriptors/copypaste_jscpd.md#readme)| [COPYPASTE_JSCPD](descriptors/copypaste_jscpd.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | +| | [**REPOSITORY**](descriptors/repository.md#readme) | [devskim](descriptors/repository_devskim.md#readme)| [REPOSITORY_DEVSKIM](descriptors/repository_devskim.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/microsoft/DevSkim?cacheSeconds=3600)](https://github.com/microsoft/DevSkim) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [dustilock](descriptors/repository_dustilock.md#readme)| [REPOSITORY_DUSTILOCK](descriptors/repository_dustilock.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/Checkmarx/dustilock?cacheSeconds=3600)](https://github.com/Checkmarx/dustilock) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [git_diff](descriptors/repository_git_diff.md#readme)| [REPOSITORY_GIT_DIFF](descriptors/repository_git_diff.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | +| | | [gitleaks](descriptors/repository_gitleaks.md#readme)| [REPOSITORY_GITLEAKS](descriptors/repository_gitleaks.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [goodcheck](descriptors/repository_goodcheck.md#readme)| [REPOSITORY_GOODCHECK](descriptors/repository_goodcheck.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | +| | | [secretlint](descriptors/repository_secretlint.md#readme)| [REPOSITORY_SECRETLINT](descriptors/repository_secretlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [semgrep](descriptors/repository_semgrep.md#readme)| [REPOSITORY_SEMGREP](descriptors/repository_semgrep.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [syft](descriptors/repository_syft.md#readme)| [REPOSITORY_SYFT](descriptors/repository_syft.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/anchore/syft?cacheSeconds=3600)](https://github.com/anchore/syft) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](descriptors/repository_trivy.md#readme)| [REPOSITORY_TRIVY](descriptors/repository_trivy.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SPELL**](descriptors/spell.md#readme) | [misspell](descriptors/spell_misspell.md#readme)| [SPELL_MISSPELL](descriptors/spell_misspell.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [cspell](descriptors/spell_cspell.md#readme)| [SPELL_CSPELL](descriptors/spell_cspell.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | diff --git a/flavors/ci_light/action.yml b/flavors/ci_light/action.yml index 5da357369fd..3e3fed57c8f 100644 --- a/flavors/ci_light/action.yml +++ b/flavors/ci_light/action.yml @@ -7,7 +7,7 @@ outputs: description: "0 if no source file has been updated, 1 if source files has been updated" runs: using: "docker" - image: "docker://oxsecurity/megalinter-ci_light:v6.0.3" + image: "docker://oxsecurity/megalinter-ci_light:v6" args: - "-v" - "/var/run/docker.sock:/var/run/docker.sock:rw" diff --git a/flavors/documentation/action.yml b/flavors/documentation/action.yml index a4172e55bfe..d58f964b135 100644 --- a/flavors/documentation/action.yml +++ b/flavors/documentation/action.yml @@ -7,7 +7,7 @@ outputs: description: "0 if no source file has been updated, 1 if source files has been updated" runs: using: "docker" - image: "docker://oxsecurity/megalinter-documentation:v6.0.3" + image: "docker://oxsecurity/megalinter-documentation:v6" args: - "-v" - "/var/run/docker.sock:/var/run/docker.sock:rw" diff --git a/flavors/dotnet/action.yml b/flavors/dotnet/action.yml index af92e77d78a..3a6fac77c84 100644 --- a/flavors/dotnet/action.yml +++ b/flavors/dotnet/action.yml @@ -7,7 +7,7 @@ outputs: description: "0 if no source file has been updated, 1 if source files has been updated" runs: using: "docker" - image: "docker://oxsecurity/megalinter-dotnet:v6.0.3" + image: "docker://oxsecurity/megalinter-dotnet:v6" args: - "-v" - "/var/run/docker.sock:/var/run/docker.sock:rw" diff --git a/flavors/go/action.yml b/flavors/go/action.yml index f8845587861..7437e3d7899 100644 --- a/flavors/go/action.yml +++ b/flavors/go/action.yml @@ -7,7 +7,7 @@ outputs: description: "0 if no source file has been updated, 1 if source files has been updated" runs: using: "docker" - image: "docker://oxsecurity/megalinter-go:v6.0.3" + image: "docker://oxsecurity/megalinter-go:v6" args: - "-v" - "/var/run/docker.sock:/var/run/docker.sock:rw" diff --git a/flavors/java/action.yml b/flavors/java/action.yml index add7d8e8de7..06ce9b02583 100644 --- a/flavors/java/action.yml +++ b/flavors/java/action.yml @@ -7,7 +7,7 @@ outputs: description: "0 if no source file has been updated, 1 if source files has been updated" runs: using: "docker" - image: "docker://oxsecurity/megalinter-java:v6.0.3" + image: "docker://oxsecurity/megalinter-java:v6" args: - "-v" - "/var/run/docker.sock:/var/run/docker.sock:rw" diff --git a/flavors/javascript/action.yml b/flavors/javascript/action.yml index 71a46f41460..9c77cb70fdd 100644 --- a/flavors/javascript/action.yml +++ b/flavors/javascript/action.yml @@ -7,7 +7,7 @@ outputs: description: "0 if no source file has been updated, 1 if source files has been updated" runs: using: "docker" - image: "docker://oxsecurity/megalinter-javascript:v6.0.3" + image: "docker://oxsecurity/megalinter-javascript:v6" args: - "-v" - "/var/run/docker.sock:/var/run/docker.sock:rw" diff --git a/flavors/php/action.yml b/flavors/php/action.yml index d3d88762b00..0ebb2bbc83c 100644 --- a/flavors/php/action.yml +++ b/flavors/php/action.yml @@ -7,7 +7,7 @@ outputs: description: "0 if no source file has been updated, 1 if source files has been updated" runs: using: "docker" - image: "docker://oxsecurity/megalinter-php:v6.0.3" + image: "docker://oxsecurity/megalinter-php:v6" args: - "-v" - "/var/run/docker.sock:/var/run/docker.sock:rw" diff --git a/flavors/python/action.yml b/flavors/python/action.yml index 1bdd32534ef..f88c5138454 100644 --- a/flavors/python/action.yml +++ b/flavors/python/action.yml @@ -7,7 +7,7 @@ outputs: description: "0 if no source file has been updated, 1 if source files has been updated" runs: using: "docker" - image: "docker://oxsecurity/megalinter-python:v6.0.3" + image: "docker://oxsecurity/megalinter-python:v6" args: - "-v" - "/var/run/docker.sock:/var/run/docker.sock:rw" diff --git a/flavors/ruby/action.yml b/flavors/ruby/action.yml index 58ff7eeb756..3a9f1f4941b 100644 --- a/flavors/ruby/action.yml +++ b/flavors/ruby/action.yml @@ -7,7 +7,7 @@ outputs: description: "0 if no source file has been updated, 1 if source files has been updated" runs: using: "docker" - image: "docker://oxsecurity/megalinter-ruby:v6.0.3" + image: "docker://oxsecurity/megalinter-ruby:v6" args: - "-v" - "/var/run/docker.sock:/var/run/docker.sock:rw" diff --git a/flavors/rust/action.yml b/flavors/rust/action.yml index 7d75fa4d788..7c71cfccfb7 100644 --- a/flavors/rust/action.yml +++ b/flavors/rust/action.yml @@ -7,7 +7,7 @@ outputs: description: "0 if no source file has been updated, 1 if source files has been updated" runs: using: "docker" - image: "docker://oxsecurity/megalinter-rust:v6.0.3" + image: "docker://oxsecurity/megalinter-rust:v6" args: - "-v" - "/var/run/docker.sock:/var/run/docker.sock:rw" diff --git a/flavors/salesforce/action.yml b/flavors/salesforce/action.yml index 79e3de14f8d..b85a8ab0767 100644 --- a/flavors/salesforce/action.yml +++ b/flavors/salesforce/action.yml @@ -7,7 +7,7 @@ outputs: description: "0 if no source file has been updated, 1 if source files has been updated" runs: using: "docker" - image: "docker://oxsecurity/megalinter-salesforce:v6.0.3" + image: "docker://oxsecurity/megalinter-salesforce:v6" args: - "-v" - "/var/run/docker.sock:/var/run/docker.sock:rw" diff --git a/flavors/security/action.yml b/flavors/security/action.yml index 0984e99e07c..3af08e57dc3 100644 --- a/flavors/security/action.yml +++ b/flavors/security/action.yml @@ -7,7 +7,7 @@ outputs: description: "0 if no source file has been updated, 1 if source files has been updated" runs: using: "docker" - image: "docker://oxsecurity/megalinter-security:v6.0.3" + image: "docker://oxsecurity/megalinter-security:v6" args: - "-v" - "/var/run/docker.sock:/var/run/docker.sock:rw" diff --git a/flavors/swift/action.yml b/flavors/swift/action.yml index 44afd4839fa..5725d9202e1 100644 --- a/flavors/swift/action.yml +++ b/flavors/swift/action.yml @@ -7,7 +7,7 @@ outputs: description: "0 if no source file has been updated, 1 if source files has been updated" runs: using: "docker" - image: "docker://oxsecurity/megalinter-swift:v6.0.3" + image: "docker://oxsecurity/megalinter-swift:v6" args: - "-v" - "/var/run/docker.sock:/var/run/docker.sock:rw" diff --git a/flavors/terraform/action.yml b/flavors/terraform/action.yml index 74cec06c886..ea298ca6897 100644 --- a/flavors/terraform/action.yml +++ b/flavors/terraform/action.yml @@ -7,7 +7,7 @@ outputs: description: "0 if no source file has been updated, 1 if source files has been updated" runs: using: "docker" - image: "docker://oxsecurity/megalinter-terraform:v6.0.3" + image: "docker://oxsecurity/megalinter-terraform:v6" args: - "-v" - "/var/run/docker.sock:/var/run/docker.sock:rw" diff --git a/mega-linter-runner/README.md b/mega-linter-runner/README.md index ee3a8bc2a19..6036d5c0867 100644 --- a/mega-linter-runner/README.md +++ b/mega-linter-runner/README.md @@ -131,124 +131,124 @@ You can generate a ready-to-use [.mega-linter.yml configuration file](https://me ### Languages -| | Language | Linter | Configuration key | Additional | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**BASH**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash.md#readme) | [bash-exec](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_bash_exec.md#readme) | [BASH_EXEC](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_bash_exec.md#readme) | | -| | | [shellcheck](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shellcheck.md#readme) | [BASH_SHELLCHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shellcheck.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | -| | | [shfmt](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shfmt.md#readme) | [BASH_SHFMT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shfmt.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**C**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c.md#readme) | [cpplint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c_cpplint.md#readme) | [C_CPPLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c_cpplint.md#readme) | | -| | [**CLOJURE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure.md#readme) | [clj-kondo](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure_clj_kondo.md#readme) | [CLOJURE_CLJ_KONDO](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure_clj_kondo.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/borkdude/clj-kondo?cacheSeconds=3600)](https://github.com/borkdude/clj-kondo) | -| | [**COFFEE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/coffee.md#readme) | [coffeelint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/coffee_coffeelint.md#readme) | [COFFEE_COFFEELINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/coffee_coffeelint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/clutchski/coffeelint?cacheSeconds=3600)](https://github.com/clutchski/coffeelint) | -| | [**C++** (CPP)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp.md#readme) | [cpplint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp_cpplint.md#readme) | [CPP_CPPLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp_cpplint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/cpplint/cpplint?cacheSeconds=3600)](https://github.com/cpplint/cpplint) | -| | [**C#** (CSHARP)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp.md#readme) | [dotnet-format](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp_dotnet_format.md#readme) | [CSHARP_DOTNET_FORMAT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp_dotnet_format.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/dotnet/format?cacheSeconds=3600)](https://github.com/dotnet/format) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**DART**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dart.md#readme) | [dartanalyzer](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dart_dartanalyzer.md#readme) | [DART_DARTANALYZER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dart_dartanalyzer.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/dart-lang/sdk?cacheSeconds=3600)](https://github.com/dart-lang/sdk) | -| | [**GO**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go.md#readme) | [golangci-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_golangci_lint.md#readme) | [GO_GOLANGCI_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_golangci_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/golangci/golangci-lint?cacheSeconds=3600)](https://github.com/golangci/golangci-lint) | -| | | [revive](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_revive.md#readme) | [GO_REVIVE](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_revive.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/mgechev/revive?cacheSeconds=3600)](https://github.com/mgechev/revive) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**GROOVY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/groovy.md#readme) | [npm-groovy-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/groovy_npm_groovy_lint.md#readme) | [GROOVY_NPM_GROOVY_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/groovy_npm_groovy_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**JAVA**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java.md#readme) | [checkstyle](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java_checkstyle.md#readme) | [JAVA_CHECKSTYLE](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java_checkstyle.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/checkstyle/checkstyle?cacheSeconds=3600)](https://github.com/checkstyle/checkstyle) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**JAVASCRIPT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript.md#readme) | [eslint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_eslint.md#readme) | [JAVASCRIPT_ES](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_eslint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [standard](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_standard.md#readme) | [JAVASCRIPT_STANDARD](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_standard.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [prettier](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_prettier.md#readme) | [JAVASCRIPT_PRETTIER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_prettier.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**JSX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx.md#readme) | [eslint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx_eslint.md#readme) | [JSX_ESLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx_eslint.md#readme) | ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**KOTLIN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin.md#readme) | [ktlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin_ktlint.md#readme) | [KOTLIN_KTLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin_ktlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**LUA**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua.md#readme) | [luacheck](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua_luacheck.md#readme) | [LUA_LUACHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua_luacheck.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/luarocks/luacheck?cacheSeconds=3600)](https://github.com/luarocks/luacheck) | -| | [**PERL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/perl.md#readme) | [perlcritic](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/perl_perlcritic.md#readme) | [PERL_PERLCRITIC](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/perl_perlcritic.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/Perl-Critic/Perl-Critic?cacheSeconds=3600)](https://github.com/Perl-Critic/Perl-Critic) | -| | [**PHP**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php.md#readme) | [phpcs](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpcs.md#readme) | [PHP_PHPCS](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpcs.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/squizlabs/PHP_CodeSniffer?cacheSeconds=3600)](https://github.com/squizlabs/PHP_CodeSniffer) | -| | | [phpstan](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpstan.md#readme) | [PHP_PHPSTAN](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpstan.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/phpstan/phpstan?cacheSeconds=3600)](https://github.com/phpstan/phpstan) | -| | | [psalm](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_psalm.md#readme) | [PHP_PSALM](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_psalm.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/vimeo/psalm?cacheSeconds=3600)](https://github.com/vimeo/psalm) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [phplint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phplint.md#readme) | [PHP_PHPLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phplint.md#readme) | | -| | [**POWERSHELL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell.md#readme) | [powershell](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell_powershell.md#readme) | [POWERSHELL_POWERSHELL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell_powershell.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PowerShell/PSScriptAnalyzer?cacheSeconds=3600)](https://github.com/PowerShell/PSScriptAnalyzer) | -| | [**PYTHON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python.md#readme) | [pylint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_pylint.md#readme) | [PYTHON_PYLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_pylint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/pylint?cacheSeconds=3600)](https://github.com/PyCQA/pylint) | -| | | [black](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_black.md#readme) | [PYTHON_BLACK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_black.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/psf/black?cacheSeconds=3600)](https://github.com/psf/black) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [flake8](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_flake8.md#readme) | [PYTHON_FLAKE8](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_flake8.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/flake8?cacheSeconds=3600)](https://github.com/PyCQA/flake8) | -| | | [isort](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_isort.md#readme) | [PYTHON_ISORT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_isort.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/isort?cacheSeconds=3600)](https://github.com/PyCQA/isort) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [bandit](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_bandit.md#readme) | [PYTHON_BANDIT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_bandit.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/PyCQA/bandit?cacheSeconds=3600)](https://github.com/PyCQA/bandit) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [mypy](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_mypy.md#readme) | [PYTHON_MYPY](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_mypy.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/python/mypy?cacheSeconds=3600)](https://github.com/python/mypy) | -| | [**R**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/r.md#readme) | [lintr](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/r_lintr.md#readme) | [R_LINTR](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/r_lintr.md#readme) | | -| | [**RAKU**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/raku.md#readme) | [raku](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/raku_raku.md#readme) | [RAKU_RAKU](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/raku_raku.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rakudo/rakudo?cacheSeconds=3600)](https://github.com/rakudo/rakudo) | -| | [**RUBY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ruby.md#readme) | [rubocop](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ruby_rubocop.md#readme) | [RUBY_RUBOCOP](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ruby_rubocop.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rubocop-hq/rubocop?cacheSeconds=3600)](https://github.com/rubocop-hq/rubocop) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**RUST**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rust.md#readme) | [clippy](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rust_clippy.md#readme) | [RUST_CLIPPY](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rust_clippy.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rust-lang/rust-clippy?cacheSeconds=3600)](https://github.com/rust-lang/rust-clippy) | -| | [**SALESFORCE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce.md#readme) | [sfdx-scanner-apex](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_apex.md#readme) | [SALESFORCE_SFDX_SCANNER_APEX](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_apex.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | -| | | [sfdx-scanner-aura](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_aura.md#readme) | [SALESFORCE_SFDX_SCANNER_AURA](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_aura.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | -| | | [sfdx-scanner-lwc](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_lwc.md#readme) | [SALESFORCE_SFDX_SCANNER_LWC](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_lwc.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | -| | [**SCALA**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/scala.md#readme) | [scalafix](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/scala_scalafix.md#readme) | [SCALA_SCALAFIX](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/scala_scalafix.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/scalacenter/scalafix?cacheSeconds=3600)](https://github.com/scalacenter/scalafix) | -| | [**SQL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql.md#readme) | [sql-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sql_lint.md#readme) | [SQL_SQL_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sql_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | -| | | [sqlfluff](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sqlfluff.md#readme) | [SQL_SQLFLUFF](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sqlfluff.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | -| | | [tsqllint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_tsqllint.md#readme) | [SQL_TSQLLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_tsqllint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/tsqllint/tsqllint?cacheSeconds=3600)](https://github.com/tsqllint/tsqllint) | -| | [**SWIFT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/swift.md#readme) | [swiftlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/swift_swiftlint.md#readme) | [SWIFT_SWIFTLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/swift_swiftlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/realm/SwiftLint?cacheSeconds=3600)](https://github.com/realm/SwiftLint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**TSX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx.md#readme) | [eslint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx_eslint.md#readme) | [TSX_ESLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx_eslint.md#readme) | ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**TYPESCRIPT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript.md#readme) | [eslint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_eslint.md#readme) | [TYPESCRIPT_ES](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_eslint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [standard](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_standard.md#readme) | [TYPESCRIPT_STANDARD](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_standard.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [prettier](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_prettier.md#readme) | [TYPESCRIPT_PRETTIER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_prettier.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**Visual Basic .NET** (VBDOTNET)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/vbdotnet.md#readme) | [dotnet-format](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/vbdotnet_dotnet_format.md#readme) | [VBDOTNET_DOTNET_FORMAT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/vbdotnet_dotnet_format.md#readme) | ![formatter](https://shields.io/badge/-format-yellow) | +| | Language | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**BASH**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash.md#readme) | [bash-exec](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_bash_exec.md#readme)| [BASH_EXEC](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_bash_exec.md#readme)| | +| | | [shellcheck](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shellcheck.md#readme)| [BASH_SHELLCHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shellcheck.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/koalaman/shellcheck?cacheSeconds=3600)](https://github.com/koalaman/shellcheck) | +| | | [shfmt](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shfmt.md#readme)| [BASH_SHFMT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/bash_shfmt.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/mvdan/sh?cacheSeconds=3600)](https://github.com/mvdan/sh) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**C**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c.md#readme) | [cpplint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c_cpplint.md#readme)| [C_CPPLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/c_cpplint.md#readme)| | +| | [**CLOJURE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure.md#readme) | [clj-kondo](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure_clj_kondo.md#readme)| [CLOJURE_CLJ_KONDO](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/clojure_clj_kondo.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/borkdude/clj-kondo?cacheSeconds=3600)](https://github.com/borkdude/clj-kondo) | +| | [**COFFEE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/coffee.md#readme) | [coffeelint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/coffee_coffeelint.md#readme)| [COFFEE_COFFEELINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/coffee_coffeelint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/clutchski/coffeelint?cacheSeconds=3600)](https://github.com/clutchski/coffeelint) | +| | [**C++** (CPP)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp.md#readme) | [cpplint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp_cpplint.md#readme)| [CPP_CPPLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cpp_cpplint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/cpplint/cpplint?cacheSeconds=3600)](https://github.com/cpplint/cpplint) | +| | [**C#** (CSHARP)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp.md#readme) | [dotnet-format](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp_dotnet_format.md#readme)| [CSHARP_DOTNET_FORMAT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/csharp_dotnet_format.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/dotnet/format?cacheSeconds=3600)](https://github.com/dotnet/format) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**DART**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dart.md#readme) | [dartanalyzer](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dart_dartanalyzer.md#readme)| [DART_DARTANALYZER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dart_dartanalyzer.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/dart-lang/sdk?cacheSeconds=3600)](https://github.com/dart-lang/sdk) | +| | [**GO**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go.md#readme) | [golangci-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_golangci_lint.md#readme)| [GO_GOLANGCI_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_golangci_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/golangci/golangci-lint?cacheSeconds=3600)](https://github.com/golangci/golangci-lint) | +| | | [revive](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_revive.md#readme)| [GO_REVIVE](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/go_revive.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/mgechev/revive?cacheSeconds=3600)](https://github.com/mgechev/revive) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**GROOVY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/groovy.md#readme) | [npm-groovy-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/groovy_npm_groovy_lint.md#readme)| [GROOVY_NPM_GROOVY_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/groovy_npm_groovy_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/npm-groovy-lint?cacheSeconds=3600)](https://github.com/nvuillam/npm-groovy-lint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**JAVA**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java.md#readme) | [checkstyle](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java_checkstyle.md#readme)| [JAVA_CHECKSTYLE](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/java_checkstyle.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/checkstyle/checkstyle?cacheSeconds=3600)](https://github.com/checkstyle/checkstyle) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**JAVASCRIPT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript.md#readme) | [eslint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_eslint.md#readme)| [JAVASCRIPT_ES](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_eslint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [standard](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_standard.md#readme)| [JAVASCRIPT_STANDARD](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_standard.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [prettier](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_prettier.md#readme)| [JAVASCRIPT_PRETTIER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/javascript_prettier.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**JSX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx.md#readme) | [eslint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx_eslint.md#readme)| [JSX_ESLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/jsx_eslint.md#readme)| ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**KOTLIN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin.md#readme) | [ktlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin_ktlint.md#readme)| [KOTLIN_KTLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kotlin_ktlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/pinterest/ktlint?cacheSeconds=3600)](https://github.com/pinterest/ktlint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**LUA**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua.md#readme) | [luacheck](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua_luacheck.md#readme)| [LUA_LUACHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/lua_luacheck.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/luarocks/luacheck?cacheSeconds=3600)](https://github.com/luarocks/luacheck) | +| | [**PERL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/perl.md#readme) | [perlcritic](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/perl_perlcritic.md#readme)| [PERL_PERLCRITIC](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/perl_perlcritic.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/Perl-Critic/Perl-Critic?cacheSeconds=3600)](https://github.com/Perl-Critic/Perl-Critic) | +| | [**PHP**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php.md#readme) | [phpcs](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpcs.md#readme)| [PHP_PHPCS](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpcs.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/squizlabs/PHP_CodeSniffer?cacheSeconds=3600)](https://github.com/squizlabs/PHP_CodeSniffer) | +| | | [phpstan](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpstan.md#readme)| [PHP_PHPSTAN](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phpstan.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/phpstan/phpstan?cacheSeconds=3600)](https://github.com/phpstan/phpstan) | +| | | [psalm](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_psalm.md#readme)| [PHP_PSALM](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_psalm.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/vimeo/psalm?cacheSeconds=3600)](https://github.com/vimeo/psalm) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [phplint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phplint.md#readme)| [PHP_PHPLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/php_phplint.md#readme)| | +| | [**POWERSHELL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell.md#readme) | [powershell](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell_powershell.md#readme)| [POWERSHELL_POWERSHELL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/powershell_powershell.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PowerShell/PSScriptAnalyzer?cacheSeconds=3600)](https://github.com/PowerShell/PSScriptAnalyzer) | +| | [**PYTHON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python.md#readme) | [pylint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_pylint.md#readme)| [PYTHON_PYLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_pylint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/pylint?cacheSeconds=3600)](https://github.com/PyCQA/pylint) | +| | | [black](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_black.md#readme)| [PYTHON_BLACK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_black.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/psf/black?cacheSeconds=3600)](https://github.com/psf/black) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [flake8](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_flake8.md#readme)| [PYTHON_FLAKE8](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_flake8.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/flake8?cacheSeconds=3600)](https://github.com/PyCQA/flake8) | +| | | [isort](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_isort.md#readme)| [PYTHON_ISORT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_isort.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/isort?cacheSeconds=3600)](https://github.com/PyCQA/isort) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [bandit](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_bandit.md#readme)| [PYTHON_BANDIT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_bandit.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/PyCQA/bandit?cacheSeconds=3600)](https://github.com/PyCQA/bandit) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [mypy](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_mypy.md#readme)| [PYTHON_MYPY](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/python_mypy.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/python/mypy?cacheSeconds=3600)](https://github.com/python/mypy) | +| | [**R**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/r.md#readme) | [lintr](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/r_lintr.md#readme)| [R_LINTR](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/r_lintr.md#readme)| | +| | [**RAKU**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/raku.md#readme) | [raku](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/raku_raku.md#readme)| [RAKU_RAKU](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/raku_raku.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rakudo/rakudo?cacheSeconds=3600)](https://github.com/rakudo/rakudo) | +| | [**RUBY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ruby.md#readme) | [rubocop](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ruby_rubocop.md#readme)| [RUBY_RUBOCOP](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ruby_rubocop.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rubocop-hq/rubocop?cacheSeconds=3600)](https://github.com/rubocop-hq/rubocop) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**RUST**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rust.md#readme) | [clippy](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rust_clippy.md#readme)| [RUST_CLIPPY](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rust_clippy.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rust-lang/rust-clippy?cacheSeconds=3600)](https://github.com/rust-lang/rust-clippy) | +| | [**SALESFORCE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce.md#readme) | [sfdx-scanner-apex](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_apex.md#readme)| [SALESFORCE_SFDX_SCANNER_APEX](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_apex.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | +| | | [sfdx-scanner-aura](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_aura.md#readme)| [SALESFORCE_SFDX_SCANNER_AURA](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_aura.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | +| | | [sfdx-scanner-lwc](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_lwc.md#readme)| [SALESFORCE_SFDX_SCANNER_LWC](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/salesforce_sfdx_scanner_lwc.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/forcedotcom/sfdx-scanner?cacheSeconds=3600)](https://github.com/forcedotcom/sfdx-scanner) | +| | [**SCALA**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/scala.md#readme) | [scalafix](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/scala_scalafix.md#readme)| [SCALA_SCALAFIX](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/scala_scalafix.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/scalacenter/scalafix?cacheSeconds=3600)](https://github.com/scalacenter/scalafix) | +| | [**SQL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql.md#readme) | [sql-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sql_lint.md#readme)| [SQL_SQL_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sql_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/joereynolds/sql-lint?cacheSeconds=3600)](https://github.com/joereynolds/sql-lint) | +| | | [sqlfluff](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sqlfluff.md#readme)| [SQL_SQLFLUFF](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_sqlfluff.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/sqlfluff/sqlfluff?cacheSeconds=3600)](https://github.com/sqlfluff/sqlfluff) | +| | | [tsqllint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_tsqllint.md#readme)| [SQL_TSQLLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/sql_tsqllint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/tsqllint/tsqllint?cacheSeconds=3600)](https://github.com/tsqllint/tsqllint) | +| | [**SWIFT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/swift.md#readme) | [swiftlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/swift_swiftlint.md#readme)| [SWIFT_SWIFTLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/swift_swiftlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/realm/SwiftLint?cacheSeconds=3600)](https://github.com/realm/SwiftLint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**TSX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx.md#readme) | [eslint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx_eslint.md#readme)| [TSX_ESLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tsx_eslint.md#readme)| ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**TYPESCRIPT**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript.md#readme) | [eslint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_eslint.md#readme)| [TYPESCRIPT_ES](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_eslint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/eslint/eslint?cacheSeconds=3600)](https://github.com/eslint/eslint) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [standard](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_standard.md#readme)| [TYPESCRIPT_STANDARD](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_standard.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/standard/standard?cacheSeconds=3600)](https://github.com/standard/standard) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [prettier](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_prettier.md#readme)| [TYPESCRIPT_PRETTIER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/typescript_prettier.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**Visual Basic .NET** (VBDOTNET)](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/vbdotnet.md#readme) | [dotnet-format](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/vbdotnet_dotnet_format.md#readme)| [VBDOTNET_DOTNET_FORMAT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/vbdotnet_dotnet_format.md#readme)| ![formatter](https://shields.io/badge/-format-yellow) | ### Formats -| | Format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**CSS**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css.md#readme) | [stylelint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_stylelint.md#readme) | [CSS_STYLELINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_stylelint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [scss-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_scss_lint.md#readme) | [CSS_SCSS_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_scss_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | -| | [**ENV**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env.md#readme) | [dotenv-linter](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env_dotenv_linter.md#readme) | [ENV_DOTENV_LINTER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env_dotenv_linter.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**GRAPHQL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql.md#readme) | [graphql-schema-linter](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md#readme) | [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | -| | [**HTML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html.md#readme) | [htmlhint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_htmlhint.md#readme) | [HTML_HTMLHINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_htmlhint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | -| | [**JSON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json.md#readme) | [jsonlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_jsonlint.md#readme) | [JSON_JSONLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_jsonlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | -| | | [eslint-plugin-jsonc](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_eslint_plugin_jsonc.md#readme) | [JSON_ESLINT_PLUGIN_JSONC](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_eslint_plugin_jsonc.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [v8r](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_v8r.md#readme) | [JSON_V8R](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_v8r.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | -| | | [prettier](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_prettier.md#readme) | [JSON_PRETTIER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_prettier.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**LATEX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex.md#readme) | [chktex](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md#readme) | [LATEX_CHKTEX](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md#readme) | | -| | [**MARKDOWN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown.md#readme) | [markdownlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdownlint.md#readme) | [MARKDOWN_MARKDOWNLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdownlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [remark-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_remark_lint.md#readme) | [MARKDOWN_REMARK_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_remark_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/remarkjs/remark-lint?cacheSeconds=3600)](https://github.com/remarkjs/remark-lint) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [markdown-link-check](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_link_check.md#readme) | [MARKDOWN_MARKDOWN_LINK_CHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_link_check.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | -| | | [markdown-table-formatter](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_table_formatter.md#readme) | [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_table_formatter.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**PROTOBUF**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/protobuf.md#readme) | [protolint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/protobuf_protolint.md#readme) | [PROTOBUF_PROTOLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/protobuf_protolint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**RST**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst.md#readme) | [rst-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rst_lint.md#readme) | [RST_RST_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rst_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/twolfson/restructuredtext-lint?cacheSeconds=3600)](https://github.com/twolfson/restructuredtext-lint) | -| | | [rstcheck](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rstcheck.md#readme) | [RST_RSTCHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rstcheck.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/myint/rstcheck?cacheSeconds=3600)](https://github.com/myint/rstcheck) | -| | [**XML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/xml.md#readme) | [xmllint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/xml_xmllint.md#readme) | [XML_XMLLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/xml_xmllint.md#readme) | | -| | [**YAML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml.md#readme) | [prettier](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_prettier.md#readme) | [YAML_PRETTIER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_prettier.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [yamllint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_yamllint.md#readme) | [YAML_YAMLLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_yamllint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | -| | | [v8r](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_v8r.md#readme) | [YAML_V8R](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_v8r.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | Format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**CSS**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css.md#readme) | [stylelint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_stylelint.md#readme)| [CSS_STYLELINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_stylelint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/stylelint/stylelint?cacheSeconds=3600)](https://github.com/stylelint/stylelint) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [scss-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_scss_lint.md#readme)| [CSS_SCSS_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/css_scss_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/sds/scss-lint?cacheSeconds=3600)](https://github.com/sds/scss-lint) | +| | [**ENV**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env.md#readme) | [dotenv-linter](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env_dotenv_linter.md#readme)| [ENV_DOTENV_LINTER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/env_dotenv_linter.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/dotenv-linter/dotenv-linter?cacheSeconds=3600)](https://github.com/dotenv-linter/dotenv-linter) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**GRAPHQL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql.md#readme) | [graphql-schema-linter](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md#readme)| [GRAPHQL_GRAPHQL_SCHEMA_LINTER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/graphql_graphql_schema_linter.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/cjoudrey/graphql-schema-linter?cacheSeconds=3600)](https://github.com/cjoudrey/graphql-schema-linter) | +| | [**HTML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html.md#readme) | [htmlhint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_htmlhint.md#readme)| [HTML_HTMLHINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/html_htmlhint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/htmlhint/HTMLHint?cacheSeconds=3600)](https://github.com/htmlhint/HTMLHint) | +| | [**JSON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json.md#readme) | [jsonlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_jsonlint.md#readme)| [JSON_JSONLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_jsonlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/zaach/jsonlint?cacheSeconds=3600)](https://github.com/zaach/jsonlint) | +| | | [eslint-plugin-jsonc](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_eslint_plugin_jsonc.md#readme)| [JSON_ESLINT_PLUGIN_JSONC](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_eslint_plugin_jsonc.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/ota-meshi/eslint-plugin-jsonc?cacheSeconds=3600)](https://github.com/ota-meshi/eslint-plugin-jsonc) ![autofix](https://shields.io/badge/-autofix-green) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [v8r](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_v8r.md#readme)| [JSON_V8R](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_v8r.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | +| | | [prettier](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_prettier.md#readme)| [JSON_PRETTIER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/json_prettier.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**LATEX**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex.md#readme) | [chktex](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md#readme)| [LATEX_CHKTEX](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/latex_chktex.md#readme)| | +| | [**MARKDOWN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown.md#readme) | [markdownlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdownlint.md#readme)| [MARKDOWN_MARKDOWNLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdownlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/DavidAnson/markdownlint?cacheSeconds=3600)](https://github.com/DavidAnson/markdownlint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [remark-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_remark_lint.md#readme)| [MARKDOWN_REMARK_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_remark_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/remarkjs/remark-lint?cacheSeconds=3600)](https://github.com/remarkjs/remark-lint) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [markdown-link-check](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_link_check.md#readme)| [MARKDOWN_MARKDOWN_LINK_CHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_link_check.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/tcort/markdown-link-check?cacheSeconds=3600)](https://github.com/tcort/markdown-link-check) | +| | | [markdown-table-formatter](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_table_formatter.md#readme)| [MARKDOWN_MARKDOWN_TABLE_FORMATTER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/markdown_markdown_table_formatter.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/nvuillam/markdown-table-formatter?cacheSeconds=3600)](https://github.com/nvuillam/markdown-table-formatter) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**PROTOBUF**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/protobuf.md#readme) | [protolint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/protobuf_protolint.md#readme)| [PROTOBUF_PROTOLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/protobuf_protolint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/yoheimuta/protolint?cacheSeconds=3600)](https://github.com/yoheimuta/protolint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**RST**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst.md#readme) | [rst-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rst_lint.md#readme)| [RST_RST_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rst_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/twolfson/restructuredtext-lint?cacheSeconds=3600)](https://github.com/twolfson/restructuredtext-lint) | +| | | [rstcheck](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rstcheck.md#readme)| [RST_RSTCHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/rst_rstcheck.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/myint/rstcheck?cacheSeconds=3600)](https://github.com/myint/rstcheck) | +| | [**XML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/xml.md#readme) | [xmllint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/xml_xmllint.md#readme)| [XML_XMLLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/xml_xmllint.md#readme)| | +| | [**YAML**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml.md#readme) | [prettier](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_prettier.md#readme)| [YAML_PRETTIER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_prettier.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/prettier/prettier?cacheSeconds=3600)](https://github.com/prettier/prettier) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [yamllint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_yamllint.md#readme)| [YAML_YAMLLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_yamllint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/adrienverge/yamllint?cacheSeconds=3600)](https://github.com/adrienverge/yamllint) | +| | | [v8r](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_v8r.md#readme)| [YAML_V8R](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/yaml_v8r.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/chris48s/v8r?cacheSeconds=3600)](https://github.com/chris48s/v8r) | ### Tooling formats -| | Tooling format | Linter | Configuration key | Additional | -|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**ACTION**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action.md#readme) | [actionlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action_actionlint.md#readme) | [ACTION_ACTIONLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action_actionlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | -| | [**ANSIBLE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ansible.md#readme) | [ansible-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ansible_ansible_lint.md#readme) | [ANSIBLE_ANSIBLE_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ansible_ansible_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | -| | [**ARM**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/arm.md#readme) | [arm-ttk](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/arm_arm_ttk.md#readme) | [ARM_ARM_TTK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/arm_arm_ttk.md#readme) | | -| | [**CLOUDFORMATION**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cloudformation.md#readme) | [cfn-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cloudformation_cfn_lint.md#readme) | [CLOUDFORMATION_CFN_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cloudformation_cfn_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/aws-cloudformation/cfn-lint?cacheSeconds=3600)](https://github.com/aws-cloudformation/cfn-lint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**DOCKERFILE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dockerfile.md#readme) | [hadolint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dockerfile_hadolint.md#readme) | [DOCKERFILE_HADOLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dockerfile_hadolint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**EDITORCONFIG**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/editorconfig.md#readme) | [editorconfig-checker](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/editorconfig_editorconfig_checker.md#readme) | [EDITORCONFIG_EDITORCONFIG_CHECKER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/editorconfig_editorconfig_checker.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | -| | [**GHERKIN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/gherkin.md#readme) | [gherkin-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/gherkin_gherkin_lint.md#readme) | [GHERKIN_GHERKIN_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/gherkin_gherkin_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/vsiakka/gherkin-lint?cacheSeconds=3600)](https://github.com/vsiakka/gherkin-lint) | -| | [**KUBERNETES**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes.md#readme) | [kubeval](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeval.md#readme) | [KUBERNETES_KUBEVAL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeval.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | -| | | [kubeconform](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeconform.md#readme) | [KUBERNETES_KUBECONFORM](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeconform.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | -| | [**OPENAPI**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/openapi.md#readme) | [spectral](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/openapi_spectral.md#readme) | [OPENAPI_SPECTRAL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/openapi_spectral.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | -| | [**PUPPET**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/puppet.md#readme) | [puppet-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/puppet_puppet_lint.md#readme) | [PUPPET_PUPPET_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/puppet_puppet_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/rodjek/puppet-lint?cacheSeconds=3600)](https://github.com/rodjek/puppet-lint) ![autofix](https://shields.io/badge/-autofix-green) | -| | [**SNAKEMAKE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake.md#readme) | [snakemake](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakemake.md#readme) | [SNAKEMAKE_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakemake.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | -| | | [snakefmt](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakefmt.md#readme) | [SNAKEMAKE_SNAKEFMT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakefmt.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakefmt?cacheSeconds=3600)](https://github.com/snakemake/snakefmt) ![formatter](https://shields.io/badge/-format-yellow) | -| | [**TEKTON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tekton.md#readme) | [tekton-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tekton_tekton_lint.md#readme) | [TEKTON_TEKTON_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tekton_tekton_lint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | -| | [**TERRAFORM**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform.md#readme) | [tflint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_tflint.md#readme) | [TERRAFORM_TFLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_tflint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/terraform-linters/tflint?cacheSeconds=3600)](https://github.com/terraform-linters/tflint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [terrascan](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terrascan.md#readme) | [TERRAFORM_TERRASCAN](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terrascan.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/accurics/terrascan?cacheSeconds=3600)](https://github.com/accurics/terrascan) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [terragrunt](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terragrunt.md#readme) | [TERRAFORM_TERRAGRUNT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terragrunt.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/gruntwork-io/terragrunt?cacheSeconds=3600)](https://github.com/gruntwork-io/terragrunt) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [terraform-fmt](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terraform_fmt.md#readme) | [TERRAFORM_TERRAFORM_FMT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terraform_fmt.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/hashicorp/terraform?cacheSeconds=3600)](https://github.com/hashicorp/terraform) ![formatter](https://shields.io/badge/-format-yellow) | -| | | [checkov](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_checkov.md#readme) | [TERRAFORM_CHECKOV](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_checkov.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/bridgecrewio/checkov?cacheSeconds=3600)](https://github.com/bridgecrewio/checkov) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [kics](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_kics.md#readme) | [TERRAFORM_KICS](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_kics.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/checkmarx/kics?cacheSeconds=3600)](https://github.com/checkmarx/kics) | +| | Tooling format | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**ACTION**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action.md#readme) | [actionlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action_actionlint.md#readme)| [ACTION_ACTIONLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/action_actionlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rhysd/actionlint?cacheSeconds=3600)](https://github.com/rhysd/actionlint) | +| | [**ANSIBLE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ansible.md#readme) | [ansible-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ansible_ansible_lint.md#readme)| [ANSIBLE_ANSIBLE_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/ansible_ansible_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/ansible/ansible-lint?cacheSeconds=3600)](https://github.com/ansible/ansible-lint) | +| | [**ARM**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/arm.md#readme) | [arm-ttk](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/arm_arm_ttk.md#readme)| [ARM_ARM_TTK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/arm_arm_ttk.md#readme)| | +| | [**CLOUDFORMATION**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cloudformation.md#readme) | [cfn-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cloudformation_cfn_lint.md#readme)| [CLOUDFORMATION_CFN_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/cloudformation_cfn_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/aws-cloudformation/cfn-lint?cacheSeconds=3600)](https://github.com/aws-cloudformation/cfn-lint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**DOCKERFILE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dockerfile.md#readme) | [hadolint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dockerfile_hadolint.md#readme)| [DOCKERFILE_HADOLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/dockerfile_hadolint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/hadolint/hadolint?cacheSeconds=3600)](https://github.com/hadolint/hadolint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**EDITORCONFIG**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/editorconfig.md#readme) | [editorconfig-checker](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/editorconfig_editorconfig_checker.md#readme)| [EDITORCONFIG_EDITORCONFIG_CHECKER](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/editorconfig_editorconfig_checker.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/editorconfig-checker/editorconfig-checker?cacheSeconds=3600)](https://github.com/editorconfig-checker/editorconfig-checker) | +| | [**GHERKIN**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/gherkin.md#readme) | [gherkin-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/gherkin_gherkin_lint.md#readme)| [GHERKIN_GHERKIN_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/gherkin_gherkin_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/vsiakka/gherkin-lint?cacheSeconds=3600)](https://github.com/vsiakka/gherkin-lint) | +| | [**KUBERNETES**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes.md#readme) | [kubeval](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeval.md#readme)| [KUBERNETES_KUBEVAL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeval.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/instrumenta/kubeval?cacheSeconds=3600)](https://github.com/instrumenta/kubeval) | +| | | [kubeconform](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeconform.md#readme)| [KUBERNETES_KUBECONFORM](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/kubernetes_kubeconform.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/yannh/kubeconform?cacheSeconds=3600)](https://github.com/yannh/kubeconform) | +| | [**OPENAPI**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/openapi.md#readme) | [spectral](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/openapi_spectral.md#readme)| [OPENAPI_SPECTRAL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/openapi_spectral.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/stoplightio/spectral?cacheSeconds=3600)](https://github.com/stoplightio/spectral) | +| | [**PUPPET**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/puppet.md#readme) | [puppet-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/puppet_puppet_lint.md#readme)| [PUPPET_PUPPET_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/puppet_puppet_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/rodjek/puppet-lint?cacheSeconds=3600)](https://github.com/rodjek/puppet-lint) ![autofix](https://shields.io/badge/-autofix-green) | +| | [**SNAKEMAKE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake.md#readme) | [snakemake](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakemake.md#readme)| [SNAKEMAKE_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakemake.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakemake?cacheSeconds=3600)](https://github.com/snakemake/snakemake) | +| | | [snakefmt](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakefmt.md#readme)| [SNAKEMAKE_SNAKEFMT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/snakemake_snakefmt.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/snakemake/snakefmt?cacheSeconds=3600)](https://github.com/snakemake/snakefmt) ![formatter](https://shields.io/badge/-format-yellow) | +| | [**TEKTON**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tekton.md#readme) | [tekton-lint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tekton_tekton_lint.md#readme)| [TEKTON_TEKTON_LINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/tekton_tekton_lint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/IBM/tekton-lint?cacheSeconds=3600)](https://github.com/IBM/tekton-lint) | +| | [**TERRAFORM**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform.md#readme) | [tflint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_tflint.md#readme)| [TERRAFORM_TFLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_tflint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/terraform-linters/tflint?cacheSeconds=3600)](https://github.com/terraform-linters/tflint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [terrascan](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terrascan.md#readme)| [TERRAFORM_TERRASCAN](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terrascan.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/accurics/terrascan?cacheSeconds=3600)](https://github.com/accurics/terrascan) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [terragrunt](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terragrunt.md#readme)| [TERRAFORM_TERRAGRUNT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terragrunt.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/gruntwork-io/terragrunt?cacheSeconds=3600)](https://github.com/gruntwork-io/terragrunt) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [terraform-fmt](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terraform_fmt.md#readme)| [TERRAFORM_TERRAFORM_FMT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_terraform_fmt.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/hashicorp/terraform?cacheSeconds=3600)](https://github.com/hashicorp/terraform) ![formatter](https://shields.io/badge/-format-yellow) | +| | | [checkov](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_checkov.md#readme)| [TERRAFORM_CHECKOV](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_checkov.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/bridgecrewio/checkov?cacheSeconds=3600)](https://github.com/bridgecrewio/checkov) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [kics](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_kics.md#readme)| [TERRAFORM_KICS](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/terraform_kics.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/checkmarx/kics?cacheSeconds=3600)](https://github.com/checkmarx/kics) | ### Other -| | Code quality checker | Linter | Configuration key | Additional | -|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [**COPYPASTE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/copypaste.md#readme) | [jscpd](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/copypaste_jscpd.md#readme) | [COPYPASTE_JSCPD](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/copypaste_jscpd.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | -| | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md#readme) | [devskim](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_devskim.md#readme) | [REPOSITORY_DEVSKIM](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_devskim.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/microsoft/DevSkim?cacheSeconds=3600)](https://github.com/microsoft/DevSkim) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [dustilock](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_dustilock.md#readme) | [REPOSITORY_DUSTILOCK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_dustilock.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/Checkmarx/dustilock?cacheSeconds=3600)](https://github.com/Checkmarx/dustilock) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [git_diff](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_git_diff.md#readme) | [REPOSITORY_GIT_DIFF](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_git_diff.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | -| | | [gitleaks](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_gitleaks.md#readme) | [REPOSITORY_GITLEAKS](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_gitleaks.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [goodcheck](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_goodcheck.md#readme) | [REPOSITORY_GOODCHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_goodcheck.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | -| | | [secretlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_secretlint.md#readme) | [REPOSITORY_SECRETLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_secretlint.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [semgrep](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_semgrep.md#readme) | [REPOSITORY_SEMGREP](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_semgrep.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [syft](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_syft.md#readme) | [REPOSITORY_SYFT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_syft.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/anchore/syft?cacheSeconds=3600)](https://github.com/anchore/syft) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | | [trivy](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_trivy.md#readme) | [REPOSITORY_TRIVY](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_trivy.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | -| | [**SPELL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell.md#readme) | [misspell](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_misspell.md#readme) | [SPELL_MISSPELL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_misspell.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | -| | | [cspell](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_cspell.md#readme) | [SPELL_CSPELL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_cspell.md#readme) | [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | +| | Code quality checker | Linter | Configuration key | Additional | +| :---: | ----------------- | -------------- | ------------ | :-----: | +| | [**COPYPASTE**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/copypaste.md#readme) | [jscpd](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/copypaste_jscpd.md#readme)| [COPYPASTE_JSCPD](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/copypaste_jscpd.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/kucherenko/jscpd?cacheSeconds=3600)](https://github.com/kucherenko/jscpd) | +| | [**REPOSITORY**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository.md#readme) | [devskim](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_devskim.md#readme)| [REPOSITORY_DEVSKIM](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_devskim.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/microsoft/DevSkim?cacheSeconds=3600)](https://github.com/microsoft/DevSkim) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [dustilock](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_dustilock.md#readme)| [REPOSITORY_DUSTILOCK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_dustilock.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/Checkmarx/dustilock?cacheSeconds=3600)](https://github.com/Checkmarx/dustilock) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [git_diff](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_git_diff.md#readme)| [REPOSITORY_GIT_DIFF](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_git_diff.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/git/git?cacheSeconds=3600)](https://github.com/git/git) | +| | | [gitleaks](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_gitleaks.md#readme)| [REPOSITORY_GITLEAKS](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_gitleaks.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/zricethezav/gitleaks?cacheSeconds=3600)](https://github.com/zricethezav/gitleaks) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [goodcheck](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_goodcheck.md#readme)| [REPOSITORY_GOODCHECK](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_goodcheck.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/sider/goodcheck?cacheSeconds=3600)](https://github.com/sider/goodcheck) | +| | | [secretlint](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_secretlint.md#readme)| [REPOSITORY_SECRETLINT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_secretlint.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/secretlint/secretlint?cacheSeconds=3600)](https://github.com/secretlint/secretlint) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [semgrep](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_semgrep.md#readme)| [REPOSITORY_SEMGREP](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_semgrep.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/returntocorp/semgrep?cacheSeconds=3600)](https://github.com/returntocorp/semgrep) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [syft](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_syft.md#readme)| [REPOSITORY_SYFT](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_syft.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/anchore/syft?cacheSeconds=3600)](https://github.com/anchore/syft) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | | [trivy](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_trivy.md#readme)| [REPOSITORY_TRIVY](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/repository_trivy.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/aquasecurity/trivy?cacheSeconds=3600)](https://github.com/aquasecurity/trivy) ![sarif](https://shields.io/badge/-SARIF-orange) | +| | [**SPELL**](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell.md#readme) | [misspell](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_misspell.md#readme)| [SPELL_MISSPELL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_misspell.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/client9/misspell?cacheSeconds=3600)](https://github.com/client9/misspell) ![autofix](https://shields.io/badge/-autofix-green) | +| | | [cspell](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_cspell.md#readme)| [SPELL_CSPELL](https://github.com/oxsecurity/megalinter/tree/main/docs/descriptors/spell_cspell.md#readme)| [![GitHub stars](https://img.shields.io/github/stars/streetsidesoftware/cspell?cacheSeconds=3600)](https://github.com/streetsidesoftware/cspell) | diff --git a/megalinter/descriptors/schemas/megalinter-configuration.jsonschema.json b/megalinter/descriptors/schemas/megalinter-configuration.jsonschema.json index 926738a7df1..9e2ce5d7cd8 100644 --- a/megalinter/descriptors/schemas/megalinter-configuration.jsonschema.json +++ b/megalinter/descriptors/schemas/megalinter-configuration.jsonschema.json @@ -49,7 +49,6 @@ "COFFEE", "COPYPASTE", "CPP", - "CREDENTIALS", "CSHARP", "CSS", "DART", @@ -57,7 +56,6 @@ "EDITORCONFIG", "ENV", "GHERKIN", - "GIT", "GO", "GRAPHQL", "GROOVY", @@ -114,17 +112,14 @@ "COFFEE_COFFEELINT", "COPYPASTE_JSCPD", "CPP_CPPLINT", - "CREDENTIALS_SECRETLINT", "CSHARP_DOTNET_FORMAT", "CSS_STYLELINT", "CSS_SCSS_LINT", "DART_DARTANALYZER", - "DOCKERFILE_DOCKERFILELINT", "DOCKERFILE_HADOLINT", "EDITORCONFIG_EDITORCONFIG_CHECKER", "ENV_DOTENV_LINTER", "GHERKIN_GHERKIN_LINT", - "GIT_GIT_DIFF", "GO_GOLANGCI_LINT", "GO_REVIVE", "GRAPHQL_GRAPHQL_SCHEMA_LINTER", @@ -150,7 +145,6 @@ "MARKDOWN_MARKDOWN_TABLE_FORMATTER", "OPENAPI_SPECTRAL", "PERL_PERLCRITIC", - "PHP_BUILTIN", "PHP_PHPCS", "PHP_PHPSTAN", "PHP_PSALM", @@ -175,7 +169,6 @@ "REPOSITORY_SEMGREP", "REPOSITORY_SYFT", "REPOSITORY_TRIVY", - "RST_RSTFMT", "RST_RST_LINT", "RST_RSTCHECK", "RUBY_RUBOCOP",