Skip to content

Commit

Permalink
[MegaLinter] Apply linters fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@nvuillam @github-actions
nvuillam authored and github-actions[bot] committed Dec 26, 2022
1 parent d261cc0 commit 4dfa350
Show file tree
Hide file tree
Showing 87 changed files with 3,178 additions and 3,172 deletions.
274 changes: 137 additions & 137 deletions README.md
View file

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions docs/descriptors/powershell.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ description: powershell, powershell_formatter are available to analyze POWERSHEL

## Linters

| Linter | Configuration key | Status |
| ------ | ----------------- | ------ |
| [powershell](powershell_powershell.md) | [POWERSHELL](powershell_powershell.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/PowerShell/PSScriptAnalyzer)](https://github.com/PowerShell/PSScriptAnalyzer/commits) |
| Linter | Configuration key | Status |
|------------------------------------------------------------|--------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| [powershell](powershell_powershell.md) | [POWERSHELL](powershell_powershell.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/PowerShell/PSScriptAnalyzer)](https://github.com/PowerShell/PSScriptAnalyzer/commits) |
| [powershell_formatter](powershell_powershell_formatter.md) | [POWERSHELL](powershell_powershell_formatter.md) | [![GitHub last commit](https://img.shields.io/github/last-commit/PowerShell/PSScriptAnalyzer)](https://github.com/PowerShell/PSScriptAnalyzer/commits) |

## Linted files
Expand All @@ -27,10 +27,10 @@ description: powershell, powershell_formatter are available to analyze POWERSHEL

## Configuration in MegaLinter

| Variable | Description | Default value |
| ----------------- | -------------- | -------------- |
| POWERSHELL_FILTER_REGEX_INCLUDE | Custom regex including filter | |
| POWERSHELL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | |
| Variable | Description | Default value |
|---------------------------------|-------------------------------|---------------|
| POWERSHELL_FILTER_REGEX_INCLUDE | Custom regex including filter | |
| POWERSHELL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter | |


## Behind the scenes
Expand Down
40 changes: 20 additions & 20 deletions docs/descriptors/powershell_powershell.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,37 +23,37 @@ description: How to use powershell (configure, ignore files, ignore errors, help

- Enable **auto-fixes** by adding `POWERSHELL_POWERSHELL` in [APPLY_FIXES variable](https://megalinter.io/beta/configuration/#apply-fixes)

| Variable | Description | Default value |
| ----------------- | -------------- | -------------- |
| POWERSHELL_POWERSHELL_ARGUMENTS | User custom arguments to add in linter CLI call<br/>Ex: `-s --foo "bar"` | |
| POWERSHELL_POWERSHELL_FILTER_REGEX_INCLUDE | Custom regex including filter<br/>Ex: `(src\|lib)` | Include every file |
| POWERSHELL_POWERSHELL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter<br/>Ex: `(test\|examples)` | Exclude no file |
| POWERSHELL_POWERSHELL_CLI_LINT_MODE | Override default CLI lint mode<br/>- `file`: Calls the linter for each file<br/>- `list_of_files`: Call the linter with the list of files as argument<br/>- `project`: Call the linter from the root of the project | `file` |
| POWERSHELL_POWERSHELL_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files<br/>Ex: `[".py", ""]` | `[".ps1", ".psm1", ".psd1", ".ps1xml", ".pssc", ".psrc", ".cdxml"]` |
| POWERSHELL_POWERSHELL_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files<br/>Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file |
| POWERSHELL_POWERSHELL_PRE_COMMANDS | List of bash commands to run before the linter| None |
| POWERSHELL_POWERSHELL_POST_COMMANDS | List of bash commands to run after the linter| None |
| POWERSHELL_POWERSHELL_CONFIG_FILE | powershell configuration file name</br>Use `LINTER_DEFAULT` to let the linter find it | `.powershell-psscriptanalyzer.psd1` |
| POWERSHELL_POWERSHELL_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules |
| POWERSHELL_POWERSHELL_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` |
| POWERSHELL_POWERSHELL_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` |
| Variable | Description | Default value |
|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| POWERSHELL_POWERSHELL_ARGUMENTS | User custom arguments to add in linter CLI call<br/>Ex: `-s --foo "bar"` | |
| POWERSHELL_POWERSHELL_FILTER_REGEX_INCLUDE | Custom regex including filter<br/>Ex: `(src\|lib)` | Include every file |
| POWERSHELL_POWERSHELL_FILTER_REGEX_EXCLUDE | Custom regex excluding filter<br/>Ex: `(test\|examples)` | Exclude no file |
| POWERSHELL_POWERSHELL_CLI_LINT_MODE | Override default CLI lint mode<br/>- `file`: Calls the linter for each file<br/>- `list_of_files`: Call the linter with the list of files as argument<br/>- `project`: Call the linter from the root of the project | `file` |
| POWERSHELL_POWERSHELL_FILE_EXTENSIONS | Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files<br/>Ex: `[".py", ""]` | `[".ps1", ".psm1", ".psd1", ".ps1xml", ".pssc", ".psrc", ".cdxml"]` |
| POWERSHELL_POWERSHELL_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files<br/>Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]` | Include every file |
| POWERSHELL_POWERSHELL_PRE_COMMANDS | List of bash commands to run before the linter | None |
| POWERSHELL_POWERSHELL_POST_COMMANDS | List of bash commands to run after the linter | None |
| POWERSHELL_POWERSHELL_CONFIG_FILE | powershell configuration file name</br>Use `LINTER_DEFAULT` to let the linter find it | `.powershell-psscriptanalyzer.psd1` |
| POWERSHELL_POWERSHELL_RULES_PATH | Path where to find linter configuration file | Workspace folder, then MegaLinter default rules |
| POWERSHELL_POWERSHELL_DISABLE_ERRORS | Run linter but consider errors as warnings | `false` |
| POWERSHELL_POWERSHELL_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | `0` |

## IDE Integration

Use powershell in your favorite IDE to catch errors before MegaLinter !

| <!-- --> | IDE | Extension Name | Install |
| :--: | ----------------- | -------------- | :------: |
| <!-- --> | IDE | Extension Name | Install |
|:-------------------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------|---------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/vscode.ico" alt="" height="32px" class="megalinter-icon"></a> | [Visual Studio Code](https://code.visualstudio.com/) | [VSCode PowerShell extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.PowerShell) | [![Install in VSCode](https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/btn_install_vscode.png)](vscode:extension/ms-vscode.PowerShell){target=_blank} |

## MegaLinter Flavours

This linter is available in the following flavours

| <!-- --> | Flavor | Description | Embedded linters | Info |
| :------: | :----- | :---------- | :--------------: | ---: |
| <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/mega-linter-square.png" alt="" height="32px" class="megalinter-icon"></a> | [all](https://megalinter.io/beta/supported-linters/) | Default MegaLinter Flavor | 111 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/beta) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) |
| <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/dotnet.ico" alt="" height="32px" class="megalinter-icon"></a> | [dotnet](https://megalinter.io/beta/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 58 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/beta) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) |
| <!-- --> | Flavor | Description | Embedded linters | Info |
|:--------------------------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------|:----------------------------------------------|:----------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/images/mega-linter-square.png" alt="" height="32px" class="megalinter-icon"></a> | [all](https://megalinter.io/beta/supported-linters/) | Default MegaLinter Flavor | 111 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter/beta) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter) |
| <img src="https://github.com/oxsecurity/megalinter/raw/main/docs/assets/icons/dotnet.ico" alt="" height="32px" class="megalinter-icon"></a> | [dotnet](https://megalinter.io/beta/flavors/dotnet/) | Optimized for C, C++, C# or VB based projects | 58 | ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/oxsecurity/megalinter-dotnet/beta) ![Docker Pulls](https://img.shields.io/docker/pulls/oxsecurity/megalinter-dotnet) |

## Behind the scenes

Expand Down
Loading

0 comments on commit 4dfa350

Please sign in to comment.