Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: unify linter configuration with sylabs/sif #2024

Open
18 of 24 tasks
dtrudg opened this issue Aug 11, 2023 · 0 comments
Open
18 of 24 tasks

chore: unify linter configuration with sylabs/sif #2024

dtrudg opened this issue Aug 11, 2023 · 0 comments
Labels

Comments

@dtrudg
Copy link
Member

dtrudg commented Aug 11, 2023

Type of issue

technical debt

Description of issue

The sylabs/singularity project uses a much less comprehensive set of linters than other projects, such as sylabs/sif

We should aim to unify the set of linters used, by adding, where it is practical, those used by sylabs/sif but not here.

Not all of the linters below will be able to be applied in Singularity. They should be considered individually.

  • - asciicheck
  • - bidichk
  • - bodyclose
  • - dogsled
  • - dupword
  • - errcheck
  • - errchkjson
  • - errname
  • - errorlint
  • - exportloopref
  • - forcetypeassert
  • gochecknoinits not practical at this point
  • - gocritic
  • godot no practical value
  • godox At this point, TODO etc. markers in our code are useful for context, cannot be found as easily with issues.
  • - goerr113
  • - gomodguard
  • - goprintffuncname
  • - gosec
  • - interfacebloat
  • ireturn Not possible without a lot of rewrite for little benefit
  • lll Beneficial in some places, but would need lots of nolint for areas where longer lines are clearer
  • mirror removed?
  • nilnil Not practical given existing widespread coding style
  • - nolintlint
  • nonamedreturns Aspirational at this time, with some disagreement on universal applicability.
  • - prealloc
  • - reassign
  • - tenv
  • thelper Lots of our testing code (esp. in e2e) uses shared functions that aren't "helpers" in this sense
  • - typecheck
  • unconvert Not at this time. (We have lots of casts that are "superfluous" on one compilation platform but not on another. Plus some casts that are strictly speaking superfluous nevertheless provide crucial information when reading the code.)
  • - unparam
  • - whitespace
dtrudg added a commit to dtrudg/singularity that referenced this issue Aug 11, 2023
From sylabs#2024, enable the linters that don't (yet) report any lint.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant