actions/lint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-12-22 04:32:16 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

chore: format super-linter summaries (#6063)

Browse source 
Run Prettier to format the Super-linter summary file to produce
summaries with consistent formatting.
This commit is contained in:
Marco Ferrari 2024-08-25 19:43:33 +02:00 committed by GitHub
parent a5c0cf27db
commit 11d4aac68c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
19 changed files with 553 additions and 508 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
.github/linters/.markdown-lint.yml vendored
View file

@ -1,35 +1,2 @@
---
###########################
###########################
## Markdown Linter rules ##
###########################
###########################
# Linter rules doc:
# - https://github.com/DavidAnson/markdownlint
#
# Note:
# To comment out a single error:
# <!-- markdownlint-disable -->
# any violations you want
# <!-- markdownlint-restore -->
#
###############
# Rules by id #
###############
MD004: false # Unordered list style
MD007:
indent: 2 # Unordered list indentation
MD013:
line_length: 808 # Line length
MD026:
punctuation: ".,;:!。，；:" # List of not allowed
MD029: false # Ordered list item prefix
MD033: false # Allow inline HTML
MD036: false # Emphasis used instead of a heading
#################
# Rules by tags #
#################
blank_lines: false # Error on blank lines
extends: "markdownlint/style/prettier"

4
.prettierignore
View file

@ -1,4 +0,0 @@
# 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

25
Makefile
View file

@ -145,6 +145,7 @@ open-shell-super-linter-container: ## Open a shell in the Super-linter container
docker run $(DOCKER_FLAGS) \
--interactive \
--entrypoint /bin/bash \
--rm \
-v "$(CURDIR)":/tmp/lint \
$(SUPER_LINTER_TEST_CONTAINER_URL)
@ -167,6 +168,7 @@ test-actions-runner-debug: ## Run super-linter with ACTIONS_RUNNER_DEBUG=true
-e DEFAULT_BRANCH=main \
-e USE_FIND_ALGORITHM=true \
-v "$(CURDIR)/.github":/tmp/lint/.github \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: test-actions-steps-debug
@ -178,6 +180,7 @@ test-actions-steps-debug: ## Run super-linter with ACTIONS_STEPS_DEBUG=true
-e DEFAULT_BRANCH=main \
-e USE_FIND_ALGORITHM=true \
-v "$(CURDIR)/.github":/tmp/lint/.github \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: test-runner-debug
@ -189,6 +192,7 @@ test-runner-debug: ## Run super-linter with RUNNER_DEBUG=1
-e DEFAULT_BRANCH=main \
-e USE_FIND_ALGORITHM=true \
-v "$(CURDIR)/.github":/tmp/lint/.github \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: test-find
@ -200,6 +204,7 @@ test-find: ## Run super-linter on a subdirectory with USE_FIND_ALGORITHM=true
-e DEFAULT_BRANCH=main \
-e USE_FIND_ALGORITHM=true \
-v "$(CURDIR)/.github":/tmp/lint/.github \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
# We need to set USE_FIND_ALGORITHM=true because the DEFALUT_WORKSPACE is not
@ -215,6 +220,7 @@ test-non-default-workdir: ## Run super-linter with DEFAULT_WORKSPACE set
-e USE_FIND_ALGORITHM=true \
-e VALIDATE_ALL_CODEBASE=true \
-v $(CURDIR)/.github:/tmp/not-default-workspace/.github \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: test-git-flags
@ -229,6 +235,7 @@ test-git-flags: ## Run super-linter with different git-related flags
-e IGNORE_GITIGNORED_FILES=true \
-e VALIDATE_ALL_CODEBASE=true \
-v "$(CURDIR)":/tmp/lint \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: lint-codebase
@ -246,6 +253,7 @@ lint-codebase: ## Lint the entire codebase
-e SAVE_SUPER_LINTER_SUMMARY=true \
-e VALIDATE_ALL_CODEBASE=true \
-v "$(CURDIR):/tmp/lint" \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
# Return an error if there are changes to commit
@ -273,6 +281,7 @@ fix-codebase: ## Fix and format the entire codebase
-e SAVE_SUPER_LINTER_SUMMARY=true \
-e VALIDATE_ALL_CODEBASE=true \
-v "$(CURDIR):/tmp/lint" \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL) \
&& /bin/bash -c "source test/testUtils.sh; if ! CheckUnexpectedGitChanges ${CURDIR}; then exit 1; fi"
@ -293,6 +302,7 @@ lint-subset-files-enable-only-one-type: ## Lint a small subset of files in the c
-e VALIDATE_ALL_CODEBASE=true \
-e VALIDATE_MARKDOWN=true \
-v "$(CURDIR):/tmp/lint" \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: lint-subset-files-enable-expensive-io-checks
@ -312,6 +322,7 @@ lint-subset-files-enable-expensive-io-checks: ## Lint a small subset of files in
-e VALIDATE_STATES=true \
-e VALIDATE_TEKTON=true \
-v "$(CURDIR):/tmp/lint" \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: test-lib
@ -323,6 +334,7 @@ test-globals-languages: ## Test globals/languages.sh
-v "$(CURDIR):/tmp/lint" \
-w /tmp/lint \
--entrypoint /tmp/lint/test/lib/globalsLanguagesTest.sh \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: test-globals-linter-command-options
@ -331,6 +343,7 @@ test-globals-linter-command-options: ## Test globals/LinterCommandsOptions.sh
-v "$(CURDIR):/tmp/lint" \
-w /tmp/lint \
--entrypoint /tmp/lint/test/lib/globalsLinterCommandsOptionsTest.sh \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: test-linter-rules
@ -339,6 +352,7 @@ test-linter-rules: ## Test linterRules.sh
-v "$(CURDIR):/tmp/lint" \
-w /tmp/lint \
--entrypoint /tmp/lint/test/lib/linterRulesTest.sh \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: test-build-file-list
@ -347,6 +361,7 @@ test-build-file-list: ## Test buildFileList
-v "$(CURDIR):/tmp/lint" \
-w /tmp/lint \
--entrypoint /tmp/lint/test/lib/buildFileListTest.sh \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: test-detect-files
@ -355,6 +370,7 @@ test-detect-files: ## Test detectFiles
-v "$(CURDIR):/tmp/lint" \
-w /tmp/lint \
--entrypoint /tmp/lint/test/lib/detectFilesTest.sh \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: test-github-event
@ -363,6 +379,7 @@ test-github-event: ## Test githubEvent
-v "$(CURDIR):/tmp/lint" \
-w /tmp/lint \
--entrypoint /tmp/lint/test/lib/githubEventTest.sh \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: test-setup-ssh
@ -372,6 +389,7 @@ test-setup-ssh: ## Test setupSSH
-v "$(CURDIR):/tmp/lint" \
-w /tmp/lint \
--entrypoint /tmp/lint/test/lib/setupSSHTest.sh \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: test-validation
@ -380,6 +398,7 @@ test-validation: ## Test validation
-v "$(CURDIR):/tmp/lint" \
-w /tmp/lint \
--entrypoint /tmp/lint/test/lib/validationTest.sh \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: test-output
@ -388,6 +407,7 @@ test-output: ## Test output
-v "$(CURDIR):/tmp/lint" \
-w /tmp/lint \
--entrypoint /tmp/lint/test/lib/outputTest.sh \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: test-linter-commands
@ -396,6 +416,7 @@ test-linter-commands: ## Test linterCommands
-v "$(CURDIR):/tmp/lint" \
-w /tmp/lint \
--entrypoint /tmp/lint/test/lib/linterCommandsTest.sh \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
# Run this test against a small directory because we're only interested in
@ -410,6 +431,7 @@ test-default-config-files: ## Test default configuration files loading
-e DEFAULT_BRANCH=main \
-e USE_FIND_ALGORITHM=true \
-v "$(CURDIR)/docs":/tmp/lint \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: test-custom-ssl-cert
@ -422,6 +444,7 @@ test-custom-ssl-cert: ## Test the configuration of a custom SSL/TLS certificate
-e USE_FIND_ALGORITHM=true \
-e SSL_CERT_SECRET="$(shell cat test/data/ssl-certificate/rootCA-test.crt)" \
-v "$(CURDIR)/docs":/tmp/lint \
--rm \
$(SUPER_LINTER_TEST_CONTAINER_URL)
.PHONY: test-non-default-home-directory
@ -562,6 +585,7 @@ build-dev-container-image: docker-dev-container-build-check ## Build commit lint
lint-commits: build-dev-container-image ## Lint commits
docker run \
-v "$(CURDIR):/source-repository" \
--rm \
${DEV_CONTAINER_URL} \
commitlint \
--config .github/linters/commitlint.config.js \
@ -575,6 +599,7 @@ release-please-dry-run: build-dev-container-image check-github-token ## Run rele
@echo "Running release-please against branch: ${RELEASE_PLEASE_TARGET_BRANCH}"; \
docker run \
-v "$(CURDIR):/source-repository" \
--rm \
${DEV_CONTAINER_URL} \
release-please \
release-pr \

21
lib/functions/output.sh
View file

@ -6,8 +6,8 @@ WriteSummaryHeader() {
{
echo "# Super-linter summary"
echo ""
echo "| Language | Validation result |"
echo "| -----------------------|-------------------|"
echo "| Language | Validation result |"
echo "| -------- | ----------------- |"
} >>"${SUPER_LINTER_SUMMARY_OUTPUT_PATH}"
}
@ -38,3 +38,20 @@ WriteSummaryFooterFailure() {
echo "Super-linter detected linting errors"
} >>"${SUPER_LINTER_SUMMARY_OUTPUT_PATH}"
}
FormatSuperLinterSummaryFile() {
local SUPER_LINTER_SUMMARY_OUTPUT_PATH="${1}"
local SUPER_LINTER_SUMMARY_FORMAT_COMMAND=(prettier --write)
# Override the default prettier ignore paths (.gitignore, .prettierignore) to
# avoid considering their defaults because prettier will skip formatting
# the summary report file if the summary report file is ignored in those
# ignore files, which is usually the case for generated files.
# Ref: https://prettier.io/docs/en/cli#--ignore-path
SUPER_LINTER_SUMMARY_FORMAT_COMMAND+=(--ignore-path /dev/null)
SUPER_LINTER_SUMMARY_FORMAT_COMMAND+=("${SUPER_LINTER_SUMMARY_OUTPUT_PATH}")
debug "Formatting the Super-linter summary file by running: ${SUPER_LINTER_SUMMARY_FORMAT_COMMAND[*]}"
if ! "${SUPER_LINTER_SUMMARY_FORMAT_COMMAND[@]}"; then
error "Error while formatting the Super-linter summary file."
return 1
fi
}

3
lib/linter.sh
View file

