Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

xmlencoderclose: linter that checks xml.Encoder is closed#3895

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
adamdecaf wants to merge1 commit intogolangci:master
base:master
Choose a base branch
Loading
fromadamdecaf:add-xmlencoderclose

Conversation

@adamdecaf
Copy link

xmlencoderclose is a linter which checks to make sure thatxml.Encoder instances are closed. Without closing an Encoder it may not flush all data. Closing encoders also verifies the XML has balanced start/end tags.

We've identified a need for this linter atMoov and it has found several bugs.

$ xmlencoderclose ./.../Users/adam/code/src/github.com/moov-io/1120x/pkg/utils/types.go:72:27: Encoder.Close must be called
$ xmlencoderclose ./.../Users/adam/code/src/github.com/moov-io/fincen/pkg/service/handlers.go:109:18: Encoder.Close must be called

@boring-cyborg
Copy link

Hey, thank you for opening your first Pull Request !

@CLAassistant
Copy link

CLAassistant commentedJun 8, 2023
edited
Loading

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign ourContributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let usrecheck it.

@ldez
Copy link
Member

ldez commentedJun 8, 2023
edited
Loading

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 usego/analysis.
  • It must have a valid tag, ex:v1.0.0,v0.1.0.
  • It must not containinit().
  • It must not containpanic(),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 withT=<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 anddisable 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 theManager.GetAllSupportedLinterConfigs(...) and.golangci.reference.yml.
  • The load mode (WithLoadMode(...)):
    • if the linter doesn't use types:goanalysis.LoadModeSyntax
    • goanalysis.LoadModeTypesInfo requiredWithLoadForGoAnalysis() in theManager.GetAllSupportedLinterConfigs(...)
  • The version inWithSince(...) must be the next minor version (v1.X.0) of golangci-lint.

Recommendations

  • The linter should not use SSA. (SSA can be a problem with 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.

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

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.

@ldezldez added the linter: newSupport new linter labelJun 8, 2023
@ldezldez added the waiting for: contributor feedbackRequires additional feedback labelOct 9, 2023
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@alexandearalexandearalexandear left review comments

Assignees

No one assigned

Labels

linter: newSupport new linterwaiting for: contributor feedbackRequires additional feedback

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@adamdecaf@CLAassistant@ldez@alexandear

[8]ページ先頭

©2009-2025 Movatter.jp