linters.md

Linters

• GitHub Actions
• Markdown
• Terraform
• Spelling
• YAML
• Go
• Security

GitHub Actions

actionlint is used to lint all GitHub Actions workflows.

The command to execute is:

task gh:lint

Markdown

David Anson's markdownlint-cli2 is leveraged for linting markdown.

The command to execute is:

task md:lint

Note

Markdown linter runs automatically following task docs to lint autogenerated files.

Terraform

Terraform linting includes terraform fmt, tflint, including autofix and trivy for misconfiguration.

The command to execute is:

task tf:lint

Spelling

Lychee is used to check for broken links and cspell for spelling in markdown files. This repository defaults to US English. If your documentation introduces a word that fails the spelling validation, add it to the .cspell.yml file

The command to execute is:

task: spell:lint

YAML

yamllint is used to lint YAML.

The command to execute is:

task: yml:lint

Go

golangci-lint and govulncheck are used to lint Go code.

The command to execute is:

task: go:lint

Security

gitleaks and checkov are used for security checks.

The command to execute is:

task sec:lint