Skip to content

Add custom structfield linter to check struct field names and tags #3843

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Nov 26, 2025
+668 −275
Merged

Add custom structfield linter to check struct field names and tags #3843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e7e528b
Add custom structfield linter to check struct field names and tags
alexandear Nov 24, 2025
be99d05
sort linters in configs; update doc
alexandear Nov 25, 2025
14009b9
rename options
alexandear Nov 25, 2025
a5979df
cover all cases from review
alexandear Nov 25, 2025
e83e366
add exceptions
alexandear Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .custom-gcl.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: v2.6.1
plugins:
- module: "github.com/google/go-github/v79/tools/fmtpercentv"
path: ./tools/fmtpercentv
- module: "github.com/google/go-github/v79/tools/jsonfieldname"
path: ./tools/jsonfieldname
- module: "github.com/google/go-github/v79/tools/sliceofpointers"
path: ./tools/sliceofpointers
- module: "github.com/google/go-github/v79/tools/structfield"
path: ./tools/structfield
218 changes: 209 additions & 9 deletions .golangci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ linters:
- goheader
- gosec
- intrange
- jsonfieldname
- misspell
- modernize
- musttag
Expand All @@ -27,6 +26,7 @@ linters:
- revive
- sliceofpointers
- staticcheck
- structfield
- tparallel
- unconvert
- unparam
Expand Down Expand Up @@ -152,12 +152,16 @@ linters:
type: module
description: Reports usage of %d or %s in format strings.
original-url: github.com/google/go-github/v79/tools/fmtpercentv
jsonfieldname:
sliceofpointers:
type: module
description: Reports usage of []*string and slices of structs without pointers.
original-url: github.com/google/go-github/v79/tools/sliceofpointers
structfield:
type: module
description: Reports mismatches between Go field and JSON tag names.
original-url: github.com/google/go-github/v79/tools/jsonfieldname
description: Reports mismatches between Go field and JSON, URL tag names and types.
original-url: github.com/google/go-github/v79/tools/structfield
settings:
allowed-exceptions:
allowed-tag-names:
- ActionsCacheUsageList.RepoCacheUsage # TODO: RepoCacheUsages ?
- AuditEntry.ExternalIdentityNameID
- AuditEntry.Timestamp
Expand Down Expand Up @@ -186,6 +190,8 @@ linters:
- ListCheckSuiteResults.Total
- ListCustomDeploymentRuleIntegrationsResponse.AvailableIntegrations
- ListDeploymentProtectionRuleResponse.ProtectionRules
- ListIDPGroupsOptions.Query
- ListProjectsOptions.Query
- OrganizationCustomRepoRoles.CustomRepoRoles # TODO: CustomRoles
- OrganizationCustomRoles.CustomRepoRoles # TODO: Roles
- PreReceiveHook.ConfigURL
Expand Down Expand Up @@ -219,10 +225,201 @@ linters:
- WeeklyStats.Commits
- WeeklyStats.Deletions
- WeeklyStats.Week
sliceofpointers:
type: module
description: Reports usage of []*string and slices of structs without pointers.
original-url: github.com/google/go-github/v79/tools/sliceofpointers
allowed-tag-types:
- ActivityListStarredOptions.Direction # TODO: Activities
- ActivityListStarredOptions.Sort # TODO: Activities
- AddProjectItemOptions.ID # TODO: Projects
- AddProjectItemOptions.Type # TODO: Projects
- AlertInstancesListOptions.Ref # TODO: CodeScanning
- AlertListOptions.Direction # TODO: CodeScanning
- AlertListOptions.Ref # TODO: CodeScanning
- AlertListOptions.Severity # TODO: CodeScanning
- AlertListOptions.Sort # TODO: CodeScanning
- AlertListOptions.State # TODO: CodeScanning
- AlertListOptions.ToolGUID # TODO: CodeScanning
- AlertListOptions.ToolName # TODO: CodeScanning
- APIMetaArtifactAttestations.TrustDomain # TODO: Meta
- CommitsListOptions.Author # TODO: Repositories
- CommitsListOptions.Path # TODO: Repositories
- CommitsListOptions.SHA # TODO: Repositories
- CommitsListOptions.Since # TODO: Repositories
- CommitsListOptions.Until # TODO: Repositories
- CreateTag.Message # TODO: Git
- CreateTag.Object # TODO: Git
- CreateTag.Tag # TODO: Git
- CreateTag.Type # TODO: Git
- CredentialAuthorizationsListOptions.Login # TODO: Organizations
- DependabotEncryptedSecret.SelectedRepositoryIDs # TODO: Dependabot
- DependabotEncryptedSecret.Visibility # TODO: Dependabot
- DeploymentRequest.RequiredContexts # TODO: Deployments
- DeploymentsListOptions.Environment # TODO: Repositories
- DeploymentsListOptions.Ref # TODO: Repositories
- DeploymentsListOptions.SHA # TODO: Repositories
- DeploymentsListOptions.Task # TODO: Repositories
- DiscussionCommentListOptions.Direction # TODO: Teams
- DiscussionListOptions.Direction # TODO: Teams
- DismissalRestrictionsRequest.Apps # TODO: Repositories
- DismissalRestrictionsRequest.Teams # TODO: Repositories
- DismissalRestrictionsRequest.Users # TODO: Repositories
- EncryptedSecret.SelectedRepositoryIDs # TODO: Actions
- EncryptedSecret.Visibility # TODO: Actions
- ErrorBlock.Reason # TODO: Common
- ErrorResponse.DocumentationURL # TODO: Common
- GetCodeownersErrorsOptions.Ref # TODO: Repositories
- GistListOptions.Since # TODO: Gists
- HostedRunnerRequest.EnableStaticIP # TODO: Actions
- HostedRunnerRequest.Image # TODO: Actions
- HostedRunnerRequest.ImageVersion # TODO: Actions
- HostedRunnerRequest.MaximumRunners # TODO: Actions
- HostedRunnerRequest.Name # TODO: Actions
- HostedRunnerRequest.RunnerGroupID # TODO: Actions
- HostedRunnerRequest.Size # TODO: Actions
- IssueEvent.Action # TODO: Issues
- IssueListByRepoOptions.Assignee # TODO: Issues
- IssueListByRepoOptions.Assignee # TODO: Issues
- IssueListByRepoOptions.Creator # TODO: Issues
- IssueListByRepoOptions.Creator # TODO: Issues
- IssueListByRepoOptions.Direction # TODO: Issues
- IssueListByRepoOptions.Direction # TODO: Issues
- IssueListByRepoOptions.Mentioned # TODO: Issues
- IssueListByRepoOptions.Mentioned # TODO: Issues
- IssueListByRepoOptions.Milestone # TODO: Issues
- IssueListByRepoOptions.Since # TODO: Issues
- IssueListByRepoOptions.Since # TODO: Issues
- IssueListByRepoOptions.Sort # TODO: Issues
- IssueListByRepoOptions.Sort # TODO: Issues
- IssueListByRepoOptions.State # TODO: Issues
- IssueListOptions.Direction # TODO: Issues
- IssueListOptions.Filter # TODO: Issues
- IssueListOptions.Since # TODO: Issues
- IssueListOptions.Sort # TODO: Issues
- IssueListOptions.State # TODO: Issues
- IssueRequest.Assignees # TODO: Issues
- IssueRequest.Labels # TODO: Issues
- License.Conditions # TODO: Licenses
- License.Limitations # TODO: Licenses
- License.Permissions # TODO: Licenses
- ListCodespacesOptions.RepositoryID # TODO: Codespaces
- ListCollaboratorsOptions.Affiliation # TODO: Repositories
- ListCollaboratorsOptions.Permission # TODO: Repositories
- ListContributorsOptions.Anon # TODO: Repositories
- ListCursorOptions.After # TODO: Common
- ListCursorOptions.Before # TODO: Common
- ListCursorOptions.Cursor # TODO: Common
- ListCursorOptions.First # TODO: Common
- ListCursorOptions.Last # TODO: Common
- ListCursorOptions.Page # TODO: Common
- ListCursorOptions.PerPage # TODO: Common
- ListCustomPropertyValuesOptions.RepositoryQuery # TODO: Organizations
- ListEnterpriseRunnerGroupOptions.VisibleToOrganization # TODO: Enterprise
- ListFineGrainedPATOptions.Direction # TODO: Organizations
- ListFineGrainedPATOptions.LastUsedAfter # TODO: Organizations
- ListFineGrainedPATOptions.LastUsedBefore # TODO: Organizations
- ListFineGrainedPATOptions.Permission # TODO: Organizations
- ListFineGrainedPATOptions.Repository # TODO: Organizations
- ListFineGrainedPATOptions.Sort # TODO: Organizations
- ListIDPGroupsOptions.Query # TODO: Teams
- ListMembersOptions.Filter # TODO: Organizations
- ListMembersOptions.Role # TODO: Organizations
- ListOptions.Page # TODO: Common
- ListOptions.PerPage # TODO: Common
- ListOrgMembershipsOptions.State # TODO: Organizations
- ListOrgRunnerGroupOptions.VisibleToRepository # TODO: Actions
- ListOutsideCollaboratorsOptions.Filter # TODO: Organizations
- ListProvisionedSCIMGroupsEnterpriseOptions.Count # TODO: Enterprise
- ListProvisionedSCIMGroupsEnterpriseOptions.ExcludedAttributes # TODO: Enterprise
- ListProvisionedSCIMGroupsEnterpriseOptions.Filter # TODO: Enterprise
- ListProvisionedSCIMGroupsEnterpriseOptions.StartIndex # TODO: Enterprise
- ListReactionOptions.Content # TODO: Reactions
- ListRepositoryActivityOptions.ActivityType # TODO: Repositories
- ListRepositoryActivityOptions.Actor # TODO: Repositories
- ListRepositoryActivityOptions.After # TODO: Repositories
- ListRepositoryActivityOptions.Before # TODO: Repositories
- ListRepositoryActivityOptions.Direction # TODO: Repositories
- ListRepositoryActivityOptions.PerPage # TODO: Repositories
- ListRepositoryActivityOptions.Ref # TODO: Repositories
- ListRepositoryActivityOptions.TimePeriod # TODO: Repositories
- ListRepositorySecurityAdvisoriesOptions.Direction # TODO: SecurityAdvisories
- ListRepositorySecurityAdvisoriesOptions.Direction # TODO: SecurityAdvisories
- ListRepositorySecurityAdvisoriesOptions.Sort # TODO: SecurityAdvisories
- ListRepositorySecurityAdvisoriesOptions.Sort # TODO: SecurityAdvisories
- ListRepositorySecurityAdvisoriesOptions.State # TODO: SecurityAdvisories
- ListRepositorySecurityAdvisoriesOptions.State # TODO: SecurityAdvisories
- ListWorkflowJobsOptions.Filter # TODO: Actions
- ListWorkflowRunsOptions.Actor # TODO: Actions
- ListWorkflowRunsOptions.Branch # TODO: Actions
- ListWorkflowRunsOptions.CheckSuiteID # TODO: Actions
- ListWorkflowRunsOptions.Created # TODO: Actions
- ListWorkflowRunsOptions.Event # TODO: Actions
- ListWorkflowRunsOptions.ExcludePullRequests # TODO: Actions
- ListWorkflowRunsOptions.HeadSHA # TODO: Actions
- ListWorkflowRunsOptions.Status # TODO: Actions
- LockIssueOptions.LockReason # TODO: Issues
- MarketplacePlan.Bullets # TODO: Marketplaces
- MilestoneListOptions.Direction # TODO: Issues
- MilestoneListOptions.Sort # TODO: Issues
- MilestoneListOptions.State # TODO: Issues
- NotificationListOptions.All # TODO: Activities
- NotificationListOptions.Before # TODO: Activities
- NotificationListOptions.Participating # TODO: Activities
- NotificationListOptions.Since # TODO: Activities
- OrganizationsListOptions.Since # TODO: Organizations
- ProjectV2ItemFieldValue.DataType # TODO: Projects
- ProjectV2ItemFieldValue.Name # TODO: Projects
- PullRequestListCommentsOptions.Direction # TODO: PullRequests
- PullRequestListCommentsOptions.Since # TODO: PullRequests
- PullRequestListCommentsOptions.Sort # TODO: PullRequests
- PullRequestListOptions.Base # TODO: PullRequests
- PullRequestListOptions.Direction # TODO: PullRequests
- PullRequestListOptions.Head # TODO: PullRequests
- PullRequestListOptions.Sort # TODO: PullRequests
- PullRequestListOptions.State # TODO: PullRequests
- Rate.Resource # TODO: Common
- RepositoryAddCollaboratorOptions.Permission # TODO: Repositories
- RepositoryContentGetOptions.Ref # TODO: Repositories
- RepositoryCreateForkOptions.DefaultBranchOnly # TODO: Repositories
- RepositoryCreateForkOptions.Name # TODO: Repositories
- RepositoryCreateForkOptions.Organization # TODO: Repositories
- RepositoryListAllOptions.Since # TODO: Repositories
- RepositoryListByAuthenticatedUserOptions.Affiliation # TODO: Repositories
- RepositoryListByAuthenticatedUserOptions.Direction # TODO: Repositories
- RepositoryListByAuthenticatedUserOptions.Sort # TODO: Repositories
- RepositoryListByAuthenticatedUserOptions.Type # TODO: Repositories
- RepositoryListByAuthenticatedUserOptions.Visibility # TODO: Repositories
- RepositoryListByOrgOptions.Direction # TODO: Repositories
- RepositoryListByOrgOptions.Sort # TODO: Repositories
- RepositoryListByOrgOptions.Type # TODO: Repositories
- RepositoryListByUserOptions.Direction # TODO: Repositories
- RepositoryListByUserOptions.Sort # TODO: Repositories
- RepositoryListByUserOptions.Type # TODO: Repositories
- RepositoryListForksOptions.Sort # TODO: Repositories
- RepositoryListOptions.Affiliation # TODO: Repositories
- RepositoryListOptions.Direction # TODO: Repositories
- RepositoryListOptions.Sort # TODO: Repositories
- RepositoryListOptions.Type # TODO: Repositories
- RepositoryListOptions.Visibility # TODO: Repositories
- RequiredStatusChecks.Checks # TODO: Repositories
- RequiredStatusChecks.Contexts # TODO: Repositories
- SearchOptions.Order # TODO: Search
- SearchOptions.Sort # TODO: Search
- Secret.SelectedRepositoriesURL # TODO: Actions
- Secret.Visibility # TODO: Actions
- SecretScanningAlertListOptions.Direction # TODO: SecretScanning
- SecretScanningAlertListOptions.IsMultiRepo # TODO: SecretScanning
- SecretScanningAlertListOptions.IsPubliclyLeaked # TODO: SecretScanning
- SecretScanningAlertListOptions.Resolution # TODO: SecretScanning
- SecretScanningAlertListOptions.SecretType # TODO: SecretScanning
- SecretScanningAlertListOptions.Sort # TODO: SecretScanning
- SecretScanningAlertListOptions.State # TODO: SecretScanning
- SecretScanningAlertListOptions.Validity # TODO: SecretScanning
- TeamAddTeamMembershipOptions.Role # TODO: Teams
- TeamAddTeamRepoOptions.Permission # TODO: Teams
- TeamListTeamMembersOptions.Role # TODO: Teams
- TrafficBreakdownOptions.Per # TODO: Repositories
- UpdateRuleParameters.UpdateAllowsFetchAndMerge # TODO: Rules
- UploadOptions.Label # TODO: Repositories
- UploadOptions.Name # TODO: Repositories
- UserListOptions.Since # TODO: Users
exclusions:
rules:
- linters:
Expand Down Expand Up @@ -258,6 +455,9 @@ linters:
# Because fmt.Sprint(reset.Unix())) is more readable than strconv.FormatInt(reset.Unix(), 10).
- linters: [perfsprint]
text: fmt.Sprint.* can be replaced with faster strconv.FormatInt
issues:
max-issues-per-linter: 0
max-same-issues: 0
formatters:
enable:
- gci
Expand Down
Loading
Loading