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

chore: fix formatting issues (#6028)

Browse source
This commit is contained in:
Marco Ferrari 2024-08-15 10:21:26 +02:00 committed by GitHub
parent 2f0ac20566
commit 2664cb3b19
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
42 changed files with 565 additions and 581 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.devcontainer/devcontainer.json
View file

@ -29,8 +29,5 @@
"type": "bind" "type": "bind"
} }
], ],
"runArgs": [ "runArgs": ["--env-file", ".devcontainer/devcontainer.env"]
"--env-file",
".devcontainer/devcontainer.env"
]
} }

6
.editorconfig
View file

@ -33,3 +33,9 @@ indent_size = 4
# Disable the filename rule because our test case logic requires that files used in test cases # Disable the filename rule because our test case logic requires that files used in test cases
# follow a certain syntax which is not compatible with what ktlint currently mandates (PascalCase) # follow a certain syntax which is not compatible with what ktlint currently mandates (PascalCase)
disabled_rules = filename disabled_rules = filename
[*.md]
# Indentation in Markdown files might not be constant, or a multiple of 2.
# Prettier takes care of formatting Markdown files.
indent_size = unset

1
.github/ISSUE_TEMPLATE/config.yml vendored
View file

@ -1,3 +1,2 @@
--- ---
blank_issues_enabled: false blank_issues_enabled: false
...

2
.github/ISSUE_TEMPLATE/feature_request.yml vendored
View file

@ -37,5 +37,3 @@ body:
Links? References? Anything that will give us more context about the issue you are encountering. Links? References? Anything that will give us more context about the issue you are encountering.
validations: validations:
required: false required: false
---

1
.github/dependabot.yml vendored
View file

@ -4,7 +4,6 @@
################################# #################################
version: 2 version: 2
updates: updates:
- package-ecosystem: "devcontainers" - package-ecosystem: "devcontainers"
commit-message: commit-message:
prefix: "chore(devcontainer)" prefix: "chore(devcontainer)"

2
.github/linters/.checkov-test-linters-failure.yaml vendored
View file

@ -5,5 +5,3 @@ directory:
- test/linters/checkov/bad - test/linters/checkov/bad
quiet: false quiet: false
...

1
.github/linters/.checkov-test-linters-success.yaml vendored
View file

@ -19,4 +19,3 @@ skip-framework:
# we have to do that as part of the test Helm chart or the test Kustomize # we have to do that as part of the test Helm chart or the test Kustomize
# "package". # "package".
- kubernetes - kubernetes
...

1
.github/linters/.checkov.yaml vendored
View file

@ -28,4 +28,3 @@ skip-path:
- test/linters/terraform_fmt - test/linters/terraform_fmt
- test/linters/terraform_tflint - test/linters/terraform_tflint
- test/linters/terraform_terrascan - test/linters/terraform_terrascan
...

5
.github/linters/.eslintrc.yml vendored
View file

@ -12,10 +12,10 @@ ignorePatterns:
- "!.*" - "!.*"
- "**/node_modules/.*" - "**/node_modules/.*"
parser: '@typescript-eslint/parser' parser: "@typescript-eslint/parser"
plugins: plugins:
- '@typescript-eslint' - "@typescript-eslint"
# Don't set the jsonSyntax parser option for JSON, JSON5, and JSONC # Don't set the jsonSyntax parser option for JSON, JSON5, and JSONC
# so we can use eslint-plugin-jsonc to automatically fix issues # so we can use eslint-plugin-jsonc to automatically fix issues
@ -41,4 +41,3 @@ overrides:
- "*.tsx" - "*.tsx"
extends: extends:
- plugin:react/recommended - plugin:react/recommended
...

1
.github/linters/.golangci.yml vendored
View file

@ -4,4 +4,3 @@
linters: linters:
enable: enable:
- gofmt - gofmt
...

8
.github/linters/.jscpd-test-linters.json vendored
View file

@ -1,10 +1,6 @@
{ {
"absolute": true, "absolute": true,
"ignore": [ "ignore": ["**/node_modules/**"],
"**/node_modules/**" "reporters": ["consoleFull"],
],
"reporters": [
"consoleFull"
],
"threshold": 0 "threshold": 0
} }

4
.github/linters/.jscpd.json vendored
View file

@ -43,8 +43,6 @@
"**/workflows/cd.yml", "**/workflows/cd.yml",
"**/workflows/ci.yml" "**/workflows/ci.yml"
], ],
"reporters": [ "reporters": ["consoleFull"],
"consoleFull"
],
"threshold": 0 "threshold": 0
} }

15
.github/linters/tsconfig.json vendored
View file

@ -2,20 +2,11 @@
"compilerOptions": { "compilerOptions": {
"strictNullChecks": true "strictNullChecks": true
}, },
"include": [ "include": ["src", "tests", "tools", "/tmp/lint/test/linters"],
"src",
"tests",
"tools",
"/tmp/lint/test/linters"
],
"overrides": [ "overrides": [
{ {
"extends": [ "extends": ["plugin:@typescript-eslint/disable-type-checked"],
"plugin:@typescript-eslint/disable-type-checked" "files": ["./**/*.{ts,tsx}"]
],
"files": [
"./**/*.{ts,tsx}"
]
} }
] ]
} }

6
.github/pull_request-template.md vendored
View file

@ -1,7 +1,13 @@
<!-- Start with an H2 because GitHub automatically adds the commit description before the template, --> <!-- Start with an H2 because GitHub automatically adds the commit description before the template, -->
<!-- so contributors don't have to manually cut-paste the description after the H1. --> <!-- so contributors don't have to manually cut-paste the description after the H1. -->
<!-- Also, include the header in a "prettier ignore" block because it adds a blank line -->
<!-- after the markdownlint-disable-next-line directive, making it useless. -->
<!-- Ref: https://github.com/prettier/prettier/issues/14350 -->
<!-- Ref: https://github.com/prettier/prettier/issues/10128 -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable-next-line MD041 --> <!-- markdownlint-disable-next-line MD041 -->
## Readiness checklist ## Readiness checklist
<!-- prettier-ignore-end -->
In order to have this pull request merged, complete the following tasks. In order to have this pull request merged, complete the following tasks.

6
.github/release-please/release-please-config.json vendored
View file

@ -34,11 +34,7 @@
".": { ".": {
"changelog-path": "CHANGELOG.md", "changelog-path": "CHANGELOG.md",
"release-type": "simple", "release-type": "simple",
"extra-files": [ "extra-files": ["action.yml", "README.md", "slim/action.yml"]
"action.yml",
"README.md",
"slim/action.yml"
]
} }
} }
} }

1
.github/workflows/dependabot-automation.yaml vendored
View file

@ -27,4 +27,3 @@ jobs:
# This doesn't trigger an automated merge because we require at approvals # This doesn't trigger an automated merge because we require at approvals
- name: Enable auto-merge - name: Enable auto-merge
run: gh pr merge --auto --squash --delete-branch "${PR_URL}" run: gh pr merge --auto --squash --delete-branch "${PR_URL}"
...

1
.github/workflows/lint-commit.yaml vendored
View file

@ -72,4 +72,3 @@ jobs:
- name: Validate commits - name: Validate commits
run: | run: |
make lint-commits make lint-commits
...

3
.github/workflows/thank_contributors.yaml vendored
View file

@ -2,7 +2,7 @@ name: Monthly contributor report
on: on:
workflow_dispatch: workflow_dispatch:
schedule: schedule:
- cron: '3 2 1 * *' - cron: "3 2 1 * *"
permissions: permissions:
issues: write issues: write
@ -13,7 +13,6 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Get dates for last month - name: Get dates for last month
shell: bash shell: bash
run: | run: |

4
.prettierignore Normal file
View file

@ -0,0 +1,4 @@
# Don't format Markdown files to verify tests
# because we don't yet generate formatted Markdown
# tables when creating the summary file
test/data/super-linter-summary/markdown/table/**/*.md

23
CODE_OF_CONDUCT.md
View file

@ -14,21 +14,21 @@ appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment Examples of behavior that contributes to creating a positive environment
include: include:
* Using welcoming and inclusive language - Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences - Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism - Gracefully accepting constructive criticism
* Focusing on what is best for the community - Focusing on what is best for the community
* Showing empathy towards other community members - Showing empathy towards other community members
Examples of unacceptable behavior by participants include: Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or - The use of sexualized language or imagery and unwelcome sexual attention or
advances advances
* Trolling, insulting/derogatory comments, and personal or political attacks - Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment - Public or private harassment
* Publishing others' private information, such as a physical or electronic - Publishing others' private information, such as a physical or electronic
address, without explicit permission address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a - Other conduct which could reasonably be considered inappropriate in a
professional setting professional setting
## Our Responsibilities ## Our Responsibilities
@ -68,8 +68,11 @@ members of the project's leadership.
## Attribution ## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
<!-- textlint-disable --> <!-- textlint-disable -->
available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct/) available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct/)
<!-- textlint-enable --> <!-- textlint-enable -->
[homepage]: https://www.contributor-covenant.org [homepage]: https://www.contributor-covenant.org

42
README.md
View file

@ -52,7 +52,7 @@ Here are some notable Super-linter features:
Super-linter supports the following tools: Super-linter supports the following tools:
| _Language_ | _Linter_ | | _Language_ | _Linter_ |
|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Ansible** | [ansible-lint](https://github.com/ansible/ansible-lint) | | **Ansible** | [ansible-lint](https://github.com/ansible/ansible-lint) |
| **AWS CloudFormation templates** | [cfn-lint](https://github.com/aws-cloudformation/cfn-python-lint/) | | **AWS CloudFormation templates** | [cfn-lint](https://github.com/aws-cloudformation/cfn-python-lint/) |
| **Azure Resource Manager (ARM)** | [arm-ttk](https://github.com/azure/arm-ttk) | | **Azure Resource Manager (ARM)** | [arm-ttk](https://github.com/azure/arm-ttk) |
@ -122,7 +122,7 @@ To run super-linter as a GitHub Action, you do the following:
push: null push: null
pull_request: null pull_request: null
permissions: { } permissions: {}
jobs: jobs:
build: build:
@ -148,7 +148,6 @@ To run super-linter as a GitHub Action, you do the following:
env: env:
# To report GitHub Actions status checks # To report GitHub Actions status checks
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
...
``` ```
1. Commit that file to a new branch. 1. Commit that file to a new branch.
@ -190,7 +189,7 @@ Super-Linter provides several variants:
You can configure Super-linter using the following environment variables: You can configure Super-linter using the following environment variables:
| **Environment variable** | **Default Value** | **Description** | | **Environment variable** | **Default Value** | **Description** |
|-------------------------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ----------------------------------------------- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **ANSIBLE_CONFIG_FILE** | `.ansible-lint.yml` | Filename for [Ansible-lint configuration](https://ansible.readthedocs.io/projects/lint/configuring/) (ex: `.ansible-lint`, `.ansible-lint.yml`) | | **ANSIBLE_CONFIG_FILE** | `.ansible-lint.yml` | Filename for [Ansible-lint configuration](https://ansible.readthedocs.io/projects/lint/configuring/) (ex: `.ansible-lint`, `.ansible-lint.yml`) |
| **ANSIBLE_DIRECTORY** | `/ansible` | Flag to set the root directory for Ansible file location(s), relative to `DEFAULT_WORKSPACE`. Set to `.` to use the top-level of the `DEFAULT_WORKSPACE`. | | **ANSIBLE_DIRECTORY** | `/ansible` | Flag to set the root directory for Ansible file location(s), relative to `DEFAULT_WORKSPACE`. Set to `.` to use the top-level of the `DEFAULT_WORKSPACE`. |
| **BASH_EXEC_IGNORE_LIBRARIES** | `false` | If set to `true`, shell files with a file extension and no shebang line are ignored when checking if the executable bit is set. | | **BASH_EXEC_IGNORE_LIBRARIES** | `false` | If set to `true`, shell files with a file extension and no shebang line are ignored when checking if the executable bit is set. |
@ -212,18 +211,24 @@ You can configure Super-linter using the following environment variables:
| **FIX_ANSIBLE** | `false` | Option to enable fix mode for `ANSIBLE`. | | **FIX_ANSIBLE** | `false` | Option to enable fix mode for `ANSIBLE`. |
| **FIX_CLANG_FORMAT** | `false` | Option to enable fix mode for `CLANG_FORMAT`. | | **FIX_CLANG_FORMAT** | `false` | Option to enable fix mode for `CLANG_FORMAT`. |
| **FIX_CSHARP** | `false` | Option to enable fix mode for `CSHARP`. | | **FIX_CSHARP** | `false` | Option to enable fix mode for `CSHARP`. |
| **FIX_CSS_PRETTIER** | `true` | Flag to enable or disable the formatting of CSS, Sass, and SCSS files with Prettier. |
| **FIX_CSS** | `false` | Option to enable fix mode for `CSS`. | | **FIX_CSS** | `false` | Option to enable fix mode for `CSS`. |
| **FIX_ENV** | `false` | Option to enable fix mode for `ENV`. | | **FIX_ENV** | `false` | Option to enable fix mode for `ENV`. |
| **FIX_GO** | `false` | Option to enable fix mode for `GO`. |
| **FIX_GO_MODULES** | `false` | Option to enable fix mode for `GO_MODULES`. | | **FIX_GO_MODULES** | `false` | Option to enable fix mode for `GO_MODULES`. |
| **FIX_GO** | `false` | Option to enable fix mode for `GO`. |
| **FIX_GOOGLE_JAVA_FORMAT** | `false` | Option to enable fix mode for `GOOGLE_JAVA_FORMAT`. | | **FIX_GOOGLE_JAVA_FORMAT** | `false` | Option to enable fix mode for `GOOGLE_JAVA_FORMAT`. |
| **FIX_GRAPHQL_PRETTIER** | `true` | Flag to enable or disable the formatting of GraphQL files with Prettier. |
| **FIX_GROOVY** | `false` | Option to enable fix mode for `GROOVY`. | | **FIX_GROOVY** | `false` | Option to enable fix mode for `GROOVY`. |
| **FIX_HTML_PRETTIER** | `true` | Flag to enable or disable the formatting of HTML files with Prettier. |
| **FIX_JAVASCRIPT_ES** | `false` | Option to enable fix mode for `JAVASCRIPT_ES`. | | **FIX_JAVASCRIPT_ES** | `false` | Option to enable fix mode for `JAVASCRIPT_ES`. |
| **FIX_JAVASCRIPT_PRETTIER** | `false` | Option to enable fix mode for `JAVASCRIPT_PRETTIER`. | | **FIX_JAVASCRIPT_PRETTIER** | `false` | Flag to enable or disable the formatting of JavaScript files with Prettier. |
| **FIX_JAVASCRIPT_STANDARD** | `false` | Option to enable fix mode for `JAVASCRIPT_STANDARD`. | | **FIX_JAVASCRIPT_STANDARD** | `false` | Option to enable fix mode for `JAVASCRIPT_STANDARD`. |
| **FIX_JSON_PRETTIER** | `true` | Flag to enable or disable the formatting of JSON files with Prettier. |
| **FIX_JSON** | `false` | Option to enable fix mode for `JSON`. | | **FIX_JSON** | `false` | Option to enable fix mode for `JSON`. |
| **FIX_JSONC** | `false` | Option to enable fix mode for `JSONC`. | | **FIX_JSONC** | `false` | Option to enable fix mode for `JSONC`. |
| **FIX_JSX_PRETTIER** | `true` | Flag to enable or disable the formatting of JSX files with Prettier. |
| **FIX_JSX** | `false` | Option to enable fix mode for `JSX`. | | **FIX_JSX** | `false` | Option to enable fix mode for `JSX`. |
| **FIX_MARKDOWN_PRETTIER** | `true` | Flag to enable or disable the formatting of Markdown files with Prettier. |
| **FIX_MARKDOWN** | `false` | Option to enable fix mode for `MARKDOWN`. | | **FIX_MARKDOWN** | `false` | Option to enable fix mode for `MARKDOWN`. |
| **FIX_POWERSHELL** | `false` | Option to enable fix mode for `POWERSHELL`. | | **FIX_POWERSHELL** | `false` | Option to enable fix mode for `POWERSHELL`. |
| **FIX_PROTOBUF** | `false` | Option to enable fix mode for `PROTOBUF`. | | **FIX_PROTOBUF** | `false` | Option to enable fix mode for `PROTOBUF`. |
@ -242,8 +247,10 @@ You can configure Super-linter using the following environment variables:
| **FIX_TERRAFORM_FMT** | `false` | Option to enable fix mode for `TERRAFORM_FMT`. | | **FIX_TERRAFORM_FMT** | `false` | Option to enable fix mode for `TERRAFORM_FMT`. |
| **FIX_TSX** | `false` | Option to enable fix mode for `TSX`. | | **FIX_TSX** | `false` | Option to enable fix mode for `TSX`. |
| **FIX_TYPESCRIPT_ES** | `false` | Option to enable fix mode for `TYPESCRIPT_ES`. | | **FIX_TYPESCRIPT_ES** | `false` | Option to enable fix mode for `TYPESCRIPT_ES`. |
| **FIX_TYPESCRIPT_PRETTIER** | `false` | Option to enable fix mode for `TYPESCRIPT_PRETTIER`. | | **FIX_TYPESCRIPT_PRETTIER** | `false` | Flag to enable or disable the formatting of TypeScript files with Prettier. |
| **FIX_TYPESCRIPT_STANDARD** | `false` | Option to enable fix mode for `TYPESCRIPT_STANDARD`. | | **FIX_TYPESCRIPT_STANDARD** | `false` | Option to enable fix mode for `TYPESCRIPT_STANDARD`. |
| **FIX_VUE_PRETTIER** | `true` | Flag to enable or disable the formatting of Vue files with Prettier. |
| **FIX_YAML_PRETTIER** | `true` | Flag to enable or disable the formatting of YAML files with Prettier. |
| **GITHUB_ACTIONS_CONFIG_FILE** | `actionlint.yml` | Filename for [Actionlint configuration](https://github.com/rhysd/actionlint/blob/main/docs/config.md) (ex: `actionlint.yml`) | | **GITHUB_ACTIONS_CONFIG_FILE** | `actionlint.yml` | Filename for [Actionlint configuration](https://github.com/rhysd/actionlint/blob/main/docs/config.md) (ex: `actionlint.yml`) |
| **GITHUB_ACTIONS_COMMAND_ARGS** | `null` | Additional arguments passed to `actionlint` command. Useful to [ignore some errors](https://github.com/rhysd/actionlint/blob/main/docs/usage.md#ignore-some-errors) | | **GITHUB_ACTIONS_COMMAND_ARGS** | `null` | Additional arguments passed to `actionlint` command. Useful to [ignore some errors](https://github.com/rhysd/actionlint/blob/main/docs/usage.md#ignore-some-errors) |
| **GITHUB_CUSTOM_API_URL** | `https://api.${GITHUB_DOMAIN}` | Specify a custom GitHub API URL in case GitHub Enterprise is used: e.g. `https://github.myenterprise.com/api/v3` | | **GITHUB_CUSTOM_API_URL** | `https://api.${GITHUB_DOMAIN}` | Specify a custom GitHub API URL in case GitHub Enterprise is used: e.g. `https://github.myenterprise.com/api/v3` |
@ -308,7 +315,8 @@ You can configure Super-linter using the following environment variables:
| **VALIDATE_CLOUDFORMATION** | `true` | Flag to enable or disable the linting process of the AWS Cloud Formation language. | | **VALIDATE_CLOUDFORMATION** | `true` | Flag to enable or disable the linting process of the AWS Cloud Formation language. |
| **VALIDATE_COFFEESCRIPT** | `true` | Flag to enable or disable the linting process of the CoffeeScript language. | | **VALIDATE_COFFEESCRIPT** | `true` | Flag to enable or disable the linting process of the CoffeeScript language. |
| **VALIDATE_CSHARP** | `true` | Flag to enable or disable the linting process of the C# language. | | **VALIDATE_CSHARP** | `true` | Flag to enable or disable the linting process of the C# language. |
| **VALIDATE_CSS** | `true` | Flag to enable or disable the linting process of the CSS language. | | **VALIDATE_CSS** | `true` | Flag to enable or disable the linting process of the CSS, Sass, and SCSS files. |
| **VALIDATE_CSS_PRETTIER** | `true` | Flag to enable or disable checking the formatting of CSS, Sass, and SCSS files with Prettier. |
| **VALIDATE_DART** | `true` | Flag to enable or disable the linting process of the Dart language. | | **VALIDATE_DART** | `true` | Flag to enable or disable the linting process of the Dart language. |
| **VALIDATE_DOCKERFILE_HADOLINT** | `true` | Flag to enable or disable the linting process of the Docker language. | | **VALIDATE_DOCKERFILE_HADOLINT** | `true` | Flag to enable or disable the linting process of the Docker language. |
| **VALIDATE_EDITORCONFIG** | `true` | Flag to enable or disable the linting process with the EditorConfig. | | **VALIDATE_EDITORCONFIG** | `true` | Flag to enable or disable the linting process with the EditorConfig. |
@ -319,22 +327,27 @@ You can configure Super-linter using the following environment variables:
| **VALIDATE_GO** | `true` | Flag to enable or disable the linting process of the individual Golang files. Set this to `false` if you want to lint Go modules. See the `VALIDATE_GO_MODULES` variable. | | **VALIDATE_GO** | `true` | Flag to enable or disable the linting process of the individual Golang files. Set this to `false` if you want to lint Go modules. See the `VALIDATE_GO_MODULES` variable. |
| **VALIDATE_GO_MODULES** | `true` | Flag to enable or disable the linting process of Go modules. Super-linter considers a directory to be a Go module if it contains a file named `go.mod`. | | **VALIDATE_GO_MODULES** | `true` | Flag to enable or disable the linting process of Go modules. Super-linter considers a directory to be a Go module if it contains a file named `go.mod`. |
| **VALIDATE_GO_RELEASER** | `true` | Flag to enable or disable the linting process of the GoReleaser config file. | | **VALIDATE_GO_RELEASER** | `true` | Flag to enable or disable the linting process of the GoReleaser config file. |
| **VALIDATE_GRAPHQL_PRETTIER** | `true` | Flag to enable or disable checking the formatting of GraphQL files with Prettier. |
| **VALIDATE_GOOGLE_JAVA_FORMAT** | `true` | Flag to enable or disable the linting process of the Java language. (Utilizing: google-java-format) | | **VALIDATE_GOOGLE_JAVA_FORMAT** | `true` | Flag to enable or disable the linting process of the Java language. (Utilizing: google-java-format) |
| **VALIDATE_GROOVY** | `true` | Flag to enable or disable the linting process of the language. | | **VALIDATE_GROOVY** | `true` | Flag to enable or disable the linting process of the language. |
| **VALIDATE_HTML** | `true` | Flag to enable or disable the linting process of the HTML language. | | **VALIDATE_HTML** | `true` | Flag to enable or disable the linting process of the HTML language. |
| **VALIDATE_HTML_PRETTIER** | `true` | Flag to enable or disable checking the formatting of HTML files with Prettier. |
| **VALIDATE_JAVA** | `true` | Flag to enable or disable the linting process of the Java language. (Utilizing: checkstyle) | | **VALIDATE_JAVA** | `true` | Flag to enable or disable the linting process of the Java language. (Utilizing: checkstyle) |
| **VALIDATE_JAVASCRIPT_ES** | `true` | Flag to enable or disable the linting process of the JavaScript language. (Utilizing: ESLint) | | **VALIDATE_JAVASCRIPT_ES** | `true` | Flag to enable or disable the linting process of the JavaScript language. (Utilizing: ESLint) |
| **VALIDATE_JAVASCRIPT_PRETTIER** | `true` | Flag to enable or disable the linting process of the JavaScript language. (Utilizing: prettier) | | **VALIDATE_JAVASCRIPT_PRETTIER** | `true` | Flag to enable or disable checking the formatting of JavaScript files with Prettier. |
| **VALIDATE_JAVASCRIPT_STANDARD** | `true` | Flag to enable or disable the linting process of the JavaScript language. (Utilizing: standard) | | **VALIDATE_JAVASCRIPT_STANDARD** | `true` | Flag to enable or disable the linting process of the JavaScript language. (Utilizing: standard) |
| **VALIDATE_JSCPD** | `true` | Flag to enable or disable JSCPD. | | **VALIDATE_JSCPD** | `true` | Flag to enable or disable JSCPD. |
| **VALIDATE_JSON** | `true` | Flag to enable or disable the linting process of the JSON language. | | **VALIDATE_JSON** | `true` | Flag to enable or disable the linting process of the JSON language. |
| **VALIDATE_JSON_PRETTIER** | `true` | Flag to enable or disable checking the formatting of JSON files with Prettier. |
| **VALIDATE_JSONC** | `true` | Flag to enable or disable the linting process of the JSONC and JSON5 languages. | | **VALIDATE_JSONC** | `true` | Flag to enable or disable the linting process of the JSONC and JSON5 languages. |
| **VALIDATE_JSX** | `true` | Flag to enable or disable the linting process for jsx files (Utilizing: ESLint) | | **VALIDATE_JSX** | `true` | Flag to enable or disable the linting process for jsx files (Utilizing: ESLint) |
| **VALIDATE_JSX_PRETTIER** | `true` | Flag to enable or disable checking the formatting of JSX files with Prettier. |
| **VALIDATE_KOTLIN** | `true` | Flag to enable or disable the linting process of the Kotlin language. | | **VALIDATE_KOTLIN** | `true` | Flag to enable or disable the linting process of the Kotlin language. |
| **VALIDATE_KUBERNETES_KUBECONFORM** | `true` | Flag to enable or disable the linting process of Kubernetes descriptors with Kubeconform | | **VALIDATE_KUBERNETES_KUBECONFORM** | `true` | Flag to enable or disable the linting process of Kubernetes descriptors with Kubeconform |
| **VALIDATE_LATEX** | `true` | Flag to enable or disable the linting process of the LaTeX language. | | **VALIDATE_LATEX** | `true` | Flag to enable or disable the linting process of the LaTeX language. |
| **VALIDATE_LUA** | `true` | Flag to enable or disable the linting process of the language. | | **VALIDATE_LUA** | `true` | Flag to enable or disable the linting process of the language. |
| **VALIDATE_MARKDOWN** | `true` | Flag to enable or disable the linting process of the Markdown language. | | **VALIDATE_MARKDOWN** | `true` | Flag to enable or disable the linting process of the Markdown language. |
| **VALIDATE_MARKDOWN_PRETTIER** | `true` | Flag to enable or disable checking the formatting of Markdown files with Prettier. |
| **VALIDATE_NATURAL_LANGUAGE** | `true` | Flag to enable or disable the linting process of the natural language. | | **VALIDATE_NATURAL_LANGUAGE** | `true` | Flag to enable or disable the linting process of the natural language. |
| **VALIDATE_OPENAPI** | `true` | Flag to enable or disable the linting process of the OpenAPI language. | | **VALIDATE_OPENAPI** | `true` | Flag to enable or disable the linting process of the OpenAPI language. |
| **VALIDATE_PERL** | `true` | Flag to enable or disable the linting process of the Perl language. | | **VALIDATE_PERL** | `true` | Flag to enable or disable the linting process of the Perl language. |
@ -367,16 +380,18 @@ You can configure Super-linter using the following environment variables:
| **VALIDATE_STATES** | `true` | Flag to enable or disable the linting process for AWS States Language. | | **VALIDATE_STATES** | `true` | Flag to enable or disable the linting process for AWS States Language. |
| **VALIDATE_SQLFLUFF** | `true` | Flag to enable or disable the linting process of the SQL language. (Utilizing: sqlfuff) | | **VALIDATE_SQLFLUFF** | `true` | Flag to enable or disable the linting process of the SQL language. (Utilizing: sqlfuff) |
| **VALIDATE_TEKTON** | `true` | Flag to enable or disable the linting process of the Tekton language. | | **VALIDATE_TEKTON** | `true` | Flag to enable or disable the linting process of the Tekton language. |
| **VALIDATE_TERRAFORM_FMT** | `true` | Flag to enable or disable the formatting process of the Terraform files. | | **VALIDATE_TERRAFORM_FMT** | `true` | Flag to enable or disable checking the formatting process of the Terraform files. |
| **VALIDATE_TERRAFORM_TERRASCAN** | `true` | Flag to enable or disable the linting process of the Terraform language for security related issues. | | **VALIDATE_TERRAFORM_TERRASCAN** | `true` | Flag to enable or disable the linting process of the Terraform language for security related issues. |
| **VALIDATE_TERRAFORM_TFLINT** | `true` | Flag to enable or disable the linting process of the Terraform language. (Utilizing tflint) | | **VALIDATE_TERRAFORM_TFLINT** | `true` | Flag to enable or disable the linting process of the Terraform language. (Utilizing tflint) |
| **VALIDATE_TERRAGRUNT** | `true` | Flag to enable or disable the linting process for Terragrunt files. | | **VALIDATE_TERRAGRUNT** | `true` | Flag to enable or disable the linting process for Terragrunt files. |
| **VALIDATE_TSX** | `true` | Flag to enable or disable the linting process for tsx files (Utilizing: ESLint) | | **VALIDATE_TSX** | `true` | Flag to enable or disable the linting process for tsx files (Utilizing: ESLint) |
| **VALIDATE_TYPESCRIPT_ES** | `true` | Flag to enable or disable the linting process of the TypeScript language. (Utilizing: ESLint) | | **VALIDATE_TYPESCRIPT_ES** | `true` | Flag to enable or disable the linting process of the TypeScript language. (Utilizing: ESLint) |
| **VALIDATE_TYPESCRIPT_PRETTIER** | `true` | Flag to enable or disable the linting process of the TypeScript language. (Utilizing: prettier) | | **VALIDATE_TYPESCRIPT_PRETTIER** | `true` | Flag to enable or disable checking the formatting of TypeScript files with Prettier. |
| **VALIDATE_TYPESCRIPT_STANDARD** | `true` | Flag to enable or disable the linting process of the TypeScript language. (Utilizing: ts-standard) | | **VALIDATE_TYPESCRIPT_STANDARD** | `true` | Flag to enable or disable the linting process of the TypeScript language. (Utilizing: ts-standard) |
| **VALIDATE_VUE_PRETTIER** | `true` | Flag to enable or disable checking the formatting of Vue files with Prettier. |
| **VALIDATE_XML** | `true` | Flag to enable or disable the linting process of the XML language. | | **VALIDATE_XML** | `true` | Flag to enable or disable the linting process of the XML language. |
| **VALIDATE_YAML** | `true` | Flag to enable or disable the linting process of the YAML language. | | **VALIDATE_YAML** | `true` | Flag to enable or disable the linting process of the YAML language. |
| **VALIDATE_YAML_PRETTIER** | `true` | Flag to enable or disable checking the formatting of YAML files with Prettier. |
| **YAML_CONFIG_FILE** | `.yaml-lint.yml` | Filename for [Yamllint configuration](https://yamllint.readthedocs.io/en/stable/configuration.html) (ex: `.yaml-lint.yml`, `.yamllint.yml`) | | **YAML_CONFIG_FILE** | `.yaml-lint.yml` | Filename for [Yamllint configuration](https://yamllint.readthedocs.io/en/stable/configuration.html) (ex: `.yaml-lint.yml`, `.yamllint.yml`) |
| **YAML_ERROR_ON_WARNING** | `false` | Flag to enable or disable the error on warning for Yamllint. | | **YAML_ERROR_ON_WARNING** | `false` | Flag to enable or disable the error on warning for Yamllint. |
@ -470,6 +485,7 @@ For example:
- Do not lint JavaScript files inside test folder: `FILTER_REGEX_EXCLUDE: .*test/.*.js` - Do not lint JavaScript files inside test folder: `FILTER_REGEX_EXCLUDE: .*test/.*.js`
<!-- This `README.md` has both markers in the text, so it is considered not generated. --> <!-- This `README.md` has both markers in the text, so it is considered not generated. -->
Additionally, if you set `IGNORE_GENERATED_FILES` to `true`, super-linter Additionally, if you set `IGNORE_GENERATED_FILES` to `true`, super-linter
ignores any file with `@generated` string in it, unless the file ignores any file with `@generated` string in it, unless the file
also has `@not-generated` marker. For example, super-linter considers a file also has `@not-generated` marker. For example, super-linter considers a file
@ -523,7 +539,7 @@ For example, you can configure this private key as an
and access it with the `secrets` parameter from your GitHub Actions workflow: and access it with the `secrets` parameter from your GitHub Actions workflow:
```yaml ```yaml
env: env:
SSH_KEY: ${{ secrets.SSH_PRIVATE_KEY }} SSH_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
``` ```
@ -532,7 +548,7 @@ If you need to inject a SSL certificate into the trust store, you can use the
path to the files that contains a CA that can be used to validate the certificate: path to the files that contains a CA that can be used to validate the certificate:
```yaml ```yaml
env: env:
SSL_CERT_SECRET: ${{ secrets.ROOT_CA }} SSL_CERT_SECRET: ${{ secrets.ROOT_CA }}
``` ```

16
TEMPLATES/.ansible-lint.yml
View file

@ -29,14 +29,14 @@ quiet: true
# Tags to skip # # Tags to skip #
################ ################
skip_list: skip_list:
- 'empty-string-compare' # Allow compare to empty string - "empty-string-compare" # Allow compare to empty string
- '204' # Allow string length greater than 160 chars - "204" # Allow string length greater than 160 chars
- 'no-changed-when' # False positives for running command shells - "no-changed-when" # False positives for running command shells
- 'command-instead-of-module' # Allow git commands for push, add, etc... - "command-instead-of-module" # Allow git commands for push, add, etc...
- 'command-instead-of-shell' # Allow use of shell when you want - "command-instead-of-shell" # Allow use of shell when you want
- 'no-handler' # Allow step to run like handler - "no-handler" # Allow step to run like handler
- 'unnamed-task' # Allow tasks without a name - "unnamed-task" # Allow tasks without a name
- 'yaml' # Disable YAML linting since it's done by yamllint - "yaml" # Disable YAML linting since it's done by yamllint
################## ##################
# Tags to follow # # Tags to follow #

1
TEMPLATES/.checkov.yaml
View file

@ -1,4 +1,3 @@
--- ---
# Don't report passed checks in output # Don't report passed checks in output
quiet: true quiet: true
...

5
TEMPLATES/.eslintrc.yml
View file

@ -8,13 +8,12 @@ ignorePatterns:
- "!.*" - "!.*"
- "**/node_modules/.*" - "**/node_modules/.*"
parser: '@typescript-eslint/parser' parser: "@typescript-eslint/parser"
plugins: plugins:
- '@typescript-eslint' - "@typescript-eslint"
overrides: overrides:
# JSON files # JSON files
- files: - files:
- "*.json" - "*.json"

9
TEMPLATES/.jscpd.json
View file

@ -1,11 +1,6 @@
{ {
"threshold": 0, "threshold": 0,
"reporters": [ "reporters": ["consoleFull"],
"consoleFull" "ignore": ["**/__snapshots__/**", "**/node_modules/**"],
],
"ignore": [
"**/__snapshots__/**",
"**/node_modules/**"
],
"absolute": true "absolute": true
} }

1
TEMPLATES/.openapirc.yml
View file

@ -1,5 +1,4 @@
--- ---
########################## ##########################
########################## ##########################
## OpenAPI Linter rules ## ## OpenAPI Linter rules ##

1
TEMPLATES/actionlint.yml
View file

@ -1,2 +1 @@
--- ---
...

14
action.yml
View file

@ -1,12 +1,12 @@
--- ---
name: 'Super-Linter' name: "Super-Linter"
author: 'Super-linter contributors' author: "Super-linter contributors"
description: 'Super-linter is a ready-to-run collection of linters and code analyzers, to help validate your source code.' description: "Super-linter is a ready-to-run collection of linters and code analyzers, to help validate your source code."
runs: runs:
using: 'docker' using: "docker"
image: 'docker://ghcr.io/super-linter/super-linter:v6.9.0' # x-release-please-version image: "docker://ghcr.io/super-linter/super-linter:v6.9.0" # x-release-please-version
branding: branding:
icon: 'check-square' icon: "check-square"
color: 'white' color: "white"
# You can view https://github.com/super-linter/super-linter#environment-variables # You can view https://github.com/super-linter/super-linter#environment-variables
# to see a comprehensive list of all environment variables that can be passed # to see a comprehensive list of all environment variables that can be passed

4
docs/add-new-linter.md
View file

@ -1,6 +1,6 @@
# How to add support for a new tool to super-linter # How to add support for a new tool to super-linter
If you want to propose a *Pull Request* to add **new** language support or a If you want to propose a _Pull Request_ to add **new** language support or a
new tool, it should include: new tool, it should include:
- Update documentation: - Update documentation:
@ -102,9 +102,11 @@ new tool, it should include:
item as `<LANGUAGE_NAME>`. item as `<LANGUAGE_NAME>`.
- Linter configuration: - Linter configuration:
- Create a new minimal configuration file in the `TEMPLATES` directory with the same name as the - Create a new minimal configuration file in the `TEMPLATES` directory with the same name as the
default configuration filename. Example: `TEMPLATES/.ruff.toml`. default configuration filename. Example: `TEMPLATES/.ruff.toml`.
- `lib/globals/linterRules.sh`: - `lib/globals/linterRules.sh`:
- If the new linter accepts a configuration files from the command line, - If the new linter accepts a configuration files from the command line,
define a new variable: define a new variable:
`<LANGUAGE_NAME>_FILE_NAME="${<LANGUAGE_NAME>_CONFIG_FILE:-"default-config-file-name.conf"}"` `<LANGUAGE_NAME>_FILE_NAME="${<LANGUAGE_NAME>_CONFIG_FILE:-"default-config-file-name.conf"}"`

2
docs/run-linter-locally.md
View file

@ -38,7 +38,7 @@ super-linter:
stage: Super-linter stage: Super-linter
# Use a specific Super-linter version instead of latest for more reproducible builds # Use a specific Super-linter version instead of latest for more reproducible builds
image: super-linter/super-linter:latest image: super-linter/super-linter:latest
script: [ "true" ] script: ["true"]
variables: variables:
RUN_LOCAL: "true" RUN_LOCAL: "true"
DEFAULT_WORKSPACE: $CI_PROJECT_DIR DEFAULT_WORKSPACE: $CI_PROJECT_DIR

14
slim/action.yml
View file

@ -1,12 +1,12 @@
--- ---
name: 'Super-Linter slim' name: "Super-Linter slim"
author: 'Super-linter contributors' author: "Super-linter contributors"
description: 'Super-linter is a ready-to-run collection of linters and code analyzers, to help validate your source code.' description: "Super-linter is a ready-to-run collection of linters and code analyzers, to help validate your source code."
runs: runs:
using: 'docker' using: "docker"
image: 'docker://ghcr.io/super-linter/super-linter:slim-v6.9.0' # x-release-please-version image: "docker://ghcr.io/super-linter/super-linter:slim-v6.9.0" # x-release-please-version
branding: branding:
icon: 'check-square' icon: "check-square"
color: 'white' color: "white"
# You can view https://github.com/super-linter/super-linter#environment-variables # You can view https://github.com/super-linter/super-linter#environment-variables
# to see a comprehensive list of all environment variables that can be passed # to see a comprehensive list of all environment variables that can be passed

8
test/data/github-event/github-event-push.json
View file

@ -178,13 +178,7 @@
"svn_url": "https://github.com/super-linter/super-linter", "svn_url": "https://github.com/super-linter/super-linter",
"tags_url": "https://api.github.com/repos/super-linter/super-linter/tags", "tags_url": "https://api.github.com/repos/super-linter/super-linter/tags",
"teams_url": "https://api.github.com/repos/super-linter/super-linter/teams", "teams_url": "https://api.github.com/repos/super-linter/super-linter/teams",
"topics": [ "topics": ["actions", "ci", "hacktoberfest", "linter", "quality-check"],
"actions",
"ci",
"hacktoberfest",
"linter",
"quality-check"
],
"trees_url": "https://api.github.com/repos/super-linter/super-linter/git/trees{/sha}", "trees_url": "https://api.github.com/repos/super-linter/super-linter/git/trees{/sha}",
"updated_at": "2024-01-04T16:38:53Z", "updated_at": "2024-01-04T16:38:53Z",
"url": "https://github.com/super-linter/super-linter", "url": "https://github.com/super-linter/super-linter",

1
test/linters-config/fix-mode/.ansible-lint.yml
View file

@ -6,4 +6,3 @@ parseable: true
quiet: true quiet: true
use_default_rules: true use_default_rules: true
verbosity: 1 verbosity: 1
...

5
test/linters-config/fix-mode/.eslintrc.yml
View file

@ -12,10 +12,10 @@ ignorePatterns:
- "!.*" - "!.*"
- "**/node_modules/.*" - "**/node_modules/.*"
parser: '@typescript-eslint/parser' parser: "@typescript-eslint/parser"
plugins: plugins:
- '@typescript-eslint' - "@typescript-eslint"
# Don't set the jsonSyntax parser option for JSON, JSON5, and JSONC # Don't set the jsonSyntax parser option for JSON, JSON5, and JSONC
# so we can use eslint-plugin-jsonc to automatically fix issues # so we can use eslint-plugin-jsonc to automatically fix issues
@ -41,4 +41,3 @@ overrides:
- "*.tsx" - "*.tsx"
extends: extends:
- plugin:react/recommended - plugin:react/recommended
...

1
test/linters-config/fix-mode/.golangci.yml
View file

@ -2,4 +2,3 @@
linters: linters:
enable: enable:
- gofmt - gofmt
...