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

feat: add linter dupword #3192

Merged
merged 4 commits into from Sep 15, 2022
Merged

feat: add linter dupword #3192

merged 4 commits into from Sep 15, 2022

Conversation

Abirdcfly
Copy link
Contributor

@Abirdcfly Abirdcfly commented Sep 5, 2022

dupword is a linter that checks for duplicate words in the source code (usually miswritten)

Examples in real code and related issues can be viewed in Abirdcfly/dupword#3

https://github.com/Abirdcfly/dupword

@boring-cyborg
Copy link

boring-cyborg bot commented Sep 5, 2022

Hey, thank you for opening your first Pull Request !

@CLAassistant
Copy link

CLAassistant commented Sep 5, 2022

CLA assistant check
All committers have signed the CLA.

@ldez
Copy link
Member

ldez commented Sep 5, 2022

In order for a pull request adding a linter to be reviewed, the linter and the PR must follow some requirements.

Pull Request Description

  • It must have a link to the linter repository.
  • It must provide a short description about the linter.

Linter

  • It must not be a duplicate of another linter or a rule of a linter. (the team will help to verify that)
  • It must have a valid license and the file must contain the required information by the license, ex: author, year, etc.
  • The linter repository must have a CI and tests.
  • It must use go/analysis.
  • It must have a valid tag, ex: v1.0.0, v0.1.0.
  • It must not contain init().
  • It must not contain panic(), log.fatal(), os.exit(), or similar.
  • It must not have false positives/negatives. (the team will help to verify that)
  • It must have tests inside golangci-lint.

The Linter Tests Inside Golangci-lint

  • They must have at least one std lib import.
  • They must work with T=<name of the linter test file>.go make test_linters. (the team will help to verify that)

.golangci.reference.yml

  • The linter must be added to the list of available linters (alphabetical case-insensitive order).
    • enable and disable options
  • If the linter has a configuration, the exhaustive configuration of the linter must be added (alphabetical case-insensitive order)
    • The values must be different from the default ones.
    • The default values must be defined in a comment.
    • The option must have a short description.

Others Requirements

  • The files (tests and linter) inside golangci-lint must have the same name as the linter.
  • The .golangci.yml of golangci-lint itself must not be edited and the linter must not be added to this file.
  • The linters must be sorted in the alphabetical order (case-insensitive) in the Manager.GetAllSupportedLinterConfigs(...) and .golangci.reference.yml.
  • The load mode (WithLoadMode(...)):
    • if the linter doesn't use types: goanalysis.LoadModeSyntax
    • goanalysis.LoadModeTypesInfo required WithLoadForGoAnalysis() in the Manager.GetAllSupportedLinterConfigs(...)
  • The version in WithSince(...) must be the next minor version (v1.X.0) of golangci-lint.

Recommendations

  • The linter should not use SSA. (currently, SSA does not support generics)
  • The linter repository should have a readme and linting.
  • The linter should be published as a binary. (useful to diagnose bug origins)

The golangci-lint team will edit this comment to check the boxes before and during the review.

This checklist does not imply that we will accept the linter.

@ldez
Copy link
Member

ldez commented Sep 7, 2022

Hello,

your linter seems weird: I expected an automatic detection of duplicate words and not a list of words.

@ldez ldez added the feedback required Requires additional feedback label Sep 7, 2022
@Abirdcfly
Copy link
Contributor Author

Abirdcfly commented Sep 7, 2022

automatic detection of duplicate words and not a list of words.

There are two reasons: First, the repetitive 'the' 'a' 'and' is not grammatically valid, and there is no false positive problem. Second, I find that repeating these words is more common.

I prefer this tool to use the -fix parameter to help me fix the problem automatically without error. Instead of many lines that need to add nolint.


update 09/10:

I have release dupword v0.0.6 to support detection arbitrary duplicate words and make it default, but add my advice in README.md.

And For an example of detecting arbitrary duplicate words in istio's latest code, see Abirdcfly/dupword#4

As far as I can see, detecting arbitrary duplicate words instead of specifying a list does detect a lot of unexpected errors (see Abirdcfly/dupword#4, like if of set), but it also requires accepting a higher number of false positives (in Abirdcfly/dupword#4, 14/26=53.8% duplicate words is correct), but considering that these false positives only require adding // nolint once, the ability to detect arbitrary words makes a lot of sense.

@bombsimon
Copy link
Member

I guess this is also useful for people who for whatever reason write their comments in other languages than english.

@ldez
Copy link
Member

ldez commented Sep 11, 2022

Your linter seems to not work as expected: the tests are failing (and it's not related to my changes).

@Abirdcfly
Copy link
Contributor Author

Your linter seems to not work as expected: the tests are failing (and it's not related to my changes).

Sorry for the error, Have updated the code. Locally Test passed via make test

@Abirdcfly
Copy link
Contributor Author

Abirdcfly commented Sep 11, 2022

https://github.com/golangci/golangci-lint/runs/8293831034?check_suite_focus=true#step:4:1508

--- FAIL: TestSourcesFromTestdata/staticcheck.go (2.41s)

Windows test fail, I guess it is flake?

@ldez
Copy link
Member

ldez commented Sep 11, 2022

Windows test fail, I guess it is flake?

Yes it's flaky, it will fix by my PR #3204

@ldez ldez added enhancement New feature or improvement and removed feedback required Requires additional feedback labels Sep 11, 2022
Abirdcfly and others added 3 commits September 15, 2022 09:41
Signed-off-by: Abirdcfly <fp544037857@gmail.com>
Signed-off-by: Abirdcfly <fp544037857@gmail.com>
Copy link
Member

@ldez ldez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ldez ldez merged commit febe5fd into golangci:master Sep 15, 2022
SeigeC pushed a commit to SeigeC/golangci-lint that referenced this pull request Apr 4, 2023
@ldez ldez added this to the v1.50 milestone Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or improvement linter: new Support new linter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants