Skip to content

Conversation

@digitalstraw
Copy link

propro is an abbreviation of Protected Properties. It prevents direct writes to public/exported struct properties.

Why propro?

ORMs like GORM, or JSON needs to access public/exported fields of structs it works with. Therefore, developers use mapping entities with private properties to model structs which contain public properties. However, this approach has drawbacks: it introduces a lot of boilerplate code because it requires writing and maintaining mapping logic for both directions, and adds extra unit tests for those mappings.

propro solves this problem at the linter level by blocking direct writes to public fields of protected structs.
This allows entities to keep exported fields and be used directly with GORM and JSON—without all the mapping boilerplate.

More info here: https://github.com/digitalstraw/propro

@boring-cyborg
Copy link

boring-cyborg bot commented Dec 5, 2025

Hey, thank you for opening your first Pull Request !

@CLAassistant
Copy link

CLAassistant commented Dec 5, 2025

CLA assistant check
All committers have signed the CLA.

@ldez
Copy link
Member

ldez commented Dec 5, 2025

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.

Base Requirements

These requirements are not declarative; the team will verify them.

  • It must not be a duplicate of another linter or a rule of a linter.
  • It must not have false positives/negatives.

Linter

  • It must have a valid license:
    • AGPL is not allowed
    • The file must start with LICENSE (capitalized)
    • The file must contain the required information by the license, ex: author, year, etc.
  • It must use Go version <= 1.24.0
  • The linter repository must have a CI and tests.
  • It must use go/analysis.
  • It must have a valid semver tag, ex: v1.0.0, v0.1.0 (0.0.x are not valid).
  • It must not contain:
    • init()
    • panic()
    • log.Fatal(), os.Exit(), or similar.
  • It must not modify the AST.
  • 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 lists 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.

Other 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 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 (v2.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 for diagnosing bug origins).
  • The linter repository should have a .gitignore (IDE files, binaries, OS files, etc. should not be committed)
  • Use main as the default branch name.

Workflow

  • A tag should never be recreated.
  • The reviews or changes should be addressed as commits (no squash).

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.

@ldez ldez self-requested a review December 5, 2025 10:57
@ldez ldez added the linter: new Support new linter label Dec 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

linter: new Support new linter

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants