[Feature]: Add lint configs and a lint CI job for every language in the repo

Open
#765 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
50/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
github-actions, go, lua, powershell, shell, yaml

Research direction

Start in .github/workflows/ci.yml to see the existing job layout, then check .github/workflows/e2e-tests.yml at lines 32 and 108 for the actions/setup-go@v4 usage. Run each linter locally against install.sh, scripts/bump.sh, scripts/e2e-test.sh, the PowerShell scripts and the Lua files, and add the matching config files. Done means each config is checked in and a CI job fails on findings.

Written by the indexing model from the issue text.

Description

enhancement help wanted
1. Your usage scenarios?

Nothing lints the code. The CI workflows build, test and run E2E checks, but no job lints any language in the repository. Checked on main at c4f6275:

  • No linter configuration is checked in: no .golangci.yml, .shellcheckrc, PSScriptAnalyzerSettings.psd1, .luarc.json, Markdown or YAML lint config, or actionlint setup.
  • No workflow runs a linter. .github/workflows/ci.yml has build, test, coverage and regression jobs; docs/package.json only defines docs:dev, docs:build and docs:preview.
  • The existing workflows already fail actionlint: .github/workflows/e2e-tests.yml:32 and :108 use actions/setup-go@v4, which actionlint reports as too old to run on GitHub Actions.
  • Files with no linter at all: 19 Lua files, 3 shell scripts (install.sh, scripts/bump.sh, scripts/e2e-test.sh), 5 PowerShell scripts, and all workflow files.

The reference is version-fox/vfox-java. Its lint.yml runs go vet and unit tests for its Go module, and stylua --check plus lua-language-server --check for its Lua code, with checked-in stylua.toml and .luarc.json files.

2. What is your expected outcome?

A checked-in lint configuration for each language and a CI job that fails on findings:

  • Go: golangci-lint with a .golangci.yml (it includes the go vet analyzers).
  • Shell: shellcheck for install.sh and scripts/*.sh.
  • PowerShell: PSScriptAnalyzer for the .ps1 files, with a PSScriptAnalyzerSettings.psd1.
  • Lua: lua-language-server --check (or luacheck) with a .luarc.json.
  • Workflows: actionlint, after the setup-go@v4 usage is updated.

Formatting is out of scope for this issue.

Dominant language
Go
Stars
4k
Forks
177
Avg merge
1d 20h
Merged PRs (30d)
31

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from version-fox/vfox

All issues in version-fox/vfox

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.