Can be a local folder or a remote URL (ex: `https://raw.githubusercontent.com/some_org/some_repo/mega-linter-rules` ) | +| **LOG_FILE** | `mega-linter.log` | The file name for outputting logs. All output is sent to the log file regardless of `LOG_LEVEL`. Use `none` to not generate this file. | +| **LOG_LEVEL** | `INFO` | How much output the script will generate to the console. One of `INFO`, `DEBUG`, `WARNING` or `ERROR`. | +| **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 | +| **MEGALINTER_FILES_TO_LINT** | \[\] | Comma-separated list of files to analyze. Using this variable will bypass other file listing methods | +| **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 | +| **PARALLEL_PROCESS_NUMBER** | | All available cores are used by default. If there are too many, you need to decrease the number of used cores in order to enhance performances (example: `4`) | +| [**PLUGINS**](plugins.md) | \[\] | List of plugin urls to install and run during MegaLinter run | +| [**POST_COMMANDS**](config-postcommands.md) | \[\] | Custom bash commands to run after linters | +| [**PRE_COMMANDS**](config-precommands.md) | \[\] | Custom bash commands to run before linters | +| **PRINT_ALPACA** | `true` | Enable printing alpaca image to console | +| **PRINT_ALL_FILES** | `false` | Display all files analyzed by the linter instead of only the number | +| **REPORT_OUTPUT_FOLDER** | `${GITHUB_WORKSPACE}/megalinter-reports` | Directory for generating report files. Set to `none` to not generate reports | +| [**SECURED_ENV_VARIABLES**](config-variables-security.md) | \[\] | Additional list of secured environment variables to hide when calling linters. | +| [**SECURED_ENV_VARIABLES_DEFAULT**](config-variables-security.md) | MegaLinter & CI platforms sensitive variables | List of secured environment variables to hide when calling linters. [Default list](config-variables-security.md). This is not recommended to override this variable, use SECURED_ENV_VARIABLES | +| **SHOW_ELAPSED_TIME** | `false` | Displays elapsed time in reports | +| **SHOW_SKIPPED_LINTERS** | `true` | Displays all disabled linters mega-linter could have run | +| **SKIP_CLI_LINT_MODES** | \[\] | Comma-separated list of cli_lint_modes. To use if you want to skip linters with some CLI lint modes (ex: `file,project`). Available values: `file`,`cli_lint_mode`,`project`. | +| **TYPESCRIPT_DEFAULT_STYLE** | `standard` | Typescript default style to check/apply. `standard`,`prettier` | +| **VALIDATE_ALL_CODEBASE** | `true` | Will parse the entire repository and find all files to validate across all types. **NOTE:** When set to `false`, only **new** or **edited** files will be parsed for validation. | + + + diff --git a/docs/configuration.md b/docs/configuration.md index 819d70b1703..6b0935d567f 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,6 +1,6 @@ --- title: MegaLinter configuration Guide -description: List of all configuration variables that can be used to customize the use of MegaLinter (activation, filtering, auto-update, pre-post commands...) +description: List of all configuration variables that can be used to customize the use of MegaLinter (activation, filtering, auto-update, pre-post commands…) --- @@ -8,10 +8,10 @@ description: List of all configuration variables that can be used to customize t # Configuration -MegaLinter configuration variables can be defined in a **.mega-linter.yml** file at the root of the repository or with **environment variables**. +MegaLinter configuration variables are defined in a **.mega-linter.yml** file at the root of the repository or with **environment variables**. You can see an example config file in this repo: [**.mega-linter.yml**](https://github.com/oxsecurity/megalinter/blob/main/.mega-linter.yml) -Configuration is assisted with auto-completion and validation in most commonly used IDEs, thanks to [JSON schema](https://megalinter.io/json-schemas/configuration.html) stored on [schemastore.org](https://www.schemastore.org/) +Configuration is assisted with autocompletion and validation in most commonly used IDEs, thanks to [JSON schema](https://megalinter.io/json-schemas/configuration.html) stored on [schemastore.org](https://www.schemastore.org/) - VSCode: You need a VSCode extension like [Red Hat YAML](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) - IDEA family: Auto-completion natively supported @@ -20,56 +20,58 @@ Configuration is assisted with auto-completion and validation in most commonly u ## Common variables -| **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) | -| **CLEAR_REPORT_FOLDER** | `false` | Flag to clear files from report folder (usually megalinter-reports) before starting the linting process | -| **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. | -| [**DISABLE**](#activation-and-deactivation) | | List of disabled descriptors keys [(more info)](#activation-and-deactivation) | -| [**DISABLE_LINTERS**](#activation-and-deactivation) | | List of disabled linters keys [(more info)](#activation-and-deactivation) | -| [**DISABLE_ERRORS_LINTERS**](#activation-and-deactivation) | | List of enabled but not blocking linters keys [(more info)](#activation-and-deactivation) | -| [**ENABLE**](#activation-and-deactivation) | | List of enabled descriptors keys [(more info)](#activation-and-deactivation) | -| [**ENABLE_LINTERS**](#activation-and-deactivation) | | List of enabled linters keys [(more info)](#activation-and-deactivation) | -| **EXCLUDED_DIRECTORIES** | \[...many values...\] | List of excluded directory basenames. They are excluded at any nested level. | -| **EXTENDS** | | Base `mega-linter.yml` config file(s) to extend local configuration from. Can be a single URL or a list of `.mega-linter.yml` config files URLs. Later files take precedence. | -| **FAIL_IF_MISSING_LINTER_IN_FLAVOR** | `false` | If set to `true`, MegaLinter fails if a linter is missing in the selected flavor | -| **FAIL_IF_UPDATED_SOURCES** | `false` | If set to `true`, MegaLinter fails if a linter or formatter has auto-fixed sources, even if there are no errors | -| [**FILTER_REGEX_EXCLUDE**](#filter-linted-files) | `none` | Regular expression defining which files will be excluded from linting [(more info)](#filter-linted-files) .ex: `.*src/test.*`) | -| [**FILTER_REGEX_INCLUDE**](#filter-linted-files) | `all` | Regular expression defining which files will be processed by linters [(more info)](#filter-linted-files) .ex: `.*src/.*`) | -| **FLAVOR_SUGGESTIONS** | `true` | Provides suggestions about different MegaLinter flavors to use to improve runtime performances | -| **FORMATTERS_DISABLE_ERRORS** | `true` | Formatter errors will be reported as errors (and not warnings) if this variable is set to `false` | -| **GIT_AUTHORIZATION_BEARER** | | If set, calls git with **`Authorization: Bearer`+value** | -| **GITHUB_WORKSPACE** | | Base directory for `REPORT_OUTPUT_FOLDER`, for user-defined linter rules location, for location of linted files if `DEFAULT_WORKSPACE` is not set | -| **IGNORE_GENERATED_FILES** | `false` | If set to `true`, MegaLinter will skip files containing `@generated` marker but without `@not-generated` marker (more info at [https://generated.at](https://generated.at/)) | -| **IGNORE_GITIGNORED_FILES** | `true` | If set to `true`, MegaLinter will skip files ignored by git using `.gitignore` file | -| **JAVASCRIPT_DEFAULT_STYLE** | `standard` | Javascript default style to check/apply. `standard`,`prettier` | -| **LINTER_RULES_PATH** | `.github/linters` | Directory for all linter configuration rules.
Can be a local folder or a remote URL (ex: `https://raw.githubusercontent.com/some_org/some_repo/mega-linter-rules` ) | -| **LOG_FILE** | `mega-linter.log` | The file name for outputting logs. All output is sent to the log file regardless of `LOG_LEVEL`. Use `none` to not generate this file. | -| **LOG_LEVEL** | `INFO` | How much output the script will generate to the console. One of `INFO`, `DEBUG`, `WARNING` or `ERROR`. | -| **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 | -| **MEGALINTER_FILES_TO_LINT** | \[\] | Comma-separated list of files to analyze. Using this variable will bypass other file listing methods | -| **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 | -| [**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 | -| **PRINT_ALL_FILES** | `false` | Display all files analyzed by the linter instead of only the number | -| **REPORT_OUTPUT_FOLDER** | `${GITHUB_WORKSPACE}/megalinter-reports` | Directory for generating report files. Set to `none` to not generate reports | -| **SHOW_ELAPSED_TIME** | `false` | Displays elapsed time in reports | -| **SHOW_SKIPPED_LINTERS** | `true` | Displays all disabled linters mega-linter could have run | -| **SKIP_CLI_LINT_MODES** | \[\] | Comma-separated list of cli_lint_modes. To use if you want to skip linters with some CLI lint modes (ex: `file,project`). Available values: `file`,`cli_lint_mode`,`project`. | -| **TYPESCRIPT_DEFAULT_STYLE** | `standard` | Typescript default style to check/apply. `standard`,`prettier` | -| **VALIDATE_ALL_CODEBASE** | `true` | Will parse the entire repository and find all files to validate across all types. **NOTE:** When set to `false`, only **new** or **edited** files will be parsed for validation. | +| **ENV VAR** | **Default Value** | **Notes** | +|----------------------------------------------------------------------|-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **ADDITIONAL_EXCLUDED_DIRECTORIES** | \[\] | List of additional excluded directory basenames. they're excluded at any nested level. | +| [**APPLY_FIXES**](configuration.md#apply-fixes) | `none` | Activates formatting and autofix [(more info)](configuration.md#apply-fixes) | +| **CLEAR_REPORT_FOLDER** | `false` | Flag to clear files from report folder (usually megalinter-reports) before starting the linting process | +| **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. | +| [**DISABLE**](#activation-and-deactivation) | | List of disabled descriptors keys [(more info)](#activation-and-deactivation) | +| [**DISABLE_LINTERS**](#activation-and-deactivation) | | List of disabled linters keys [(more info)](#activation-and-deactivation) | +| [**DISABLE_ERRORS_LINTERS**](#activation-and-deactivation) | | List of enabled but not blocking linters keys [(more info)](#activation-and-deactivation) | +| [**ENABLE**](#activation-and-deactivation) | | List of enabled descriptors keys [(more info)](#activation-and-deactivation) | +| [**ENABLE_LINTERS**](#activation-and-deactivation) | | List of enabled linters keys [(more info)](#activation-and-deactivation) | +| **EXCLUDED_DIRECTORIES** | \[…many values…\] | List of excluded directory basenames. they're excluded at any nested level. | +| **EXTENDS** | | Base `mega-linter.yml` config file(s) to extend local configuration from. Can be a single URL or a list of `.mega-linter.yml` config files URLs. Later files take precedence. | +| **FAIL_IF_MISSING_LINTER_IN_FLAVOR** | `false` | If set to `true`, MegaLinter fails if a linter is missing in the selected flavor | +| **FAIL_IF_UPDATED_SOURCES** | `false` | If set to `true`, MegaLinter fails if a linter or formatter has autofixed sources, even if there are no errors | +| [**FILTER_REGEX_EXCLUDE**](#filter-linted-files) | `none` | Regular expression defining which files will be excluded from linting [(more info)](#filter-linted-files) .ex: `.*src/test.*`) | +| [**FILTER_REGEX_INCLUDE**](#filter-linted-files) | `all` | Regular expression defining which files will be processed by linters [(more info)](#filter-linted-files) .ex: `.*src/.*`) | +| **FLAVOR_SUGGESTIONS** | `true` | Provides suggestions about different MegaLinter flavors to use to improve runtime performances | +| **FORMATTERS_DISABLE_ERRORS** | `true` | Formatter errors will be reported as errors (and not warnings) if this variable is set to `false` | +| **GIT_AUTHORIZATION_BEARER** | | If set, calls git with **`Authorization: Bearer`+value** | +| **GITHUB_WORKSPACE** | | Base directory for `REPORT_OUTPUT_FOLDER`, for user-defined linter rules location, for location of linted files if `DEFAULT_WORKSPACE` isn't set | +| **IGNORE_GENERATED_FILES** | `false` | If set to `true`, MegaLinter will skip files containing `@generated` marker but without `@not-generated` marker (more info at [https://generated.at](https://generated.at/)) | +| **IGNORE_GITIGNORED_FILES** | `true` | If set to `true`, MegaLinter will skip files ignored by git using `.gitignore` file | +| **JAVASCRIPT_DEFAULT_STYLE** | `standard` | Javascript default style to check/apply. `standard`,`prettier` | +| **LINTER_RULES_PATH** | `.github/linters` | Directory for all linter configuration rules.
Can be a local folder or a remote URL (ex: `https://raw.githubusercontent.com/some_org/some_repo/mega-linter-rules` ) | +| **LOG_FILE** | `mega-linter.log` | The file name for outputting logs. All output is sent to the log file regardless of `LOG_LEVEL`. Use `none` to not generate this file. | +| **LOG_LEVEL** | `INFO` | How much output the script will generate to the console. One of `INFO`, `DEBUG`, `WARNING` or `ERROR`. | +| **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 | +| **MEGALINTER_FILES_TO_LINT** | \[\] | Comma-separated list of files to analyze. Using this variable will bypass other file listing methods | +| **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 | +| [**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 | +| **PRINT_ALL_FILES** | `false` | Display all files analyzed by the linter instead of only the number | +| **REPORT_OUTPUT_FOLDER** | `${GITHUB_WORKSPACE}/megalinter-reports` | Directory for generating report files. Set to `none` to not generate reports | +| [**SECURED_ENV_VARIABLES**](#environment-variables-security) | \[\] | Additional list of secured environment variables to hide when calling linters. | +| [**SECURED_ENV_VARIABLES_DEFAULT**](#environment-variables-security) | MegaLinter & CI platforms sensitive variables | List of secured environment variables to hide when calling linters. [Default list](#environment-variables-security). This is not recommended to override this variable, use SECURED_ENV_VARIABLES | +| **SHOW_ELAPSED_TIME** | `false` | Displays elapsed time in reports | +| **SHOW_SKIPPED_LINTERS** | `true` | Displays all disabled linters mega-linter could have run | +| **SKIP_CLI_LINT_MODES** | \[\] | Comma-separated list of cli_lint_modes. To use if you want to skip linters with some CLI lint modes (ex: `file,project`). Available values: `file`,`cli_lint_mode`,`project`. | +| **TYPESCRIPT_DEFAULT_STYLE** | `standard` | Typescript default style to check/apply. `standard`,`prettier` | +| **VALIDATE_ALL_CODEBASE** | `true` | Will parse the entire repository and find all files to validate across all types. **NOTE:** When set to `false`, only **new** or **edited** files will be parsed for validation. | ## Activation and deactivation MegaLinter have all linters enabled by default, but allows to enable only some, or disable only some -- If `ENABLE` is not set, all descriptors are activated by default. If set, all linters of listed descriptors will be activated by default +- If `ENABLE` isn't set, all descriptors are activated by default. If set, all linters of listed descriptors will be activated by default - If `ENABLE_LINTERS` is set, only listed linters will be processed - If `DISABLE` is set, the linters in the listed descriptors will be skipped - If `DISABLE_LINTERS` is set, the listed linters will be skipped @@ -107,8 +109,8 @@ You can apply filters to a single linter by defining variable `
Ex: `-s --foo "bar"` | | +| ACTION_ACTIONLINT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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` | @@ -32,32 +33,36 @@ Static checker for GitHub Actions workflow files | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling ACTION_ACTIONLINT and its pre/post commands | None | | ACTION_ACTIONLINT_CONFIG_FILE | actionlint configuration file nameUse `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` | +| ACTION_ACTIONLINT_CLI_EXECUTABLE | Override CLI executable | `['actionlint']` | +| ACTION_DIRECTORY | Directory containing ACTION files (use `any` to always activate the linter) | `.github/workflows` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| Ex: `-s --foo "bar"` | | +| ANSIBLE_ANSIBLE_LINT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling ANSIBLE_ANSIBLE_LINT and its pre/post commands | None | | ANSIBLE_ANSIBLE_LINT_CONFIG_FILE | ansible-lint configuration file nameUse `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` | +| ANSIBLE_ANSIBLE_LINT_CLI_EXECUTABLE | Override CLI executable | `['ansible-lint']` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| [_API_SPECTRAL_](api_spectral.md) | [](https://github.com/stoplightio/spectral) | + +## Linted files + +- File extensions: + - `.yml` + - `.yaml` + - `.json` + +- Detected file content: + - `"asyncapi":` + - `"openapi":` + - `"swagger":` + - `asyncapi:` + - `openapi:` + - `swagger:` + +## Configuration in MegaLinter + +| Variable | Description | Default value | +|--------------------------|-------------------------------------------------|---------------| +| API_PRE_COMMANDS | List of bash commands to run before the linters | None | +| API_POST_COMMANDS | List of bash commands to run after the linters | None | +| API_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| API_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | + diff --git a/docs/descriptors/api_spectral.md b/docs/descriptors/api_spectral.md new file mode 100644 index 00000000000..c03c6f6a48c --- /dev/null +++ b/docs/descriptors/api_spectral.md @@ -0,0 +1,134 @@ +--- +title: spectral configuration in MegaLinter +description: How to use spectral (configure, ignore files, ignore errors, help & version documentations) to analyze API files +--- + + + +
+
+ 
+
+
+
+[](https://github.com/stoplightio/spectral) [](https://github.com/stoplightio/spectral/releases) [](https://github.com/stoplightio/spectral/commits) [](https://github.com/stoplightio/spectral/graphs/commit-activity/) [](https://github.com/stoplightio/spectral/graphs/contributors/)
+
+## spectral documentation
+
+- Version in MegaLinter: **6.11.1**
+- Visit [Official Web Site](https://docs.stoplight.io/docs/spectral/674b27b261c3c-overview){target=_blank}
+- See [How to configure spectral rules](https://docs.stoplight.io/docs/spectral/9ffa04e052cc1-spectral-cli#using-a-ruleset-file){target=_blank}
+ - If custom `.spectral.yaml` config file isn't found, [.spectral.yaml](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.spectral.yaml){target=_blank} will be used
+- See [Index of problems detected by spectral](https://docs.stoplight.io/docs/spectral/4dec24461f3af-open-api-rules){target=_blank}
+
+[](https://github.com/stoplightio/spectral){target=_blank}
+
+## Configuration in MegaLinter
+
+- Enable spectral by adding `API_SPECTRAL` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable spectral by adding `API_SPECTRAL` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+
+| Variable | Description | Default value |
+|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
+| API_SPECTRAL_ARGUMENTS | User custom arguments to add in linter CLI call
+
+Ex: `-s --foo "bar"` | | +| API_SPECTRAL_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
Ex: `-s --foo "bar"` | | +| API_SPECTRAL_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| API_SPECTRAL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| API_SPECTRAL_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `project`: Call the linter from the root of the project | `file` | +| API_SPECTRAL_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".yml", ".yaml", ".json"]` | +| API_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 | +| API_SPECTRAL_PRE_COMMANDS | List of bash commands to run before the linter | None | +| API_SPECTRAL_POST_COMMANDS | List of bash commands to run after the linter | None | +| API_SPECTRAL_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling API_SPECTRAL and its pre/post commands | None | +| API_SPECTRAL_CONFIG_FILE | spectral configuration file nameUse `LINTER_DEFAULT` to let the linter find it | `.spectral.yaml` | +| API_SPECTRAL_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| API_SPECTRAL_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| API_SPECTRAL_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| API_SPECTRAL_CLI_EXECUTABLE | Override CLI executable | `['spectral']` | + +## IDE Integration + +Use spectral in your favorite IDE to catch errors before MegaLinter ! + +| | IDE | Extension Name | Install | +|:--------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|-------------------------------------------------------------------|:-------------------------------------------------------------------------------:| +|
| [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| Ex: `-s --foo "bar"` | | +| ARM_ARM_TTK_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `project`: Call the linter from the root of the project | `file` | @@ -30,10 +31,12 @@ description: How to use arm-ttk (configure, ignore files, ignore errors, help & | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling ARM_ARM_TTK and its pre/post commands | None | | ARM_ARM_TTK_CONFIG_FILE | arm-ttk configuration file nameUse `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` | +| ARM_ARM_TTK_CLI_EXECUTABLE | Override CLI executable | `['arm-ttk']` | ## IDE Integration @@ -47,10 +50,11 @@ Use arm-ttk in your favorite IDE to catch errors before MegaLinter ! This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------|:----------------------------------------------|:----------------:|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| Ex: `-s --foo "bar"` | | +| BASH_EXEC_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `project`: Call the linter from the root of the project | `file` | @@ -31,30 +32,34 @@ Note: You can run `git add --chmod=+x myfile.sh` to make a file executable on Wi | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling BASH_EXEC and its pre/post commands | 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` | +| BASH_EXEC_CLI_EXECUTABLE | Override CLI executable | `['bash-exec']` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| Ex: `-s --foo "bar"` | | +| BASH_SHELLCHECK_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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` | @@ -31,8 +32,10 @@ description: How to use shellcheck (configure, ignore files, ignore errors, help | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling BASH_SHELLCHECK and its pre/post commands | 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` | +| BASH_SHELLCHECK_CLI_EXECUTABLE | Override CLI executable | `['shellcheck']` | ## IDE Integration @@ -55,22 +58,24 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| Ex: `-s --foo "bar"` | | +| BASH_SHFMT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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` | @@ -31,8 +32,10 @@ description: How to use shfmt (configure, ignore files, ignore errors, help & ve | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling BASH_SHFMT and its pre/post commands | 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` | +| BASH_SHFMT_CLI_EXECUTABLE | Override CLI executable | `['shfmt']` | ## IDE Integration @@ -54,21 +57,24 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| 
bicep_linter
[](https://github.com/Azure/bicep) [](https://github.com/Azure/bicep/releases) [](https://github.com/Azure/bicep/commits) [](https://github.com/Azure/bicep/graphs/commit-activity/) [](https://github.com/Azure/bicep/graphs/contributors/)
@@ -12,7 +12,7 @@ use a `bicepconfig.json` file. For more information, see the [documentation for
## bicep_linter documentation
-- Version in MegaLinter: **0.15.31**
+- Version in MegaLinter: **0.28.1**
- Visit [Official Web Site](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/linter){target=_blank}
- See [How to configure bicep_linter rules](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/bicep-config){target=_blank}
- See [How to disable bicep_linter rules in files](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/linter#silencing-false-positives){target=_blank}
@@ -22,12 +22,13 @@ use a `bicepconfig.json` file. For more information, see the [documentation for
## Configuration in MegaLinter
-- Enable bicep_linter by adding `BICEP_BICEP_LINTER` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable bicep_linter by adding `BICEP_BICEP_LINTER` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable bicep_linter by adding `BICEP_BICEP_LINTER` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable bicep_linter by adding `BICEP_BICEP_LINTER` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
| Variable | Description | Default value |
|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| BICEP_BICEP_LINTER_ARGUMENTS | User custom arguments to add in linter CLI callEx: `-s --foo "bar"` | | +| BICEP_BICEP_LINTER_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
Ex: `-s --foo "bar"` | | | BICEP_BICEP_LINTER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | | BICEP_BICEP_LINTER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | | BICEP_BICEP_LINTER_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `project`: Call the linter from the root of the project | `file` | @@ -35,8 +36,10 @@ use a `bicepconfig.json` file. For more information, see the [documentation for | BICEP_BICEP_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 | | BICEP_BICEP_LINTER_PRE_COMMANDS | List of bash commands to run before the linter | None | | BICEP_BICEP_LINTER_POST_COMMANDS | List of bash commands to run after the linter | None | +| BICEP_BICEP_LINTER_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling BICEP_BICEP_LINTER and its pre/post commands | None | | BICEP_BICEP_LINTER_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | | BICEP_BICEP_LINTER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| BICEP_BICEP_LINTER_CLI_EXECUTABLE | Override CLI executable | `['bicep']` | ## IDE Integration @@ -50,10 +53,11 @@ Use bicep_linter in your favorite IDE to catch errors before MegaLinter ! This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------|:----------------------------------------------|:----------------:|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| [_C_CPPLINT_](c_cpplint.md) | [](https://github.com/cpplint/cpplint) | +| Linter | Additional | +|---------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [**cpplint**](c_cpplint.md)
[_C_CPPLINT_](c_cpplint.md) | [](https://github.com/cpplint/cpplint) | +| [**clang-format**](c_clang_format.md)
[_C_CLANG_FORMAT_](c_clang_format.md) | [](https://github.com/llvm/llvm-project)  | ## Linted files @@ -21,8 +22,10 @@ description: cpplint is available to analyze C files in MegaLinter ## 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_PRE_COMMANDS | List of bash commands to run before the linters | None | +| C_POST_COMMANDS | List of bash commands to run after the linters | None | +| C_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| C_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/c_clang_format.md b/docs/descriptors/c_clang_format.md new file mode 100644 index 00000000000..13f03d5c2be --- /dev/null +++ b/docs/descriptors/c_clang_format.md @@ -0,0 +1,185 @@ +--- +title: clang-format configuration in MegaLinter +description: How to use clang-format (configure, ignore files, ignore errors, help & version documentations) to analyze C files +--- + + +# clang-format +[](https://github.com/llvm/llvm-project)  [](https://github.com/llvm/llvm-project/releases) [](https://github.com/llvm/llvm-project/commits) [](https://github.com/llvm/llvm-project/graphs/commit-activity/) [](https://github.com/llvm/llvm-project/graphs/contributors/) + +## clang-format documentation + +- Version in MegaLinter: **17.0.6** +- Visit [Official Web Site](https://releases.llvm.org/17.0.1/tools/clang/docs/ClangFormat.html){target=_blank} +- See [How to disable clang-format rules in files](https://releases.llvm.org/17.0.1/tools/clang/docs/ClangFormatStyleOptions.html#disabling-formatting-on-a-piece-of-code){target=_blank} +- See [Index of problems detected by clang-format](https://releases.llvm.org/17.0.1/tools/clang/docs/ClangFormat.html){target=_blank} + +[](https://github.com/llvm/llvm-project){target=_blank} + +## Configuration in MegaLinter + +- Enable clang-format by adding `C_CLANG_FORMAT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) +- Disable clang-format by adding `C_CLANG_FORMAT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) + +- Enable **autofixes** by adding `C_CLANG_FORMAT` in [APPLY_FIXES variable](https://megalinter.io/7.13.0/configuration/#apply-fixes) + +| Variable | Description | Default value | +|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| +| C_CLANG_FORMAT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| C_CLANG_FORMAT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
Ex: `-s --foo "bar"` | | +| C_CLANG_FORMAT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| C_CLANG_FORMAT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| C_CLANG_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 | `list_of_files` | +| C_CLANG_FORMAT_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".c", ".h"]` | +| C_CLANG_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 | +| C_CLANG_FORMAT_PRE_COMMANDS | List of bash commands to run before the linter | None | +| C_CLANG_FORMAT_POST_COMMANDS | List of bash commands to run after the linter | None | +| C_CLANG_FORMAT_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling C_CLANG_FORMAT and its pre/post commands | None | +| C_CLANG_FORMAT_CONFIG_FILE | clang-format configuration file nameUse `LINTER_DEFAULT` to let the linter find it | `.clang-format` | +| C_CLANG_FORMAT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| C_CLANG_FORMAT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| C_CLANG_FORMAT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| C_CLANG_FORMAT_CLI_EXECUTABLE | Override CLI executable | `['clang-format']` | + +## IDE Integration + +Use clang-format in your favorite IDE to catch errors before MegaLinter ! + +| | IDE | Extension Name | Install | +|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +|
| [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| Ex: `-s --foo "bar"` | | +| C_CPPLINT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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` | @@ -30,18 +31,23 @@ description: How to use cpplint (configure, ignore files, ignore errors, help & | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling C_CPPLINT and its pre/post commands | 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` | +| C_CPPLINT_CLI_EXECUTABLE | Override CLI executable | `['cpplint']` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------|:------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| [_CLOJURE_CLJ_KONDO_](clojure_clj_kondo.md) | [](https://github.com/borkdude/clj-kondo) | +| Linter | Additional | +|---------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [**clj-kondo**](clojure_clj_kondo.md)
[_CLOJURE_CLJ_KONDO_](clojure_clj_kondo.md) | [](https://github.com/borkdude/clj-kondo) | +| [**cljstyle**](clojure_cljstyle.md)
[_CLOJURE_CLJSTYLE_](clojure_cljstyle.md) | [](https://github.com/greglook/cljstyle)  | ## Linted files @@ -23,8 +24,60 @@ description: clj-kondo is available to analyze CLOJURE files in MegaLinter ## 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_PRE_COMMANDS | List of bash commands to run before the linters | None | +| CLOJURE_POST_COMMANDS | List of bash commands to run after the linters | None | +| CLOJURE_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| CLOJURE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | + + +## Behind the scenes + +### Installation + +- Dockerfile commands : +```dockerfile +ENV LANG=C.UTF-8 +RUN ALPINE_GLIBC_BASE_URL="https://github.com/sgerrand/alpine-pkg-glibc/releases/download" && \ + ALPINE_GLIBC_PACKAGE_VERSION="2.34-r0" && \ + ALPINE_GLIBC_BASE_PACKAGE_FILENAME="glibc-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \ + ALPINE_GLIBC_BIN_PACKAGE_FILENAME="glibc-bin-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \ + ALPINE_GLIBC_I18N_PACKAGE_FILENAME="glibc-i18n-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \ + apk add --no-cache --virtual=.build-dependencies wget ca-certificates && \ + echo \ + "-----BEGIN PUBLIC KEY-----\ + MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApZ2u1KJKUu/fW4A25y9m\ + y70AGEa/J3Wi5ibNVGNn1gT1r0VfgeWd0pUybS4UmcHdiNzxJPgoWQhV2SSW1JYu\ + tOqKZF5QSN6X937PTUpNBjUvLtTQ1ve1fp39uf/lEXPpFpOPL88LKnDBgbh7wkCp\ + m2KzLVGChf83MS0ShL6G9EQIAUxLm99VpgRjwqTQ/KfzGtpke1wqws4au0Ab4qPY\ + KXvMLSPLUp7cfulWvhmZSegr5AdhNw5KNizPqCJT8ZrGvgHypXyiFvvAH5YRtSsc\ + Zvo9GI2e2MaZyo9/lvb+LbLEJZKEQckqRj4P26gmASrZEPStwc+yqy1ShHLA0j6m\ + 1QIDAQAB\ + -----END PUBLIC KEY-----" | sed 's/ */\\n/g' > "/etc/apk/keys/sgerrand.rsa.pub" && \ + wget --quiet --tries=10 --waitretry=10 \ + "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \ + "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \ + "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_I18N_PACKAGE_FILENAME" && \ + mv /etc/nsswitch.conf /etc/nsswitch.conf.bak && \ + apk add --no-cache --force-overwrite \ + "$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \ + "$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \ + "$ALPINE_GLIBC_I18N_PACKAGE_FILENAME" && \ + \ + mv /etc/nsswitch.conf.bak /etc/nsswitch.conf && \ + rm "/etc/apk/keys/sgerrand.rsa.pub" && \ + (/usr/glibc-compat/bin/localedef --force --inputfile POSIX --charmap UTF-8 "$LANG" || true) && \ + echo "export LANG=$LANG" > /etc/profile.d/locale.sh && \ + \ + apk del glibc-i18n && \ + \ + rm "/root/.wget-hsts" && \ + apk del .build-dependencies && \ + rm \ + "$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \ + "$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \ + "$ALPINE_GLIBC_I18N_PACKAGE_FILENAME" + +``` diff --git a/docs/descriptors/clojure_clj_kondo.md b/docs/descriptors/clojure_clj_kondo.md index cfa09b35d5a..bd15d095dd0 100644 --- a/docs/descriptors/clojure_clj_kondo.md +++ b/docs/descriptors/clojure_clj_kondo.md @@ -3,7 +3,7 @@ title: clj-kondo configuration in MegaLinter description: How to use clj-kondo (configure, ignore files, ignore errors, help & version documentations) to analyze CLOJURE files --- - +
@@ -15,10 +15,10 @@ description: How to use clj-kondo (configure, ignore files, ignore errors, help
## clj-kondo documentation
-- Version in MegaLinter: **2023.03.17**
+- Version in MegaLinter: **2024.05.24**
- Visit [Official Web Site](https://github.com/borkdude/clj-kondo#readme){target=_blank}
- See [How to configure clj-kondo rules](https://github.com/borkdude/clj-kondo/blob/master/doc/config.md#configuration){target=_blank}
- - If custom `.clj-kondo/config.edn` config file is not found, [.clj-kondo/config.edn](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.clj-kondo/config.edn){target=_blank} will be used
+ - If custom `.clj-kondo/config.edn` config file isn't found, [.clj-kondo/config.edn](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.clj-kondo/config.edn){target=_blank} will be used
- See [How to disable clj-kondo rules in files](https://github.com/clj-kondo/clj-kondo/blob/master/doc/config.md#ignore-warnings-in-an-expression){target=_blank}
- See [Index of problems detected by clj-kondo](https://github.com/borkdude/clj-kondo#features){target=_blank}
@@ -26,12 +26,13 @@ description: How to use clj-kondo (configure, ignore files, ignore errors, help
## Configuration in MegaLinter
-- Enable clj-kondo by adding `CLOJURE_CLJ_KONDO` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable clj-kondo by adding `CLOJURE_CLJ_KONDO` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable clj-kondo by adding `CLOJURE_CLJ_KONDO` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable clj-kondo by adding `CLOJURE_CLJ_KONDO` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `project`: Call the linter from the root of the project | `file` | @@ -39,10 +40,12 @@ description: How to use clj-kondo (configure, ignore files, ignore errors, help | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CLOJURE_CLJ_KONDO and its pre/post commands | None | | CLOJURE_CLJ_KONDO_CONFIG_FILE | clj-kondo configuration file nameUse `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` | +| CLOJURE_CLJ_KONDO_CLI_EXECUTABLE | Override CLI executable | `['clj-kondo']` | ## IDE Integration @@ -61,9 +64,9 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------|:------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| 
| [cupcake](https://megalinter.io/6.22.2/flavors/cupcake/) | MegaLinter for the most commonly used languages | 82 |   |
-| 
| [java](https://megalinter.io/6.22.2/flavors/java/) | Optimized for JAVA based projects | 51 |   |
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [cupcake](https://megalinter.io/7.13.0/flavors/cupcake/) | MegaLinter for the most commonly used languages | 84 |   |
+| | [java](https://megalinter.io/7.13.0/flavors/java/) | Optimized for JAVA based projects | 54 |   |
## Behind the scenes
@@ -91,8 +94,7 @@ clj-kondo --lint --config .clj-kondo/config.edn myfile.clj
### Help content
```shell
-clj-kondo v2023.03.17
-
+clj-kondo v2024.05.24
Options:
@@ -113,8 +115,7 @@ Options:
using `--cache-dir`. If `--cache-dir` is not set, cache is resolved using the
nearest `.clj-kondo` directory in the current and parent directories.
- --config : config may be a file or an EDN expression. See
- https://cljdoc.org/d/clj-kondo/clj-kondo/2023.03.17/doc/configuration
+ --config : extra config that is merged. May be a file or an EDN expression. See https://github.com/clj-kondo/clj-kondo/blob/master/doc/config.md.
--config-dir : use this config directory instead of auto-detected
.clj-kondo dir.
@@ -138,7 +139,50 @@ Options:
- Dockerfile commands :
```dockerfile
-RUN curl -sLO https://raw.githubusercontent.com/clj-kondo/clj-kondo/master/script/install-clj-kondo \
+# Parent descriptor install
+ENV LANG=C.UTF-8
+RUN ALPINE_GLIBC_BASE_URL="https://github.com/sgerrand/alpine-pkg-glibc/releases/download" && \
+ ALPINE_GLIBC_PACKAGE_VERSION="2.34-r0" && \
+ ALPINE_GLIBC_BASE_PACKAGE_FILENAME="glibc-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
+ ALPINE_GLIBC_BIN_PACKAGE_FILENAME="glibc-bin-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
+ ALPINE_GLIBC_I18N_PACKAGE_FILENAME="glibc-i18n-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
+ apk add --no-cache --virtual=.build-dependencies wget ca-certificates && \
+ echo \
+ "-----BEGIN PUBLIC KEY-----\
+ MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApZ2u1KJKUu/fW4A25y9m\
+ y70AGEa/J3Wi5ibNVGNn1gT1r0VfgeWd0pUybS4UmcHdiNzxJPgoWQhV2SSW1JYu\
+ tOqKZF5QSN6X937PTUpNBjUvLtTQ1ve1fp39uf/lEXPpFpOPL88LKnDBgbh7wkCp\
+ m2KzLVGChf83MS0ShL6G9EQIAUxLm99VpgRjwqTQ/KfzGtpke1wqws4au0Ab4qPY\
+ KXvMLSPLUp7cfulWvhmZSegr5AdhNw5KNizPqCJT8ZrGvgHypXyiFvvAH5YRtSsc\
+ Zvo9GI2e2MaZyo9/lvb+LbLEJZKEQckqRj4P26gmASrZEPStwc+yqy1ShHLA0j6m\
+ 1QIDAQAB\
+ -----END PUBLIC KEY-----" | sed 's/ */\\n/g' > "/etc/apk/keys/sgerrand.rsa.pub" && \
+ wget --quiet --tries=10 --waitretry=10 \
+ "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_I18N_PACKAGE_FILENAME" && \
+ mv /etc/nsswitch.conf /etc/nsswitch.conf.bak && \
+ apk add --no-cache --force-overwrite \
+ "$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_I18N_PACKAGE_FILENAME" && \
+ \
+ mv /etc/nsswitch.conf.bak /etc/nsswitch.conf && \
+ rm "/etc/apk/keys/sgerrand.rsa.pub" && \
+ (/usr/glibc-compat/bin/localedef --force --inputfile POSIX --charmap UTF-8 "$LANG" || true) && \
+ echo "export LANG=$LANG" > /etc/profile.d/locale.sh && \
+ \
+ apk del glibc-i18n && \
+ \
+ rm "/root/.wget-hsts" && \
+ apk del .build-dependencies && \
+ rm \
+ "$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_I18N_PACKAGE_FILENAME"
+
+# Linter install
+RUN curl --retry 5 --retry-delay 5 -sLO https://raw.githubusercontent.com/clj-kondo/clj-kondo/master/script/install-clj-kondo \
&& chmod +x install-clj-kondo \
&& ./install-clj-kondo
diff --git a/docs/descriptors/clojure_cljstyle.md b/docs/descriptors/clojure_cljstyle.md
new file mode 100644
index 00000000000..57bede819fa
--- /dev/null
+++ b/docs/descriptors/clojure_cljstyle.md
@@ -0,0 +1,168 @@
+---
+title: cljstyle configuration in MegaLinter
+description: How to use cljstyle (configure, ignore files, ignore errors, help & version documentations) to analyze CLOJURE files
+---
+
+
+# cljstyle
+[](https://github.com/greglook/cljstyle)  [](https://github.com/greglook/cljstyle/releases) [](https://github.com/greglook/cljstyle/commits) [](https://github.com/greglook/cljstyle/graphs/commit-activity/) [](https://github.com/greglook/cljstyle/graphs/contributors/)
+
+_This linter has been disabled in this version_
+
+## cljstyle documentation
+
+- Version in MegaLinter: **0.15.0**
+- Visit [Official Web Site](https://github.com/greglook/cljstyle#readme){target=_blank}
+- See [How to configure cljstyle rules](https://github.com/greglook/cljstyle/blob/main/doc/configuration.md#format-rules){target=_blank}
+- See [How to disable cljstyle rules in files](https://github.com/greglook/cljstyle#ignoring-forms){target=_blank}
+- See [Index of problems detected by cljstyle](https://github.com/greglook/cljstyle/blob/main/doc/configuration.md#format-rules){target=_blank}
+
+[](https://github.com/greglook/cljstyle){target=_blank}
+
+## Configuration in MegaLinter
+
+- Enable cljstyle by adding `CLOJURE_CLJSTYLE` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable cljstyle by adding `CLOJURE_CLJSTYLE` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+
+- Enable **autofixes** by adding `CLOJURE_CLJSTYLE` in [APPLY_FIXES variable](https://megalinter.io/7.13.0/configuration/#apply-fixes)
+
+| Variable | Description | Default value |
+|----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
+| CLOJURE_CLJSTYLE_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| CLOJURE_CLJSTYLE_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
Ex: `-s --foo "bar"` | | +| CLOJURE_CLJSTYLE_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| CLOJURE_CLJSTYLE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| CLOJURE_CLJSTYLE_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `project`: Call the linter from the root of the project | `file` | +| CLOJURE_CLJSTYLE_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".clj", ".cljs", ".cljc", ".edn"]` | +| CLOJURE_CLJSTYLE_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_CLJSTYLE_PRE_COMMANDS | List of bash commands to run before the linter | None | +| CLOJURE_CLJSTYLE_POST_COMMANDS | List of bash commands to run after the linter | None | +| CLOJURE_CLJSTYLE_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CLOJURE_CLJSTYLE and its pre/post commands | None | +| CLOJURE_CLJSTYLE_CONFIG_FILE | cljstyle configuration file nameUse `LINTER_DEFAULT` to let the linter find it | `.cljstyle` | +| CLOJURE_CLJSTYLE_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| CLOJURE_CLJSTYLE_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| CLOJURE_CLJSTYLE_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| CLOJURE_CLJSTYLE_CLI_EXECUTABLE | Override CLI executable | `['cljstyle']` | + +## IDE Integration + +Use cljstyle in your favorite IDE to catch errors before MegaLinter ! + +| | IDE | Extension Name | Install | +|:------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------|-------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------:| +|
| [Emacs](https://www.gnu.org/software/emacs/) | [cljstyle-mode](https://github.com/greglook/cljstyle/blob/main/doc/integrations.md#emacs) | [Visit Web Site](https://github.com/greglook/cljstyle/blob/main/doc/integrations.md#emacs){target=_blank} |
+
+## MegaLinter Flavours
+
+This linter is available in the following flavours
+
+| | Flavor | Description | Embedded linters | Info |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------|:--------------------------|:----------------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+
+## Behind the scenes
+
+### How are identified applicable files
+
+- File extensions: `.clj`, `.cljs`, `.cljc`, `.edn`
+
+
+
+### How the linting is performed
+
+- cljstyle is called one time by identified file (`file` CLI lint mode)
+
+### Example calls
+
+```shell
+cljstyle check
+```
+
+```shell
+cljstyle fix
+```
+
+```shell
+clj-kondo fix myfile.clj path/to/myfile.clj
+```
+
+
+### Help content
+
+```shell
+Usage: cljstyle [options] [args...]
+
+Commands:
+ find Find files which would be processed.
+ check Check source files and print a diff for errors.
+ fix Edit source files to fix formatting errors.
+ pipe Fixes formatting errors from stdin and pipes the results to stdout.
+ config Show config used for a given path.
+ migrate Migrate legacy configuration files.
+ version Print program version information.
+
+Options:
+ --ignore PATTERN Ignore files matching the given pattern. May be set multiple times.
+ --timeout SEC 300 Maximum time to allow the process to run for.
+ --timeout-trace Dump thread stack traces when the tool times out.
+ --stats FILE Write formatting stats to the named file. The extension controls the format and may be either 'edn' or 'tsv'.
+ --report Print stats report at the end of a run.
+ --report-timing Print detailed rule timings at the end of a run.
+ --no-color Don't output ANSI color codes.
+ -v, --verbose Print detailed debugging output.
+ -h, --help Show help and usage information.
+```
+
+### Installation on mega-linter Docker image
+
+- Dockerfile commands :
+```dockerfile
+# Parent descriptor install
+ENV LANG=C.UTF-8
+RUN ALPINE_GLIBC_BASE_URL="https://github.com/sgerrand/alpine-pkg-glibc/releases/download" && \
+ ALPINE_GLIBC_PACKAGE_VERSION="2.34-r0" && \
+ ALPINE_GLIBC_BASE_PACKAGE_FILENAME="glibc-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
+ ALPINE_GLIBC_BIN_PACKAGE_FILENAME="glibc-bin-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
+ ALPINE_GLIBC_I18N_PACKAGE_FILENAME="glibc-i18n-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
+ apk add --no-cache --virtual=.build-dependencies wget ca-certificates && \
+ echo \
+ "-----BEGIN PUBLIC KEY-----\
+ MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApZ2u1KJKUu/fW4A25y9m\
+ y70AGEa/J3Wi5ibNVGNn1gT1r0VfgeWd0pUybS4UmcHdiNzxJPgoWQhV2SSW1JYu\
+ tOqKZF5QSN6X937PTUpNBjUvLtTQ1ve1fp39uf/lEXPpFpOPL88LKnDBgbh7wkCp\
+ m2KzLVGChf83MS0ShL6G9EQIAUxLm99VpgRjwqTQ/KfzGtpke1wqws4au0Ab4qPY\
+ KXvMLSPLUp7cfulWvhmZSegr5AdhNw5KNizPqCJT8ZrGvgHypXyiFvvAH5YRtSsc\
+ Zvo9GI2e2MaZyo9/lvb+LbLEJZKEQckqRj4P26gmASrZEPStwc+yqy1ShHLA0j6m\
+ 1QIDAQAB\
+ -----END PUBLIC KEY-----" | sed 's/ */\\n/g' > "/etc/apk/keys/sgerrand.rsa.pub" && \
+ wget --quiet --tries=10 --waitretry=10 \
+ "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_I18N_PACKAGE_FILENAME" && \
+ mv /etc/nsswitch.conf /etc/nsswitch.conf.bak && \
+ apk add --no-cache --force-overwrite \
+ "$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_I18N_PACKAGE_FILENAME" && \
+ \
+ mv /etc/nsswitch.conf.bak /etc/nsswitch.conf && \
+ rm "/etc/apk/keys/sgerrand.rsa.pub" && \
+ (/usr/glibc-compat/bin/localedef --force --inputfile POSIX --charmap UTF-8 "$LANG" || true) && \
+ echo "export LANG=$LANG" > /etc/profile.d/locale.sh && \
+ \
+ apk del glibc-i18n && \
+ \
+ rm "/root/.wget-hsts" && \
+ apk del .build-dependencies && \
+ rm \
+ "$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_I18N_PACKAGE_FILENAME"
+
+# Linter install
+RUN curl --retry 5 --retry-delay 5 -sLO https://raw.githubusercontent.com/greglook/cljstyle/main/util/install-cljstyle \
+ && chmod +x install-cljstyle \
+ && ./install-cljstyle
+
+```
+
diff --git a/docs/descriptors/cloudformation.md b/docs/descriptors/cloudformation.md
index 9c851172f01..214973c19ed 100644
--- a/docs/descriptors/cloudformation.md
+++ b/docs/descriptors/cloudformation.md
@@ -3,7 +3,7 @@ title: CLOUDFORMATION linters in MegaLinter
description: cfn-lint is available to analyze CLOUDFORMATION files in MegaLinter
---
-
+
# CLOUDFORMATION
@@ -26,8 +26,10 @@ description: cfn-lint is available to analyze CLOUDFORMATION files in MegaLinter
## 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_PRE_COMMANDS | List of bash commands to run before the linters | None |
+| CLOUDFORMATION_POST_COMMANDS | List of bash commands to run after the linters | None |
+| 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 a311b29bd94..a36c1a74d8a 100644
--- a/docs/descriptors/cloudformation_cfn_lint.md
+++ b/docs/descriptors/cloudformation_cfn_lint.md
@@ -3,7 +3,7 @@ title: cfn-lint configuration in MegaLinter
description: How to use cfn-lint (configure, ignore files, ignore errors, help & version documentations) to analyze CLOUDFORMATION files
---
-
+
Ex: `-s --foo "bar"` | | +| CLOJURE_CLJ_KONDO_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `project`: Call the linter from the root of the project | `file` | @@ -39,10 +40,12 @@ description: How to use clj-kondo (configure, ignore files, ignore errors, help | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CLOJURE_CLJ_KONDO and its pre/post commands | None | | CLOJURE_CLJ_KONDO_CONFIG_FILE | clj-kondo configuration file nameUse `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` | +| CLOJURE_CLJ_KONDO_CLI_EXECUTABLE | Override CLI executable | `['clj-kondo']` | ## IDE Integration @@ -61,9 +64,9 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------|:------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| Ex: `-s --foo "bar"` | | +| CLOJURE_CLJSTYLE_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
Ex: `-s --foo "bar"` | | +| CLOJURE_CLJSTYLE_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| CLOJURE_CLJSTYLE_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| CLOJURE_CLJSTYLE_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `project`: Call the linter from the root of the project | `file` | +| CLOJURE_CLJSTYLE_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".clj", ".cljs", ".cljc", ".edn"]` | +| CLOJURE_CLJSTYLE_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_CLJSTYLE_PRE_COMMANDS | List of bash commands to run before the linter | None | +| CLOJURE_CLJSTYLE_POST_COMMANDS | List of bash commands to run after the linter | None | +| CLOJURE_CLJSTYLE_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CLOJURE_CLJSTYLE and its pre/post commands | None | +| CLOJURE_CLJSTYLE_CONFIG_FILE | cljstyle configuration file nameUse `LINTER_DEFAULT` to let the linter find it | `.cljstyle` | +| CLOJURE_CLJSTYLE_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| CLOJURE_CLJSTYLE_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| CLOJURE_CLJSTYLE_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| CLOJURE_CLJSTYLE_CLI_EXECUTABLE | Override CLI executable | `['cljstyle']` | + +## IDE Integration + +Use cljstyle in your favorite IDE to catch errors before MegaLinter ! + +| | IDE | Extension Name | Install | +|:------------------------------------------------------------------------------------------------------------------------------------------:|----------------------------------------------|-------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------:| +|
| [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+
+## Behind the scenes
+
+### How are identified applicable files
+
+- File extensions: `.clj`, `.cljs`, `.cljc`, `.edn`
+
+
+
+### How the linting is performed
+
+- cljstyle is called one time by identified file (`file` CLI lint mode)
+
+### Example calls
+
+```shell
+cljstyle check
+```
+
+```shell
+cljstyle fix
+```
+
+```shell
+clj-kondo fix myfile.clj path/to/myfile.clj
+```
+
+
+### Help content
+
+```shell
+Usage: cljstyle [options]
@@ -15,21 +15,22 @@ description: How to use cfn-lint (configure, ignore files, ignore errors, help &
## cfn-lint documentation
-- Version in MegaLinter: **0.76.1**
+- Version in MegaLinter: **1.5.0**
- Visit [Official Web Site](https://github.com/aws-cloudformation/cfn-lint#readme){target=_blank}
- - If custom `.cfnlintrc.yml` config file is not found, [.cfnlintrc.yml](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.cfnlintrc.yml){target=_blank} will be used
+ - If custom `.cfnlintrc.yml` config file isn't found, [.cfnlintrc.yml](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.cfnlintrc.yml){target=_blank} will be used
- See [Index of problems detected by cfn-lint](https://github.com/aws-cloudformation/cfn-lint/blob/main/docs/rules.md){target=_blank}
[](https://github.com/aws-cloudformation/cfn-lint){target=_blank}
## Configuration in MegaLinter
-- Enable cfn-lint by adding `CLOUDFORMATION_CFN_LINT` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable cfn-lint by adding `CLOUDFORMATION_CFN_LINT` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable cfn-lint by adding `CLOUDFORMATION_CFN_LINT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable cfn-lint by adding `CLOUDFORMATION_CFN_LINT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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` | @@ -37,10 +38,12 @@ description: How to use cfn-lint (configure, ignore files, ignore errors, help & | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CLOUDFORMATION_CFN_LINT and its pre/post commands | None | | CLOUDFORMATION_CFN_LINT_CONFIG_FILE | cfn-lint configuration file nameUse `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` | +| CLOUDFORMATION_CFN_LINT_CLI_EXECUTABLE | Override CLI executable | `['cfn-lint']` | ## IDE Integration @@ -59,9 +62,9 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------|:------------------------------------------------|:----------------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [cupcake](https://megalinter.io/6.22.2/flavors/cupcake/) | MegaLinter for the most commonly used languages | 82 |   |
-| 
| [security](https://megalinter.io/6.22.2/flavors/security/) | Optimized for security | 22 |   |
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [cupcake](https://megalinter.io/7.13.0/flavors/cupcake/) | MegaLinter for the most commonly used languages | 84 |   |
+| | [security](https://megalinter.io/7.13.0/flavors/security/) | Optimized for security | 24 |   |
## Behind the scenes
@@ -93,7 +96,7 @@ cfn-lint --config-file .cfnlintrc.yml myfile.yml
usage:
Basic: cfn-lint test.yaml
Ignore a rule: cfn-lint -i E3012 -- test.yaml
-Configure a rule: cfn-lint -x E3012:strict=false -t test.yaml
+Configure a rule: cfn-lint -x E3012:strict=true -t test.yaml
Lint all yaml files in a folder: cfn-lint dir/**/*.yaml
CloudFormation Linter
@@ -125,7 +128,7 @@ Standard:
Include experimental rules
-x CONFIGURE_RULES [CONFIGURE_RULES ...], --configure-rule CONFIGURE_RULES [CONFIGURE_RULES ...]
Provide configuration for a rule. Format
- RuleId:key=value. Example: E3012:strict=false
+ RuleId:key=value. Example: E3012:strict=true
--config-file CONFIG_FILE
Specify the cfnlintrc file to use
-z CUSTOM_RULES, --custom-rules CUSTOM_RULES
@@ -159,4 +162,4 @@ Advanced / Debugging:
### Installation on mega-linter Docker image
- PIP packages (Python):
- - [cfn-lint](https://pypi.org/project/cfn-lint)
+ - [cfn-lint[sarif]](https://pypi.org/project/cfn-lint[sarif])
diff --git a/docs/descriptors/coffee.md b/docs/descriptors/coffee.md
index 203456ea88c..2dde47f7817 100644
--- a/docs/descriptors/coffee.md
+++ b/docs/descriptors/coffee.md
@@ -3,7 +3,7 @@ title: COFFEE linters in MegaLinter
description: coffeelint is available to analyze COFFEE files in MegaLinter
---
-
+
# COFFEE
@@ -20,8 +20,10 @@ description: coffeelint is available to analyze COFFEE files in MegaLinter
## 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_PRE_COMMANDS | List of bash commands to run before the linters | None |
+| COFFEE_POST_COMMANDS | List of bash commands to run after the linters | None |
+| 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 272b0ed609b..b00fc35423e 100644
--- a/docs/descriptors/coffee_coffeelint.md
+++ b/docs/descriptors/coffee_coffeelint.md
@@ -3,29 +3,28 @@ title: coffeelint configuration in MegaLinter
description: How to use coffeelint (configure, ignore files, ignore errors, help & version documentations) to analyze COFFEE files
---
-
+
# coffeelint
[](https://github.com/clutchski/coffeelint) [](https://github.com/clutchski/coffeelint/releases) [](https://github.com/clutchski/coffeelint/commits) [](https://github.com/clutchski/coffeelint/graphs/commit-activity/) [](https://github.com/clutchski/coffeelint/graphs/contributors/)
## coffeelint documentation
- Version in MegaLinter: **5.2.11**
-- Visit [Official Web Site](http://www.coffeelint.org){target=_blank}
-- See [How to configure coffeelint rules](http://www.coffeelint.org/#options){target=_blank}
- - If custom `.coffee-lint.json` config file is not found, [.coffee-lint.json](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.coffee-lint.json){target=_blank} will be used
-- See [How to disable coffeelint rules in files](http://www.coffeelint.org/#options){target=_blank}
-- See [Index of problems detected by coffeelint](http://www.coffeelint.org/#options){target=_blank}
+- Visit [Official Web Site](https://coffeelint.github.io/){target=_blank}
+ - If custom `.coffee-lint.json` config file isn't found, [.coffee-lint.json](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.coffee-lint.json){target=_blank} will be used
+- See [Index of problems detected by coffeelint](https://coffeelint.github.io/#options){target=_blank}
[](https://github.com/clutchski/coffeelint){target=_blank}
## Configuration in MegaLinter
-- Enable coffeelint by adding `COFFEE_COFFEELINT` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable coffeelint by adding `COFFEE_COFFEELINT` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable coffeelint by adding `COFFEE_COFFEELINT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable coffeelint by adding `COFFEE_COFFEELINT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `project`: Call the linter from the root of the project | `file` | @@ -33,10 +32,12 @@ description: How to use coffeelint (configure, ignore files, ignore errors, help | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling COFFEE_COFFEELINT and its pre/post commands | None | | COFFEE_COFFEELINT_CONFIG_FILE | coffeelint configuration file nameUse `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` | +| COFFEE_COFFEELINT_CLI_EXECUTABLE | Override CLI executable | `['coffeelint']` | ## IDE Integration @@ -51,10 +52,11 @@ Use coffeelint in your favorite IDE to catch errors before MegaLinter ! This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------|:------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| 
| [javascript](https://megalinter.io/6.22.2/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 57 |   |
+| | Flavor | Description | Embedded linters | Info |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------|:---------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| 
| [dotnetweb](https://megalinter.io/7.13.0/flavors/dotnetweb/) | Optimized for C, C++, C# or VB based projects with JS/TS | 72 |   |
+| | [javascript](https://megalinter.io/7.13.0/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 61 |   |
## Behind the scenes
diff --git a/docs/descriptors/copypaste.md b/docs/descriptors/copypaste.md
index a23464e5cc9..d04eb0c4490 100644
--- a/docs/descriptors/copypaste.md
+++ b/docs/descriptors/copypaste.md
@@ -3,7 +3,7 @@ title: COPYPASTE linters in MegaLinter
description: jscpd is available to analyze COPYPASTE files in MegaLinter
---
-
+
# COPYPASTE
@@ -17,8 +17,10 @@ description: jscpd is available to analyze COPYPASTE files in MegaLinter
## 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_PRE_COMMANDS | List of bash commands to run before the linters | None |
+| COPYPASTE_POST_COMMANDS | List of bash commands to run after the linters | None |
+| 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 a912558a881..c68b65c3c5f 100644
--- a/docs/descriptors/copypaste_jscpd.md
+++ b/docs/descriptors/copypaste_jscpd.md
@@ -3,7 +3,7 @@ title: jscpd configuration in MegaLinter
description: How to use jscpd (configure, ignore files, ignore errors, help & version documentations) to analyze COPYPASTE files
---
-
+
Ex: `-s --foo "bar"` | | +| CLOUDFORMATION_CFN_LINT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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` | @@ -37,10 +38,12 @@ description: How to use cfn-lint (configure, ignore files, ignore errors, help & | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CLOUDFORMATION_CFN_LINT and its pre/post commands | None | | CLOUDFORMATION_CFN_LINT_CONFIG_FILE | cfn-lint configuration file nameUse `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` | +| CLOUDFORMATION_CFN_LINT_CLI_EXECUTABLE | Override CLI executable | `['cfn-lint']` | ## IDE Integration @@ -59,9 +62,9 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------|:------------------------------------------------|:----------------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| Ex: `-s --foo "bar"` | | +| COFFEE_COFFEELINT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `project`: Call the linter from the root of the project | `file` | @@ -33,10 +32,12 @@ description: How to use coffeelint (configure, ignore files, ignore errors, help | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling COFFEE_COFFEELINT and its pre/post commands | None | | COFFEE_COFFEELINT_CONFIG_FILE | coffeelint configuration file nameUse `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` | +| COFFEE_COFFEELINT_CLI_EXECUTABLE | Override CLI executable | `['coffeelint']` | ## IDE Integration @@ -51,10 +52,11 @@ Use coffeelint in your favorite IDE to catch errors before MegaLinter ! This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------|:------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+|
@@ -34,28 +34,31 @@ Example:
## jscpd documentation
-- Version in MegaLinter: **3.5.4**
+- Version in MegaLinter: **4.0.5**
- Visit [Official Web Site](https://github.com/kucherenko/jscpd/tree/master/packages/jscpd#readme){target=_blank}
- See [How to configure jscpd rules](https://github.com/kucherenko/jscpd/tree/master/packages/jscpd#config-file){target=_blank}
- - If custom `.jscpd.json` config file is not found, [.jscpd.json](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.jscpd.json){target=_blank} will be used
+ - If custom `.jscpd.json` config file isn't found, [.jscpd.json](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.jscpd.json){target=_blank} will be used
- See [How to disable jscpd rules in files](https://github.com/kucherenko/jscpd/tree/master/packages/jscpd#ignored-blocks){target=_blank}
[](https://github.com/kucherenko/jscpd){target=_blank}
## Configuration in MegaLinter
-- Enable jscpd by adding `COPYPASTE_JSCPD` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable jscpd by adding `COPYPASTE_JSCPD` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/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_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 nameUse `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` | +- Enable jscpd by adding `COPYPASTE_JSCPD` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) +- Disable jscpd by adding `COPYPASTE_JSCPD` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
Ex: `-s --foo "bar"` | | +| 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling COPYPASTE_JSCPD and its pre/post commands | None | +| COPYPASTE_JSCPD_CONFIG_FILE | jscpd configuration file nameUse `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` | +| COPYPASTE_JSCPD_CLI_EXECUTABLE | Override CLI executable | `['jscpd']` | ## MegaLinter Flavours @@ -63,21 +66,23 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| 
| [ci_light](https://megalinter.io/6.22.2/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 20 |   |
-| | [cupcake](https://megalinter.io/6.22.2/flavors/cupcake/) | MegaLinter for the most commonly used languages | 82 |   |
-| 
| [documentation](https://megalinter.io/6.22.2/flavors/documentation/) | MegaLinter for documentation projects | 48 |   |
-| 
| [dotnet](https://megalinter.io/6.22.2/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 60 |   |
-| 
| [go](https://megalinter.io/6.22.2/flavors/go/) | Optimized for GO based projects | 50 |   |
-| | [java](https://megalinter.io/6.22.2/flavors/java/) | Optimized for JAVA based projects | 51 |   |
-| | [javascript](https://megalinter.io/6.22.2/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 57 |   |
-| 
| [php](https://megalinter.io/6.22.2/flavors/php/) | Optimized for PHP based projects | 51 |   |
-| 
| [python](https://megalinter.io/6.22.2/flavors/python/) | Optimized for PYTHON based projects | 59 |   |
-| 
| [ruby](https://megalinter.io/6.22.2/flavors/ruby/) | Optimized for RUBY based projects | 48 |   |
-| 
| [rust](https://megalinter.io/6.22.2/flavors/rust/) | Optimized for RUST based projects | 48 |   |
-| 
| [salesforce](https://megalinter.io/6.22.2/flavors/salesforce/) | Optimized for Salesforce based projects | 51 |   |
-| 
| [swift](https://megalinter.io/6.22.2/flavors/swift/) | Optimized for SWIFT based projects | 48 |   |
-| 
| [terraform](https://megalinter.io/6.22.2/flavors/terraform/) | Optimized for TERRAFORM based projects | 53 |   |
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| 
| [c_cpp](https://megalinter.io/7.13.0/flavors/c_cpp/) | Optimized for pure C/C++ projects | 56 |   |
+| | [ci_light](https://megalinter.io/7.13.0/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 21 |   |
+| | [cupcake](https://megalinter.io/7.13.0/flavors/cupcake/) | MegaLinter for the most commonly used languages | 84 |   |
+| | [documentation](https://megalinter.io/7.13.0/flavors/documentation/) | MegaLinter for documentation projects | 51 |   |
+| | [dotnet](https://megalinter.io/7.13.0/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 63 |   |
+| | [dotnetweb](https://megalinter.io/7.13.0/flavors/dotnetweb/) | Optimized for C, C++, C# or VB based projects with JS/TS | 72 |   |
+| | [go](https://megalinter.io/7.13.0/flavors/go/) | Optimized for GO based projects | 53 |   |
+| | [java](https://megalinter.io/7.13.0/flavors/java/) | Optimized for JAVA based projects | 54 |   |
+| | [javascript](https://megalinter.io/7.13.0/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 61 |   |
+| | [php](https://megalinter.io/7.13.0/flavors/php/) | Optimized for PHP based projects | 56 |   |
+| | [python](https://megalinter.io/7.13.0/flavors/python/) | Optimized for PYTHON based projects | 64 |   |
+| | [ruby](https://megalinter.io/7.13.0/flavors/ruby/) | Optimized for RUBY based projects | 52 |   |
+| | [rust](https://megalinter.io/7.13.0/flavors/rust/) | Optimized for RUST based projects | 52 |   |
+| | [salesforce](https://megalinter.io/7.13.0/flavors/salesforce/) | Optimized for Salesforce based projects | 56 |   |
+| | [swift](https://megalinter.io/7.13.0/flavors/swift/) | Optimized for SWIFT based projects | 52 |   |
+| | [terraform](https://megalinter.io/7.13.0/flavors/terraform/) | Optimized for TERRAFORM based projects | 56 |   |
## Behind the scenes
@@ -92,7 +97,7 @@ This linter is available in the following flavours
jscpd is called once on the whole project directory (`project` CLI lint mode)
- filtering can not be done using MegaLinter configuration variables,it must be done using jscpd configuration or ignore file (if existing)
-- `VALIDATE_ALL_CODEBASE: false` does not make jscpd analyze only updated files
+- `VALIDATE_ALL_CODEBASE: false` doesn't make jscpd analyze only updated files
### Example calls
@@ -132,7 +137,7 @@ Options:
comma to use (Default is time,console)
-o, --output [string] reporters to use (Default is ./report/)
-m, --mode [string] mode of quality of search, can be "strict", "mild" and "weak" (Default is "function mild(token) {
- return strict(token) && token.type !== 'empty' && token.type !== 'new_line';
+ return strict(token) && token.type !== "empty" && token.type !== "new_line";
}")
-f, --format [string] format or formats separated by comma (Example
php,javascript,python)
diff --git a/docs/descriptors/cpp.md b/docs/descriptors/cpp.md
index ccc5fc79e2b..1397ce700ed 100644
--- a/docs/descriptors/cpp.md
+++ b/docs/descriptors/cpp.md
@@ -1,17 +1,18 @@
---
title: CPP linters in MegaLinter
-description: cpplint is available to analyze CPP files in MegaLinter
+description: cpplint, clang-format are available to analyze CPP files in MegaLinter
---
-
+
# C++
## Linters
-| Linter | Additional |
-|-------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
-| [**cpplint**](cpp_cpplint.md)
[_CPP_CPPLINT_](cpp_cpplint.md) | [](https://github.com/cpplint/cpplint) | +| Linter | Additional | +|---------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [**cpplint**](cpp_cpplint.md)
[_CPP_CPPLINT_](cpp_cpplint.md) | [](https://github.com/cpplint/cpplint) | +| [**clang-format**](cpp_clang_format.md)
[_CPP_CLANG_FORMAT_](cpp_clang_format.md) | [](https://github.com/llvm/llvm-project)  | ## Linted files @@ -30,8 +31,10 @@ description: cpplint is available to analyze CPP files in MegaLinter ## 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_PRE_COMMANDS | List of bash commands to run before the linters | None | +| CPP_POST_COMMANDS | List of bash commands to run after the linters | None | +| CPP_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| CPP_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/cpp_clang_format.md b/docs/descriptors/cpp_clang_format.md new file mode 100644 index 00000000000..b91ba55f8a3 --- /dev/null +++ b/docs/descriptors/cpp_clang_format.md @@ -0,0 +1,185 @@ +--- +title: clang-format configuration in MegaLinter +description: How to use clang-format (configure, ignore files, ignore errors, help & version documentations) to analyze CPP files +--- + + +# clang-format +[](https://github.com/llvm/llvm-project)  [](https://github.com/llvm/llvm-project/releases) [](https://github.com/llvm/llvm-project/commits) [](https://github.com/llvm/llvm-project/graphs/commit-activity/) [](https://github.com/llvm/llvm-project/graphs/contributors/) + +## clang-format documentation + +- Version in MegaLinter: **17.0.6** +- Visit [Official Web Site](https://releases.llvm.org/17.0.1/tools/clang/docs/ClangFormat.html){target=_blank} +- See [How to disable clang-format rules in files](https://releases.llvm.org/17.0.1/tools/clang/docs/ClangFormatStyleOptions.html#disabling-formatting-on-a-piece-of-code){target=_blank} +- See [Index of problems detected by clang-format](https://releases.llvm.org/17.0.1/tools/clang/docs/ClangFormat.html){target=_blank} + +[](https://github.com/llvm/llvm-project){target=_blank} + +## Configuration in MegaLinter + +- Enable clang-format by adding `CPP_CLANG_FORMAT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) +- Disable clang-format by adding `CPP_CLANG_FORMAT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) + +- Enable **autofixes** by adding `CPP_CLANG_FORMAT` in [APPLY_FIXES variable](https://megalinter.io/7.13.0/configuration/#apply-fixes) + +| Variable | Description | Default value | +|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------| +| CPP_CLANG_FORMAT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| CPP_CLANG_FORMAT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
Ex: `-s --foo "bar"` | | +| CPP_CLANG_FORMAT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| CPP_CLANG_FORMAT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| CPP_CLANG_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 | `list_of_files` | +| CPP_CLANG_FORMAT_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_CLANG_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 | +| CPP_CLANG_FORMAT_PRE_COMMANDS | List of bash commands to run before the linter | None | +| CPP_CLANG_FORMAT_POST_COMMANDS | List of bash commands to run after the linter | None | +| CPP_CLANG_FORMAT_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CPP_CLANG_FORMAT and its pre/post commands | None | +| CPP_CLANG_FORMAT_CONFIG_FILE | clang-format configuration file nameUse `LINTER_DEFAULT` to let the linter find it | `.clang-format` | +| CPP_CLANG_FORMAT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| CPP_CLANG_FORMAT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| CPP_CLANG_FORMAT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| CPP_CLANG_FORMAT_CLI_EXECUTABLE | Override CLI executable | `['clang-format']` | + +## IDE Integration + +Use clang-format in your favorite IDE to catch errors before MegaLinter ! + +| | IDE | Extension Name | Install | +|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +|
| [Visual Studio Code](https://code.visualstudio.com/) | [Clang-Format](https://marketplace.visualstudio.com/items?itemName=xaver.clang-format) | [](vscode:extension/xaver.clang-format){target=_blank} |
+| | [Emacs](https://www.gnu.org/software/emacs/) | [clang-format](https://releases.llvm.org/17.0.1/tools/clang/docs/ClangFormat.html#emacs-integration) | [Visit Web Site](https://releases.llvm.org/17.0.1/tools/clang/docs/ClangFormat.html#emacs-integration){target=_blank} |
+
+## MegaLinter Flavours
+
+This linter is available in the following flavours
+
+| | Flavor | Description | Embedded linters | Info |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------|:----------------------------------|:----------------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [c_cpp](https://megalinter.io/7.13.0/flavors/c_cpp/) | Optimized for pure C/C++ projects | 56 |   |
+
+## Behind the scenes
+
+### How are identified applicable files
+
+- File extensions: `.cpp`, `.h`, `.cc`, `.hpp`, `.cxx`, `.cu`, `.hxx`, `.c++`, `.hh`, `.h++`, `.cuh`
+
+
+
+### How the linting is performed
+
+- clang-format is called once with the list of files as arguments (`list_of_files` CLI lint mode)
+
+### Example calls
+
+```shell
+clang-format --Werror --dry-run myfile.cpp
+```
+
+
+### Help content
+
+```shell
+OVERVIEW: A tool to format C/C++/Java/JavaScript/JSON/Objective-C/Protobuf/C# code.
+
+If no arguments are specified, it formats the code from standard input
+and writes the result to the standard output.
+If s are given, it reformats the files. If -i is specified
+together with s, the files are edited in-place. Otherwise, the
+result is written to the standard output.
+
+USAGE: clang-format [options] [ ...]
+
+OPTIONS:
+
+Clang-format options:
+
+ --Werror - If set, changes formatting warnings to errors
+ --Wno-error= - If set don't error out on the specified warning type.
+ =unknown - If set, unknown format options are only warned about.
+ This can be used to enable formatting, even if the
+ configuration contains unknown (newer) options.
+ Use with caution, as this might lead to dramatically
+ differing format depending on an option being
+ supported or not.
+ --assume-filename= - Set filename used to determine the language and to find
+ .clang-format file.
+ Only used when reading from stdin.
+ If this is not passed, the .clang-format file is searched
+ relative to the current working directory when reading stdin.
+ Unrecognized filenames are treated as C++.
+ supported:
+ CSharp: .cs
+ Java: .java
+ JavaScript: .mjs .js .ts
+ Json: .json
+ Objective-C: .m .mm
+ Proto: .proto .protodevel
+ TableGen: .td
+ TextProto: .textpb .pb.txt .textproto .asciipb
+ Verilog: .sv .svh .v .vh
+ --cursor= - The position of the cursor when invoking
+ clang-format from an editor integration
+ --dry-run - If set, do not actually make the formatting changes
+ --dump-config - Dump configuration options to stdout and exit.
+ Can be used with -style option.
+ --fallback-style= - The name of the predefined style used as a
+ fallback in case clang-format is invoked with
+ -style=file, but can not find the .clang-format
+ file to use. Defaults to 'LLVM'.
+ Use -fallback-style=none to skip formatting.
+ --ferror-limit= - Set the maximum number of clang-format errors to emit
+ before stopping (0 = no limit).
+ Used only with --dry-run or -n
+ --files= - A file containing a list of files to process, one per line.
+ -i - Inplace edit s, if specified.
+ --length= - Format a range of this length (in bytes).
+ Multiple ranges can be formatted by specifying
+ several -offset and -length pairs.
+ When only a single -offset is specified without
+ -length, clang-format will format up to the end
+ of the file.
+ Can only be used with one input file.
+ --lines= - : - format a range of
+ lines (both 1-based).
+ Multiple ranges can be formatted by specifying
+ several -lines arguments.
+ Can't be used with -offset and -length.
+ Can only be used with one input file.
+ -n - Alias for --dry-run
+ --offset= - Format a range starting at this byte offset.
+ Multiple ranges can be formatted by specifying
+ several -offset and -length pairs.
+ Can only be used with one input file.
+ --output-replacements-xml - Output replacements as XML.
+ --qualifier-alignment= - If set, overrides the qualifier alignment style
+ determined by the QualifierAlignment style flag
+ --sort-includes - If set, overrides the include sorting behavior
+ determined by the SortIncludes style flag
+ --style= - Set coding style. can be:
+ 1. A preset: LLVM, GNU, Google, Chromium, Microsoft,
+ Mozilla, WebKit.
+ 2. 'file' to load style configuration from a
+ .clang-format file in one of the parent directories
+ of the source file (for stdin, see --assume-filename).
+ If no .clang-format file is found, falls back to
+ --fallback-style.
+ --style=file is the default.
+ 3. 'file:' to explicitly specify
+ the configuration file.
+ 4. "{key: value, ...}" to set specific parameters, e.g.:
+ --style="{BasedOnStyle: llvm, IndentWidth: 8}"
+ --verbose - If set, shows the list of processed files
+
+Generic Options:
+
+ --help - Display available options (--help-hidden for more)
+ --help-list - Display list of available options (--help-list-hidden for more)
+ --version - Display the version of this program
+```
+
+### Installation on mega-linter Docker image
+
+- APK packages (Linux):
+ - [clang17-extra-tools](https://pkgs.alpinelinux.org/packages?branch=edge&name=clang17-extra-tools)
diff --git a/docs/descriptors/cpp_cpplint.md b/docs/descriptors/cpp_cpplint.md
index 3998167ad7d..0cdd571ca4f 100644
--- a/docs/descriptors/cpp_cpplint.md
+++ b/docs/descriptors/cpp_cpplint.md
@@ -3,7 +3,7 @@ title: cpplint configuration in MegaLinter
description: How to use cpplint (configure, ignore files, ignore errors, help & version documentations) to analyze CPP files
---
-
+
# cpplint
[](https://github.com/cpplint/cpplint) [](https://github.com/cpplint/cpplint/releases) [](https://github.com/cpplint/cpplint/commits) [](https://github.com/cpplint/cpplint/graphs/commit-activity/) [](https://github.com/cpplint/cpplint/graphs/contributors/)
@@ -17,12 +17,13 @@ description: How to use cpplint (configure, ignore files, ignore errors, help &
## Configuration in MegaLinter
-- Enable cpplint by adding `CPP_CPPLINT` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable cpplint by adding `CPP_CPPLINT` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable cpplint by adding `CPP_CPPLINT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable cpplint by adding `CPP_CPPLINT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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` | @@ -30,18 +31,23 @@ description: How to use cpplint (configure, ignore files, ignore errors, help & | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CPP_CPPLINT and its pre/post commands | 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` | +| CPP_CPPLINT_CLI_EXECUTABLE | Override CLI executable | `['cpplint']` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------|:------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [cupcake](https://megalinter.io/6.22.2/flavors/cupcake/) | MegaLinter for the most commonly used languages | 82 |   |
-| | [dotnet](https://megalinter.io/6.22.2/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 60 |   |
+| | Flavor | Description | Embedded linters | Info |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------|:---------------------------------------------------------|:----------------:|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [c_cpp](https://megalinter.io/7.13.0/flavors/c_cpp/) | Optimized for pure C/C++ projects | 56 |   |
+| | [cupcake](https://megalinter.io/7.13.0/flavors/cupcake/) | MegaLinter for the most commonly used languages | 84 |   |
+| | [dotnet](https://megalinter.io/7.13.0/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 63 |   |
+| | [dotnetweb](https://megalinter.io/7.13.0/flavors/dotnetweb/) | Optimized for C, C++, C# or VB based projects with JS/TS | 72 |   |
+| | [python](https://megalinter.io/7.13.0/flavors/python/) | Optimized for PYTHON based projects | 64 |   |
## Behind the scenes
diff --git a/docs/descriptors/csharp.md b/docs/descriptors/csharp.md
index 5af6a85638e..e88d5857e24 100644
--- a/docs/descriptors/csharp.md
+++ b/docs/descriptors/csharp.md
@@ -1,18 +1,19 @@
---
title: CSHARP linters in MegaLinter
-description: dotnet-format, csharpier are available to analyze CSHARP files in MegaLinter
+description: dotnet-format, csharpier, roslynator are available to analyze CSHARP files in MegaLinter
---
-
+
# C#
## Linters
-| Linter | Additional |
-|----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [**dotnet-format**](csharp_dotnet_format.md)
[_CSHARP_DOTNET_FORMAT_](csharp_dotnet_format.md) | [](https://github.com/dotnet/format)  | -| [**csharpier**](csharp_csharpier.md)
[_CSHARP_CSHARPIER_](csharp_csharpier.md) | [](https://github.com/belav/csharpier)  | +| Linter | Additional | +|----------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [**dotnet-format**](csharp_dotnet_format.md)
[_CSHARP_DOTNET_FORMAT_](csharp_dotnet_format.md) | [](https://github.com/dotnet/format)  | +| [**csharpier**](csharp_csharpier.md)
[_CSHARP_CSHARPIER_](csharp_csharpier.md) | [](https://github.com/belav/csharpier)  | +| [**roslynator**](csharp_roslynator.md)
[_CSHARP_ROSLYNATOR_](csharp_roslynator.md) | [](https://github.com/dotnet/Roslynator)  | ## Linted files @@ -21,10 +22,12 @@ description: dotnet-format, csharpier are available to analyze CSHARP files in M ## 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_PRE_COMMANDS | List of bash commands to run before the linters | None | +| CSHARP_POST_COMMANDS | List of bash commands to run after the linters | None | +| CSHARP_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| CSHARP_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | ## Behind the scenes @@ -33,19 +36,7 @@ description: dotnet-format, csharpier are available to analyze CSHARP files in M - Dockerfile commands : ```dockerfile -RUN wget --tries=5 -q -O dotnet-install.sh https://dot.net/v1/dotnet-install.sh \ - && chmod +x dotnet-install.sh \ - && ./dotnet-install.sh --install-dir /usr/share/dotnet -channel 6.0 -version latest - -ENV PATH="${PATH}:/root/.dotnet/tools:/usr/share/dotnet" +RUN apk add --no-cache dotnet8-sdk +ENV PATH="${PATH}:/root/.dotnet/tools" ``` -- APK packages (Linux): - - [icu-libs](https://pkgs.alpinelinux.org/packages?branch=edge&name=icu-libs) - - [libcurl](https://pkgs.alpinelinux.org/packages?branch=edge&name=libcurl) - - [libintl](https://pkgs.alpinelinux.org/packages?branch=edge&name=libintl) - - [libssl1.1](https://pkgs.alpinelinux.org/packages?branch=edge&name=libssl1.1) - - [libstdc++](https://pkgs.alpinelinux.org/packages?branch=edge&name=libstdc++) - - [lttng-ust-dev](https://pkgs.alpinelinux.org/packages?branch=edge&name=lttng-ust-dev) - - [zlib](https://pkgs.alpinelinux.org/packages?branch=edge&name=zlib) - - [zlib-dev](https://pkgs.alpinelinux.org/packages?branch=edge&name=zlib-dev) diff --git a/docs/descriptors/csharp_csharpier.md b/docs/descriptors/csharp_csharpier.md index 1dd1d39e3f2..e61c4752da0 100644 --- a/docs/descriptors/csharp_csharpier.md +++ b/docs/descriptors/csharp_csharpier.md @@ -3,13 +3,13 @@ title: csharpier configuration in MegaLinter description: How to use csharpier (configure, ignore files, ignore errors, help & version documentations) to analyze CSHARP files --- - + #
csharpier
[](https://github.com/belav/csharpier)  [](https://github.com/belav/csharpier/releases) [](https://github.com/belav/csharpier/commits) [](https://github.com/belav/csharpier/graphs/commit-activity/) [](https://github.com/belav/csharpier/graphs/contributors/)
## csharpier documentation
-- Version in MegaLinter: **0.23.0**
+- Version in MegaLinter: **0.28.2**
- Visit [Official Web Site](https://csharpier.com/){target=_blank}
- See [How to configure csharpier rules](https://csharpier.com/docs/Configuration){target=_blank}
- See [How to ignore files and directories with csharpier](https://csharpier.com/docs/Ignore){target=_blank}
@@ -19,23 +19,28 @@ description: How to use csharpier (configure, ignore files, ignore errors, help
## Configuration in MegaLinter
-- Enable csharpier by adding `CSHARP_CSHARPIER` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable csharpier by adding `CSHARP_CSHARPIER` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-
-- Enable **auto-fixes** by adding `CSHARP_CSHARPIER` in [APPLY_FIXES variable](https://megalinter.io/6.22.2/configuration/#apply-fixes)
-
-| Variable | Description | Default value |
-|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
-| CSHARP_CSHARPIER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | -| CSHARP_CSHARPIER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| CSHARP_CSHARPIER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| CSHARP_CSHARPIER_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` | -| CSHARP_CSHARPIER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".cs"]` | -| CSHARP_CSHARPIER_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_CSHARPIER_PRE_COMMANDS | List of bash commands to run before the linter | None | -| CSHARP_CSHARPIER_POST_COMMANDS | List of bash commands to run after the linter | None | -| CSHARP_CSHARPIER_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | -| CSHARP_CSHARPIER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +- Enable csharpier by adding `CSHARP_CSHARPIER` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) +- Disable csharpier by adding `CSHARP_CSHARPIER` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) + +- Enable **autofixes** by adding `CSHARP_CSHARPIER` in [APPLY_FIXES variable](https://megalinter.io/7.13.0/configuration/#apply-fixes) + +| Variable | Description | Default value | +|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| +| CSHARP_CSHARPIER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| CSHARP_CSHARPIER_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
Ex: `-s --foo "bar"` | | +| CSHARP_CSHARPIER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| CSHARP_CSHARPIER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| CSHARP_CSHARPIER_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` | +| CSHARP_CSHARPIER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".cs"]` | +| CSHARP_CSHARPIER_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_CSHARPIER_PRE_COMMANDS | List of bash commands to run before the linter | None | +| CSHARP_CSHARPIER_POST_COMMANDS | List of bash commands to run after the linter | None | +| CSHARP_CSHARPIER_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CSHARP_CSHARPIER and its pre/post commands | None | +| CSHARP_CSHARPIER_CONFIG_FILE | csharpier configuration file nameUse `LINTER_DEFAULT` to let the linter find it | `.csharpierrc` | +| CSHARP_CSHARPIER_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| CSHARP_CSHARPIER_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| CSHARP_CSHARPIER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| CSHARP_CSHARPIER_CLI_EXECUTABLE | Override CLI executable | `['dotnet-csharpier']` | ## IDE Integration @@ -51,10 +56,12 @@ Use csharpier in your favorite IDE to catch errors before MegaLinter ! This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------|:----------------------------------------------|:----------------:|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [dotnet](https://megalinter.io/6.22.2/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 60 |   |
+| | Flavor | Description | Embedded linters | Info |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------|:---------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [dotnet](https://megalinter.io/7.13.0/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 63 |   |
+| | [dotnetweb](https://megalinter.io/7.13.0/flavors/dotnetweb/) | Optimized for C, C++, C# or VB based projects with JS/TS | 72 |   |
+| 
| [formatters](https://megalinter.io/7.13.0/flavors/formatters/) | Contains only formatters | 17 |   |
## Behind the scenes
@@ -92,11 +99,16 @@ Arguments:
Options:
--check Check that files are formatted. Will not write any changes.
+ --loglevel Specify the log level - Debug, Information (default), Warning, Error, None [default: Information]
--no-cache Bypass the cache to determine if a file needs to be formatted.
+ --no-msbuild-check Bypass the check to determine if a csproj files references a different version of CSharpier.MsBuild.
+ --include-generated Include files generated by the SDK and files that begin with Specify the port that CSharpier should start on. Defaults to a random unused port.
--config-path Path to the CSharpier configuration file
--version Show version information
-?, -h, --help Show help and usage information
@@ -108,12 +120,9 @@ Options:
- Dockerfile commands :
```dockerfile
# Parent descriptor install
-RUN wget --tries=5 -q -O dotnet-install.sh https://dot.net/v1/dotnet-install.sh \
- && chmod +x dotnet-install.sh \
- && ./dotnet-install.sh --install-dir /usr/share/dotnet -channel 6.0 -version latest
-
-ENV PATH="${PATH}:/root/.dotnet/tools:/usr/share/dotnet"
+RUN apk add --no-cache dotnet8-sdk
+ENV PATH="${PATH}:/root/.dotnet/tools"
# Linter install
-RUN /usr/share/dotnet/dotnet tool install -g csharpier
+RUN dotnet tool install --global csharpier
```
diff --git a/docs/descriptors/csharp_dotnet_format.md b/docs/descriptors/csharp_dotnet_format.md
index 3184cc28ddf..3795c73abce 100644
--- a/docs/descriptors/csharp_dotnet_format.md
+++ b/docs/descriptors/csharp_dotnet_format.md
@@ -3,7 +3,7 @@ title: dotnet-format configuration in MegaLinter
description: How to use dotnet-format (configure, ignore files, ignore errors, help & version documentations) to analyze CSHARP files
---
-
+
# 
dotnet-format
[](https://github.com/dotnet/format)  [](https://github.com/dotnet/format/releases) [](https://github.com/dotnet/format/commits) [](https://github.com/dotnet/format/graphs/commit-activity/) [](https://github.com/dotnet/format/graphs/contributors/)
@@ -11,21 +11,22 @@ dotnet-format requires a `.sln` or `.csproj` file to run correctly.
## dotnet-format documentation
-- Version in MegaLinter: **6.0.407**
+- Version in MegaLinter: **8.0.106**
- Visit [Official Web Site](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-format){target=_blank}
[](https://github.com/dotnet/format){target=_blank}
## Configuration in MegaLinter
-- Enable dotnet-format by adding `CSHARP_DOTNET_FORMAT` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable dotnet-format by adding `CSHARP_DOTNET_FORMAT` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable dotnet-format by adding `CSHARP_DOTNET_FORMAT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable dotnet-format by adding `CSHARP_DOTNET_FORMAT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
-- Enable **auto-fixes** by adding `CSHARP_DOTNET_FORMAT` in [APPLY_FIXES variable](https://megalinter.io/6.22.2/configuration/#apply-fixes)
+- Enable **autofixes** by adding `CSHARP_DOTNET_FORMAT` in [APPLY_FIXES variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `project`: Call the linter from the root of the project | `file` | @@ -33,17 +34,21 @@ dotnet-format requires a `.sln` or `.csproj` file to run correctly. | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CSHARP_DOTNET_FORMAT and its pre/post commands | 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` | +| CSHARP_DOTNET_FORMAT_CLI_EXECUTABLE | Override CLI executable | `['dotnet']` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------|:----------------------------------------------|:----------------:|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [dotnet](https://megalinter.io/6.22.2/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 60 |   |
+| | Flavor | Description | Embedded linters | Info |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------|:---------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [dotnet](https://megalinter.io/7.13.0/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 63 |   |
+| | [dotnetweb](https://megalinter.io/7.13.0/flavors/dotnetweb/) | Optimized for C, C++, C# or VB based projects with JS/TS | 72 |   |
+| | [formatters](https://megalinter.io/7.13.0/flavors/formatters/) | Contains only formatters | 17 |   |
## Behind the scenes
@@ -75,31 +80,31 @@ Description:
Formats code to match editorconfig settings.
Usage:
- dotnet-format [] [command] [options]
+ dotnet-format [] [command] [options]
Arguments:
- The project or solution file to operate on. If a file is not specified, the command will search the current directory for one. [default: /]
+ The project or solution file to operate on. If a file is not specified, the command will search the current directory for one. [default: /]
Options:
- --diagnostics A space separated list of diagnostic ids to use as a filter when fixing code style or 3rd party issues. []
- --exclude-diagnostics A space separated list of diagnostic ids to ignore when fixing code style or 3rd party issues. []
+ -?, -h, --help Show help and usage information
+ --version Show version information
+ --diagnostics A space separated list of diagnostic ids to use as a filter when fixing code style or 3rd party issues. []
+ --exclude-diagnostics A space separated list of diagnostic ids to ignore when fixing code style or 3rd party issues. []
--severity The severity of diagnostics to fix. Allowed values are info, warn, and error.
--no-restore Doesn't execute an implicit restore before formatting.
--verify-no-changes Verify no formatting changes would be performed. Terminates with a non-zero exit code if any files would have been formatted.
- --include A list of relative file or folder paths to include in formatting. All files are formatted if empty. []
- --exclude A list of relative file or folder paths to exclude from formatting. []
+ --include A list of relative file or folder paths to include in formatting. All files are formatted if empty. []
+ --exclude A list of relative file or folder paths to exclude from formatting. []
--include-generated Format files generated by the SDK.
-v, --verbosity Set the verbosity level. Allowed values are q[uiet], m[inimal], n[ormal], d[etailed], and diag[nostic]
--binarylog Log all project or solution load information to a binary log file.
--report Accepts a file path which if provided will produce a json report in the given directory.
- --version Show version information
- -?, -h, --help Show help and usage information
Commands:
- whitespace Run whitespace formatting. [default: /]
- style Run code style analyzers and apply fixes. [default: /]
- analyzers Run 3rd party analyzers and apply fixes. [default: /]
+ whitespace Run whitespace formatting. [default: /]
+ style Run code style analyzers and apply fixes. [default: /]
+ analyzers Run 3rd party analyzers and apply fixes. [default: /]
```
diff --git a/docs/descriptors/csharp_roslynator.md b/docs/descriptors/csharp_roslynator.md
new file mode 100644
index 00000000000..9e6ab5e1f41
--- /dev/null
+++ b/docs/descriptors/csharp_roslynator.md
@@ -0,0 +1,119 @@
+---
+title: roslynator configuration in MegaLinter
+description: How to use roslynator (configure, ignore files, ignore errors, help & version documentations) to analyze CSHARP files
+---
+
+
+# 
roslynator
+[](https://github.com/dotnet/Roslynator)  [](https://github.com/dotnet/Roslynator/releases) [](https://github.com/dotnet/Roslynator/commits) [](https://github.com/dotnet/Roslynator/graphs/commit-activity/) [](https://github.com/dotnet/Roslynator/graphs/contributors/)
+
+## roslynator documentation
+
+- Version in MegaLinter: **0.8.9.0**
+- Visit [Official Web Site](https://github.com/dotnet/Roslynator#readme){target=_blank}
+- See [How to configure roslynator rules](https://josefpihrt.github.io/docs/roslynator/configuration){target=_blank}
+- See [How to disable roslynator rules in files](https://josefpihrt.github.io/docs/roslynator/how-to-suppress-diagnostic){target=_blank}
+- See [Index of problems detected by roslynator](https://josefpihrt.github.io/docs/roslynator/analyzers){target=_blank}
+
+[](https://github.com/dotnet/Roslynator){target=_blank}
+
+## Configuration in MegaLinter
+
+- Enable roslynator by adding `CSHARP_ROSLYNATOR` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable roslynator by adding `CSHARP_ROSLYNATOR` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+
+- Enable **autofixes** by adding `CSHARP_ROSLYNATOR` in [APPLY_FIXES variable](https://megalinter.io/7.13.0/configuration/#apply-fixes)
+
+| Variable | Description | Default value |
+|-----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
+| CSHARP_ROSLYNATOR_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| CSHARP_ROSLYNATOR_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
Ex: `-s --foo "bar"` | | +| CSHARP_ROSLYNATOR_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| CSHARP_ROSLYNATOR_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| CSHARP_ROSLYNATOR_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `project`: Call the linter from the root of the project | `file` | +| CSHARP_ROSLYNATOR_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".csproj"]` | +| CSHARP_ROSLYNATOR_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_ROSLYNATOR_PRE_COMMANDS | List of bash commands to run before the linter | None | +| CSHARP_ROSLYNATOR_POST_COMMANDS | List of bash commands to run after the linter | None | +| CSHARP_ROSLYNATOR_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CSHARP_ROSLYNATOR and its pre/post commands | None | +| CSHARP_ROSLYNATOR_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| CSHARP_ROSLYNATOR_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| CSHARP_ROSLYNATOR_CLI_EXECUTABLE | Override CLI executable | `['roslynator']` | + +## IDE Integration + +Use roslynator in your favorite IDE to catch errors before MegaLinter ! + +| | IDE | Extension Name | Install | +|:--------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|--------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +|
| visual_studio | [Roslynator 2022](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2022) | [Visit Web Site](https://marketplace.visualstudio.com/items?itemName=josefpihrt.Roslynator2022){target=_blank} |
+| | [Visual Studio Code](https://code.visualstudio.com/) | [Roslynator](https://marketplace.visualstudio.com/items?itemName=josefpihrt-vscode.roslynator) | [](vscode:extension/josefpihrt-vscode.roslynator){target=_blank} |
+
+## MegaLinter Flavours
+
+This linter is available in the following flavours
+
+| | Flavor | Description | Embedded linters | Info |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------|:---------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [dotnet](https://megalinter.io/7.13.0/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 63 |   |
+| | [dotnetweb](https://megalinter.io/7.13.0/flavors/dotnetweb/) | Optimized for C, C++, C# or VB based projects with JS/TS | 72 |   |
+| | [formatters](https://megalinter.io/7.13.0/flavors/formatters/) | Contains only formatters | 17 |   |
+
+## Behind the scenes
+
+### How are identified applicable files
+
+- File extensions: `.csproj`
+
+
+
+### How the linting is performed
+
+- roslynator is called one time by identified file (`file` CLI lint mode)
+
+### Example calls
+
+```shell
+roslynator analyze myproject.csproj
+```
+
+```shell
+roslynator fix myproject.csproj
+```
+
+
+### Help content
+
+```shell
+Roslynator Command Line Tool version 0.8.9.0 (Roslyn version 4.9.0.0)
+Usage: roslynator [command] [arguments]
+
+Commands:
+ analyze Analyzes specified project or solution and reports diagnostics.
+ find-symbol Finds symbols in the specified project or solution.
+ fix Fixes diagnostics in the specified project or solution.
+ format Formats whitespace in the specified project or solution.
+ generate-doc Generates reference documentation from specified project/solution.
+ generate-doc-root [deprecated] Generates root documentation file from specified project/solution.
+ list-symbols Lists symbols from the specified project or solution.
+ lloc Counts logical lines of code in the specified project or solution.
+ loc Counts physical lines of code in the specified project or solution.
+ migrate Migrates analyzers to a new version.
+ rename-symbol Rename symbols in the specified project or solution.
+ spellcheck Searches the specified project or solution for possible misspellings or typos.
+
+Run 'roslynator help [command]' for more information on a command.
+```
+
+### Installation on mega-linter Docker image
+
+- Dockerfile commands :
+```dockerfile
+# Parent descriptor install
+RUN apk add --no-cache dotnet8-sdk
+ENV PATH="${PATH}:/root/.dotnet/tools"
+# Linter install
+RUN dotnet tool install -g roslynator.dotnet.cli
+```
+
diff --git a/docs/descriptors/css.md b/docs/descriptors/css.md
index d03d19e616c..63a6395eb53 100644
--- a/docs/descriptors/css.md
+++ b/docs/descriptors/css.md
@@ -3,7 +3,7 @@ title: CSS linters in MegaLinter
description: stylelint, scss-lint are available to analyze CSS files in MegaLinter
---
-
+
# CSS
@@ -12,7 +12,7 @@ description: stylelint, scss-lint are available to analyze CSS files in MegaLint
| Linter | Additional |
|---------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [**stylelint**](css_stylelint.md)
[_CSS_STYLELINT_](css_stylelint.md) | [](https://github.com/stylelint/stylelint)  | -| [**scss-lint**](css_scss_lint.md)
[_CSS_SCSS_LINT_](css_scss_lint.md) | [](https://github.com/sds/scss-lint) | +| [**scss-lint**](css_scss_lint.md)
[_CSS_SCSS_LINT_](css_scss_lint.md) |  [](https://github.com/sds/scss-lint) | ## Linted files @@ -23,8 +23,10 @@ description: stylelint, scss-lint are available to analyze CSS files in MegaLint ## 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_PRE_COMMANDS | List of bash commands to run before the linters | None | +| CSS_POST_COMMANDS | List of bash commands to run after the linters | None | +| 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 2377a21eafc..e7fb793c743 100644 --- a/docs/descriptors/css_scss_lint.md +++ b/docs/descriptors/css_scss_lint.md @@ -3,7 +3,7 @@ title: scss-lint configuration in MegaLinter description: How to use scss-lint (configure, ignore files, ignore errors, help & version documentations) to analyze CSS files --- - + -[](https://github.com/sds/scss-lint) [](https://github.com/sds/scss-lint/releases) [](https://github.com/sds/scss-lint/commits) [](https://github.com/sds/scss-lint/graphs/commit-activity/) [](https://github.com/sds/scss-lint/graphs/contributors/) + [](https://github.com/sds/scss-lint) [](https://github.com/sds/scss-lint/releases) [](https://github.com/sds/scss-lint/commits) [](https://github.com/sds/scss-lint/graphs/commit-activity/) [](https://github.com/sds/scss-lint/graphs/contributors/) + +> This linter has been deprecated. +> +> https://github.com/sds/scss-lint#notice-consider-other-tools-before-adopting-scss-lint +> +> You should disable scss-lint by adding it in DISABLE_LINTERS property. +> +> It will be maintained at least until the next major release. ## scss-lint documentation @@ -24,12 +32,13 @@ description: How to use scss-lint (configure, ignore files, ignore errors, help ## Configuration in MegaLinter -- Enable scss-lint by adding `CSS_SCSS_LINT` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation) -- Disable scss-lint by adding `CSS_SCSS_LINT` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation) +- Enable scss-lint by adding `CSS_SCSS_LINT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) +- Disable scss-lint by adding `CSS_SCSS_LINT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `project`: Call the linter from the root of the project | `file` | @@ -37,10 +46,12 @@ description: How to use scss-lint (configure, ignore files, ignore errors, help | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CSS_SCSS_LINT and its pre/post commands | None | | CSS_SCSS_LINT_CONFIG_FILE | scss-lint configuration file nameUse `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` | +| CSS_SCSS_LINT_CLI_EXECUTABLE | Override CLI executable | `['scss-lint']` | ## IDE Integration @@ -56,22 +67,24 @@ Use scss-lint in your favorite IDE to catch errors before MegaLinter ! This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [cupcake](https://megalinter.io/6.22.2/flavors/cupcake/) | MegaLinter for the most commonly used languages | 82 |   |
-| | [documentation](https://megalinter.io/6.22.2/flavors/documentation/) | MegaLinter for documentation projects | 48 |   |
-| | [dotnet](https://megalinter.io/6.22.2/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 60 |   |
-| | [go](https://megalinter.io/6.22.2/flavors/go/) | Optimized for GO based projects | 50 |   |
-| | [java](https://megalinter.io/6.22.2/flavors/java/) | Optimized for JAVA based projects | 51 |   |
-| | [javascript](https://megalinter.io/6.22.2/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 57 |   |
-| | [php](https://megalinter.io/6.22.2/flavors/php/) | Optimized for PHP based projects | 51 |   |
-| | [python](https://megalinter.io/6.22.2/flavors/python/) | Optimized for PYTHON based projects | 59 |   |
-| | [ruby](https://megalinter.io/6.22.2/flavors/ruby/) | Optimized for RUBY based projects | 48 |   |
-| | [rust](https://megalinter.io/6.22.2/flavors/rust/) | Optimized for RUST based projects | 48 |   |
-| | [salesforce](https://megalinter.io/6.22.2/flavors/salesforce/) | Optimized for Salesforce based projects | 51 |   |
-| | [swift](https://megalinter.io/6.22.2/flavors/swift/) | Optimized for SWIFT based projects | 48 |   |
-| | [terraform](https://megalinter.io/6.22.2/flavors/terraform/) | Optimized for TERRAFORM based projects | 53 |   |
+| | Flavor | Description | Embedded linters | Info |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:---------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [c_cpp](https://megalinter.io/7.13.0/flavors/c_cpp/) | Optimized for pure C/C++ projects | 56 |   |
+| | [cupcake](https://megalinter.io/7.13.0/flavors/cupcake/) | MegaLinter for the most commonly used languages | 84 |   |
+| | [documentation](https://megalinter.io/7.13.0/flavors/documentation/) | MegaLinter for documentation projects | 51 |   |
+| | [dotnet](https://megalinter.io/7.13.0/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 63 |   |
+| | [dotnetweb](https://megalinter.io/7.13.0/flavors/dotnetweb/) | Optimized for C, C++, C# or VB based projects with JS/TS | 72 |   |
+| | [go](https://megalinter.io/7.13.0/flavors/go/) | Optimized for GO based projects | 53 |   |
+| | [java](https://megalinter.io/7.13.0/flavors/java/) | Optimized for JAVA based projects | 54 |   |
+| | [javascript](https://megalinter.io/7.13.0/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 61 |   |
+| | [php](https://megalinter.io/7.13.0/flavors/php/) | Optimized for PHP based projects | 56 |   |
+| | [python](https://megalinter.io/7.13.0/flavors/python/) | Optimized for PYTHON based projects | 64 |   |
+| | [ruby](https://megalinter.io/7.13.0/flavors/ruby/) | Optimized for RUBY based projects | 52 |   |
+| | [rust](https://megalinter.io/7.13.0/flavors/rust/) | Optimized for RUST based projects | 52 |   |
+| | [salesforce](https://megalinter.io/7.13.0/flavors/salesforce/) | Optimized for Salesforce based projects | 56 |   |
+| | [swift](https://megalinter.io/7.13.0/flavors/swift/) | Optimized for SWIFT based projects | 52 |   |
+| | [terraform](https://megalinter.io/7.13.0/flavors/terraform/) | Optimized for TERRAFORM based projects | 56 |   |
## Behind the scenes
diff --git a/docs/descriptors/css_stylelint.md b/docs/descriptors/css_stylelint.md
index 6e2906cf408..8f8134ad4ed 100644
--- a/docs/descriptors/css_stylelint.md
+++ b/docs/descriptors/css_stylelint.md
@@ -3,11 +3,11 @@ title: stylelint configuration in MegaLinter
description: How to use stylelint (configure, ignore files, ignore errors, help & version documentations) to analyze CSS files
---
-
+
@@ -15,10 +15,10 @@ description: How to use stylelint (configure, ignore files, ignore errors, help
## stylelint documentation
-- Version in MegaLinter: **15.4.0**
+- Version in MegaLinter: **16.6.1**
- Visit [Official Web Site](https://stylelint.io){target=_blank}
- See [How to configure stylelint rules](https://stylelint.io/user-guide/configure){target=_blank}
- - If custom `.stylelintrc.json` config file is not found, [.stylelintrc.json](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.stylelintrc.json){target=_blank} will be used
+ - If custom `.stylelintrc.json` config file isn't found, [.stylelintrc.json](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.stylelintrc.json){target=_blank} will be used
- See [How to disable stylelint rules in files](https://stylelint.io/user-guide/ignore-code){target=_blank}
- See [Index of problems detected by stylelint](https://stylelint.io/user-guide/rules/list){target=_blank}
@@ -26,14 +26,15 @@ description: How to use stylelint (configure, ignore files, ignore errors, help
## Configuration in MegaLinter
-- Enable stylelint by adding `CSS_STYLELINT` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable stylelint by adding `CSS_STYLELINT` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable stylelint by adding `CSS_STYLELINT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable stylelint by adding `CSS_STYLELINT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
-- Enable **auto-fixes** by adding `CSS_STYLELINT` in [APPLY_FIXES variable](https://megalinter.io/6.22.2/configuration/#apply-fixes)
+- Enable **autofixes** by adding `CSS_STYLELINT` in [APPLY_FIXES variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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` | @@ -41,10 +42,12 @@ description: How to use stylelint (configure, ignore files, ignore errors, help | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CSS_STYLELINT and its pre/post commands | None | | CSS_STYLELINT_CONFIG_FILE | stylelint configuration file nameUse `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` | +| CSS_STYLELINT_CLI_EXECUTABLE | Override CLI executable | `['stylelint']` | ## IDE Integration @@ -63,22 +66,24 @@ Use stylelint in your favorite IDE to catch errors before MegaLinter ! This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [cupcake](https://megalinter.io/6.22.2/flavors/cupcake/) | MegaLinter for the most commonly used languages | 82 |   |
-| | [documentation](https://megalinter.io/6.22.2/flavors/documentation/) | MegaLinter for documentation projects | 48 |   |
-| | [dotnet](https://megalinter.io/6.22.2/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 60 |   |
-| | [go](https://megalinter.io/6.22.2/flavors/go/) | Optimized for GO based projects | 50 |   |
-| | [java](https://megalinter.io/6.22.2/flavors/java/) | Optimized for JAVA based projects | 51 |   |
-| | [javascript](https://megalinter.io/6.22.2/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 57 |   |
-| | [php](https://megalinter.io/6.22.2/flavors/php/) | Optimized for PHP based projects | 51 |   |
-| | [python](https://megalinter.io/6.22.2/flavors/python/) | Optimized for PYTHON based projects | 59 |   |
-| | [ruby](https://megalinter.io/6.22.2/flavors/ruby/) | Optimized for RUBY based projects | 48 |   |
-| | [rust](https://megalinter.io/6.22.2/flavors/rust/) | Optimized for RUST based projects | 48 |   |
-| | [salesforce](https://megalinter.io/6.22.2/flavors/salesforce/) | Optimized for Salesforce based projects | 51 |   |
-| | [swift](https://megalinter.io/6.22.2/flavors/swift/) | Optimized for SWIFT based projects | 48 |   |
-| | [terraform](https://megalinter.io/6.22.2/flavors/terraform/) | Optimized for TERRAFORM based projects | 53 |   |
+| | Flavor | Description | Embedded linters | Info |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:---------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [c_cpp](https://megalinter.io/7.13.0/flavors/c_cpp/) | Optimized for pure C/C++ projects | 56 |   |
+| | [cupcake](https://megalinter.io/7.13.0/flavors/cupcake/) | MegaLinter for the most commonly used languages | 84 |   |
+| | [documentation](https://megalinter.io/7.13.0/flavors/documentation/) | MegaLinter for documentation projects | 51 |   |
+| | [dotnet](https://megalinter.io/7.13.0/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 63 |   |
+| | [dotnetweb](https://megalinter.io/7.13.0/flavors/dotnetweb/) | Optimized for C, C++, C# or VB based projects with JS/TS | 72 |   |
+| | [go](https://megalinter.io/7.13.0/flavors/go/) | Optimized for GO based projects | 53 |   |
+| | [java](https://megalinter.io/7.13.0/flavors/java/) | Optimized for JAVA based projects | 54 |   |
+| | [javascript](https://megalinter.io/7.13.0/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 61 |   |
+| | [php](https://megalinter.io/7.13.0/flavors/php/) | Optimized for PHP based projects | 56 |   |
+| | [python](https://megalinter.io/7.13.0/flavors/python/) | Optimized for PYTHON based projects | 64 |   |
+| | [ruby](https://megalinter.io/7.13.0/flavors/ruby/) | Optimized for RUBY based projects | 52 |   |
+| | [rust](https://megalinter.io/7.13.0/flavors/rust/) | Optimized for RUST based projects | 52 |   |
+| | [salesforce](https://megalinter.io/7.13.0/flavors/salesforce/) | Optimized for Salesforce based projects | 56 |   |
+| | [swift](https://megalinter.io/7.13.0/flavors/swift/) | Optimized for SWIFT based projects | 52 |   |
+| | [terraform](https://megalinter.io/7.13.0/flavors/terraform/) | Optimized for TERRAFORM based projects | 56 |   |
## Behind the scenes
@@ -118,25 +123,27 @@ stylelint --fix --config .stylelintrc.json myfile.css myfile2.css myfile3.css
Input: Files(s), glob(s), or nothing to use stdin.
If an input argument is wrapped in quotation marks, it will be passed to
- globby for cross-platform glob support. node_modules are always ignored.
+ globby for cross-platform glob support. "node_modules" are always ignored.
You can also pass no input and use stdin, instead.
Options:
- --config, -c
+ --config, -c
+
+ A path to a specific configuration file (JSON, YAML, CommonJS, or ES module),
+ or a module name in "node_modules" that points to one. If no argument is
+ provided, Stylelint will search for configuration files in the following
+ places, in this order:
+
+ - a "stylelint" property in "package.json"
+ - a ".stylelintrc" file
+ - a ".stylelintrc.{cjs,mjs,js,json,yaml,yml}" file
+ - a "stylelint.config.{cjs,mjs,js}" file
- Path to a specific configuration file (JSON, YAML, or CommonJS), or the
- name of a module in node_modules that points to one. If no --config
- argument is provided, stylelint will search for configuration files in
- the following places, in this order:
- - a stylelint property in package.json
- - a .stylelintrc file (with or without filename extension:
- .json, .yaml, .yml, and .js are available)
- - a stylelint.config.js file exporting a JS object
The search will begin in the working directory and move up the directory
tree until a configuration file is found.
- --config-basedir
+ --config-basedir
An absolute path to the directory that relative paths defining "extends",
"plugins", and "customSyntax" are *relative to*. Only necessary if these
@@ -144,77 +151,88 @@ stylelint --fix --config .stylelintrc.json myfile.css myfile2.css myfile3.css
--print-config
- Print the configuration for the given path.
+ Print the configuration for the given input file path. Globs are unsupported.
- --ignore-path, -i
+ --ignore-path, -i
- Path to a file containing patterns that describe files to ignore. The
- path can be absolute or relative to process.cwd(). You can repeat the
+ A path to a file containing patterns that describe files to ignore. The
+ path can be absolute or relative to "process.cwd()". You can repeat the
option to provide multiple paths. By default, Stylelint looks for
- .stylelintignore in process.cwd().
+ ".stylelintignore" in "process.cwd()". Multiple can be set.
- --ignore-pattern, --ip
+ --ignore-pattern, --ip
- Pattern of files to ignore (in addition to those in .stylelintignore)
+ A pattern of files to ignore (in addition to those in ".stylelintignore").
+ Multiple can be set.
--fix
Automatically fix problems of certain rules.
- --custom-syntax
+ --custom-syntax
- Module name or path to a JS file exporting a PostCSS-compatible syntax.
+ A module name or path to a JS file exporting a PostCSS-compatible syntax.
--stdin
Accept stdin input even if it is empty.
- --stdin-filename
+ --stdin-filename
A filename to assign stdin input.
--ignore-disables, --id
- Ignore stylelint-disable comments.
+ Ignore "stylelint-disable" comments.
--disable-default-ignores, --di
- Allow linting of node_modules.
+ Allow linting of "node_modules".
- --cache [default: false]
+ --[no-]cache
Store the info about processed files in order to only operate on the
- changed ones the next time you run stylelint. By default, the cache
- is stored in "./.stylelintcache". To adjust this, use --cache-location.
+ changed ones the next time you run Stylelint. By default, the cache is
+ stored in "./.stylelintcache". To adjust this, use "--cache-location".
+ Cache is disabled by default.
- --cache-location [default: '.stylelintcache']
+ --cache-location
- Path to a file or directory to be used for the cache location.
- Default is "./.stylelintcache". If a directory is specified, a cache
- file will be created inside the specified folder, with a name derived
- from a hash of the current working directory.
+ A path to a file or directory to be used for the cache location. If a
+ directory is specified, a cache file will be created inside the specified
+ folder, with a name derived from a hash of the current working directory.
If the directory for the cache does not exist, make sure you add a trailing "/"
- on *nix systems or "\" on Windows. Otherwise the path will be assumed to be a file.
+ on *nix systems or "\" on Windows. Otherwise the path will be assumed to
+ be a file.
+
+ --cache-strategy
- --cache-strategy [default: "metadata"]
+ A strategy for the cache to use for detecting changed files. Either one of:
- Strategy for the cache to use for detecting changed files. Can be either
- "metadata" or "content".
+ metadata by metadata of a file (default)
+ content by content of a file
- The "content" strategy can be useful in cases where the modification time of
- your files changes even if their contents have not. For example, this can happen
- during git operations like "git clone" because git does not track file modification
- time.
+ The "content" strategy can be useful in cases where the modification time
+ of your files changes even if their contents have not. For example, this can
+ happen during git operations like "git clone" because git does not track file
+ modification time.
- --formatter, -f [default: "string"]
+ --formatter, -f
- The output formatter: "compact", "github", "json", "string", "tap", "unix" or "verbose".
+ An output formatter. The variants are as follows:
- --custom-formatter
+ string human-readable strings (default)
+ compact similar to ESLint's compact formatter
+ github workflow commands for GitHub Actions
+ json JSON format
+ tap TAP format
+ unix C compiler-like format
+ verbose extend "string" to include a file list and a tally
- Path to a JS file exporting a custom formatting function.
- The file can either be a filesystem path, a module name, or a file to load from a dependency.
+ --custom-formatter
+
+ A path to a JS file or module name exporting a custom formatting function.
--quiet, -q
@@ -225,48 +243,52 @@ stylelint --fix --config .stylelintrc.json myfile.css myfile2.css myfile3.css
Ignore deprecations warnings.
- --color
- --no-color
+ --[no-]color
Force enabling/disabling of color.
--report-needless-disables, --rd
- Also report errors for stylelint-disable comments that are not blocking a lint warning.
- The process will exit with code 2 if needless disables are found.
+ Also report errors for "stylelint-disable" comments that are not blocking
+ a lint warning. The process will exit with code 2 if needless disables are found.
--report-invalid-scope-disables, --risd
- Report stylelint-disable comments that used for rules that don't exist within the configuration object.
- The process will exit with code 2 if invalid scope disables are found.
+ Report "stylelint-disable" comments that used for rules that don't exist
+ within the configuration object. The process will exit with code 2 if invalid
+ scope disables are found.
--report-descriptionless-disables, --rdd
- Report stylelint-disable comments without a description.
- The process will exit with code 2 if descriptionless disables are found.
-
- --max-warnings, --mw
-
- Number of warnings above which the process will exit with code 2.
- Useful when setting "defaultSeverity" to "warning" and expecting the
- process to fail on warnings (e.g. CI build).
+ Report "stylelint-disable" comments without a description. The process will
+ exit with code 2 if descriptionless disables are found.
- --output-file, -o
+ --max-warnings, --mw
- Path of file to write report.
+ The number of warnings above which the process will exit with code 2.
+ Useful when setting "defaultSeverity" to "warning" and expecting the process
+ to fail on warnings (e.g. CI build).
- --version, -v
+ --output-file, -o
- Show the currently installed version of stylelint.
+ A file path to write a report.
--allow-empty-input, --aei
- When glob pattern matches no files, the process will exit without throwing an error.
+ When a glob pattern matches no files, the process will exit without throwing an error.
- --globby-options, --go
+ --globby-options, --go
Options in JSON format passed to globby.
+ --version, -v
+
+ Show the version.
+
+ --help, -h
+
+ Show the help.
+
```
### Installation on mega-linter Docker image
diff --git a/docs/descriptors/dart.md b/docs/descriptors/dart.md
index f7f3eee69dc..d186bdacb57 100644
--- a/docs/descriptors/dart.md
+++ b/docs/descriptors/dart.md
@@ -3,7 +3,7 @@ title: DART linters in MegaLinter
description: dartanalyzer is available to analyze DART files in MegaLinter
---
-
+
# DART
@@ -20,8 +20,60 @@ description: dartanalyzer is available to analyze DART files in MegaLinter
## 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_PRE_COMMANDS | List of bash commands to run before the linters | None |
+| DART_POST_COMMANDS | List of bash commands to run after the linters | None |
+| DART_FILTER_REGEX_INCLUDE | Custom regex including filter | |
+| DART_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | |
+
+
+## Behind the scenes
+
+### Installation
+
+- Dockerfile commands :
+```dockerfile
+ENV LANG=C.UTF-8
+RUN ALPINE_GLIBC_BASE_URL="https://github.com/sgerrand/alpine-pkg-glibc/releases/download" && \
+ ALPINE_GLIBC_PACKAGE_VERSION="2.34-r0" && \
+ ALPINE_GLIBC_BASE_PACKAGE_FILENAME="glibc-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
+ ALPINE_GLIBC_BIN_PACKAGE_FILENAME="glibc-bin-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
+ ALPINE_GLIBC_I18N_PACKAGE_FILENAME="glibc-i18n-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
+ apk add --no-cache --virtual=.build-dependencies wget ca-certificates && \
+ echo \
+ "-----BEGIN PUBLIC KEY-----\
+ MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApZ2u1KJKUu/fW4A25y9m\
+ y70AGEa/J3Wi5ibNVGNn1gT1r0VfgeWd0pUybS4UmcHdiNzxJPgoWQhV2SSW1JYu\
+ tOqKZF5QSN6X937PTUpNBjUvLtTQ1ve1fp39uf/lEXPpFpOPL88LKnDBgbh7wkCp\
+ m2KzLVGChf83MS0ShL6G9EQIAUxLm99VpgRjwqTQ/KfzGtpke1wqws4au0Ab4qPY\
+ KXvMLSPLUp7cfulWvhmZSegr5AdhNw5KNizPqCJT8ZrGvgHypXyiFvvAH5YRtSsc\
+ Zvo9GI2e2MaZyo9/lvb+LbLEJZKEQckqRj4P26gmASrZEPStwc+yqy1ShHLA0j6m\
+ 1QIDAQAB\
+ -----END PUBLIC KEY-----" | sed 's/ */\\n/g' > "/etc/apk/keys/sgerrand.rsa.pub" && \
+ wget --quiet --tries=10 --waitretry=10 \
+ "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_I18N_PACKAGE_FILENAME" && \
+ mv /etc/nsswitch.conf /etc/nsswitch.conf.bak && \
+ apk add --no-cache --force-overwrite \
+ "$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_I18N_PACKAGE_FILENAME" && \
+ \
+ mv /etc/nsswitch.conf.bak /etc/nsswitch.conf && \
+ rm "/etc/apk/keys/sgerrand.rsa.pub" && \
+ (/usr/glibc-compat/bin/localedef --force --inputfile POSIX --charmap UTF-8 "$LANG" || true) && \
+ echo "export LANG=$LANG" > /etc/profile.d/locale.sh && \
+ \
+ apk del glibc-i18n && \
+ \
+ rm "/root/.wget-hsts" && \
+ apk del .build-dependencies && \
+ rm \
+ "$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_I18N_PACKAGE_FILENAME"
+
+```
diff --git a/docs/descriptors/dart_dartanalyzer.md b/docs/descriptors/dart_dartanalyzer.md
index 52a8a346ad0..3410f577b1b 100644
--- a/docs/descriptors/dart_dartanalyzer.md
+++ b/docs/descriptors/dart_dartanalyzer.md
@@ -3,33 +3,28 @@ title: dartanalyzer configuration in MegaLinter
description: How to use dartanalyzer (configure, ignore files, ignore errors, help & version documentations) to analyze DART files
---
-
-
-
dartanalyzer
 [](https://github.com/dart-lang/sdk) [](https://github.com/dart-lang/sdk/releases) [](https://github.com/dart-lang/sdk/commits) [](https://github.com/dart-lang/sdk/graphs/commit-activity/) [](https://github.com/dart-lang/sdk/graphs/contributors/)
## dartanalyzer documentation
- Visit [Official Web Site](https://github.com/dart-lang/sdk/tree/master/pkg/analyzer_cli#readme){target=_blank}
- See [How to configure dartanalyzer rules](https://dart.dev/guides/language/analysis-options#the-analysis-options-file){target=_blank}
- - If custom `analysis_options.yml` config file is not found, [analysis_options.yml](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/analysis_options.yml){target=_blank} will be used
+ - If custom `analysis_options.yml` config file isn't found, [analysis_options.yml](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/analysis_options.yml){target=_blank} will be used
- See [How to disable dartanalyzer rules in files](https://dart.dev/guides/language/analysis-options#suppressing-rules-for-a-file){target=_blank}
[](https://github.com/dart-lang/sdk){target=_blank}
## Configuration in MegaLinter
-- Enable dartanalyzer by adding `DART_DARTANALYZER` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable dartanalyzer by adding `DART_DARTANALYZER` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable dartanalyzer by adding `DART_DARTANALYZER` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable dartanalyzer by adding `DART_DARTANALYZER` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `project`: Call the linter from the root of the project | `file` | @@ -37,10 +32,12 @@ description: How to use dartanalyzer (configure, ignore files, ignore errors, he | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling DART_DARTANALYZER and its pre/post commands | None | | DART_DARTANALYZER_CONFIG_FILE | dartanalyzer configuration file nameUse `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` | +| DART_DARTANALYZER_CLI_EXECUTABLE | Override CLI executable | `['dartanalyzer']` | ## IDE Integration @@ -57,7 +54,7 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------|:--------------------------|:----------------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
## Behind the scenes
@@ -116,12 +113,51 @@ For more information, see https://www.dartlang.org/tools/analyzer.
- Dockerfile commands :
```dockerfile
+# Parent descriptor install
+ENV LANG=C.UTF-8
+RUN ALPINE_GLIBC_BASE_URL="https://github.com/sgerrand/alpine-pkg-glibc/releases/download" && \
+ ALPINE_GLIBC_PACKAGE_VERSION="2.34-r0" && \
+ ALPINE_GLIBC_BASE_PACKAGE_FILENAME="glibc-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
+ ALPINE_GLIBC_BIN_PACKAGE_FILENAME="glibc-bin-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
+ ALPINE_GLIBC_I18N_PACKAGE_FILENAME="glibc-i18n-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
+ apk add --no-cache --virtual=.build-dependencies wget ca-certificates && \
+ echo \
+ "-----BEGIN PUBLIC KEY-----\
+ MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApZ2u1KJKUu/fW4A25y9m\
+ y70AGEa/J3Wi5ibNVGNn1gT1r0VfgeWd0pUybS4UmcHdiNzxJPgoWQhV2SSW1JYu\
+ tOqKZF5QSN6X937PTUpNBjUvLtTQ1ve1fp39uf/lEXPpFpOPL88LKnDBgbh7wkCp\
+ m2KzLVGChf83MS0ShL6G9EQIAUxLm99VpgRjwqTQ/KfzGtpke1wqws4au0Ab4qPY\
+ KXvMLSPLUp7cfulWvhmZSegr5AdhNw5KNizPqCJT8ZrGvgHypXyiFvvAH5YRtSsc\
+ Zvo9GI2e2MaZyo9/lvb+LbLEJZKEQckqRj4P26gmASrZEPStwc+yqy1ShHLA0j6m\
+ 1QIDAQAB\
+ -----END PUBLIC KEY-----" | sed 's/ */\\n/g' > "/etc/apk/keys/sgerrand.rsa.pub" && \
+ wget --quiet --tries=10 --waitretry=10 \
+ "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_I18N_PACKAGE_FILENAME" && \
+ mv /etc/nsswitch.conf /etc/nsswitch.conf.bak && \
+ apk add --no-cache --force-overwrite \
+ "$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_I18N_PACKAGE_FILENAME" && \
+ \
+ mv /etc/nsswitch.conf.bak /etc/nsswitch.conf && \
+ rm "/etc/apk/keys/sgerrand.rsa.pub" && \
+ (/usr/glibc-compat/bin/localedef --force --inputfile POSIX --charmap UTF-8 "$LANG" || true) && \
+ echo "export LANG=$LANG" > /etc/profile.d/locale.sh && \
+ \
+ apk del glibc-i18n && \
+ \
+ rm "/root/.wget-hsts" && \
+ apk del .build-dependencies && \
+ rm \
+ "$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_I18N_PACKAGE_FILENAME"
+
+# Linter install
ARG DART_VERSION='2.8.4'
-ARG GLIBC_VERSION='2.34-r0'
-RUN wget --tries=50 -q -O /etc/apk/keys/sgerrand.rsa.pub https://alpine-pkgs.sgerrand.com/sgerrand.rsa.pub \
- && wget --tries=5 -q https://github.com/sgerrand/alpine-pkg-glibc/releases/download/${GLIBC_VERSION}/glibc-${GLIBC_VERSION}.apk \
- && apk add --force-overwrite --no-cache glibc-${GLIBC_VERSION}.apk && rm glibc-${GLIBC_VERSION}.apk \
- && wget --tries=5 https://storage.googleapis.com/dart-archive/channels/stable/release/${DART_VERSION}/sdk/dartsdk-linux-x64-release.zip -O - -q | unzip -q - \
+RUN wget --tries=5 https://storage.googleapis.com/dart-archive/channels/stable/release/${DART_VERSION}/sdk/dartsdk-linux-x64-release.zip -O - -q | unzip -q - \
&& chmod +x dart-sdk/bin/dart* \
&& mv dart-sdk/bin/* /usr/bin/ && mv dart-sdk/lib/* /usr/lib/ && mv dart-sdk/include/* /usr/include/ \
&& rm -r dart-sdk/
diff --git a/docs/descriptors/dockerfile.md b/docs/descriptors/dockerfile.md
index fc068506838..68958f90e24 100644
--- a/docs/descriptors/dockerfile.md
+++ b/docs/descriptors/dockerfile.md
@@ -3,7 +3,7 @@ title: DOCKERFILE linters in MegaLinter
description: hadolint is available to analyze DOCKERFILE files in MegaLinter
---
-
+
# DOCKERFILE
@@ -16,12 +16,15 @@ description: hadolint is available to analyze DOCKERFILE files in MegaLinter
## Linted files
- File names:
+ - `Containerfile`
- `Dockerfile`
## 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_PRE_COMMANDS | List of bash commands to run before the linters | None |
+| DOCKERFILE_POST_COMMANDS | List of bash commands to run after the linters | None |
+| 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 7a2ee7f3081..6c765a4dbfb 100644
--- a/docs/descriptors/dockerfile_hadolint.md
+++ b/docs/descriptors/dockerfile_hadolint.md
@@ -3,7 +3,7 @@ title: hadolint configuration in MegaLinter
description: How to use hadolint (configure, ignore files, ignore errors, help & version documentations) to analyze DOCKERFILE files
---
-
+
# 
hadolint
[](https://github.com/hadolint/hadolint)  [](https://github.com/hadolint/hadolint/releases) [](https://github.com/hadolint/hadolint/commits) [](https://github.com/hadolint/hadolint/graphs/commit-activity/) [](https://github.com/hadolint/hadolint/graphs/contributors/)
@@ -12,6 +12,7 @@ description: How to use hadolint (configure, ignore files, ignore errors, help &
- Version in MegaLinter: **2.12.0**
- Visit [Official Web Site](https://github.com/hadolint/hadolint#readme){target=_blank}
- See [How to configure hadolint rules](https://github.com/hadolint/hadolint#configure){target=_blank}
+ - If custom `.hadolint.yaml` config file isn't found, [.hadolint.yaml](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.hadolint.yaml){target=_blank} will be used
- See [How to disable hadolint rules in files](https://github.com/hadolint/hadolint#inline-ignores){target=_blank}
- See [Index of problems detected by hadolint](https://github.com/hadolint/hadolint#rules){target=_blank}
@@ -19,23 +20,26 @@ description: How to use hadolint (configure, ignore files, ignore errors, help &
## Configuration in MegaLinter
-- Enable hadolint by adding `DOCKERFILE_HADOLINT` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable hadolint by adding `DOCKERFILE_HADOLINT` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable hadolint by adding `DOCKERFILE_HADOLINT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable hadolint by adding `DOCKERFILE_HADOLINT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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 | `list_of_files` | | 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_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"]` | `["Containerfile", "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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling DOCKERFILE_HADOLINT and its pre/post commands | None | | DOCKERFILE_HADOLINT_CONFIG_FILE | hadolint configuration file nameUse `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` | +| DOCKERFILE_HADOLINT_CLI_EXECUTABLE | Override CLI executable | `['hadolint']` | ## IDE Integration @@ -52,28 +56,30 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [ci_light](https://megalinter.io/6.22.2/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 20 |   |
-| | [cupcake](https://megalinter.io/6.22.2/flavors/cupcake/) | MegaLinter for the most commonly used languages | 82 |   |
-| | [documentation](https://megalinter.io/6.22.2/flavors/documentation/) | MegaLinter for documentation projects | 48 |   |
-| | [dotnet](https://megalinter.io/6.22.2/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 60 |   |
-| | [go](https://megalinter.io/6.22.2/flavors/go/) | Optimized for GO based projects | 50 |   |
-| | [java](https://megalinter.io/6.22.2/flavors/java/) | Optimized for JAVA based projects | 51 |   |
-| | [javascript](https://megalinter.io/6.22.2/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 57 |   |
-| | [php](https://megalinter.io/6.22.2/flavors/php/) | Optimized for PHP based projects | 51 |   |
-| | [python](https://megalinter.io/6.22.2/flavors/python/) | Optimized for PYTHON based projects | 59 |   |
-| | [ruby](https://megalinter.io/6.22.2/flavors/ruby/) | Optimized for RUBY based projects | 48 |   |
-| | [rust](https://megalinter.io/6.22.2/flavors/rust/) | Optimized for RUST based projects | 48 |   |
-| | [salesforce](https://megalinter.io/6.22.2/flavors/salesforce/) | Optimized for Salesforce based projects | 51 |   |
-| | [security](https://megalinter.io/6.22.2/flavors/security/) | Optimized for security | 22 |   |
-| | [swift](https://megalinter.io/6.22.2/flavors/swift/) | Optimized for SWIFT based projects | 48 |   |
-| | [terraform](https://megalinter.io/6.22.2/flavors/terraform/) | Optimized for TERRAFORM based projects | 53 |   |
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [c_cpp](https://megalinter.io/7.13.0/flavors/c_cpp/) | Optimized for pure C/C++ projects | 56 |   |
+| | [ci_light](https://megalinter.io/7.13.0/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 21 |   |
+| | [cupcake](https://megalinter.io/7.13.0/flavors/cupcake/) | MegaLinter for the most commonly used languages | 84 |   |
+| | [documentation](https://megalinter.io/7.13.0/flavors/documentation/) | MegaLinter for documentation projects | 51 |   |
+| | [dotnet](https://megalinter.io/7.13.0/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 63 |   |
+| | [dotnetweb](https://megalinter.io/7.13.0/flavors/dotnetweb/) | Optimized for C, C++, C# or VB based projects with JS/TS | 72 |   |
+| | [go](https://megalinter.io/7.13.0/flavors/go/) | Optimized for GO based projects | 53 |   |
+| | [java](https://megalinter.io/7.13.0/flavors/java/) | Optimized for JAVA based projects | 54 |   |
+| | [javascript](https://megalinter.io/7.13.0/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 61 |   |
+| | [php](https://megalinter.io/7.13.0/flavors/php/) | Optimized for PHP based projects | 56 |   |
+| | [python](https://megalinter.io/7.13.0/flavors/python/) | Optimized for PYTHON based projects | 64 |   |
+| | [ruby](https://megalinter.io/7.13.0/flavors/ruby/) | Optimized for RUBY based projects | 52 |   |
+| | [rust](https://megalinter.io/7.13.0/flavors/rust/) | Optimized for RUST based projects | 52 |   |
+| | [salesforce](https://megalinter.io/7.13.0/flavors/salesforce/) | Optimized for Salesforce based projects | 56 |   |
+| | [security](https://megalinter.io/7.13.0/flavors/security/) | Optimized for security | 24 |   |
+| | [swift](https://megalinter.io/7.13.0/flavors/swift/) | Optimized for SWIFT based projects | 52 |   |
+| | [terraform](https://megalinter.io/7.13.0/flavors/terraform/) | Optimized for TERRAFORM based projects | 56 |   |
## Behind the scenes
### How are identified applicable files
-- File names (regex): `Dockerfile`
+- File names (regex): `Containerfile`, `Dockerfile`
@@ -154,7 +160,9 @@ Available options:
- Dockerfile commands :
```dockerfile
-FROM hadolint/hadolint:v2.12.0-alpine as hadolint
+# renovate: datasource=docker depName=hadolint/hadolint
+ARG DOCKERFILE_HADOLINT_VERSION=v2.12.0-alpine
+FROM hadolint/hadolint:${DOCKERFILE_HADOLINT_VERSION} as hadolint
COPY --link --from=hadolint /bin/hadolint /usr/bin/hadolint
```
diff --git a/docs/descriptors/editorconfig.md b/docs/descriptors/editorconfig.md
index 9ec2029f994..78bb411feb7 100644
--- a/docs/descriptors/editorconfig.md
+++ b/docs/descriptors/editorconfig.md
@@ -3,7 +3,7 @@ title: EDITORCONFIG linters in MegaLinter
description: editorconfig-checker is available to analyze EDITORCONFIG files in MegaLinter
---
-
+
# EDITORCONFIG
@@ -21,8 +21,10 @@ description: editorconfig-checker is available to analyze EDITORCONFIG files in
## 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_PRE_COMMANDS | List of bash commands to run before the linters | None |
+| EDITORCONFIG_POST_COMMANDS | List of bash commands to run after the linters | None |
+| 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 97864eb1f3f..8763260cfe7 100644
--- a/docs/descriptors/editorconfig_editorconfig_checker.md
+++ b/docs/descriptors/editorconfig_editorconfig_checker.md
@@ -3,7 +3,7 @@ title: editorconfig-checker configuration in MegaLinter
description: How to use editorconfig-checker (configure, ignore files, ignore errors, help & version documentations) to analyze EDITORCONFIG files
---
-
+
Ex: `-s --foo "bar"` | | -| 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 nameUse `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` | +- Enable jscpd by adding `COPYPASTE_JSCPD` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) +- Disable jscpd by adding `COPYPASTE_JSCPD` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
Ex: `-s --foo "bar"` | | +| 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling COPYPASTE_JSCPD and its pre/post commands | None | +| COPYPASTE_JSCPD_CONFIG_FILE | jscpd configuration file nameUse `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` | +| COPYPASTE_JSCPD_CLI_EXECUTABLE | Override CLI executable | `['jscpd']` | ## MegaLinter Flavours @@ -63,21 +66,23 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| [_CPP_CPPLINT_](cpp_cpplint.md) | [](https://github.com/cpplint/cpplint) | +| Linter | Additional | +|---------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [**cpplint**](cpp_cpplint.md)
[_CPP_CPPLINT_](cpp_cpplint.md) | [](https://github.com/cpplint/cpplint) | +| [**clang-format**](cpp_clang_format.md)
[_CPP_CLANG_FORMAT_](cpp_clang_format.md) | [](https://github.com/llvm/llvm-project)  | ## Linted files @@ -30,8 +31,10 @@ description: cpplint is available to analyze CPP files in MegaLinter ## 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_PRE_COMMANDS | List of bash commands to run before the linters | None | +| CPP_POST_COMMANDS | List of bash commands to run after the linters | None | +| CPP_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| CPP_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/cpp_clang_format.md b/docs/descriptors/cpp_clang_format.md new file mode 100644 index 00000000000..b91ba55f8a3 --- /dev/null +++ b/docs/descriptors/cpp_clang_format.md @@ -0,0 +1,185 @@ +--- +title: clang-format configuration in MegaLinter +description: How to use clang-format (configure, ignore files, ignore errors, help & version documentations) to analyze CPP files +--- + + +# clang-format +[](https://github.com/llvm/llvm-project)  [](https://github.com/llvm/llvm-project/releases) [](https://github.com/llvm/llvm-project/commits) [](https://github.com/llvm/llvm-project/graphs/commit-activity/) [](https://github.com/llvm/llvm-project/graphs/contributors/) + +## clang-format documentation + +- Version in MegaLinter: **17.0.6** +- Visit [Official Web Site](https://releases.llvm.org/17.0.1/tools/clang/docs/ClangFormat.html){target=_blank} +- See [How to disable clang-format rules in files](https://releases.llvm.org/17.0.1/tools/clang/docs/ClangFormatStyleOptions.html#disabling-formatting-on-a-piece-of-code){target=_blank} +- See [Index of problems detected by clang-format](https://releases.llvm.org/17.0.1/tools/clang/docs/ClangFormat.html){target=_blank} + +[](https://github.com/llvm/llvm-project){target=_blank} + +## Configuration in MegaLinter + +- Enable clang-format by adding `CPP_CLANG_FORMAT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) +- Disable clang-format by adding `CPP_CLANG_FORMAT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) + +- Enable **autofixes** by adding `CPP_CLANG_FORMAT` in [APPLY_FIXES variable](https://megalinter.io/7.13.0/configuration/#apply-fixes) + +| Variable | Description | Default value | +|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------| +| CPP_CLANG_FORMAT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| CPP_CLANG_FORMAT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
Ex: `-s --foo "bar"` | | +| CPP_CLANG_FORMAT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| CPP_CLANG_FORMAT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| CPP_CLANG_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 | `list_of_files` | +| CPP_CLANG_FORMAT_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_CLANG_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 | +| CPP_CLANG_FORMAT_PRE_COMMANDS | List of bash commands to run before the linter | None | +| CPP_CLANG_FORMAT_POST_COMMANDS | List of bash commands to run after the linter | None | +| CPP_CLANG_FORMAT_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CPP_CLANG_FORMAT and its pre/post commands | None | +| CPP_CLANG_FORMAT_CONFIG_FILE | clang-format configuration file nameUse `LINTER_DEFAULT` to let the linter find it | `.clang-format` | +| CPP_CLANG_FORMAT_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| CPP_CLANG_FORMAT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | +| CPP_CLANG_FORMAT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| CPP_CLANG_FORMAT_CLI_EXECUTABLE | Override CLI executable | `['clang-format']` | + +## IDE Integration + +Use clang-format in your favorite IDE to catch errors before MegaLinter ! + +| | IDE | Extension Name | Install | +|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +|
| [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| Ex: `-s --foo "bar"` | | +| CPP_CPPLINT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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` | @@ -30,18 +31,23 @@ description: How to use cpplint (configure, ignore files, ignore errors, help & | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CPP_CPPLINT and its pre/post commands | 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` | +| CPP_CPPLINT_CLI_EXECUTABLE | Override CLI executable | `['cpplint']` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------|:------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| [_CSHARP_DOTNET_FORMAT_](csharp_dotnet_format.md) | [](https://github.com/dotnet/format)  | -| [**csharpier**](csharp_csharpier.md)
[_CSHARP_CSHARPIER_](csharp_csharpier.md) | [](https://github.com/belav/csharpier)  | +| Linter | Additional | +|----------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [**dotnet-format**](csharp_dotnet_format.md)
[_CSHARP_DOTNET_FORMAT_](csharp_dotnet_format.md) | [](https://github.com/dotnet/format)  | +| [**csharpier**](csharp_csharpier.md)
[_CSHARP_CSHARPIER_](csharp_csharpier.md) | [](https://github.com/belav/csharpier)  | +| [**roslynator**](csharp_roslynator.md)
[_CSHARP_ROSLYNATOR_](csharp_roslynator.md) | [](https://github.com/dotnet/Roslynator)  | ## Linted files @@ -21,10 +22,12 @@ description: dotnet-format, csharpier are available to analyze CSHARP files in M ## 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_PRE_COMMANDS | List of bash commands to run before the linters | None | +| CSHARP_POST_COMMANDS | List of bash commands to run after the linters | None | +| CSHARP_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| CSHARP_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | ## Behind the scenes @@ -33,19 +36,7 @@ description: dotnet-format, csharpier are available to analyze CSHARP files in M - Dockerfile commands : ```dockerfile -RUN wget --tries=5 -q -O dotnet-install.sh https://dot.net/v1/dotnet-install.sh \ - && chmod +x dotnet-install.sh \ - && ./dotnet-install.sh --install-dir /usr/share/dotnet -channel 6.0 -version latest - -ENV PATH="${PATH}:/root/.dotnet/tools:/usr/share/dotnet" +RUN apk add --no-cache dotnet8-sdk +ENV PATH="${PATH}:/root/.dotnet/tools" ``` -- APK packages (Linux): - - [icu-libs](https://pkgs.alpinelinux.org/packages?branch=edge&name=icu-libs) - - [libcurl](https://pkgs.alpinelinux.org/packages?branch=edge&name=libcurl) - - [libintl](https://pkgs.alpinelinux.org/packages?branch=edge&name=libintl) - - [libssl1.1](https://pkgs.alpinelinux.org/packages?branch=edge&name=libssl1.1) - - [libstdc++](https://pkgs.alpinelinux.org/packages?branch=edge&name=libstdc++) - - [lttng-ust-dev](https://pkgs.alpinelinux.org/packages?branch=edge&name=lttng-ust-dev) - - [zlib](https://pkgs.alpinelinux.org/packages?branch=edge&name=zlib) - - [zlib-dev](https://pkgs.alpinelinux.org/packages?branch=edge&name=zlib-dev) diff --git a/docs/descriptors/csharp_csharpier.md b/docs/descriptors/csharp_csharpier.md index 1dd1d39e3f2..e61c4752da0 100644 --- a/docs/descriptors/csharp_csharpier.md +++ b/docs/descriptors/csharp_csharpier.md @@ -3,13 +3,13 @@ title: csharpier configuration in MegaLinter description: How to use csharpier (configure, ignore files, ignore errors, help & version documentations) to analyze CSHARP files --- - + #
csharpier
[](https://github.com/belav/csharpier)  [](https://github.com/belav/csharpier/releases) [](https://github.com/belav/csharpier/commits) [](https://github.com/belav/csharpier/graphs/commit-activity/) [](https://github.com/belav/csharpier/graphs/contributors/)
## csharpier documentation
-- Version in MegaLinter: **0.23.0**
+- Version in MegaLinter: **0.28.2**
- Visit [Official Web Site](https://csharpier.com/){target=_blank}
- See [How to configure csharpier rules](https://csharpier.com/docs/Configuration){target=_blank}
- See [How to ignore files and directories with csharpier](https://csharpier.com/docs/Ignore){target=_blank}
@@ -19,23 +19,28 @@ description: How to use csharpier (configure, ignore files, ignore errors, help
## Configuration in MegaLinter
-- Enable csharpier by adding `CSHARP_CSHARPIER` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable csharpier by adding `CSHARP_CSHARPIER` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-
-- Enable **auto-fixes** by adding `CSHARP_CSHARPIER` in [APPLY_FIXES variable](https://megalinter.io/6.22.2/configuration/#apply-fixes)
-
-| Variable | Description | Default value |
-|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
-| CSHARP_CSHARPIER_ARGUMENTS | User custom arguments to add in linter CLI callEx: `-s --foo "bar"` | | -| CSHARP_CSHARPIER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | -| CSHARP_CSHARPIER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | -| CSHARP_CSHARPIER_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` | -| CSHARP_CSHARPIER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".cs"]` | -| CSHARP_CSHARPIER_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_CSHARPIER_PRE_COMMANDS | List of bash commands to run before the linter | None | -| CSHARP_CSHARPIER_POST_COMMANDS | List of bash commands to run after the linter | None | -| CSHARP_CSHARPIER_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | -| CSHARP_CSHARPIER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +- Enable csharpier by adding `CSHARP_CSHARPIER` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) +- Disable csharpier by adding `CSHARP_CSHARPIER` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) + +- Enable **autofixes** by adding `CSHARP_CSHARPIER` in [APPLY_FIXES variable](https://megalinter.io/7.13.0/configuration/#apply-fixes) + +| Variable | Description | Default value | +|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| +| CSHARP_CSHARPIER_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| CSHARP_CSHARPIER_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
Ex: `-s --foo "bar"` | | +| CSHARP_CSHARPIER_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| CSHARP_CSHARPIER_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| CSHARP_CSHARPIER_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` | +| CSHARP_CSHARPIER_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".cs"]` | +| CSHARP_CSHARPIER_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_CSHARPIER_PRE_COMMANDS | List of bash commands to run before the linter | None | +| CSHARP_CSHARPIER_POST_COMMANDS | List of bash commands to run after the linter | None | +| CSHARP_CSHARPIER_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CSHARP_CSHARPIER and its pre/post commands | None | +| CSHARP_CSHARPIER_CONFIG_FILE | csharpier configuration file nameUse `LINTER_DEFAULT` to let the linter find it | `.csharpierrc` | +| CSHARP_CSHARPIER_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules | +| CSHARP_CSHARPIER_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| CSHARP_CSHARPIER_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| CSHARP_CSHARPIER_CLI_EXECUTABLE | Override CLI executable | `['dotnet-csharpier']` | ## IDE Integration @@ -51,10 +56,12 @@ Use csharpier in your favorite IDE to catch errors before MegaLinter ! This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------|:----------------------------------------------|:----------------:|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| dotnet-format
[](https://github.com/dotnet/format)  [](https://github.com/dotnet/format/releases) [](https://github.com/dotnet/format/commits) [](https://github.com/dotnet/format/graphs/commit-activity/) [](https://github.com/dotnet/format/graphs/contributors/)
@@ -11,21 +11,22 @@ dotnet-format requires a `.sln` or `.csproj` file to run correctly.
## dotnet-format documentation
-- Version in MegaLinter: **6.0.407**
+- Version in MegaLinter: **8.0.106**
- Visit [Official Web Site](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-format){target=_blank}
[](https://github.com/dotnet/format){target=_blank}
## Configuration in MegaLinter
-- Enable dotnet-format by adding `CSHARP_DOTNET_FORMAT` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable dotnet-format by adding `CSHARP_DOTNET_FORMAT` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable dotnet-format by adding `CSHARP_DOTNET_FORMAT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable dotnet-format by adding `CSHARP_DOTNET_FORMAT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
-- Enable **auto-fixes** by adding `CSHARP_DOTNET_FORMAT` in [APPLY_FIXES variable](https://megalinter.io/6.22.2/configuration/#apply-fixes)
+- Enable **autofixes** by adding `CSHARP_DOTNET_FORMAT` in [APPLY_FIXES variable](https://megalinter.io/7.13.0/configuration/#apply-fixes)
| Variable | Description | Default value |
|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| CSHARP_DOTNET_FORMAT_ARGUMENTS | User custom arguments to add in linter CLI callEx: `-s --foo "bar"` | | +| CSHARP_DOTNET_FORMAT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `project`: Call the linter from the root of the project | `file` | @@ -33,17 +34,21 @@ dotnet-format requires a `.sln` or `.csproj` file to run correctly. | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CSHARP_DOTNET_FORMAT and its pre/post commands | 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` | +| CSHARP_DOTNET_FORMAT_CLI_EXECUTABLE | Override CLI executable | `['dotnet']` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------|:----------------------------------------------|:----------------:|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| roslynator
+[](https://github.com/dotnet/Roslynator)  [](https://github.com/dotnet/Roslynator/releases) [](https://github.com/dotnet/Roslynator/commits) [](https://github.com/dotnet/Roslynator/graphs/commit-activity/) [](https://github.com/dotnet/Roslynator/graphs/contributors/)
+
+## roslynator documentation
+
+- Version in MegaLinter: **0.8.9.0**
+- Visit [Official Web Site](https://github.com/dotnet/Roslynator#readme){target=_blank}
+- See [How to configure roslynator rules](https://josefpihrt.github.io/docs/roslynator/configuration){target=_blank}
+- See [How to disable roslynator rules in files](https://josefpihrt.github.io/docs/roslynator/how-to-suppress-diagnostic){target=_blank}
+- See [Index of problems detected by roslynator](https://josefpihrt.github.io/docs/roslynator/analyzers){target=_blank}
+
+[](https://github.com/dotnet/Roslynator){target=_blank}
+
+## Configuration in MegaLinter
+
+- Enable roslynator by adding `CSHARP_ROSLYNATOR` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable roslynator by adding `CSHARP_ROSLYNATOR` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+
+- Enable **autofixes** by adding `CSHARP_ROSLYNATOR` in [APPLY_FIXES variable](https://megalinter.io/7.13.0/configuration/#apply-fixes)
+
+| Variable | Description | Default value |
+|-----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
+| CSHARP_ROSLYNATOR_ARGUMENTS | User custom arguments to add in linter CLI callEx: `-s --foo "bar"` | | +| CSHARP_ROSLYNATOR_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
Ex: `-s --foo "bar"` | | +| CSHARP_ROSLYNATOR_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | +| CSHARP_ROSLYNATOR_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | +| CSHARP_ROSLYNATOR_CLI_LINT_MODE | Override default CLI lint mode
- `file`: Calls the linter for each file
- `project`: Call the linter from the root of the project | `file` | +| CSHARP_ROSLYNATOR_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files
Ex: `[".py", ""]` | `[".csproj"]` | +| CSHARP_ROSLYNATOR_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_ROSLYNATOR_PRE_COMMANDS | List of bash commands to run before the linter | None | +| CSHARP_ROSLYNATOR_POST_COMMANDS | List of bash commands to run after the linter | None | +| CSHARP_ROSLYNATOR_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CSHARP_ROSLYNATOR and its pre/post commands | None | +| CSHARP_ROSLYNATOR_DISABLE_ERRORS | Run linter but consider errors as warnings | `true` | +| CSHARP_ROSLYNATOR_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| CSHARP_ROSLYNATOR_CLI_EXECUTABLE | Override CLI executable | `['roslynator']` | + +## IDE Integration + +Use roslynator in your favorite IDE to catch errors before MegaLinter ! + +| | IDE | Extension Name | Install | +|:--------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|--------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +|
| [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| [_CSS_STYLELINT_](css_stylelint.md) | [](https://github.com/stylelint/stylelint)  | -| [**scss-lint**](css_scss_lint.md)
[_CSS_SCSS_LINT_](css_scss_lint.md) | [](https://github.com/sds/scss-lint) | +| [**scss-lint**](css_scss_lint.md)
[_CSS_SCSS_LINT_](css_scss_lint.md) |  [](https://github.com/sds/scss-lint) | ## Linted files @@ -23,8 +23,10 @@ description: stylelint, scss-lint are available to analyze CSS files in MegaLint ## 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_PRE_COMMANDS | List of bash commands to run before the linters | None | +| CSS_POST_COMMANDS | List of bash commands to run after the linters | None | +| 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 2377a21eafc..e7fb793c743 100644 --- a/docs/descriptors/css_scss_lint.md +++ b/docs/descriptors/css_scss_lint.md @@ -3,7 +3,7 @@ title: scss-lint configuration in MegaLinter description: How to use scss-lint (configure, ignore files, ignore errors, help & version documentations) to analyze CSS files --- - + -[](https://github.com/sds/scss-lint) [](https://github.com/sds/scss-lint/releases) [](https://github.com/sds/scss-lint/commits) [](https://github.com/sds/scss-lint/graphs/commit-activity/) [](https://github.com/sds/scss-lint/graphs/contributors/) + [](https://github.com/sds/scss-lint) [](https://github.com/sds/scss-lint/releases) [](https://github.com/sds/scss-lint/commits) [](https://github.com/sds/scss-lint/graphs/commit-activity/) [](https://github.com/sds/scss-lint/graphs/contributors/) + +> This linter has been deprecated. +> +> https://github.com/sds/scss-lint#notice-consider-other-tools-before-adopting-scss-lint +> +> You should disable scss-lint by adding it in DISABLE_LINTERS property. +> +> It will be maintained at least until the next major release. ## scss-lint documentation @@ -24,12 +32,13 @@ description: How to use scss-lint (configure, ignore files, ignore errors, help ## Configuration in MegaLinter -- Enable scss-lint by adding `CSS_SCSS_LINT` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation) -- Disable scss-lint by adding `CSS_SCSS_LINT` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation) +- Enable scss-lint by adding `CSS_SCSS_LINT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) +- Disable scss-lint by adding `CSS_SCSS_LINT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `project`: Call the linter from the root of the project | `file` | @@ -37,10 +46,12 @@ description: How to use scss-lint (configure, ignore files, ignore errors, help | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CSS_SCSS_LINT and its pre/post commands | None | | CSS_SCSS_LINT_CONFIG_FILE | scss-lint configuration file nameUse `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` | +| CSS_SCSS_LINT_CLI_EXECUTABLE | Override CLI executable | `['scss-lint']` | ## IDE Integration @@ -56,22 +67,24 @@ Use scss-lint in your favorite IDE to catch errors before MegaLinter ! This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| 
+ 
Ex: `-s --foo "bar"` | | +| CSS_STYLELINT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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` | @@ -41,10 +42,12 @@ description: How to use stylelint (configure, ignore files, ignore errors, help | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling CSS_STYLELINT and its pre/post commands | None | | CSS_STYLELINT_CONFIG_FILE | stylelint configuration file nameUse `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` | +| CSS_STYLELINT_CLI_EXECUTABLE | Override CLI executable | `['stylelint']` | ## IDE Integration @@ -63,22 +66,24 @@ Use stylelint in your favorite IDE to catch errors before MegaLinter ! This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+|
-
- 
-
-
-
+
+#
-
-dartanalyzer
 [](https://github.com/dart-lang/sdk) [](https://github.com/dart-lang/sdk/releases) [](https://github.com/dart-lang/sdk/commits) [](https://github.com/dart-lang/sdk/graphs/commit-activity/) [](https://github.com/dart-lang/sdk/graphs/contributors/)
## dartanalyzer documentation
- Visit [Official Web Site](https://github.com/dart-lang/sdk/tree/master/pkg/analyzer_cli#readme){target=_blank}
- See [How to configure dartanalyzer rules](https://dart.dev/guides/language/analysis-options#the-analysis-options-file){target=_blank}
- - If custom `analysis_options.yml` config file is not found, [analysis_options.yml](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/analysis_options.yml){target=_blank} will be used
+ - If custom `analysis_options.yml` config file isn't found, [analysis_options.yml](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/analysis_options.yml){target=_blank} will be used
- See [How to disable dartanalyzer rules in files](https://dart.dev/guides/language/analysis-options#suppressing-rules-for-a-file){target=_blank}
[](https://github.com/dart-lang/sdk){target=_blank}
## Configuration in MegaLinter
-- Enable dartanalyzer by adding `DART_DARTANALYZER` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable dartanalyzer by adding `DART_DARTANALYZER` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable dartanalyzer by adding `DART_DARTANALYZER` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable dartanalyzer by adding `DART_DARTANALYZER` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
| Variable | Description | Default value |
|-----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
| DART_DARTANALYZER_ARGUMENTS | User custom arguments to add in linter CLI callEx: `-s --foo "bar"` | | +| DART_DARTANALYZER_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `project`: Call the linter from the root of the project | `file` | @@ -37,10 +32,12 @@ description: How to use dartanalyzer (configure, ignore files, ignore errors, he | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling DART_DARTANALYZER and its pre/post commands | None | | DART_DARTANALYZER_CONFIG_FILE | dartanalyzer configuration file nameUse `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` | +| DART_DARTANALYZER_CLI_EXECUTABLE | Override CLI executable | `['dartanalyzer']` | ## IDE Integration @@ -57,7 +54,7 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------|:--------------------------|:----------------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
## Behind the scenes
@@ -116,12 +113,51 @@ For more information, see https://www.dartlang.org/tools/analyzer.
- Dockerfile commands :
```dockerfile
+# Parent descriptor install
+ENV LANG=C.UTF-8
+RUN ALPINE_GLIBC_BASE_URL="https://github.com/sgerrand/alpine-pkg-glibc/releases/download" && \
+ ALPINE_GLIBC_PACKAGE_VERSION="2.34-r0" && \
+ ALPINE_GLIBC_BASE_PACKAGE_FILENAME="glibc-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
+ ALPINE_GLIBC_BIN_PACKAGE_FILENAME="glibc-bin-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
+ ALPINE_GLIBC_I18N_PACKAGE_FILENAME="glibc-i18n-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
+ apk add --no-cache --virtual=.build-dependencies wget ca-certificates && \
+ echo \
+ "-----BEGIN PUBLIC KEY-----\
+ MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApZ2u1KJKUu/fW4A25y9m\
+ y70AGEa/J3Wi5ibNVGNn1gT1r0VfgeWd0pUybS4UmcHdiNzxJPgoWQhV2SSW1JYu\
+ tOqKZF5QSN6X937PTUpNBjUvLtTQ1ve1fp39uf/lEXPpFpOPL88LKnDBgbh7wkCp\
+ m2KzLVGChf83MS0ShL6G9EQIAUxLm99VpgRjwqTQ/KfzGtpke1wqws4au0Ab4qPY\
+ KXvMLSPLUp7cfulWvhmZSegr5AdhNw5KNizPqCJT8ZrGvgHypXyiFvvAH5YRtSsc\
+ Zvo9GI2e2MaZyo9/lvb+LbLEJZKEQckqRj4P26gmASrZEPStwc+yqy1ShHLA0j6m\
+ 1QIDAQAB\
+ -----END PUBLIC KEY-----" | sed 's/ */\\n/g' > "/etc/apk/keys/sgerrand.rsa.pub" && \
+ wget --quiet --tries=10 --waitretry=10 \
+ "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_I18N_PACKAGE_FILENAME" && \
+ mv /etc/nsswitch.conf /etc/nsswitch.conf.bak && \
+ apk add --no-cache --force-overwrite \
+ "$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_I18N_PACKAGE_FILENAME" && \
+ \
+ mv /etc/nsswitch.conf.bak /etc/nsswitch.conf && \
+ rm "/etc/apk/keys/sgerrand.rsa.pub" && \
+ (/usr/glibc-compat/bin/localedef --force --inputfile POSIX --charmap UTF-8 "$LANG" || true) && \
+ echo "export LANG=$LANG" > /etc/profile.d/locale.sh && \
+ \
+ apk del glibc-i18n && \
+ \
+ rm "/root/.wget-hsts" && \
+ apk del .build-dependencies && \
+ rm \
+ "$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
+ "$ALPINE_GLIBC_I18N_PACKAGE_FILENAME"
+
+# Linter install
ARG DART_VERSION='2.8.4'
-ARG GLIBC_VERSION='2.34-r0'
-RUN wget --tries=50 -q -O /etc/apk/keys/sgerrand.rsa.pub https://alpine-pkgs.sgerrand.com/sgerrand.rsa.pub \
- && wget --tries=5 -q https://github.com/sgerrand/alpine-pkg-glibc/releases/download/${GLIBC_VERSION}/glibc-${GLIBC_VERSION}.apk \
- && apk add --force-overwrite --no-cache glibc-${GLIBC_VERSION}.apk && rm glibc-${GLIBC_VERSION}.apk \
- && wget --tries=5 https://storage.googleapis.com/dart-archive/channels/stable/release/${DART_VERSION}/sdk/dartsdk-linux-x64-release.zip -O - -q | unzip -q - \
+RUN wget --tries=5 https://storage.googleapis.com/dart-archive/channels/stable/release/${DART_VERSION}/sdk/dartsdk-linux-x64-release.zip -O - -q | unzip -q - \
&& chmod +x dart-sdk/bin/dart* \
&& mv dart-sdk/bin/* /usr/bin/ && mv dart-sdk/lib/* /usr/lib/ && mv dart-sdk/include/* /usr/include/ \
&& rm -r dart-sdk/
diff --git a/docs/descriptors/dockerfile.md b/docs/descriptors/dockerfile.md
index fc068506838..68958f90e24 100644
--- a/docs/descriptors/dockerfile.md
+++ b/docs/descriptors/dockerfile.md
@@ -3,7 +3,7 @@ title: DOCKERFILE linters in MegaLinter
description: hadolint is available to analyze DOCKERFILE files in MegaLinter
---
-
+
# DOCKERFILE
@@ -16,12 +16,15 @@ description: hadolint is available to analyze DOCKERFILE files in MegaLinter
## Linted files
- File names:
+ - `Containerfile`
- `Dockerfile`
## 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_PRE_COMMANDS | List of bash commands to run before the linters | None |
+| DOCKERFILE_POST_COMMANDS | List of bash commands to run after the linters | None |
+| 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 7a2ee7f3081..6c765a4dbfb 100644
--- a/docs/descriptors/dockerfile_hadolint.md
+++ b/docs/descriptors/dockerfile_hadolint.md
@@ -3,7 +3,7 @@ title: hadolint configuration in MegaLinter
description: How to use hadolint (configure, ignore files, ignore errors, help & version documentations) to analyze DOCKERFILE files
---
-
+
# hadolint
[](https://github.com/hadolint/hadolint)  [](https://github.com/hadolint/hadolint/releases) [](https://github.com/hadolint/hadolint/commits) [](https://github.com/hadolint/hadolint/graphs/commit-activity/) [](https://github.com/hadolint/hadolint/graphs/contributors/)
@@ -12,6 +12,7 @@ description: How to use hadolint (configure, ignore files, ignore errors, help &
- Version in MegaLinter: **2.12.0**
- Visit [Official Web Site](https://github.com/hadolint/hadolint#readme){target=_blank}
- See [How to configure hadolint rules](https://github.com/hadolint/hadolint#configure){target=_blank}
+ - If custom `.hadolint.yaml` config file isn't found, [.hadolint.yaml](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.hadolint.yaml){target=_blank} will be used
- See [How to disable hadolint rules in files](https://github.com/hadolint/hadolint#inline-ignores){target=_blank}
- See [Index of problems detected by hadolint](https://github.com/hadolint/hadolint#rules){target=_blank}
@@ -19,23 +20,26 @@ description: How to use hadolint (configure, ignore files, ignore errors, help &
## Configuration in MegaLinter
-- Enable hadolint by adding `DOCKERFILE_HADOLINT` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable hadolint by adding `DOCKERFILE_HADOLINT` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable hadolint by adding `DOCKERFILE_HADOLINT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable hadolint by adding `DOCKERFILE_HADOLINT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
| Variable | Description | Default value |
|-------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
| DOCKERFILE_HADOLINT_ARGUMENTS | User custom arguments to add in linter CLI callEx: `-s --foo "bar"` | | +| DOCKERFILE_HADOLINT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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 | `list_of_files` | | 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_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"]` | `["Containerfile", "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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling DOCKERFILE_HADOLINT and its pre/post commands | None | | DOCKERFILE_HADOLINT_CONFIG_FILE | hadolint configuration file nameUse `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` | +| DOCKERFILE_HADOLINT_CLI_EXECUTABLE | Override CLI executable | `['hadolint']` | ## IDE Integration @@ -52,28 +56,30 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+|
@@ -15,7 +15,7 @@ description: How to use editorconfig-checker (configure, ignore files, ignore er
## editorconfig-checker documentation
-- Version in MegaLinter: **2.7.0**
+- Version in MegaLinter: **3.0.3**
- Visit [Official Web Site](https://editorconfig-checker.github.io/){target=_blank}
- See [How to configure editorconfig-checker rules](https://github.com/editorconfig-checker/editorconfig-checker#configuration){target=_blank}
- See [How to disable editorconfig-checker rules in files](https://github.com/editorconfig-checker/editorconfig-checker#excluding){target=_blank}
@@ -24,12 +24,13 @@ description: How to use editorconfig-checker (configure, ignore files, ignore er
## Configuration in MegaLinter
-- Enable editorconfig-checker by adding `EDITORCONFIG_EDITORCONFIG_CHECKER` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable editorconfig-checker by adding `EDITORCONFIG_EDITORCONFIG_CHECKER` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable editorconfig-checker by adding `EDITORCONFIG_EDITORCONFIG_CHECKER` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable editorconfig-checker by adding `EDITORCONFIG_EDITORCONFIG_CHECKER` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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` | @@ -37,31 +38,35 @@ description: How to use editorconfig-checker (configure, ignore files, ignore er | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling EDITORCONFIG_EDITORCONFIG_CHECKER and its pre/post commands | None | | EDITORCONFIG_EDITORCONFIG_CHECKER_CONFIG_FILE | editorconfig-checker configuration file nameUse `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` | +| EDITORCONFIG_EDITORCONFIG_CHECKER_CLI_EXECUTABLE | Override CLI executable | `['editorconfig-checker']` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [cupcake](https://megalinter.io/6.22.2/flavors/cupcake/) | MegaLinter for the most commonly used languages | 82 |   |
-| | [documentation](https://megalinter.io/6.22.2/flavors/documentation/) | MegaLinter for documentation projects | 48 |   |
-| | [dotnet](https://megalinter.io/6.22.2/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 60 |   |
-| | [go](https://megalinter.io/6.22.2/flavors/go/) | Optimized for GO based projects | 50 |   |
-| | [java](https://megalinter.io/6.22.2/flavors/java/) | Optimized for JAVA based projects | 51 |   |
-| | [javascript](https://megalinter.io/6.22.2/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 57 |   |
-| | [php](https://megalinter.io/6.22.2/flavors/php/) | Optimized for PHP based projects | 51 |   |
-| | [python](https://megalinter.io/6.22.2/flavors/python/) | Optimized for PYTHON based projects | 59 |   |
-| | [ruby](https://megalinter.io/6.22.2/flavors/ruby/) | Optimized for RUBY based projects | 48 |   |
-| | [rust](https://megalinter.io/6.22.2/flavors/rust/) | Optimized for RUST based projects | 48 |   |
-| | [salesforce](https://megalinter.io/6.22.2/flavors/salesforce/) | Optimized for Salesforce based projects | 51 |   |
-| | [swift](https://megalinter.io/6.22.2/flavors/swift/) | Optimized for SWIFT based projects | 48 |   |
-| | [terraform](https://megalinter.io/6.22.2/flavors/terraform/) | Optimized for TERRAFORM based projects | 53 |   |
+| | Flavor | Description | Embedded linters | Info |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:---------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [c_cpp](https://megalinter.io/7.13.0/flavors/c_cpp/) | Optimized for pure C/C++ projects | 56 |   |
+| | [cupcake](https://megalinter.io/7.13.0/flavors/cupcake/) | MegaLinter for the most commonly used languages | 84 |   |
+| | [documentation](https://megalinter.io/7.13.0/flavors/documentation/) | MegaLinter for documentation projects | 51 |   |
+| | [dotnet](https://megalinter.io/7.13.0/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 63 |   |
+| | [dotnetweb](https://megalinter.io/7.13.0/flavors/dotnetweb/) | Optimized for C, C++, C# or VB based projects with JS/TS | 72 |   |
+| | [go](https://megalinter.io/7.13.0/flavors/go/) | Optimized for GO based projects | 53 |   |
+| | [java](https://megalinter.io/7.13.0/flavors/java/) | Optimized for JAVA based projects | 54 |   |
+| | [javascript](https://megalinter.io/7.13.0/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 61 |   |
+| | [php](https://megalinter.io/7.13.0/flavors/php/) | Optimized for PHP based projects | 56 |   |
+| | [python](https://megalinter.io/7.13.0/flavors/python/) | Optimized for PYTHON based projects | 64 |   |
+| | [ruby](https://megalinter.io/7.13.0/flavors/ruby/) | Optimized for RUBY based projects | 52 |   |
+| | [rust](https://megalinter.io/7.13.0/flavors/rust/) | Optimized for RUST based projects | 52 |   |
+| | [salesforce](https://megalinter.io/7.13.0/flavors/salesforce/) | Optimized for Salesforce based projects | 56 |   |
+| | [swift](https://megalinter.io/7.13.0/flavors/swift/) | Optimized for SWIFT based projects | 52 |   |
+| | [terraform](https://megalinter.io/7.13.0/flavors/terraform/) | Optimized for TERRAFORM based projects | 56 |   |
## Behind the scenes
@@ -107,6 +112,10 @@ USAGE:
show which files would be checked
-exclude string
a regex which files should be excluded from checking - needs to be a valid regular expression
+ -f string
+ specify the output format: default, gcc (default "default")
+ -format string
+ specify the output format: default, gcc (default "default")
-h print the help
-help
print the help
@@ -127,7 +136,9 @@ USAGE:
- Dockerfile commands :
```dockerfile
-FROM mstruebing/editorconfig-checker:2.7.0 as editorconfig-checker
+# renovate: datasource=docker depName=mstruebing/editorconfig-checker
+ARG EDITORCONFIG_EDITORCONFIG_CHECKER_VERSION=v3.0.3
+FROM mstruebing/editorconfig-checker:${EDITORCONFIG_EDITORCONFIG_CHECKER_VERSION} as editorconfig-checker
COPY --link --from=editorconfig-checker /usr/bin/ec /usr/bin/editorconfig-checker
```
diff --git a/docs/descriptors/env.md b/docs/descriptors/env.md
index bce49e486be..70618f58b34 100644
--- a/docs/descriptors/env.md
+++ b/docs/descriptors/env.md
@@ -3,7 +3,7 @@ title: ENV linters in MegaLinter
description: dotenv-linter is available to analyze ENV files in MegaLinter
---
-
+
# ENV
@@ -20,8 +20,10 @@ description: dotenv-linter is available to analyze ENV files in MegaLinter
## 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_PRE_COMMANDS | List of bash commands to run before the linters | None |
+| ENV_POST_COMMANDS | List of bash commands to run after the linters | None |
+| 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 53ec49894fc..175bb0f1041 100644
--- a/docs/descriptors/env_dotenv_linter.md
+++ b/docs/descriptors/env_dotenv_linter.md
@@ -3,7 +3,7 @@ title: dotenv-linter configuration in MegaLinter
description: How to use dotenv-linter (configure, ignore files, ignore errors, help & version documentations) to analyze ENV files
---
-
+
Ex: `-s --foo "bar"` | | +| EDITORCONFIG_EDITORCONFIG_CHECKER_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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` | @@ -37,31 +38,35 @@ description: How to use editorconfig-checker (configure, ignore files, ignore er | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling EDITORCONFIG_EDITORCONFIG_CHECKER and its pre/post commands | None | | EDITORCONFIG_EDITORCONFIG_CHECKER_CONFIG_FILE | editorconfig-checker configuration file nameUse `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` | +| EDITORCONFIG_EDITORCONFIG_CHECKER_CLI_EXECUTABLE | Override CLI executable | `['editorconfig-checker']` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+|
@@ -23,23 +23,26 @@ description: How to use dotenv-linter (configure, ignore files, ignore errors, h
## Configuration in MegaLinter
-- Enable dotenv-linter by adding `ENV_DOTENV_LINTER` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable dotenv-linter by adding `ENV_DOTENV_LINTER` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-
-- Enable **auto-fixes** by adding `ENV_DOTENV_LINTER` in [APPLY_FIXES variable](https://megalinter.io/6.22.2/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
- `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` | +- Enable dotenv-linter by adding `ENV_DOTENV_LINTER` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) +- Disable dotenv-linter by adding `ENV_DOTENV_LINTER` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) + +- Enable **autofixes** by adding `ENV_DOTENV_LINTER` in [APPLY_FIXES variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling ENV_DOTENV_LINTER and its pre/post commands | 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` | +| ENV_DOTENV_LINTER_CLI_EXECUTABLE | Override CLI executable | `['dotenv-linter']` | ## MegaLinter Flavours @@ -47,21 +50,23 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [ci_light](https://megalinter.io/6.22.2/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 20 |   |
-| | [cupcake](https://megalinter.io/6.22.2/flavors/cupcake/) | MegaLinter for the most commonly used languages | 82 |   |
-| | [documentation](https://megalinter.io/6.22.2/flavors/documentation/) | MegaLinter for documentation projects | 48 |   |
-| | [dotnet](https://megalinter.io/6.22.2/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 60 |   |
-| | [go](https://megalinter.io/6.22.2/flavors/go/) | Optimized for GO based projects | 50 |   |
-| | [java](https://megalinter.io/6.22.2/flavors/java/) | Optimized for JAVA based projects | 51 |   |
-| | [javascript](https://megalinter.io/6.22.2/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 57 |   |
-| | [php](https://megalinter.io/6.22.2/flavors/php/) | Optimized for PHP based projects | 51 |   |
-| | [python](https://megalinter.io/6.22.2/flavors/python/) | Optimized for PYTHON based projects | 59 |   |
-| | [ruby](https://megalinter.io/6.22.2/flavors/ruby/) | Optimized for RUBY based projects | 48 |   |
-| | [rust](https://megalinter.io/6.22.2/flavors/rust/) | Optimized for RUST based projects | 48 |   |
-| | [salesforce](https://megalinter.io/6.22.2/flavors/salesforce/) | Optimized for Salesforce based projects | 51 |   |
-| | [swift](https://megalinter.io/6.22.2/flavors/swift/) | Optimized for SWIFT based projects | 48 |   |
-| | [terraform](https://megalinter.io/6.22.2/flavors/terraform/) | Optimized for TERRAFORM based projects | 53 |   |
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [c_cpp](https://megalinter.io/7.13.0/flavors/c_cpp/) | Optimized for pure C/C++ projects | 56 |   |
+| | [ci_light](https://megalinter.io/7.13.0/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 21 |   |
+| | [cupcake](https://megalinter.io/7.13.0/flavors/cupcake/) | MegaLinter for the most commonly used languages | 84 |   |
+| | [documentation](https://megalinter.io/7.13.0/flavors/documentation/) | MegaLinter for documentation projects | 51 |   |
+| | [dotnet](https://megalinter.io/7.13.0/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 63 |   |
+| | [dotnetweb](https://megalinter.io/7.13.0/flavors/dotnetweb/) | Optimized for C, C++, C# or VB based projects with JS/TS | 72 |   |
+| | [go](https://megalinter.io/7.13.0/flavors/go/) | Optimized for GO based projects | 53 |   |
+| | [java](https://megalinter.io/7.13.0/flavors/java/) | Optimized for JAVA based projects | 54 |   |
+| | [javascript](https://megalinter.io/7.13.0/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 61 |   |
+| | [php](https://megalinter.io/7.13.0/flavors/php/) | Optimized for PHP based projects | 56 |   |
+| | [python](https://megalinter.io/7.13.0/flavors/python/) | Optimized for PYTHON based projects | 64 |   |
+| | [ruby](https://megalinter.io/7.13.0/flavors/ruby/) | Optimized for RUBY based projects | 52 |   |
+| | [rust](https://megalinter.io/7.13.0/flavors/rust/) | Optimized for RUST based projects | 52 |   |
+| | [salesforce](https://megalinter.io/7.13.0/flavors/salesforce/) | Optimized for Salesforce based projects | 56 |   |
+| | [swift](https://megalinter.io/7.13.0/flavors/swift/) | Optimized for SWIFT based projects | 52 |   |
+| | [terraform](https://megalinter.io/7.13.0/flavors/terraform/) | Optimized for TERRAFORM based projects | 56 |   |
## Behind the scenes
diff --git a/docs/descriptors/gherkin.md b/docs/descriptors/gherkin.md
index c7057ee59aa..ac4f43116bb 100644
--- a/docs/descriptors/gherkin.md
+++ b/docs/descriptors/gherkin.md
@@ -3,7 +3,7 @@ title: GHERKIN linters in MegaLinter
description: gherkin-lint is available to analyze GHERKIN files in MegaLinter
---
-
+
# GHERKIN
@@ -20,8 +20,10 @@ description: gherkin-lint is available to analyze GHERKIN files in MegaLinter
## 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_PRE_COMMANDS | List of bash commands to run before the linters | None |
+| GHERKIN_POST_COMMANDS | List of bash commands to run after the linters | None |
+| 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 9b490958de7..e53a0713670 100644
--- a/docs/descriptors/gherkin_gherkin_lint.md
+++ b/docs/descriptors/gherkin_gherkin_lint.md
@@ -3,7 +3,7 @@ title: gherkin-lint configuration in MegaLinter
description: How to use gherkin-lint (configure, ignore files, ignore errors, help & version documentations) to analyze GHERKIN files
---
-
+
# gherkin-lint
[](https://github.com/vsiakka/gherkin-lint) [](https://github.com/vsiakka/gherkin-lint/releases) [](https://github.com/vsiakka/gherkin-lint/commits) [](https://github.com/vsiakka/gherkin-lint/graphs/commit-activity/) [](https://github.com/vsiakka/gherkin-lint/graphs/contributors/)
@@ -11,19 +11,20 @@ description: How to use gherkin-lint (configure, ignore files, ignore errors, he
- Visit [Official Web Site](https://github.com/vsiakka/gherkin-lint#readme){target=_blank}
- See [How to configure gherkin-lint rules](https://github.com/vsiakka/gherkin-lint#rule-configuration){target=_blank}
- - If custom `.gherkin-lintrc` config file is not found, [.gherkin-lintrc](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.gherkin-lintrc){target=_blank} will be used
+ - If custom `.gherkin-lintrc` config file isn't found, [.gherkin-lintrc](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.gherkin-lintrc){target=_blank} will be used
- See [Index of problems detected by gherkin-lint](https://github.com/vsiakka/gherkin-lint#available-rules){target=_blank}
[](https://github.com/vsiakka/gherkin-lint){target=_blank}
## Configuration in MegaLinter
-- Enable gherkin-lint by adding `GHERKIN_GHERKIN_LINT` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable gherkin-lint by adding `GHERKIN_GHERKIN_LINT` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable gherkin-lint by adding `GHERKIN_GHERKIN_LINT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable gherkin-lint by adding `GHERKIN_GHERKIN_LINT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `project`: Call the linter from the root of the project | `file` | @@ -31,19 +32,23 @@ description: How to use gherkin-lint (configure, ignore files, ignore errors, he | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling GHERKIN_GHERKIN_LINT and its pre/post commands | None | | GHERKIN_GHERKIN_LINT_CONFIG_FILE | gherkin-lint configuration file nameUse `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` | +| GHERKIN_GHERKIN_LINT_CLI_EXECUTABLE | Override CLI executable | `['gherkin-lint']` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------|:----------------------------------------------|:----------------:|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [dotnet](https://megalinter.io/6.22.2/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 60 |   |
+| | Flavor | Description | Embedded linters | Info |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------|:---------------------------------------------------------|:----------------:|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [c_cpp](https://megalinter.io/7.13.0/flavors/c_cpp/) | Optimized for pure C/C++ projects | 56 |   |
+| | [dotnet](https://megalinter.io/7.13.0/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 63 |   |
+| | [dotnetweb](https://megalinter.io/7.13.0/flavors/dotnetweb/) | Optimized for C, C++, C# or VB based projects with JS/TS | 72 |   |
## Behind the scenes
diff --git a/docs/descriptors/go.md b/docs/descriptors/go.md
index 04f58cfa89b..da0741e10f3 100644
--- a/docs/descriptors/go.md
+++ b/docs/descriptors/go.md
@@ -3,16 +3,16 @@ title: GO linters in MegaLinter
description: golangci-lint, revive are available to analyze GO files in MegaLinter
---
-
+
# GO
## Linters
-| Linter | Additional |
-|----------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [**golangci-lint**](go_golangci_lint.md)
[_GO_GOLANGCI_LINT_](go_golangci_lint.md) | [](https://github.com/golangci/golangci-lint) | -| [**revive**](go_revive.md)
[_GO_REVIVE_](go_revive.md) | [](https://github.com/mgechev/revive)  | +| Linter | Additional | +|----------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [**golangci-lint**](go_golangci_lint.md)
[_GO_GOLANGCI_LINT_](go_golangci_lint.md) | [](https://github.com/golangci/golangci-lint)  | +| [**revive**](go_revive.md)
[_GO_REVIVE_](go_revive.md) | [](https://github.com/mgechev/revive)  | ## Linted files @@ -21,8 +21,10 @@ description: golangci-lint, revive are available to analyze GO files in MegaLint ## 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_PRE_COMMANDS | List of bash commands to run before the linters | None | +| GO_POST_COMMANDS | List of bash commands to run after the linters | None | +| GO_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| GO_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/go_golangci_lint.md b/docs/descriptors/go_golangci_lint.md index 516a56d7b2a..162668dce14 100644 --- a/docs/descriptors/go_golangci_lint.md +++ b/docs/descriptors/go_golangci_lint.md @@ -3,7 +3,7 @@ title: golangci-lint configuration in MegaLinter description: How to use golangci-lint (configure, ignore files, ignore errors, help & version documentations) to analyze GO files --- - +
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 | `list_of_files` | -| 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 nameUse `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` | +- Enable golangci-lint by adding `GO_GOLANGCI_LINT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) +- Disable golangci-lint by adding `GO_GOLANGCI_LINT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) + +- Enable **autofixes** by adding `GO_GOLANGCI_LINT` in [APPLY_FIXES variable](https://megalinter.io/7.13.0/configuration/#apply-fixes) + +| Variable | Description | Default value | +|----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| +| GO_GOLANGCI_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| GO_GOLANGCI_LINT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
Ex: `-s --foo "bar"` | | +| 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling GO_GOLANGCI_LINT and its pre/post commands | None | +| GO_GOLANGCI_LINT_CONFIG_FILE | golangci-lint configuration file nameUse `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` | +| GO_GOLANGCI_LINT_CLI_EXECUTABLE | Override CLI executable | `['golangci-lint']` | ## IDE Integration @@ -64,9 +66,9 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------|:------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [cupcake](https://megalinter.io/6.22.2/flavors/cupcake/) | MegaLinter for the most commonly used languages | 82 |   |
-| | [go](https://megalinter.io/6.22.2/flavors/go/) | Optimized for GO based projects | 50 |   |
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [cupcake](https://megalinter.io/7.13.0/flavors/cupcake/) | MegaLinter for the most commonly used languages | 84 |   |
+| | [go](https://megalinter.io/7.13.0/flavors/go/) | Optimized for GO based projects | 53 |   |
## Behind the scenes
@@ -78,7 +80,10 @@ This linter is available in the following flavours
### How the linting is performed
-- golangci-lint is called once with the list of files as arguments (`list_of_files` CLI lint mode)
+golangci-lint is called once on the whole project directory (`project` CLI lint mode)
+
+- filtering can not be done using MegaLinter configuration variables,it must be done using golangci-lint configuration or ignore file (if existing)
+- `VALIDATE_ALL_CODEBASE: false` doesn't make golangci-lint analyze only updated files
### Example calls
@@ -103,21 +108,18 @@ Usage:
Available Commands:
cache Cache control and information
completion Generate the autocompletion script for the specified shell
- config Config
+ config Config file information
+ custom Build a version of golangci-lint with custom linters
help Help
linters List current linters configuration
run Run the linters
version Version
Flags:
- --color string Use color when printing; can be 'always', 'auto', or 'never' (default "auto")
- -j, --concurrency int Concurrency (default NumCPU) (default 2)
- --cpu-profile-path string Path to CPU profile output file
- -h, --help help for golangci-lint
- --mem-profile-path string Path to memory profile output file
- --trace-path string Path to trace output file
- -v, --verbose verbose output
- --version Print version
+ --color string Use color when printing; can be 'always', 'auto', or 'never' (default "auto")
+ -h, --help Help for a command
+ -v, --verbose Verbose output
+ --version Print version
Use "golangci-lint [command] --help" for more information about a command.
```
diff --git a/docs/descriptors/go_revive.md b/docs/descriptors/go_revive.md
index 5ad30cd61b2..655f3e7d3a3 100644
--- a/docs/descriptors/go_revive.md
+++ b/docs/descriptors/go_revive.md
@@ -3,13 +3,13 @@ title: revive configuration in MegaLinter
description: How to use revive (configure, ignore files, ignore errors, help & version documentations) to analyze GO files
---
-
+
# 
revive
[](https://github.com/mgechev/revive)  [](https://github.com/mgechev/revive/releases) [](https://github.com/mgechev/revive/commits) [](https://github.com/mgechev/revive/graphs/commit-activity/) [](https://github.com/mgechev/revive/graphs/contributors/)
## revive documentation
-- Version in MegaLinter: **1.3.1**
+- Version in MegaLinter: **1.3.7**
- Visit [Official Web Site](https://revive.run/){target=_blank}
- See [How to configure revive rules](https://revive.run/docs#custom-configuration){target=_blank}
- See [Index of problems detected by revive](https://revive.run/r){target=_blank}
@@ -18,12 +18,13 @@ description: How to use revive (configure, ignore files, ignore errors, help & v
## Configuration in MegaLinter
-- Enable revive by adding `GO_REVIVE` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable revive by adding `GO_REVIVE` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable revive by adding `GO_REVIVE` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable revive by adding `GO_REVIVE` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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 | `list_of_files` | @@ -31,10 +32,12 @@ description: How to use revive (configure, ignore files, ignore errors, help & v | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling GO_REVIVE and its pre/post commands | None | | GO_REVIVE_CONFIG_FILE | revive configuration file nameUse `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` | +| GO_REVIVE_CLI_EXECUTABLE | Override CLI executable | `['revive']` | ## IDE Integration @@ -52,9 +55,9 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------|:------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [cupcake](https://megalinter.io/6.22.2/flavors/cupcake/) | MegaLinter for the most commonly used languages | 82 |   |
-| | [go](https://megalinter.io/6.22.2/flavors/go/) | Optimized for GO based projects | 50 |   |
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [cupcake](https://megalinter.io/7.13.0/flavors/cupcake/) | MegaLinter for the most commonly used languages | 84 |   |
+| | [go](https://megalinter.io/7.13.0/flavors/go/) | Optimized for GO based projects | 53 |   |
## Behind the scenes
@@ -93,7 +96,7 @@ Example:
Usage of revive:
-config string
- path to the configuration TOML file, defaults to $HOME/revive.toml, if present (i.e. -config myconf.toml)
+ path to the configuration TOML file, defaults to $XDG_CONFIG_HOME/revive.toml or $HOME/revive.toml, if present (i.e. -config myconf.toml)
-exclude value
list of globs which specify files to be excluded (i.e. -exclude foo/...)
-formatter string
@@ -111,11 +114,10 @@ Usage of revive:
- Dockerfile commands :
```dockerfile
FROM golang:1-alpine as revive
-## The golang image used as a builder is a temporary workaround
+## The golang image used as a builder is a temporary workaround (https://github.com/mgechev/revive/issues/787)
## for the released revive binaries not returning version numbers (devel).
## The install command should then be what is commented in the go.megalinter-descriptor.yml
RUN GOBIN=/usr/bin go install github.com/mgechev/revive@latest
-
COPY --link --from=revive /usr/bin/revive /usr/bin/revive
```
diff --git a/docs/descriptors/graphql.md b/docs/descriptors/graphql.md
index b417322f4b4..6c44e349cbd 100644
--- a/docs/descriptors/graphql.md
+++ b/docs/descriptors/graphql.md
@@ -3,7 +3,7 @@ title: GRAPHQL linters in MegaLinter
description: graphql-schema-linter is available to analyze GRAPHQL files in MegaLinter
---
-
+
# GRAPHQL
@@ -20,8 +20,10 @@ description: graphql-schema-linter is available to analyze GRAPHQL files in Mega
## 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_PRE_COMMANDS | List of bash commands to run before the linters | None |
+| GRAPHQL_POST_COMMANDS | List of bash commands to run after the linters | None |
+| 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 fb554b3f24f..7a5daeb236f 100644
--- a/docs/descriptors/graphql_graphql_schema_linter.md
+++ b/docs/descriptors/graphql_graphql_schema_linter.md
@@ -3,7 +3,7 @@ title: graphql-schema-linter configuration in MegaLinter
description: How to use graphql-schema-linter (configure, ignore files, ignore errors, help & version documentations) to analyze GRAPHQL files
---
-
+
# graphql-schema-linter
[](https://github.com/cjoudrey/graphql-schema-linter) [](https://github.com/cjoudrey/graphql-schema-linter/releases) [](https://github.com/cjoudrey/graphql-schema-linter/commits) [](https://github.com/cjoudrey/graphql-schema-linter/graphs/commit-activity/) [](https://github.com/cjoudrey/graphql-schema-linter/graphs/contributors/)
@@ -19,12 +19,13 @@ description: How to use graphql-schema-linter (configure, ignore files, ignore e
## Configuration in MegaLinter
-- Enable graphql-schema-linter by adding `GRAPHQL_GRAPHQL_SCHEMA_LINTER` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable graphql-schema-linter by adding `GRAPHQL_GRAPHQL_SCHEMA_LINTER` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable graphql-schema-linter by adding `GRAPHQL_GRAPHQL_SCHEMA_LINTER` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable graphql-schema-linter by adding `GRAPHQL_GRAPHQL_SCHEMA_LINTER` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `project`: Call the linter from the root of the project | `file` | @@ -32,31 +33,35 @@ description: How to use graphql-schema-linter (configure, ignore files, ignore e | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling GRAPHQL_GRAPHQL_SCHEMA_LINTER and its pre/post commands | None | | GRAPHQL_GRAPHQL_SCHEMA_LINTER_CONFIG_FILE | graphql-schema-linter configuration file nameUse `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` | +| GRAPHQL_GRAPHQL_SCHEMA_LINTER_CLI_EXECUTABLE | Override CLI executable | `['graphql-schema-linter']` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [cupcake](https://megalinter.io/6.22.2/flavors/cupcake/) | MegaLinter for the most commonly used languages | 82 |   |
-| | [documentation](https://megalinter.io/6.22.2/flavors/documentation/) | MegaLinter for documentation projects | 48 |   |
-| | [dotnet](https://megalinter.io/6.22.2/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 60 |   |
-| | [go](https://megalinter.io/6.22.2/flavors/go/) | Optimized for GO based projects | 50 |   |
-| | [java](https://megalinter.io/6.22.2/flavors/java/) | Optimized for JAVA based projects | 51 |   |
-| | [javascript](https://megalinter.io/6.22.2/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 57 |   |
-| | [php](https://megalinter.io/6.22.2/flavors/php/) | Optimized for PHP based projects | 51 |   |
-| | [python](https://megalinter.io/6.22.2/flavors/python/) | Optimized for PYTHON based projects | 59 |   |
-| | [ruby](https://megalinter.io/6.22.2/flavors/ruby/) | Optimized for RUBY based projects | 48 |   |
-| | [rust](https://megalinter.io/6.22.2/flavors/rust/) | Optimized for RUST based projects | 48 |   |
-| | [salesforce](https://megalinter.io/6.22.2/flavors/salesforce/) | Optimized for Salesforce based projects | 51 |   |
-| | [swift](https://megalinter.io/6.22.2/flavors/swift/) | Optimized for SWIFT based projects | 48 |   |
-| | [terraform](https://megalinter.io/6.22.2/flavors/terraform/) | Optimized for TERRAFORM based projects | 53 |   |
+| | Flavor | Description | Embedded linters | Info |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:---------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [c_cpp](https://megalinter.io/7.13.0/flavors/c_cpp/) | Optimized for pure C/C++ projects | 56 |   |
+| | [cupcake](https://megalinter.io/7.13.0/flavors/cupcake/) | MegaLinter for the most commonly used languages | 84 |   |
+| | [documentation](https://megalinter.io/7.13.0/flavors/documentation/) | MegaLinter for documentation projects | 51 |   |
+| | [dotnet](https://megalinter.io/7.13.0/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 63 |   |
+| | [dotnetweb](https://megalinter.io/7.13.0/flavors/dotnetweb/) | Optimized for C, C++, C# or VB based projects with JS/TS | 72 |   |
+| | [go](https://megalinter.io/7.13.0/flavors/go/) | Optimized for GO based projects | 53 |   |
+| | [java](https://megalinter.io/7.13.0/flavors/java/) | Optimized for JAVA based projects | 54 |   |
+| | [javascript](https://megalinter.io/7.13.0/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 61 |   |
+| | [php](https://megalinter.io/7.13.0/flavors/php/) | Optimized for PHP based projects | 56 |   |
+| | [python](https://megalinter.io/7.13.0/flavors/python/) | Optimized for PYTHON based projects | 64 |   |
+| | [ruby](https://megalinter.io/7.13.0/flavors/ruby/) | Optimized for RUBY based projects | 52 |   |
+| | [rust](https://megalinter.io/7.13.0/flavors/rust/) | Optimized for RUST based projects | 52 |   |
+| | [salesforce](https://megalinter.io/7.13.0/flavors/salesforce/) | Optimized for Salesforce based projects | 56 |   |
+| | [swift](https://megalinter.io/7.13.0/flavors/swift/) | Optimized for SWIFT based projects | 52 |   |
+| | [terraform](https://megalinter.io/7.13.0/flavors/terraform/) | Optimized for TERRAFORM based projects | 56 |   |
## Behind the scenes
diff --git a/docs/descriptors/groovy.md b/docs/descriptors/groovy.md
index 4d344331c6a..45e7f9b7949 100644
--- a/docs/descriptors/groovy.md
+++ b/docs/descriptors/groovy.md
@@ -3,7 +3,7 @@ title: GROOVY linters in MegaLinter
description: npm-groovy-lint is available to analyze GROOVY files in MegaLinter
---
-
+
# GROOVY
@@ -26,8 +26,10 @@ description: npm-groovy-lint is available to analyze GROOVY files in MegaLinter
## 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_PRE_COMMANDS | List of bash commands to run before the linters | None |
+| GROOVY_POST_COMMANDS | List of bash commands to run after the linters | None |
+| 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 8a6ca32d68e..8c2498e83a8 100644
--- a/docs/descriptors/groovy_npm_groovy_lint.md
+++ b/docs/descriptors/groovy_npm_groovy_lint.md
@@ -3,16 +3,16 @@ title: npm-groovy-lint configuration in MegaLinter
description: How to use npm-groovy-lint (configure, ignore files, ignore errors, help & version documentations) to analyze GROOVY files
---
-
+
# 
npm-groovy-lint
[](https://github.com/nvuillam/npm-groovy-lint)   [](https://github.com/nvuillam/npm-groovy-lint/releases) [](https://github.com/nvuillam/npm-groovy-lint/commits) [](https://github.com/nvuillam/npm-groovy-lint/graphs/commit-activity/) [](https://github.com/nvuillam/npm-groovy-lint/graphs/contributors/)
## npm-groovy-lint documentation
-- Version in MegaLinter: **11.1.1**
+- Version in MegaLinter: **14.6.0**
- Visit [Official Web Site](https://nvuillam.github.io/npm-groovy-lint/){target=_blank}
- See [How to configure npm-groovy-lint rules](https://github.com/nvuillam/npm-groovy-lint#configuration){target=_blank}
- - If custom `.groovylintrc.json` config file is not found, [.groovylintrc.json](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.groovylintrc.json){target=_blank} will be used
+ - If custom `.groovylintrc.json` config file isn't found, [.groovylintrc.json](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.groovylintrc.json){target=_blank} will be used
- See [How to disable npm-groovy-lint rules in files](https://github.com/nvuillam/npm-groovy-lint#disabling-rules-in-source){target=_blank}
- See [Index of problems detected by npm-groovy-lint](https://codenarc.org/codenarc-rule-index.html){target=_blank}
@@ -20,14 +20,15 @@ description: How to use npm-groovy-lint (configure, ignore files, ignore errors,
## Configuration in MegaLinter
-- Enable npm-groovy-lint by adding `GROOVY_NPM_GROOVY_LINT` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable npm-groovy-lint by adding `GROOVY_NPM_GROOVY_LINT` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable npm-groovy-lint by adding `GROOVY_NPM_GROOVY_LINT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable npm-groovy-lint by adding `GROOVY_NPM_GROOVY_LINT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
-- Enable **auto-fixes** by adding `GROOVY_NPM_GROOVY_LINT` in [APPLY_FIXES variable](https://megalinter.io/6.22.2/configuration/#apply-fixes)
+- Enable **autofixes** by adding `GROOVY_NPM_GROOVY_LINT` in [APPLY_FIXES variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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 | `list_of_files` | @@ -35,10 +36,12 @@ description: How to use npm-groovy-lint (configure, ignore files, ignore errors, | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling GROOVY_NPM_GROOVY_LINT and its pre/post commands | None | | GROOVY_NPM_GROOVY_LINT_CONFIG_FILE | npm-groovy-lint configuration file nameUse `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` | +| GROOVY_NPM_GROOVY_LINT_CLI_EXECUTABLE | Override CLI executable | `['npm-groovy-lint']` | ## IDE Integration @@ -54,21 +57,23 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [ci_light](https://megalinter.io/6.22.2/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 20 |   |
-| | [cupcake](https://megalinter.io/6.22.2/flavors/cupcake/) | MegaLinter for the most commonly used languages | 82 |   |
-| | [documentation](https://megalinter.io/6.22.2/flavors/documentation/) | MegaLinter for documentation projects | 48 |   |
-| | [dotnet](https://megalinter.io/6.22.2/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 60 |   |
-| | [go](https://megalinter.io/6.22.2/flavors/go/) | Optimized for GO based projects | 50 |   |
-| | [java](https://megalinter.io/6.22.2/flavors/java/) | Optimized for JAVA based projects | 51 |   |
-| | [javascript](https://megalinter.io/6.22.2/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 57 |   |
-| | [php](https://megalinter.io/6.22.2/flavors/php/) | Optimized for PHP based projects | 51 |   |
-| | [python](https://megalinter.io/6.22.2/flavors/python/) | Optimized for PYTHON based projects | 59 |   |
-| | [ruby](https://megalinter.io/6.22.2/flavors/ruby/) | Optimized for RUBY based projects | 48 |   |
-| | [rust](https://megalinter.io/6.22.2/flavors/rust/) | Optimized for RUST based projects | 48 |   |
-| | [salesforce](https://megalinter.io/6.22.2/flavors/salesforce/) | Optimized for Salesforce based projects | 51 |   |
-| | [swift](https://megalinter.io/6.22.2/flavors/swift/) | Optimized for SWIFT based projects | 48 |   |
-| | [terraform](https://megalinter.io/6.22.2/flavors/terraform/) | Optimized for TERRAFORM based projects | 53 |   |
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [c_cpp](https://megalinter.io/7.13.0/flavors/c_cpp/) | Optimized for pure C/C++ projects | 56 |   |
+| | [ci_light](https://megalinter.io/7.13.0/flavors/ci_light/) | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 21 |   |
+| | [cupcake](https://megalinter.io/7.13.0/flavors/cupcake/) | MegaLinter for the most commonly used languages | 84 |   |
+| | [documentation](https://megalinter.io/7.13.0/flavors/documentation/) | MegaLinter for documentation projects | 51 |   |
+| | [dotnet](https://megalinter.io/7.13.0/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 63 |   |
+| | [dotnetweb](https://megalinter.io/7.13.0/flavors/dotnetweb/) | Optimized for C, C++, C# or VB based projects with JS/TS | 72 |   |
+| | [go](https://megalinter.io/7.13.0/flavors/go/) | Optimized for GO based projects | 53 |   |
+| | [java](https://megalinter.io/7.13.0/flavors/java/) | Optimized for JAVA based projects | 54 |   |
+| | [javascript](https://megalinter.io/7.13.0/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 61 |   |
+| | [php](https://megalinter.io/7.13.0/flavors/php/) | Optimized for PHP based projects | 56 |   |
+| | [python](https://megalinter.io/7.13.0/flavors/python/) | Optimized for PYTHON based projects | 64 |   |
+| | [ruby](https://megalinter.io/7.13.0/flavors/ruby/) | Optimized for RUBY based projects | 52 |   |
+| | [rust](https://megalinter.io/7.13.0/flavors/rust/) | Optimized for RUST based projects | 52 |   |
+| | [salesforce](https://megalinter.io/7.13.0/flavors/salesforce/) | Optimized for Salesforce based projects | 56 |   |
+| | [swift](https://megalinter.io/7.13.0/flavors/swift/) | Optimized for SWIFT based projects | 52 |   |
+| | [terraform](https://megalinter.io/7.13.0/flavors/terraform/) | Optimized for TERRAFORM based projects | 56 |   |
## Behind the scenes
@@ -141,7 +146,12 @@ Note: command-line arguments have priority on config file properties - default:
### Installation on mega-linter Docker image
+- Dockerfile commands :
+```dockerfile
+ENV JAVA_HOME_17=/usr/lib/jvm/java-17-openjdk
+```
+
- APK packages (Linux):
- - [openjdk11](https://pkgs.alpinelinux.org/packages?branch=edge&name=openjdk11)
+ - [openjdk17](https://pkgs.alpinelinux.org/packages?branch=edge&name=openjdk17)
- NPM packages (node.js):
- [npm-groovy-lint](https://www.npmjs.com/package/npm-groovy-lint)
diff --git a/docs/descriptors/html.md b/docs/descriptors/html.md
index 38d89087c04..5ec31a217b5 100644
--- a/docs/descriptors/html.md
+++ b/docs/descriptors/html.md
@@ -3,7 +3,7 @@ title: HTML linters in MegaLinter
description: djlint, htmlhint are available to analyze HTML files in MegaLinter
---
-
+
# HTML
@@ -22,8 +22,10 @@ description: djlint, htmlhint are available to analyze HTML files in MegaLinter
## 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_PRE_COMMANDS | List of bash commands to run before the linters | None |
+| HTML_POST_COMMANDS | List of bash commands to run after the linters | None |
+| HTML_FILTER_REGEX_INCLUDE | Custom regex including filter | |
+| HTML_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | |
diff --git a/docs/descriptors/html_djlint.md b/docs/descriptors/html_djlint.md
index 403f968d26b..0fa67800b6d 100644
--- a/docs/descriptors/html_djlint.md
+++ b/docs/descriptors/html_djlint.md
@@ -3,7 +3,7 @@ title: djlint configuration in MegaLinter
description: How to use djlint (configure, ignore files, ignore errors, help & version documentations) to analyze HTML files
---
-
+
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
- `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` | +- Enable dotenv-linter by adding `ENV_DOTENV_LINTER` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) +- Disable dotenv-linter by adding `ENV_DOTENV_LINTER` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) + +- Enable **autofixes** by adding `ENV_DOTENV_LINTER` in [APPLY_FIXES variable](https://megalinter.io/7.13.0/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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling ENV_DOTENV_LINTER and its pre/post commands | 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` | +| ENV_DOTENV_LINTER_CLI_EXECUTABLE | Override CLI executable | `['dotenv-linter']` | ## MegaLinter Flavours @@ -47,21 +50,23 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| Ex: `-s --foo "bar"` | | +| GHERKIN_GHERKIN_LINT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `project`: Call the linter from the root of the project | `file` | @@ -31,19 +32,23 @@ description: How to use gherkin-lint (configure, ignore files, ignore errors, he | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling GHERKIN_GHERKIN_LINT and its pre/post commands | None | | GHERKIN_GHERKIN_LINT_CONFIG_FILE | gherkin-lint configuration file nameUse `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` | +| GHERKIN_GHERKIN_LINT_CLI_EXECUTABLE | Override CLI executable | `['gherkin-lint']` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------|:----------------------------------------------|:----------------:|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| [_GO_GOLANGCI_LINT_](go_golangci_lint.md) | [](https://github.com/golangci/golangci-lint) | -| [**revive**](go_revive.md)
[_GO_REVIVE_](go_revive.md) | [](https://github.com/mgechev/revive)  | +| Linter | Additional | +|----------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [**golangci-lint**](go_golangci_lint.md)
[_GO_GOLANGCI_LINT_](go_golangci_lint.md) | [](https://github.com/golangci/golangci-lint)  | +| [**revive**](go_revive.md)
[_GO_REVIVE_](go_revive.md) | [](https://github.com/mgechev/revive)  | ## Linted files @@ -21,8 +21,10 @@ description: golangci-lint, revive are available to analyze GO files in MegaLint ## 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_PRE_COMMANDS | List of bash commands to run before the linters | None | +| GO_POST_COMMANDS | List of bash commands to run after the linters | None | +| GO_FILTER_REGEX_INCLUDE | Custom regex including filter | | +| GO_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | | diff --git a/docs/descriptors/go_golangci_lint.md b/docs/descriptors/go_golangci_lint.md index 516a56d7b2a..162668dce14 100644 --- a/docs/descriptors/go_golangci_lint.md +++ b/docs/descriptors/go_golangci_lint.md @@ -3,7 +3,7 @@ title: golangci-lint configuration in MegaLinter description: How to use golangci-lint (configure, ignore files, ignore errors, help & version documentations) to analyze GO files --- - +
@@ -11,14 +11,14 @@ description: How to use golangci-lint (configure, ignore files, ignore errors, h
-[](https://github.com/golangci/golangci-lint) [](https://github.com/golangci/golangci-lint/releases) [](https://github.com/golangci/golangci-lint/commits) [](https://github.com/golangci/golangci-lint/graphs/commit-activity/) [](https://github.com/golangci/golangci-lint/graphs/contributors/)
+[](https://github.com/golangci/golangci-lint)  [](https://github.com/golangci/golangci-lint/releases) [](https://github.com/golangci/golangci-lint/commits) [](https://github.com/golangci/golangci-lint/graphs/commit-activity/) [](https://github.com/golangci/golangci-lint/graphs/contributors/)
## golangci-lint documentation
-- Version in MegaLinter: **1.52.2**
+- Version in MegaLinter: **1.59.1**
- Visit [Official Web Site](https://golangci-lint.run/){target=_blank}
- See [How to configure golangci-lint rules](https://golangci-lint.run/usage/configuration/#config-file){target=_blank}
- - If custom `.golangci.yml` config file is not found, [.golangci.yml](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.golangci.yml){target=_blank} will be used
+ - If custom `.golangci.yml` config file isn't found, [.golangci.yml](https://github.com/oxsecurity/megalinter/tree/main/TEMPLATES/.golangci.yml){target=_blank} will be used
- See [How to disable golangci-lint rules in files](https://golangci-lint.run/usage/false-positives/#nolint){target=_blank}
- See [Index of problems detected by golangci-lint](https://golangci-lint.run/usage/linters/){target=_blank}
@@ -26,23 +26,25 @@ description: How to use golangci-lint (configure, ignore files, ignore errors, h
## Configuration in MegaLinter
-- Enable golangci-lint by adding `GO_GOLANGCI_LINT` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable golangci-lint by adding `GO_GOLANGCI_LINT` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-
-| Variable | Description | Default value |
-|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
-| GO_GOLANGCI_LINT_ARGUMENTS | User custom arguments to add in linter CLI callEx: `-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 | `list_of_files` | -| 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 nameUse `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` | +- Enable golangci-lint by adding `GO_GOLANGCI_LINT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) +- Disable golangci-lint by adding `GO_GOLANGCI_LINT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation) + +- Enable **autofixes** by adding `GO_GOLANGCI_LINT` in [APPLY_FIXES variable](https://megalinter.io/7.13.0/configuration/#apply-fixes) + +| Variable | Description | Default value | +|----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------| +| GO_GOLANGCI_LINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| GO_GOLANGCI_LINT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
Ex: `-s --foo "bar"` | | +| 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling GO_GOLANGCI_LINT and its pre/post commands | None | +| GO_GOLANGCI_LINT_CONFIG_FILE | golangci-lint configuration file nameUse `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` | +| GO_GOLANGCI_LINT_CLI_EXECUTABLE | Override CLI executable | `['golangci-lint']` | ## IDE Integration @@ -64,9 +66,9 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------|:------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| revive
[](https://github.com/mgechev/revive)  [](https://github.com/mgechev/revive/releases) [](https://github.com/mgechev/revive/commits) [](https://github.com/mgechev/revive/graphs/commit-activity/) [](https://github.com/mgechev/revive/graphs/contributors/)
## revive documentation
-- Version in MegaLinter: **1.3.1**
+- Version in MegaLinter: **1.3.7**
- Visit [Official Web Site](https://revive.run/){target=_blank}
- See [How to configure revive rules](https://revive.run/docs#custom-configuration){target=_blank}
- See [Index of problems detected by revive](https://revive.run/r){target=_blank}
@@ -18,12 +18,13 @@ description: How to use revive (configure, ignore files, ignore errors, help & v
## Configuration in MegaLinter
-- Enable revive by adding `GO_REVIVE` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable revive by adding `GO_REVIVE` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable revive by adding `GO_REVIVE` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable revive by adding `GO_REVIVE` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
| Variable | Description | Default value |
|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
| GO_REVIVE_ARGUMENTS | User custom arguments to add in linter CLI callEx: `-s --foo "bar"` | | +| GO_REVIVE_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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 | `list_of_files` | @@ -31,10 +32,12 @@ description: How to use revive (configure, ignore files, ignore errors, help & v | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling GO_REVIVE and its pre/post commands | None | | GO_REVIVE_CONFIG_FILE | revive configuration file nameUse `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` | +| GO_REVIVE_CLI_EXECUTABLE | Override CLI executable | `['revive']` | ## IDE Integration @@ -52,9 +55,9 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------|:------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| Ex: `-s --foo "bar"` | | +| GRAPHQL_GRAPHQL_SCHEMA_LINTER_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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
- `project`: Call the linter from the root of the project | `file` | @@ -32,31 +33,35 @@ description: How to use graphql-schema-linter (configure, ignore files, ignore e | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling GRAPHQL_GRAPHQL_SCHEMA_LINTER and its pre/post commands | None | | GRAPHQL_GRAPHQL_SCHEMA_LINTER_CONFIG_FILE | graphql-schema-linter configuration file nameUse `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` | +| GRAPHQL_GRAPHQL_SCHEMA_LINTER_CLI_EXECUTABLE | Override CLI executable | `['graphql-schema-linter']` | ## MegaLinter Flavours This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| Ex: `-s --foo "bar"` | | +| GROOVY_NPM_GROOVY_LINT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
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 | `list_of_files` | @@ -35,10 +36,12 @@ description: How to use npm-groovy-lint (configure, ignore files, ignore errors, | 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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling GROOVY_NPM_GROOVY_LINT and its pre/post commands | None | | GROOVY_NPM_GROOVY_LINT_CONFIG_FILE | npm-groovy-lint configuration file nameUse `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` | +| GROOVY_NPM_GROOVY_LINT_CLI_EXECUTABLE | Override CLI executable | `['npm-groovy-lint']` | ## IDE Integration @@ -54,21 +57,23 @@ This linter is available in the following flavours | | Flavor | Description | Embedded linters | Info | |:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:-----------------------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+|
@@ -23,11 +23,11 @@ DjLint can analyse multiple formats of HTML:
- golang
- angular
-For example, define `HTML_DJLINT_HTMLHINT_ARGUMENTS: ["--profile", "django"]` to select django format
+For example, define `HTML_DJLINT_ARGUMENTS: ["--profile", "django"]` to select django format
## djlint documentation
-- Version in MegaLinter: **1.19.16**
+- Version in MegaLinter: **1.34.1**
- Visit [Official Web Site](https://djlint.com/){target=_blank}
- See [How to configure djlint rules](https://djlint.com/docs/configuration/){target=_blank}
- See [How to disable djlint rules in files](https://djlint.com/docs/ignoring-code/){target=_blank}
@@ -37,12 +37,13 @@ For example, define `HTML_DJLINT_HTMLHINT_ARGUMENTS: ["--profile", "django"]` to
## Configuration in MegaLinter
-- Enable djlint by adding `HTML_DJLINT` in [ENABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
-- Disable djlint by adding `HTML_DJLINT` in [DISABLE_LINTERS variable](https://megalinter.io/6.22.2/configuration/#activation-and-deactivation)
+- Enable djlint by adding `HTML_DJLINT` in [ENABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
+- Disable djlint by adding `HTML_DJLINT` in [DISABLE_LINTERS variable](https://megalinter.io/7.13.0/configuration/#activation-and-deactivation)
| Variable | Description | Default value |
|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|
| HTML_DJLINT_ARGUMENTS | User custom arguments to add in linter CLI call
Ex: `-s --foo "bar"` | | +| HTML_DJLINT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
Ex: `-s --foo "bar"` | | | HTML_DJLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | | HTML_DJLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | | HTML_DJLINT_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` | @@ -50,8 +51,10 @@ For example, define `HTML_DJLINT_HTMLHINT_ARGUMENTS: ["--profile", "django"]` to | HTML_DJLINT_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_DJLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | | HTML_DJLINT_POST_COMMANDS | List of bash commands to run after the linter | None | +| HTML_DJLINT_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling HTML_DJLINT and its pre/post commands | None | | HTML_DJLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | | HTML_DJLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| HTML_DJLINT_CLI_EXECUTABLE | Override CLI executable | `['djlint']` | ## IDE Integration @@ -66,22 +69,24 @@ Use djlint in your favorite IDE to catch errors before MegaLinter ! This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| | [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [cupcake](https://megalinter.io/6.22.2/flavors/cupcake/) | MegaLinter for the most commonly used languages | 82 |   |
-| | [documentation](https://megalinter.io/6.22.2/flavors/documentation/) | MegaLinter for documentation projects | 48 |   |
-| | [dotnet](https://megalinter.io/6.22.2/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 60 |   |
-| | [go](https://megalinter.io/6.22.2/flavors/go/) | Optimized for GO based projects | 50 |   |
-| | [java](https://megalinter.io/6.22.2/flavors/java/) | Optimized for JAVA based projects | 51 |   |
-| | [javascript](https://megalinter.io/6.22.2/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 57 |   |
-| | [php](https://megalinter.io/6.22.2/flavors/php/) | Optimized for PHP based projects | 51 |   |
-| | [python](https://megalinter.io/6.22.2/flavors/python/) | Optimized for PYTHON based projects | 59 |   |
-| | [ruby](https://megalinter.io/6.22.2/flavors/ruby/) | Optimized for RUBY based projects | 48 |   |
-| | [rust](https://megalinter.io/6.22.2/flavors/rust/) | Optimized for RUST based projects | 48 |   |
-| | [salesforce](https://megalinter.io/6.22.2/flavors/salesforce/) | Optimized for Salesforce based projects | 51 |   |
-| | [swift](https://megalinter.io/6.22.2/flavors/swift/) | Optimized for SWIFT based projects | 48 |   |
-| | [terraform](https://megalinter.io/6.22.2/flavors/terraform/) | Optimized for TERRAFORM based projects | 53 |   |
+| | Flavor | Description | Embedded linters | Info |
+|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:---------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+| | [c_cpp](https://megalinter.io/7.13.0/flavors/c_cpp/) | Optimized for pure C/C++ projects | 56 |   |
+| | [cupcake](https://megalinter.io/7.13.0/flavors/cupcake/) | MegaLinter for the most commonly used languages | 84 |   |
+| | [documentation](https://megalinter.io/7.13.0/flavors/documentation/) | MegaLinter for documentation projects | 51 |   |
+| | [dotnet](https://megalinter.io/7.13.0/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 63 |   |
+| | [dotnetweb](https://megalinter.io/7.13.0/flavors/dotnetweb/) | Optimized for C, C++, C# or VB based projects with JS/TS | 72 |   |
+| | [go](https://megalinter.io/7.13.0/flavors/go/) | Optimized for GO based projects | 53 |   |
+| | [java](https://megalinter.io/7.13.0/flavors/java/) | Optimized for JAVA based projects | 54 |   |
+| | [javascript](https://megalinter.io/7.13.0/flavors/javascript/) | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 61 |   |
+| | [php](https://megalinter.io/7.13.0/flavors/php/) | Optimized for PHP based projects | 56 |   |
+| | [python](https://megalinter.io/7.13.0/flavors/python/) | Optimized for PYTHON based projects | 64 |   |
+| | [ruby](https://megalinter.io/7.13.0/flavors/ruby/) | Optimized for RUBY based projects | 52 |   |
+| | [rust](https://megalinter.io/7.13.0/flavors/rust/) | Optimized for RUST based projects | 52 |   |
+| | [salesforce](https://megalinter.io/7.13.0/flavors/salesforce/) | Optimized for Salesforce based projects | 56 |   |
+| | [swift](https://megalinter.io/7.13.0/flavors/swift/) | Optimized for SWIFT based projects | 52 |   |
+| | [terraform](https://megalinter.io/7.13.0/flavors/terraform/) | Optimized for TERRAFORM based projects | 56 |   |
## Behind the scenes
@@ -110,30 +115,63 @@ Usage: djlint [OPTIONS] SRC ...
djLint · HTML template linter and formatter.
Options:
- --version Show the version and exit.
- -e, --extension TEXT File extension to check [default: html]
- -i, --ignore TEXT Codes to ignore. ex: "H014,H017"
- --reformat Reformat the file(s).
- --check Check formatting on the file(s).
- --indent INTEGER Indent spacing. [default: 4]
- --quiet Do not print diff when reformatting.
- --profile TEXT Enable defaults by template language. ops: django,
- jinja, nunjucks, handlebars, golang, angular, html
- [default: html]
- --require-pragma Only format or lint files that starts with a
- comment with the text 'djlint:on'
- --lint Lint for common issues. [default option]
- --use-gitignore Use .gitignore file to extend excludes.
- --warn Return errors as warnings.
- --preserve-leading-space Attempt to preserve leading space on text.
- --preserve-blank-lines Attempt to preserve blank lines.
- --format-css Also format contents of
Ex: `-s --foo "bar"` | | +| HTML_DJLINT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter
Ex: `-s --foo "bar"` | | | HTML_DJLINT_FILTER_REGEX_INCLUDE | Custom regex including filter
Ex: `(src\|lib)` | Include every file | | HTML_DJLINT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter
Ex: `(test\|examples)` | Exclude no file | | HTML_DJLINT_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` | @@ -50,8 +51,10 @@ For example, define `HTML_DJLINT_HTMLHINT_ARGUMENTS: ["--profile", "django"]` to | HTML_DJLINT_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_DJLINT_PRE_COMMANDS | List of bash commands to run before the linter | None | | HTML_DJLINT_POST_COMMANDS | List of bash commands to run after the linter | None | +| HTML_DJLINT_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling HTML_DJLINT and its pre/post commands | None | | HTML_DJLINT_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` | | HTML_DJLINT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` | +| HTML_DJLINT_CLI_EXECUTABLE | Override CLI executable | `['djlint']` | ## IDE Integration @@ -66,22 +69,24 @@ Use djlint in your favorite IDE to catch errors before MegaLinter ! This linter is available in the following flavours -| | Flavor | Description | Embedded linters | Info | -|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------|:------------------------------------------------------|:----------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -|
| [all](https://megalinter.io/6.22.2/supported-linters/) | Default MegaLinter Flavor | 114 |   |
-| | [all](https://megalinter.io/7.13.0/supported-linters/) | Default MegaLinter Flavor | 125 |   |
+|