[Feature]: Add lint configs and a lint CI job for every language in the repo
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
- Domain
- ci-cd, developer-experience
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
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.ymlhas build, test, coverage and regression jobs;docs/package.jsononly definesdocs:dev,docs:buildanddocs:preview. - The existing workflows already fail actionlint:
.github/workflows/e2e-tests.yml:32and:108useactions/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-lintwith a.golangci.yml(it includes thego vetanalyzers). - Shell:
shellcheckforinstall.shandscripts/*.sh. - PowerShell:
PSScriptAnalyzerfor the.ps1files, with aPSScriptAnalyzerSettings.psd1. - Lua:
lua-language-server --check(orluacheck) with a.luarc.json. - Workflows:
actionlint, after thesetup-go@v4usage 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
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from version-fox/vfox
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
version-fox/vfox#825 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
version-fox/vfox#823 ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 Half a day Newbie friendliness 45/100
version-fox/vfox#824 ·
Maintainers usually reply within 1 day
-
Plugins fail to load when the HOME path contains ';' or '?' (Lua package.path)Possibly taken @Xnadir claimed this today. Openbug
Difficulty 3/5 1-2 days Newbie friendliness 35/100
version-fox/vfox#821 ·
Maintainers usually reply within 1 day
-
[BUG]: the Available cache ignores the environment, so one setting's list is shown for anotherPossibly taken @nanami7777777 claimed this today. Openbug
Difficulty 3/5 1-2 days Newbie friendliness 25/100
version-fox/vfox#816 ·
Maintainers usually reply within 1 day
All issues in version-fox/vfox
Similar issues
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 2 days
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
seaweedfs/seaweed-block#443 ·
Maintainers usually reply within 1 day
-
HTTP `batch.Send` returns nil and inserts no rows when the block does not encodePossibly taken @Indian-boult claimed this today. Openbug queries
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
ClickHouse/clickhouse-go#2155 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
transparency-dev/tessera#1286 ·
Maintainers usually reply within 1 day