@ -561,6 +561,9 @@ Footer() {
fi
if [[ "${SAVE_SUPER_LINTER_SUMMARY}" == "true" ]]; then
if ! FormatSuperLinterSummaryFile "${SUPER_LINTER_SUMMARY_OUTPUT_PATH}"; then
fatal "Error while formatting the Super-linter summary file."
fi
debug "Super-linter summary file (${SUPER_LINTER_SUMMARY_OUTPUT_PATH}) contents:\n$(cat "${SUPER_LINTER_SUMMARY_OUTPUT_PATH}")"
fi

3
test/data/super-linter-summary/markdown/table/expected-summary-footer-failure.md
View file

@ -1,3 +0,0 @@
<!-- markdownlint-disable -->
Super-linter detected linting errors

3
test/data/super-linter-summary/markdown/table/expected-summary-footer-success.md
View file

@ -1,3 +0,0 @@
<!-- markdownlint-disable -->
All files and directories linted successfully

4
test/data/super-linter-summary/markdown/table/expected-summary-heading.md
View file

@ -1,4 +0,0 @@
# Super-linter summary
| Language | Validation result |
| -----------------------|-------------------|

2
test/data/super-linter-summary/markdown/table/expected-summary-line-failure.md
View file

@ -1,2 +0,0 @@
<!-- markdownlint-disable -->
| Test Language | Fail ❌ |

2
test/data/super-linter-summary/markdown/table/expected-summary-line-success.md
View file

@ -1,2 +0,0 @@
<!-- markdownlint-disable -->
| Test Language | Pass ✅ |

164
test/data/super-linter-summary/markdown/table/expected-summary-test-linters-expect-failure-slim.md
View file

@ -1,88 +1,90 @@
# Super-linter summary
<!-- textlint-disable terminology -->
| Language | Validation result |
| -----------------------|-------------------|
| ANSIBLE | Fail ❌ |
| BASH | Fail ❌ |
| BASH_EXEC | Fail ❌ |
| CHECKOV | Fail ❌ |
| CLANG_FORMAT | Fail ❌ |
| CLOUDFORMATION | Fail ❌ |
| CLOJURE | Fail ❌ |
| COFFEESCRIPT | Fail ❌ |
| CPP | Fail ❌ |
| CSS | Fail ❌ |
| CSS_PRETTIER | Fail ❌ |
| DART | Fail ❌ |
| DOCKERFILE_HADOLINT | Fail ❌ |
| EDITORCONFIG | Fail ❌ |
| ENV | Fail ❌ |
| GITHUB_ACTIONS | Fail ❌ |
| GITLEAKS | Fail ❌ |
| GHERKIN | Fail ❌ |
| GO | Fail ❌ |
| GO_MODULES | Fail ❌ |
| GO_RELEASER | Fail ❌ |
| GOOGLE_JAVA_FORMAT | Fail ❌ |
| GRAPHQL_PRETTIER | Fail ❌ |
| GROOVY | Fail ❌ |
| HTML | Fail ❌ |
| HTML_PRETTIER | Fail ❌ |
| JAVA | Fail ❌ |
| JAVASCRIPT_ES | Fail ❌ |
| JAVASCRIPT_PRETTIER | Fail ❌ |
| JAVASCRIPT_STANDARD | Fail ❌ |
| JSCPD | Fail ❌ |
| JSON | Fail ❌ |
| JSON_PRETTIER | Fail ❌ |
| JSONC | Fail ❌ |
| JSONC_PRETTIER | Fail ❌ |
| JSX | Fail ❌ |
| JSX_PRETTIER | Fail ❌ |
| KUBERNETES_KUBECONFORM | Fail ❌ |
| KOTLIN | Fail ❌ |
| LATEX | Fail ❌ |
| LUA | Fail ❌ |
| MARKDOWN | Fail ❌ |
| MARKDOWN_PRETTIER | Fail ❌ |
| NATURAL_LANGUAGE | Fail ❌ |
| OPENAPI | Fail ❌ |
| PERL | Fail ❌ |
| PHP_BUILTIN | Fail ❌ |
| PHP_PHPCS | Fail ❌ |
| PHP_PHPSTAN | Fail ❌ |
| PHP_PSALM | Fail ❌ |
| PROTOBUF | Fail ❌ |
| PYTHON_BLACK | Fail ❌ |
| PYTHON_PYLINT | Fail ❌ |
| PYTHON_FLAKE8 | Fail ❌ |
| PYTHON_ISORT | Fail ❌ |
| PYTHON_MYPY | Fail ❌ |
| PYTHON_RUFF | Fail ❌ |
| R | Fail ❌ |
| RAKU | Fail ❌ |
| RENOVATE | Fail ❌ |
| RUBY | Fail ❌ |
| SCALAFMT | Fail ❌ |
| SHELL_SHFMT | Fail ❌ |
| SNAKEMAKE_LINT | Fail ❌ |
| SNAKEMAKE_SNAKEFMT | Fail ❌ |
| STATES | Fail ❌ |
| SQLFLUFF | Fail ❌ |
| TEKTON | Fail ❌ |
| TERRAFORM_FMT | Fail ❌ |
| TERRAFORM_TFLINT | Fail ❌ |
| TERRAFORM_TERRASCAN | Fail ❌ |
| TERRAGRUNT | Fail ❌ |
| TSX | Fail ❌ |
| TYPESCRIPT_ES | Fail ❌ |
| TYPESCRIPT_PRETTIER | Fail ❌ |
| TYPESCRIPT_STANDARD | Fail ❌ |
| VUE_PRETTIER | Fail ❌ |
| XML | Fail ❌ |
| YAML | Fail ❌ |
| YAML_PRETTIER | Fail ❌ |
| ---------------------- | ----------------- |
| ANSIBLE | Fail ❌ |
| BASH | Fail ❌ |
| BASH_EXEC | Fail ❌ |
| CHECKOV | Fail ❌ |
| CLANG_FORMAT | Fail ❌ |
| CLOUDFORMATION | Fail ❌ |
| CLOJURE | Fail ❌ |
| COFFEESCRIPT | Fail ❌ |
| CPP | Fail ❌ |
| CSS | Fail ❌ |
| CSS_PRETTIER | Fail ❌ |
| DART | Fail ❌ |
| DOCKERFILE_HADOLINT | Fail ❌ |
| EDITORCONFIG | Fail ❌ |
| ENV | Fail ❌ |
| GITHUB_ACTIONS | Fail ❌ |
| GITLEAKS | Fail ❌ |
| GHERKIN | Fail ❌ |
| GO | Fail ❌ |
| GO_MODULES | Fail ❌ |
| GO_RELEASER | Fail ❌ |
| GOOGLE_JAVA_FORMAT | Fail ❌ |
| GRAPHQL_PRETTIER | Fail ❌ |
| GROOVY | Fail ❌ |
| HTML | Fail ❌ |
| HTML_PRETTIER | Fail ❌ |
| JAVA | Fail ❌ |
| JAVASCRIPT_ES | Fail ❌ |
| JAVASCRIPT_PRETTIER | Fail ❌ |
| JAVASCRIPT_STANDARD | Fail ❌ |
| JSCPD | Fail ❌ |
| JSON | Fail ❌ |
| JSON_PRETTIER | Fail ❌ |
| JSONC | Fail ❌ |
| JSONC_PRETTIER | Fail ❌ |
| JSX | Fail ❌ |
| JSX_PRETTIER | Fail ❌ |
| KUBERNETES_KUBECONFORM | Fail ❌ |
| KOTLIN | Fail ❌ |
| LATEX | Fail ❌ |
| LUA | Fail ❌ |
| MARKDOWN | Fail ❌ |
| MARKDOWN_PRETTIER | Fail ❌ |
| NATURAL_LANGUAGE | Fail ❌ |
| OPENAPI | Fail ❌ |
| PERL | Fail ❌ |
| PHP_BUILTIN | Fail ❌ |
| PHP_PHPCS | Fail ❌ |
| PHP_PHPSTAN | Fail ❌ |
| PHP_PSALM | Fail ❌ |
| PROTOBUF | Fail ❌ |
| PYTHON_BLACK | Fail ❌ |
| PYTHON_PYLINT | Fail ❌ |
| PYTHON_FLAKE8 | Fail ❌ |
| PYTHON_ISORT | Fail ❌ |
| PYTHON_MYPY | Fail ❌ |
| PYTHON_RUFF | Fail ❌ |
| R | Fail ❌ |
| RAKU | Fail ❌ |
| RENOVATE | Fail ❌ |
| RUBY | Fail ❌ |
| SCALAFMT | Fail ❌ |
| SHELL_SHFMT | Fail ❌ |
| SNAKEMAKE_LINT | Fail ❌ |
| SNAKEMAKE_SNAKEFMT | Fail ❌ |
| STATES | Fail ❌ |
| SQLFLUFF | Fail ❌ |
| TEKTON | Fail ❌ |
| TERRAFORM_FMT | Fail ❌ |
| TERRAFORM_TFLINT | Fail ❌ |
| TERRAFORM_TERRASCAN | Fail ❌ |
| TERRAGRUNT | Fail ❌ |
| TSX | Fail ❌ |
| TYPESCRIPT_ES | Fail ❌ |
| TYPESCRIPT_PRETTIER | Fail ❌ |
| TYPESCRIPT_STANDARD | Fail ❌ |
| VUE_PRETTIER | Fail ❌ |
| XML | Fail ❌ |
| YAML | Fail ❌ |
| YAML_PRETTIER | Fail ❌ |
<!-- textlint-enable terminology -->
Super-linter detected linting errors

186
test/data/super-linter-summary/markdown/table/expected-summary-test-linters-expect-failure-standard.md
View file

@ -1,98 +1,100 @@
# Super-linter summary
<!-- textlint-disable terminology -->
| Language | Validation result |
| -----------------------|-------------------|
| ANSIBLE | Fail ❌ |
| ARM | Fail ❌ |
| BASH | Fail ❌ |
| BASH_EXEC | Fail ❌ |
| CHECKOV | Fail ❌ |
| CLANG_FORMAT | Fail ❌ |
| CLOUDFORMATION | Fail ❌ |
| CLOJURE | Fail ❌ |
| COFFEESCRIPT | Fail ❌ |
| CPP | Fail ❌ |
| CSHARP | Fail ❌ |
| CSS | Fail ❌ |
| CSS_PRETTIER | Fail ❌ |
| DART | Fail ❌ |
| DOCKERFILE_HADOLINT | Fail ❌ |
| DOTNET_SLN_FORMAT_ANALYZERS | Fail ❌ |
| DOTNET_SLN_FORMAT_STYLE | Fail ❌ |
| DOTNET_SLN_FORMAT_WHITESPACE | Fail ❌ |
| EDITORCONFIG | Fail ❌ |
| ENV | Fail ❌ |
| GITHUB_ACTIONS | Fail ❌ |
| GITLEAKS | Fail ❌ |
| GHERKIN | Fail ❌ |
| GO | Fail ❌ |
| GO_MODULES | Fail ❌ |
| GO_RELEASER | Fail ❌ |
| GOOGLE_JAVA_FORMAT | Fail ❌ |
| GRAPHQL_PRETTIER | Fail ❌ |
| GROOVY | Fail ❌ |
| HTML | Fail ❌ |
| HTML_PRETTIER | Fail ❌ |
| JAVA | Fail ❌ |
| JAVASCRIPT_ES | Fail ❌ |
| JAVASCRIPT_PRETTIER | Fail ❌ |
| JAVASCRIPT_STANDARD | Fail ❌ |
| JSCPD | Fail ❌ |
| JSON | Fail ❌ |
| JSON_PRETTIER | Fail ❌ |
| JSONC | Fail ❌ |
| JSONC_PRETTIER | Fail ❌ |
| JSX | Fail ❌ |
| JSX_PRETTIER | Fail ❌ |
| KUBERNETES_KUBECONFORM | Fail ❌ |
| KOTLIN | Fail ❌ |
| LATEX | Fail ❌ |
| LUA | Fail ❌ |
| MARKDOWN | Fail ❌ |
| MARKDOWN_PRETTIER | Fail ❌ |
| NATURAL_LANGUAGE | Fail ❌ |
| OPENAPI | Fail ❌ |
| PERL | Fail ❌ |
| PHP_BUILTIN | Fail ❌ |
| PHP_PHPCS | Fail ❌ |
| PHP_PHPSTAN | Fail ❌ |
| PHP_PSALM | Fail ❌ |
| POWERSHELL | Fail ❌ |
| PROTOBUF | Fail ❌ |
| PYTHON_BLACK | Fail ❌ |
| PYTHON_PYLINT | Fail ❌ |
| PYTHON_FLAKE8 | Fail ❌ |
| PYTHON_ISORT | Fail ❌ |
| PYTHON_MYPY | Fail ❌ |
| PYTHON_RUFF | Fail ❌ |
| R | Fail ❌ |
| RAKU | Fail ❌ |
| RENOVATE | Fail ❌ |
| RUBY | Fail ❌ |
| RUST_2015 | Fail ❌ |
| RUST_2018 | Fail ❌ |
| RUST_2021 | Fail ❌ |
| RUST_CLIPPY | Fail ❌ |
| SCALAFMT | Fail ❌ |
| SHELL_SHFMT | Fail ❌ |
| SNAKEMAKE_LINT | Fail ❌ |
| SNAKEMAKE_SNAKEFMT | Fail ❌ |
| STATES | Fail ❌ |
| SQLFLUFF | Fail ❌ |
| TEKTON | Fail ❌ |
| TERRAFORM_FMT | Fail ❌ |
| TERRAFORM_TFLINT | Fail ❌ |
| TERRAFORM_TERRASCAN | Fail ❌ |
| TERRAGRUNT | Fail ❌ |
| TSX | Fail ❌ |
| TYPESCRIPT_ES | Fail ❌ |
| TYPESCRIPT_PRETTIER | Fail ❌ |
| TYPESCRIPT_STANDARD | Fail ❌ |
| VUE_PRETTIER | Fail ❌ |
| XML | Fail ❌ |
| YAML | Fail ❌ |
| YAML_PRETTIER | Fail ❌ |
| Language | Validation result |
| ---------------------------- | ----------------- |
| ANSIBLE | Fail ❌ |
| ARM | Fail ❌ |
| BASH | Fail ❌ |
| BASH_EXEC | Fail ❌ |
| CHECKOV | Fail ❌ |
| CLANG_FORMAT | Fail ❌ |
| CLOUDFORMATION | Fail ❌ |
| CLOJURE | Fail ❌ |
| COFFEESCRIPT | Fail ❌ |
| CPP | Fail ❌ |
| CSHARP | Fail ❌ |
| CSS | Fail ❌ |
| CSS_PRETTIER | Fail ❌ |
| DART | Fail ❌ |
| DOCKERFILE_HADOLINT | Fail ❌ |
| DOTNET_SLN_FORMAT_ANALYZERS | Fail ❌ |
| DOTNET_SLN_FORMAT_STYLE | Fail ❌ |
| DOTNET_SLN_FORMAT_WHITESPACE | Fail ❌ |
| EDITORCONFIG | Fail ❌ |
| ENV | Fail ❌ |
| GITHUB_ACTIONS | Fail ❌ |
| GITLEAKS | Fail ❌ |
| GHERKIN | Fail ❌ |
| GO | Fail ❌ |
| GO_MODULES | Fail ❌ |
| GO_RELEASER | Fail ❌ |
| GOOGLE_JAVA_FORMAT | Fail ❌ |
| GRAPHQL_PRETTIER | Fail ❌ |
| GROOVY | Fail ❌ |
| HTML | Fail ❌ |
| HTML_PRETTIER | Fail ❌ |
| JAVA | Fail ❌ |
| JAVASCRIPT_ES | Fail ❌ |
| JAVASCRIPT_PRETTIER | Fail ❌ |
| JAVASCRIPT_STANDARD | Fail ❌ |
| JSCPD | Fail ❌ |
| JSON | Fail ❌ |
| JSON_PRETTIER | Fail ❌ |
| JSONC | Fail ❌ |
| JSONC_PRETTIER | Fail ❌ |
| JSX | Fail ❌ |
| JSX_PRETTIER | Fail ❌ |
| KUBERNETES_KUBECONFORM | Fail ❌ |
| KOTLIN | Fail ❌ |
| LATEX | Fail ❌ |
| LUA | Fail ❌ |
| MARKDOWN | Fail ❌ |
| MARKDOWN_PRETTIER | Fail ❌ |
| NATURAL_LANGUAGE | Fail ❌ |
| OPENAPI | Fail ❌ |
| PERL | Fail ❌ |
| PHP_BUILTIN | Fail ❌ |
| PHP_PHPCS | Fail ❌ |
| PHP_PHPSTAN | Fail ❌ |
| PHP_PSALM | Fail ❌ |
| POWERSHELL | Fail ❌ |
| PROTOBUF | Fail ❌ |
| PYTHON_BLACK | Fail ❌ |
| PYTHON_PYLINT | Fail ❌ |
| PYTHON_FLAKE8 | Fail ❌ |
| PYTHON_ISORT | Fail ❌ |
| PYTHON_MYPY | Fail ❌ |
| PYTHON_RUFF | Fail ❌ |
| R | Fail ❌ |
| RAKU | Fail ❌ |
| RENOVATE | Fail ❌ |
| RUBY | Fail ❌ |
| RUST_2015 | Fail ❌ |
| RUST_2018 | Fail ❌ |
| RUST_2021 | Fail ❌ |
| RUST_CLIPPY | Fail ❌ |
| SCALAFMT | Fail ❌ |
| SHELL_SHFMT | Fail ❌ |
| SNAKEMAKE_LINT | Fail ❌ |
| SNAKEMAKE_SNAKEFMT | Fail ❌ |
| STATES | Fail ❌ |
| SQLFLUFF | Fail ❌ |
| TEKTON | Fail ❌ |
| TERRAFORM_FMT | Fail ❌ |
| TERRAFORM_TFLINT | Fail ❌ |
| TERRAFORM_TERRASCAN | Fail ❌ |
| TERRAGRUNT | Fail ❌ |
| TSX | Fail ❌ |
| TYPESCRIPT_ES | Fail ❌ |
| TYPESCRIPT_PRETTIER | Fail ❌ |
| TYPESCRIPT_STANDARD | Fail ❌ |
| VUE_PRETTIER | Fail ❌ |
| XML | Fail ❌ |
| YAML | Fail ❌ |
| YAML_PRETTIER | Fail ❌ |
<!-- textlint-enable terminology -->
Super-linter detected linting errors

164
test/data/super-linter-summary/markdown/table/expected-summary-test-linters-expect-success-slim.md
View file

@ -1,88 +1,90 @@
# Super-linter summary
<!-- textlint-disable terminology -->
| Language | Validation result |
| -----------------------|-------------------|
| ANSIBLE | Pass ✅ |
| BASH | Pass ✅ |
| BASH_EXEC | Pass ✅ |
| CHECKOV | Pass ✅ |
| CLANG_FORMAT | Pass ✅ |
| CLOUDFORMATION | Pass ✅ |
| CLOJURE | Pass ✅ |
| COFFEESCRIPT | Pass ✅ |
| CPP | Pass ✅ |
| CSS | Pass ✅ |
| CSS_PRETTIER | Pass ✅ |
| DART | Pass ✅ |
| DOCKERFILE_HADOLINT | Pass ✅ |
| EDITORCONFIG | Pass ✅ |
| ENV | Pass ✅ |
| GITHUB_ACTIONS | Pass ✅ |
| GITLEAKS | Pass ✅ |
| GHERKIN | Pass ✅ |
| GO | Pass ✅ |
| GO_MODULES | Pass ✅ |
| GO_RELEASER | Pass ✅ |
| GOOGLE_JAVA_FORMAT | Pass ✅ |
| GRAPHQL_PRETTIER | Pass ✅ |
| GROOVY | Pass ✅ |
| HTML | Pass ✅ |
| HTML_PRETTIER | Pass ✅ |
| JAVA | Pass ✅ |
| JAVASCRIPT_ES | Pass ✅ |
| JAVASCRIPT_PRETTIER | Pass ✅ |
| JAVASCRIPT_STANDARD | Pass ✅ |
| JSCPD | Pass ✅ |
| JSON | Pass ✅ |
| JSON_PRETTIER | Pass ✅ |
| JSONC | Pass ✅ |
| JSONC_PRETTIER | Pass ✅ |
| JSX | Pass ✅ |
| JSX_PRETTIER | Pass ✅ |
| KUBERNETES_KUBECONFORM | Pass ✅ |
| KOTLIN | Pass ✅ |
| LATEX | Pass ✅ |
| LUA | Pass ✅ |
| MARKDOWN | Pass ✅ |
| MARKDOWN_PRETTIER | Pass ✅ |
| NATURAL_LANGUAGE | Pass ✅ |
| OPENAPI | Pass ✅ |
| PERL | Pass ✅ |
| PHP_BUILTIN | Pass ✅ |
| PHP_PHPCS | Pass ✅ |
| PHP_PHPSTAN | Pass ✅ |
| PHP_PSALM | Pass ✅ |
| PROTOBUF | Pass ✅ |
| PYTHON_BLACK | Pass ✅ |
| PYTHON_PYLINT | Pass ✅ |
| PYTHON_FLAKE8 | Pass ✅ |
| PYTHON_ISORT | Pass ✅ |
| PYTHON_MYPY | Pass ✅ |
| PYTHON_RUFF | Pass ✅ |
| R | Pass ✅ |
| RAKU | Pass ✅ |
| RENOVATE | Pass ✅ |
| RUBY | Pass ✅ |
| SCALAFMT | Pass ✅ |
| SHELL_SHFMT | Pass ✅ |
| SNAKEMAKE_LINT | Pass ✅ |
| SNAKEMAKE_SNAKEFMT | Pass ✅ |
| STATES | Pass ✅ |
| SQLFLUFF | Pass ✅ |
| TEKTON | Pass ✅ |
| TERRAFORM_FMT | Pass ✅ |
| TERRAFORM_TFLINT | Pass ✅ |
| TERRAFORM_TERRASCAN | Pass ✅ |
| TERRAGRUNT | Pass ✅ |
| TSX | Pass ✅ |
| TYPESCRIPT_ES | Pass ✅ |
| TYPESCRIPT_PRETTIER | Pass ✅ |
| TYPESCRIPT_STANDARD | Pass ✅ |
| VUE_PRETTIER | Pass ✅ |
| XML | Pass ✅ |
| YAML | Pass ✅ |
| YAML_PRETTIER | Pass ✅ |
| ---------------------- | ----------------- |
| ANSIBLE | Pass ✅ |
| BASH | Pass ✅ |
| BASH_EXEC | Pass ✅ |
| CHECKOV | Pass ✅ |
| CLANG_FORMAT | Pass ✅ |
| CLOUDFORMATION | Pass ✅ |
| CLOJURE | Pass ✅ |
| COFFEESCRIPT | Pass ✅ |
| CPP | Pass ✅ |
| CSS | Pass ✅ |
| CSS_PRETTIER | Pass ✅ |
| DART | Pass ✅ |
| DOCKERFILE_HADOLINT | Pass ✅ |
| EDITORCONFIG | Pass ✅ |
| ENV | Pass ✅ |
| GITHUB_ACTIONS | Pass ✅ |
| GITLEAKS | Pass ✅ |
| GHERKIN | Pass ✅ |
| GO | Pass ✅ |
| GO_MODULES | Pass ✅ |
| GO_RELEASER | Pass ✅ |
| GOOGLE_JAVA_FORMAT | Pass ✅ |
| GRAPHQL_PRETTIER | Pass ✅ |
| GROOVY | Pass ✅ |
| HTML | Pass ✅ |
| HTML_PRETTIER | Pass ✅ |
| JAVA | Pass ✅ |
| JAVASCRIPT_ES | Pass ✅ |
| JAVASCRIPT_PRETTIER | Pass ✅ |
| JAVASCRIPT_STANDARD | Pass ✅ |
| JSCPD | Pass ✅ |
| JSON | Pass ✅ |
| JSON_PRETTIER | Pass ✅ |
| JSONC | Pass ✅ |
| JSONC_PRETTIER | Pass ✅ |
| JSX | Pass ✅ |
| JSX_PRETTIER | Pass ✅ |
| KUBERNETES_KUBECONFORM | Pass ✅ |
| KOTLIN | Pass ✅ |
| LATEX | Pass ✅ |
| LUA | Pass ✅ |
| MARKDOWN | Pass ✅ |
| MARKDOWN_PRETTIER | Pass ✅ |
| NATURAL_LANGUAGE | Pass ✅ |
| OPENAPI | Pass ✅ |
| PERL | Pass ✅ |
| PHP_BUILTIN | Pass ✅ |
| PHP_PHPCS | Pass ✅ |
| PHP_PHPSTAN | Pass ✅ |
| PHP_PSALM | Pass ✅ |
| PROTOBUF | Pass ✅ |
| PYTHON_BLACK | Pass ✅ |
| PYTHON_PYLINT | Pass ✅ |
| PYTHON_FLAKE8 | Pass ✅ |
| PYTHON_ISORT | Pass ✅ |
| PYTHON_MYPY | Pass ✅ |
| PYTHON_RUFF | Pass ✅ |
| R | Pass ✅ |
| RAKU | Pass ✅ |
| RENOVATE | Pass ✅ |
| RUBY | Pass ✅ |
| SCALAFMT | Pass ✅ |
| SHELL_SHFMT | Pass ✅ |
| SNAKEMAKE_LINT | Pass ✅ |
| SNAKEMAKE_SNAKEFMT | Pass ✅ |
| STATES | Pass ✅ |
| SQLFLUFF | Pass ✅ |
| TEKTON | Pass ✅ |
| TERRAFORM_FMT | Pass ✅ |
| TERRAFORM_TFLINT | Pass ✅ |
| TERRAFORM_TERRASCAN | Pass ✅ |
| TERRAGRUNT | Pass ✅ |
| TSX | Pass ✅ |
| TYPESCRIPT_ES | Pass ✅ |
| TYPESCRIPT_PRETTIER | Pass ✅ |
| TYPESCRIPT_STANDARD | Pass ✅ |
| VUE_PRETTIER | Pass ✅ |
| XML | Pass ✅ |
| YAML | Pass ✅ |
| YAML_PRETTIER | Pass ✅ |
<!-- textlint-enable terminology -->
All files and directories linted successfully

186
test/data/super-linter-summary/markdown/table/expected-summary-test-linters-expect-success-standard.md
View file

@ -1,98 +1,100 @@
# Super-linter summary
<!-- textlint-disable terminology -->
| Language | Validation result |
| -----------------------|-------------------|
| ANSIBLE | Pass ✅ |
| ARM | Pass ✅ |
| BASH | Pass ✅ |
| BASH_EXEC | Pass ✅ |
| CHECKOV | Pass ✅ |
| CLANG_FORMAT | Pass ✅ |
| CLOUDFORMATION | Pass ✅ |
| CLOJURE | Pass ✅ |
| COFFEESCRIPT | Pass ✅ |
| CPP | Pass ✅ |
| CSHARP | Pass ✅ |
| CSS | Pass ✅ |
| CSS_PRETTIER | Pass ✅ |
| DART | Pass ✅ |
| DOCKERFILE_HADOLINT | Pass ✅ |
| DOTNET_SLN_FORMAT_ANALYZERS | Pass ✅ |
| DOTNET_SLN_FORMAT_STYLE | Pass ✅ |
| DOTNET_SLN_FORMAT_WHITESPACE | Pass ✅ |
| EDITORCONFIG | Pass ✅ |
| ENV | Pass ✅ |
| GITHUB_ACTIONS | Pass ✅ |
| GITLEAKS | Pass ✅ |
| GHERKIN | Pass ✅ |
| GO | Pass ✅ |
| GO_MODULES | Pass ✅ |
| GO_RELEASER | Pass ✅ |
| GOOGLE_JAVA_FORMAT | Pass ✅ |
| GRAPHQL_PRETTIER | Pass ✅ |
| GROOVY | Pass ✅ |
| HTML | Pass ✅ |
| HTML_PRETTIER | Pass ✅ |
| JAVA | Pass ✅ |
| JAVASCRIPT_ES | Pass ✅ |
| JAVASCRIPT_PRETTIER | Pass ✅ |
| JAVASCRIPT_STANDARD | Pass ✅ |
| JSCPD | Pass ✅ |
| JSON | Pass ✅ |
| JSON_PRETTIER | Pass ✅ |
| JSONC | Pass ✅ |
| JSONC_PRETTIER | Pass ✅ |
| JSX | Pass ✅ |
| JSX_PRETTIER | Pass ✅ |
| KUBERNETES_KUBECONFORM | Pass ✅ |
| KOTLIN | Pass ✅ |
| LATEX | Pass ✅ |
| LUA | Pass ✅ |
| MARKDOWN | Pass ✅ |
| MARKDOWN_PRETTIER | Pass ✅ |
| NATURAL_LANGUAGE | Pass ✅ |
| OPENAPI | Pass ✅ |
| PERL | Pass ✅ |
| PHP_BUILTIN | Pass ✅ |
| PHP_PHPCS | Pass ✅ |
| PHP_PHPSTAN | Pass ✅ |
| PHP_PSALM | Pass ✅ |
| POWERSHELL | Pass ✅ |
| PROTOBUF | Pass ✅ |
| PYTHON_BLACK | Pass ✅ |
| PYTHON_PYLINT | Pass ✅ |
| PYTHON_FLAKE8 | Pass ✅ |
| PYTHON_ISORT | Pass ✅ |
| PYTHON_MYPY | Pass ✅ |
| PYTHON_RUFF | Pass ✅ |
| R | Pass ✅ |
| RAKU | Pass ✅ |
| RENOVATE | Pass ✅ |
| RUBY | Pass ✅ |
| RUST_2015 | Pass ✅ |
| RUST_2018 | Pass ✅ |
| RUST_2021 | Pass ✅ |
| RUST_CLIPPY | Pass ✅ |
| SCALAFMT | Pass ✅ |
| SHELL_SHFMT | Pass ✅ |
| SNAKEMAKE_LINT | Pass ✅ |
| SNAKEMAKE_SNAKEFMT | Pass ✅ |
| STATES | Pass ✅ |
| SQLFLUFF | Pass ✅ |
| TEKTON | Pass ✅ |
| TERRAFORM_FMT | Pass ✅ |
| TERRAFORM_TFLINT | Pass ✅ |
| TERRAFORM_TERRASCAN | Pass ✅ |
| TERRAGRUNT | Pass ✅ |
| TSX | Pass ✅ |
| TYPESCRIPT_ES | Pass ✅ |
| TYPESCRIPT_PRETTIER | Pass ✅ |
| TYPESCRIPT_STANDARD | Pass ✅ |
| VUE_PRETTIER | Pass ✅ |
| XML | Pass ✅ |
| YAML | Pass ✅ |
| YAML_PRETTIER | Pass ✅ |
| Language | Validation result |
| ---------------------------- | ----------------- |
| ANSIBLE | Pass ✅ |
| ARM | Pass ✅ |
| BASH | Pass ✅ |
| BASH_EXEC | Pass ✅ |
| CHECKOV | Pass ✅ |
| CLANG_FORMAT | Pass ✅ |
| CLOUDFORMATION | Pass ✅ |
| CLOJURE | Pass ✅ |
| COFFEESCRIPT | Pass ✅ |
| CPP | Pass ✅ |
| CSHARP | Pass ✅ |
| CSS | Pass ✅ |
| CSS_PRETTIER | Pass ✅ |
| DART | Pass ✅ |
| DOCKERFILE_HADOLINT | Pass ✅ |
| DOTNET_SLN_FORMAT_ANALYZERS | Pass ✅ |
| DOTNET_SLN_FORMAT_STYLE | Pass ✅ |
| DOTNET_SLN_FORMAT_WHITESPACE | Pass ✅ |
| EDITORCONFIG | Pass ✅ |
| ENV | Pass ✅ |
| GITHUB_ACTIONS | Pass ✅ |
| GITLEAKS | Pass ✅ |
| GHERKIN | Pass ✅ |
| GO | Pass ✅ |
| GO_MODULES | Pass ✅ |
| GO_RELEASER | Pass ✅ |
| GOOGLE_JAVA_FORMAT | Pass ✅ |
| GRAPHQL_PRETTIER | Pass ✅ |
| GROOVY | Pass ✅ |
| HTML | Pass ✅ |
| HTML_PRETTIER | Pass ✅ |
| JAVA | Pass ✅ |
| JAVASCRIPT_ES | Pass ✅ |
| JAVASCRIPT_PRETTIER | Pass ✅ |
| JAVASCRIPT_STANDARD | Pass ✅ |
| JSCPD | Pass ✅ |
| JSON | Pass ✅ |
| JSON_PRETTIER | Pass ✅ |
| JSONC | Pass ✅ |
| JSONC_PRETTIER | Pass ✅ |
| JSX | Pass ✅ |
| JSX_PRETTIER | Pass ✅ |
| KUBERNETES_KUBECONFORM | Pass ✅ |
| KOTLIN | Pass ✅ |
| LATEX | Pass ✅ |
| LUA | Pass ✅ |
| MARKDOWN | Pass ✅ |
| MARKDOWN_PRETTIER | Pass ✅ |
| NATURAL_LANGUAGE | Pass ✅ |
| OPENAPI | Pass ✅ |
| PERL | Pass ✅ |
| PHP_BUILTIN | Pass ✅ |
| PHP_PHPCS | Pass ✅ |
| PHP_PHPSTAN | Pass ✅ |
| PHP_PSALM | Pass ✅ |
| POWERSHELL | Pass ✅ |
| PROTOBUF | Pass ✅ |
| PYTHON_BLACK | Pass ✅ |
| PYTHON_PYLINT | Pass ✅ |
| PYTHON_FLAKE8 | Pass ✅ |
| PYTHON_ISORT | Pass ✅ |
| PYTHON_MYPY | Pass ✅ |
| PYTHON_RUFF | Pass ✅ |
| R | Pass ✅ |
| RAKU | Pass ✅ |
| RENOVATE | Pass ✅ |
| RUBY | Pass ✅ |
| RUST_2015 | Pass ✅ |
| RUST_2018 | Pass ✅ |
| RUST_2021 | Pass ✅ |
| RUST_CLIPPY | Pass ✅ |
| SCALAFMT | Pass ✅ |
| SHELL_SHFMT | Pass ✅ |
| SNAKEMAKE_LINT | Pass ✅ |
| SNAKEMAKE_SNAKEFMT | Pass ✅ |
| STATES | Pass ✅ |
| SQLFLUFF | Pass ✅ |
| TEKTON | Pass ✅ |
| TERRAFORM_FMT | Pass ✅ |
| TERRAFORM_TFLINT | Pass ✅ |
| TERRAFORM_TERRASCAN | Pass ✅ |
| TERRAGRUNT | Pass ✅ |
| TSX | Pass ✅ |
| TYPESCRIPT_ES | Pass ✅ |
| TYPESCRIPT_PRETTIER | Pass ✅ |
| TYPESCRIPT_STANDARD | Pass ✅ |
| VUE_PRETTIER | Pass ✅ |
| XML | Pass ✅ |
| YAML | Pass ✅ |
| YAML_PRETTIER | Pass ✅ |
<!-- textlint-enable terminology -->
All files and directories linted successfully

84
test/data/super-linter-summary/markdown/table/expected-summary-test-linters-fix-mode-slim.md
View file

@ -1,47 +1,49 @@
# Super-linter summary
<!-- textlint-disable terminology -->
| Language | Validation result |
| -----------------------|-------------------|
| ANSIBLE | Pass ✅ |
| CLANG_FORMAT | Pass ✅ |
| CSS | Pass ✅ |
| CSS_PRETTIER | Pass ✅ |
| ENV | Pass ✅ |
| GO | Pass ✅ |
| GO_MODULES | Pass ✅ |
| GOOGLE_JAVA_FORMAT | Pass ✅ |
| GRAPHQL_PRETTIER | Pass ✅ |
| GROOVY | Fail ❌ |
| HTML_PRETTIER | Pass ✅ |
| JAVASCRIPT_ES | Pass ✅ |
| JAVASCRIPT_PRETTIER | Pass ✅ |
| JAVASCRIPT_STANDARD | Pass ✅ |
| JSON | Fail ❌ |
| JSON_PRETTIER | Pass ✅ |
| JSONC | Pass ✅ |
| JSONC_PRETTIER | Pass ✅ |
| JSX | Fail ❌ |
| JSX_PRETTIER | Pass ✅ |
| MARKDOWN | Pass ✅ |
| MARKDOWN_PRETTIER | Pass ✅ |
| NATURAL_LANGUAGE | Pass ✅ |
| PROTOBUF | Fail ❌ |
| PYTHON_BLACK | Pass ✅ |
| PYTHON_ISORT | Pass ✅ |
| PYTHON_RUFF | Pass ✅ |
| RUBY | Fail ❌ |
| SCALAFMT | Pass ✅ |
| SHELL_SHFMT | Pass ✅ |
| SNAKEMAKE_SNAKEFMT | Pass ✅ |
| SQLFLUFF | Pass ✅ |
| TERRAFORM_FMT | Pass ✅ |
| TSX | Fail ❌ |
| TYPESCRIPT_ES | Pass ✅ |
| TYPESCRIPT_PRETTIER | Pass ✅ |
| TYPESCRIPT_STANDARD | Pass ✅ |
| VUE_PRETTIER | Pass ✅ |
| YAML_PRETTIER | Pass ✅ |
| Language | Validation result |
| ------------------- | ----------------- |
| ANSIBLE | Pass ✅ |
| CLANG_FORMAT | Pass ✅ |
| CSS | Pass ✅ |
| CSS_PRETTIER | Pass ✅ |
| ENV | Pass ✅ |
| GO | Pass ✅ |
| GO_MODULES | Pass ✅ |
| GOOGLE_JAVA_FORMAT | Pass ✅ |
| GRAPHQL_PRETTIER | Pass ✅ |
| GROOVY | Fail ❌ |
| HTML_PRETTIER | Pass ✅ |
| JAVASCRIPT_ES | Pass ✅ |
| JAVASCRIPT_PRETTIER | Pass ✅ |
| JAVASCRIPT_STANDARD | Pass ✅ |
| JSON | Fail ❌ |
| JSON_PRETTIER | Pass ✅ |
| JSONC | Pass ✅ |
| JSONC_PRETTIER | Pass ✅ |
| JSX | Fail ❌ |
| JSX_PRETTIER | Pass ✅ |
| MARKDOWN | Pass ✅ |
| MARKDOWN_PRETTIER | Pass ✅ |
| NATURAL_LANGUAGE | Pass ✅ |
| PROTOBUF | Fail ❌ |
| PYTHON_BLACK | Pass ✅ |
| PYTHON_ISORT | Pass ✅ |
| PYTHON_RUFF | Pass ✅ |
| RUBY | Fail ❌ |
| SCALAFMT | Pass ✅ |
| SHELL_SHFMT | Pass ✅ |
| SNAKEMAKE_SNAKEFMT | Pass ✅ |
| SQLFLUFF | Pass ✅ |
| TERRAFORM_FMT | Pass ✅ |
| TSX | Fail ❌ |
| TYPESCRIPT_ES | Pass ✅ |
| TYPESCRIPT_PRETTIER | Pass ✅ |
| TYPESCRIPT_STANDARD | Pass ✅ |
| VUE_PRETTIER | Pass ✅ |
| YAML_PRETTIER | Pass ✅ |
<!-- textlint-enable terminology -->
Super-linter detected linting errors

102
test/data/super-linter-summary/markdown/table/expected-summary-test-linters-fix-mode-standard.md
View file

@ -1,56 +1,58 @@
# Super-linter summary
<!-- textlint-disable terminology -->
| Language | Validation result |
| -----------------------|-------------------|
| ANSIBLE | Pass ✅ |
| CLANG_FORMAT | Pass ✅ |
| CSHARP | Pass ✅ |
| CSS | Pass ✅ |
| CSS_PRETTIER | Pass ✅ |
| DOTNET_SLN_FORMAT_ANALYZERS | Pass ✅ |
| DOTNET_SLN_FORMAT_STYLE | Pass ✅ |
| DOTNET_SLN_FORMAT_WHITESPACE | Pass ✅ |
| ENV | Pass ✅ |
| GO | Pass ✅ |
| GO_MODULES | Pass ✅ |
| GOOGLE_JAVA_FORMAT | Pass ✅ |
| GRAPHQL_PRETTIER | Pass ✅ |
| GROOVY | Fail ❌ |
| HTML_PRETTIER | Pass ✅ |
| JAVASCRIPT_ES | Pass ✅ |
| JAVASCRIPT_PRETTIER | Pass ✅ |
| JAVASCRIPT_STANDARD | Pass ✅ |
| JSON | Fail ❌ |
| JSON_PRETTIER | Pass ✅ |
| JSONC | Pass ✅ |
| JSONC_PRETTIER | Pass ✅ |
| JSX | Fail ❌ |
| JSX_PRETTIER | Pass ✅ |
| MARKDOWN | Pass ✅ |
| MARKDOWN_PRETTIER | Pass ✅ |
| NATURAL_LANGUAGE | Pass ✅ |
| POWERSHELL | Fail ❌ |
| PROTOBUF | Fail ❌ |
| PYTHON_BLACK | Pass ✅ |
| PYTHON_ISORT | Pass ✅ |
| PYTHON_RUFF | Pass ✅ |
| RUBY | Fail ❌ |
| RUST_2015 | Pass ✅ |
| RUST_2018 | Pass ✅ |
| RUST_2021 | Pass ✅ |
| RUST_CLIPPY | Pass ✅ |
| SCALAFMT | Pass ✅ |
| SHELL_SHFMT | Pass ✅ |
| SNAKEMAKE_SNAKEFMT | Pass ✅ |
| SQLFLUFF | Pass ✅ |
| TERRAFORM_FMT | Pass ✅ |
| TSX | Fail ❌ |
| TYPESCRIPT_ES | Pass ✅ |
| TYPESCRIPT_PRETTIER | Pass ✅ |
| TYPESCRIPT_STANDARD | Pass ✅ |
| VUE_PRETTIER | Pass ✅ |
| YAML_PRETTIER | Pass ✅ |
| Language | Validation result |
| ---------------------------- | ----------------- |
| ANSIBLE | Pass ✅ |
| CLANG_FORMAT | Pass ✅ |
| CSHARP | Pass ✅ |
| CSS | Pass ✅ |
| CSS_PRETTIER | Pass ✅ |
| DOTNET_SLN_FORMAT_ANALYZERS | Pass ✅ |
| DOTNET_SLN_FORMAT_STYLE | Pass ✅ |
| DOTNET_SLN_FORMAT_WHITESPACE | Pass ✅ |
| ENV | Pass ✅ |
| GO | Pass ✅ |
| GO_MODULES | Pass ✅ |
| GOOGLE_JAVA_FORMAT | Pass ✅ |
| GRAPHQL_PRETTIER | Pass ✅ |
| GROOVY | Fail ❌ |
| HTML_PRETTIER | Pass ✅ |
| JAVASCRIPT_ES | Pass ✅ |
| JAVASCRIPT_PRETTIER | Pass ✅ |
| JAVASCRIPT_STANDARD | Pass ✅ |
| JSON | Fail ❌ |
| JSON_PRETTIER | Pass ✅ |
| JSONC | Pass ✅ |
| JSONC_PRETTIER | Pass ✅ |
| JSX | Fail ❌ |
| JSX_PRETTIER | Pass ✅ |
| MARKDOWN | Pass ✅ |
| MARKDOWN_PRETTIER | Pass ✅ |
| NATURAL_LANGUAGE | Pass ✅ |
| POWERSHELL | Fail ❌ |
| PROTOBUF | Fail ❌ |
| PYTHON_BLACK | Pass ✅ |
| PYTHON_ISORT | Pass ✅ |
| PYTHON_RUFF | Pass ✅ |
| RUBY | Fail ❌ |
| RUST_2015 | Pass ✅ |
| RUST_2018 | Pass ✅ |
| RUST_2021 | Pass ✅ |
| RUST_CLIPPY | Pass ✅ |
| SCALAFMT | Pass ✅ |
| SHELL_SHFMT | Pass ✅ |
| SNAKEMAKE_SNAKEFMT | Pass ✅ |
| SQLFLUFF | Pass ✅ |
| TERRAFORM_FMT | Pass ✅ |
| TSX | Fail ❌ |
| TYPESCRIPT_ES | Pass ✅ |
| TYPESCRIPT_PRETTIER | Pass ✅ |
| TYPESCRIPT_STANDARD | Pass ✅ |
| VUE_PRETTIER | Pass ✅ |
| YAML_PRETTIER | Pass ✅ |
<!-- textlint-enable terminology -->
Super-linter detected linting errors

50
test/lib/outputTest.sh
View file

@ -10,6 +10,9 @@ LOG_LEVEL="DEBUG"
# shellcheck source=/dev/null
source "lib/functions/log.sh"
# shellcheck source=/dev/null
source "test/testUtils.sh"
# shellcheck source=/dev/null
source "lib/functions/output.sh"
@ -24,14 +27,14 @@ function CleanupWorkspace() {
rm -rf "${TEMP_WORKSPACE}"
}
function CheckIfFileDiff() {
local INPUT_FILE="${1}"
local EXPECTED_FILE="${2}"
# Remove eventual HTML comments from the expected file because we use them to disable certain linter rules
if ! diff "${INPUT_FILE}" <(grep -vE '^\s*<!--' "${EXPECTED_FILE}"); then
fatal "${INPUT_FILE} contents don't match with the expected contents (${EXPECTED_FILE})"
CheckIfContentsDiff() {
local INPUT_FILE_CONTENT
INPUT_FILE_CONTENT="$(cat "${1}")"
local EXPECTED_CONTENT="${2}"
if [[ "${INPUT_FILE_CONTENT}" != "${EXPECTED_CONTENT}" ]]; then
fatal "\n${INPUT_FILE_CONTENT}\ncontents don't match the expected contents:\n${EXPECTED_CONTENT}"
else
echo "${INPUT_FILE} contents match with the expected contents (${EXPECTED_FILE})"
debug "\n${INPUT_FILE_CONTENT}\ncontents match the expected contents\n${EXPECTED_CONTENT}"
fi
}
@ -43,7 +46,16 @@ function WriteSummaryMarkdownTableHeaderTest() {
local RESULTS_FILE="${TEMP_WORKSPACE}/${FUNCTION_NAME}-output.md"
InitWorkspace
WriteSummaryHeader "${RESULTS_FILE}"
CheckIfFileDiff "${RESULTS_FILE}" "test/data/super-linter-summary/markdown/table/expected-summary-heading.md"
local EXPECTED_CONTENT
EXPECTED_CONTENT=$(
cat <<EOF
# Super-linter summary
| Language | Validation result |
| -------- | ----------------- |
EOF
)
CheckIfContentsDiff "${RESULTS_FILE}" "${EXPECTED_CONTENT}"
CleanupWorkspace
notice "${FUNCTION_NAME} PASS"
@ -57,7 +69,7 @@ function WriteSummaryMarkdownTableLineSuccessTest() {
local RESULTS_FILE="${TEMP_WORKSPACE}/${FUNCTION_NAME}-output-${FUNCTION_NAME}.md"
InitWorkspace
WriteSummaryLineSuccess "${RESULTS_FILE}" "Test Language"
CheckIfFileDiff "${RESULTS_FILE}" "test/data/super-linter-summary/markdown/table/expected-summary-line-success.md"
CheckIfContentsDiff "${RESULTS_FILE}" "| Test Language | Pass ✅ |"
CleanupWorkspace
notice "${FUNCTION_NAME} PASS"
@ -71,7 +83,7 @@ function WriteSummaryMarkdownTableLineFailureTest() {
local RESULTS_FILE="${TEMP_WORKSPACE}/${FUNCTION_NAME}-output-${FUNCTION_NAME}.md"
InitWorkspace
WriteSummaryLineFailure "${RESULTS_FILE}" "Test Language"
CheckIfFileDiff "${RESULTS_FILE}" "test/data/super-linter-summary/markdown/table/expected-summary-line-failure.md"
CheckIfContentsDiff "${RESULTS_FILE}" "| Test Language | Fail ❌ |"
CleanupWorkspace
notice "${FUNCTION_NAME} PASS"
@ -85,7 +97,14 @@ function WriteSummaryMarkdownTableFooterSuccessTest() {
local RESULTS_FILE="${TEMP_WORKSPACE}/${FUNCTION_NAME}-output-${FUNCTION_NAME}.md"
InitWorkspace
WriteSummaryFooterSuccess "${RESULTS_FILE}"
CheckIfFileDiff "${RESULTS_FILE}" "test/data/super-linter-summary/markdown/table/expected-summary-footer-success.md"
local EXPECTED_CONTENT
EXPECTED_CONTENT=$(
cat <<EOF
All files and directories linted successfully
EOF
)
CheckIfContentsDiff "${RESULTS_FILE}" "${EXPECTED_CONTENT}"
CleanupWorkspace
notice "${FUNCTION_NAME} PASS"
@ -99,7 +118,14 @@ function WriteSummaryMarkdownTableFooterFailureTest() {
local RESULTS_FILE="${TEMP_WORKSPACE}/${FUNCTION_NAME}-output-${FUNCTION_NAME}.md"
InitWorkspace
WriteSummaryFooterFailure "${RESULTS_FILE}"
CheckIfFileDiff "${RESULTS_FILE}" "test/data/super-linter-summary/markdown/table/expected-summary-footer-failure.md"
local EXPECTED_CONTENT
EXPECTED_CONTENT=$(
cat <<EOF
Super-linter detected linting errors
EOF
)
CheckIfContentsDiff "${RESULTS_FILE}" "${EXPECTED_CONTENT}"
CleanupWorkspace
notice "${FUNCTION_NAME} PASS"

7
test/run-super-linter-tests.sh
View file

@ -359,15 +359,14 @@ else
fi
if [ -n "${EXPECTED_SUPER_LINTER_SUMMARY_FILE_PATH:-}" ]; then
# Remove eventual HTML comments from the expected file because we use them to disable certain linter rules
if ! diff "${SUPER_LINTER_SUMMARY_FILE_PATH}" <(grep -vE '^\s*<!--' "${EXPECTED_SUPER_LINTER_SUMMARY_FILE_PATH}"); then
if ! AssertFileContentsMatchIgnoreHtmlComments "${SUPER_LINTER_SUMMARY_FILE_PATH}" "${EXPECTED_SUPER_LINTER_SUMMARY_FILE_PATH}"; then
debug "Super-linter summary (${SUPER_LINTER_SUMMARY_FILE_PATH}) contents don't match with the expected contents (${EXPECTED_SUPER_LINTER_SUMMARY_FILE_PATH})"
exit 1
else
debug "Super-linter summary (${SUPER_LINTER_SUMMARY_FILE_PATH}) contents match with the expected contents (${EXPECTED_SUPER_LINTER_SUMMARY_FILE_PATH})"
fi
if ! diff "${SUPER_LINTER_GITHUB_STEP_SUMMARY_FILE_PATH}" <(grep -vE '^\s*<!--' "${EXPECTED_SUPER_LINTER_SUMMARY_FILE_PATH}"); then
if ! AssertFileContentsMatchIgnoreHtmlComments "${SUPER_LINTER_GITHUB_STEP_SUMMARY_FILE_PATH}" "${EXPECTED_SUPER_LINTER_SUMMARY_FILE_PATH}"; then
debug "Super-linter GitHub step summary (${SUPER_LINTER_SUMMARY_FILE_PATH}) contents don't match with the expected contents (${EXPECTED_SUPER_LINTER_SUMMARY_FILE_PATH})"
exit 1
else
@ -450,7 +449,7 @@ if [[ "${VERIFY_FIX_MODE:-}" == "true" ]]; then
"${BAD_TEST_CASE_DESTINATION_PATH}"/*/target
fi
if AssertFileContentsMatch "${BAD_TEST_CASE_DESTINATION_PATH}" "${BAD_TEST_CASE_SOURCE_PATH}"; then
if AssertFileAndDirContentsMatch "${BAD_TEST_CASE_DESTINATION_PATH}" "${BAD_TEST_CASE_SOURCE_PATH}"; then
fatal "${BAD_TEST_CASE_DESTINATION_PATH} contents match ${BAD_TEST_CASE_SOURCE_PATH} contents and they should differ because fix mode for ${LANGUAGE} should have fixed linting and formatting issues."
fi
done

16
test/testUtils.sh
View file

@ -120,7 +120,7 @@ function CheckUnexpectedGitChanges() {
fi
}
AssertFileContentsMatch() {
AssertFileAndDirContentsMatch() {
local FILE_1_PATH="${1}"
local FILE_2_PATH="${2}"
if diff -r "${FILE_1_PATH}" "${FILE_2_PATH}"; then
@ -132,6 +132,20 @@ AssertFileContentsMatch() {
fi
}
AssertFileContentsMatchIgnoreHtmlComments() {
local FILE_1_PATH="${1}"
local FILE_2_PATH="${2}"
# Use cat -s to remove duplicate blank lines because Prettier adds blank
# lines after HTML comments in Markdown files
if diff "${FILE_1_PATH}" <(grep -vE '^\s*<!--' "${FILE_2_PATH}" | cat -s); then
echo "${FILE_1_PATH} contents match with ${FILE_2_PATH} contents"
return 0
else
echo "${FILE_1_PATH} contents don't match with ${FILE_2_PATH} contents"
return 1
fi
}
IsLanguageInSlimImage() {
local LANGUAGE="${1}"
if [[ " ${LANGUAGES_NOT_IN_SLIM_IMAGE[*]} " =~ [[:space:]]${LANGUAGE}[[:space:]] ]]; then