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 ttempdir linter #4794

Draft
wants to merge 22 commits into
base: master
Choose a base branch
from

Conversation

peczenyj
Copy link

@peczenyj peczenyj commented Jun 4, 2024

ttempdir follow the naming convention of tenv and thelper

it detects the usage of temporary directories not using t.TempDir

repository: https://github.com/peczenyj/ttempdir/

Copy link

boring-cyborg bot commented Jun 4, 2024

Hey, thank you for opening your first Pull Request !

@CLAassistant
Copy link

CLAassistant commented Jun 4, 2024

CLA assistant check
All committers have signed the CLA.

@ldez
Copy link
Member

ldez commented Jun 4, 2024

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

  • The CLA must be signed

Pull Request Description

  • It must have a link to the linter repository.
  • It must provide a short description of 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 (AGPL is not allowed) 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().
  • It must not contain log.fatal(), os.exit(), or similar.
  • It must not modify the AST.
  • 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 have integration tests without configuration. (default)
  • They must have integration tests with configuration (if the linter has a configuration).

.golangci.next.reference.yml

  • The file .golangci.next.reference.yml must be updated.
  • The file .golangci.reference.yml must NOT be edited.
  • 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 lintersdb/builder_linter.go and .golangci.next.reference.yml.
  • The load mode (WithLoadMode(...)):
    • if the linter uses goanalysis.LoadModeSyntax -> no WithLoadForGoAnalysis() in lintersdb/builder_linter.go
    • if the linter uses goanalysis.LoadModeTypesInfo, it requires WithLoadForGoAnalysis() in lintersdb/builder_linter.go
  • The version in WithSince(...) must be the next minor version (v1.X.0) of golangci-lint.
  • WithURL() must contain the URL of the repository.

Recommendations

  • The file jsonschema/golangci.next.jsonschema.json should be updated.
  • The file jsonschema/golangci.jsonschema.json must NOT be edited.
  • The linter repository should have a readme and linting.
  • The linter should be published as a binary. (useful to diagnose bug origins)
  • The linter repository should have a .gitignore (IDE files, binaries, OS files, etc. should not be committed)
  • A tag should never be recreated.

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

The code review will start after the completion of those checkboxes (except for the specific items that the team will help to verify).

The reviews should be addressed as commits (no squash).

If the author of the PR is a member of the golangci-lint team, he should not edit this message.

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

@ldez ldez added linter: new Support new linter feedback required Requires additional feedback labels Jun 4, 2024
@ldez ldez changed the title add ttempdir linter feat: add ttempdir linter Jun 4, 2024
@Antonboom
Copy link
Contributor

@peczenyj

proposal – replace "can be" with "should be" or "must be"

./main_test.go:11:14: os.TempDir() can be replaced by t.TempDir() in TestMain

@peczenyj
Copy link
Author

peczenyj commented Jun 5, 2024

proposal – replace "can be" with "should be" or "must be"

./main_test.go:11:14: os.TempDir() can be replaced by t.TempDir() in TestMain

Hello @Antonboom

I am following the convention used by tenv linter.

I need to release it again with this modification. One sec

@ldez
Copy link
Member

ldez commented Jun 9, 2024

As long as the elements required by the checklist (except those related to maintainer actions) are not handled, it is useless to update your branch with master.

By doing those merges you are just spamming maintainer notifications.

The code review will start after the completion of those checkboxes (except for the specific items that the team will help to verify).

The checklist should be your priority.

@peczenyj
Copy link
Author

Thanks for the feedback @ldez -- I think I solve the last items from the checklist

@ldez ldez added enhancement New feature or improvement and removed feedback required Requires additional feedback labels Jun 10, 2024
@ldez ldez self-requested a review June 10, 2024 11:39
@ldez ldez added this to the next milestone Jun 10, 2024
@ldez
Copy link
Member

ldez commented Jun 18, 2024

We will wait for peczenyj/ttempdir#14 and peczenyj/ttempdir#18

@ldez ldez added the feedback required Requires additional feedback label Jun 18, 2024
@peczenyj peczenyj marked this pull request as draft July 4, 2024 17:00
@ldez ldez removed this from the next milestone Aug 14, 2024
@ldez
Copy link
Member

ldez commented Sep 4, 2024

@peczenyj are you still working on this linter?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or improvement feedback required Requires additional feedback linter: new Support new linter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants