Sandbox::https://redirect.github.com/google/go-github/blob/master/.golangci.yml

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

version: "2"

run:

build-tags:

- integration

allow-parallel-runners: true

linters:

default: none

enable:

- canonicalheader

- dogsled

- dupl

- errcheck

- errorlint

- extraneousnew

- fmtpercentv

- forbidigo

- gocritic

- godot

- goheader

- gosec

- govet

- ineffassign

- misspell

- modernize

- musttag

- nakedret

- nolintlint

- paralleltest

- paramcheck

- perfsprint

- revive

- sliceofpointers

- staticcheck

- structfield

- tparallel

- unconvert

- unparam

- unused

- usetesting

- whitespace

settings:

errorlint:

errorf: false

asserts: true

comparison: true

forbidigo:

forbid:

- pattern: ^fmt\.Print.*$

msg: "Do not use fmt.Print statements."

- pattern: ^reflect\.DeepEqual$

msg: "Use cmp.Equal instead of reflect.DeepEqual"

- pattern: "^http\\.Method[A-Z][a-z]*$"

msg: "Use string literals instead of http.Method constants (https://pkg.go.dev/net/http#pkg-constants)"

- pattern: ^sort\..*$

msg: "Use sorting functions from the slices package instead."

gocritic:

disable-all: true

enabled-checks:

- commentedOutCode

- commentFormatting

- deprecatedComment

- paramTypeCombine

goheader:

values:

regexp:

CopyrightDate: 'Copyright \d{4} '

template: |-

Use of this source code is governed by a BSD-style

license that can be found in the LICENSE file.

gosec:

excludes:

# duplicates errcheck

- G104

# int(os.Stdin.Fd())

- G115

# false positive

- G704

# false positive on valid struct fields "AccessToken", "ClientSecret", "Secret", "Password"

- G117

govet:

enable-all: true

disable:

- fieldalignment

- shadow

ineffassign:

check-escaping-errors: true

misspell:

locale: US

# extra words from https://go.dev/wiki/Spelling

extra-words:

- typo: marshall

correction: marshal

- typo: marshalled

correction: marshaled

- typo: marshalling

correction: marshaling

- typo: unmarshall

correction: unmarshal

- typo: unmarshalling

correction: unmarshaling

- typo: unmarshalled

correction: unmarshaled

- typo: unmarshalling

correction: unmarshaling

ignore-rules:

- analyses # returned by the GitHub API

- cancelled # returned by the GitHub API

nolintlint:

allow-unused: true

require-specific: true

perfsprint:

errorf: true

strconcat: false

revive:

# Set below 0.8 to enable error-strings rule.

confidence: 0.6

rules:

- name: blank-imports

- name: bool-literal-in-expr

- name: context-as-argument

- name: context-keys-type

- name: dot-imports

- name: early-return

- name: empty-block

- name: error-naming

- name: error-return

- name: error-strings

- name: errorf

- name: exported

arguments:

- disableChecksOnConstants

- disableChecksOnVariables

- disableStutteringCheck

- name: filename-format

arguments:

- ^[_a-z][_a-z0-9]*.go$

- name: forbidden-call-in-wg-go

- name: identical-branches

- name: identical-ifelseif-branches

- name: identical-ifelseif-conditions

- name: identical-switch-branches

- name: identical-switch-conditions

- name: if-return

- name: increment-decrement

- name: indent-error-flow

- name: inefficient-map-lookup

- name: package-comments

- name: range

- name: receiver-naming

- name: redefines-builtin-id

- name: superfluous-else

- name: time-equal

- name: time-naming

- name: unexported-naming

- name: unexported-return

- name: unnecessary-format

- name: unnecessary-if

- name: unnecessary-stmt

- name: unreachable-code

- name: unused-parameter

- name: use-any

- name: use-errors-new

- name: use-fmt-print

- name: use-slices-sort

- name: use-waitgroup-go

- name: var-declaration

- name: var-naming

staticcheck:

checks:

- "all"

- "-QF1008" # allow embedded field in selector

unparam:

check-exported: true

usetesting:

context-background: true

context-todo: true

os-chdir: true

os-mkdir-temp: true

os-setenv: true

os-create-temp: true

os-temp-dir: true

custom:

extraneousnew:

type: module

description: Reports problematic usage of 'new' or '&SomeStruct{}' when a more idiomatic 'var' pointer would be more appropriate.

original-url: github.com/google/go-github/v93/tools/extraneousnew

settings:

ignored-methods:

- RateLimitService.Get

- RepositoriesService.ReplaceAllTopics

fmtpercentv:

type: module

description: Reports usage of %d or %s in format strings.

original-url: github.com/google/go-github/v93/tools/fmtpercentv

paramcheck:

type: module

description: Reports parameter naming and type convention issues.

original-url: github.com/google/go-github/v93/tools/paramcheck

settings:

# Body type names exempt from the "pass by value, not by pointer" rule.

# TODO: fix and remove these exceptions.

body-allowed-pointer-types:

- AuthorizationRequest

- ConfigApplyOptions

- ConfigSettings

- CreateUpdateEnvironment

- CreateWorkflowDispatchEventRequest

- CustomProperty

- EncryptedSecret

- EnterpriseSecurityAnalysisSettings

- Hook

- Import

- IssueImportRequest

- Organization

- PagesUpdate

- PagesUpdateWithoutCNAME

- ProtectionRequest

- PullRequestReviewRequest

- PullRequestReviewsEnforcementUpdate

- Repository

- RepositoryContentFileOptions

- RequiredStatusChecksRequest

- SourceImportAuthor

# Body type names exempt from the "Options" suffix rule.

# TODO: fix and remove these exceptions.

body-allowed-wrong-names:

- ConfigApplyOptions

- RepositoryContentFileOptions

sliceofpointers:

type: module

description: Reports usage of []*string and slices of structs without pointers.

original-url: github.com/google/go-github/v93/tools/sliceofpointers

structfield:

type: module

description: Reports mismatches between Go field and JSON, URL tag names and types.

original-url: github.com/google/go-github/v93/tools/structfield

settings:

allowed-tag-names:

- ActionsCacheUsageList.RepoCacheUsage # TODO: RepoCacheUsages ?

- AuditEntry.ExternalIdentityNameID

- AuditEntry.Timestamp

- CheckSuite.AfterSHA

- CheckSuite.BeforeSHA

- CodeSearchResult.CodeResults

- CodeSearchResult.Total

- CommitAuthor.Login

- CommitsSearchResult.Commits

- CommitsSearchResult.Total

- Discussion.DiscussionCategory # TODO: Category ?

- EditOwner.OwnerInfo

- EnterpriseLicensedUsers.GithubComSamlNameID # TODO: GithubComSAMLNameID

- Event.RawPayload

- HookRequest.RawPayload

- HookResponse.RawPayload

- Issue.PullRequestLinks # TODO: PullRequest

- IssueImportRequest.IssueImport # TODO: Issue

- IssuesSearchResult.Issues # TODO: Items

- IssuesSearchResult.Total

- LabelsSearchResult.Labels # TODO: Items

- LabelsSearchResult.Total

- ListCheckRunsResults.Total

- ListCheckSuiteResults.Total

- ListCustomDeploymentRuleIntegrationsResponse.AvailableIntegrations

- ListDeploymentProtectionRuleResponse.ProtectionRules

- ListIDPGroupsOptions.Query

- ListProjectsOptions.Query

- OrganizationCustomRepoRoles.CustomRepoRoles # TODO: CustomRoles

- OrganizationCustomRoles.CustomRepoRoles # TODO: Roles

- PreReceiveHook.ConfigURL

- ProjectV2ItemEvent.ProjectV2Item # TODO: ProjectsV2Item

- Protection.RequireLinearHistory # TODO: RequiredLinearHistory

- ProtectionRequest.RequireLinearHistory # TODO: RequiredLinearHistory

- PullRequestComment.InReplyTo # TODO: InReplyToID

- PullRequestReviewsEnforcementRequest.BypassPullRequestAllowancesRequest # TODO: BypassPullRequestAllowances

- PullRequestReviewsEnforcementRequest.DismissalRestrictionsRequest # TODO: DismissalRestrictions

- PullRequestReviewsEnforcementUpdate.BypassPullRequestAllowancesRequest # TODO: BypassPullRequestAllowances

- PullRequestReviewsEnforcementUpdate.DismissalRestrictionsRequest # TODO: DismissalRestrictions

- Reactions.MinusOne

- Reactions.PlusOne

- RepositoriesSearchResult.Repositories

- RepositoriesSearchResult.Total

- RepositoryVulnerabilityAlert.GitHubSecurityAdvisoryID

- SecretScanningAlertLocationDetails.Startline # TODO: StartLine

- SecretScanningPatternOverride.Bypassrate # TODO: BypassRate

- StarredRepository.Repository # TODO: Repo

- Timeline.Requester # TODO: ReviewRequester

- Timeline.Reviewer # TODO: RequestedReviewer

- TopicsSearchResult.Topics # TODO: Items

- TopicsSearchResult.Total

- TotalCacheUsage.TotalActiveCachesUsageSizeInBytes # TODO: TotalActiveCachesSizeInBytes

- TransferRequest.TeamID # TODO: TeamIDs

- Tree.Entries

- User.LdapDn # TODO: LDAPDN

- UsersSearchResult.Total

- UsersSearchResult.Users

- WeeklyStats.Additions

- WeeklyStats.Commits

- WeeklyStats.Deletions

- WeeklyStats.Week

allowed-tag-types:

- APIMetaArtifactAttestations.TrustDomain # TODO: Meta

- ActionsCacheListOptions.Direction

- ActionsCacheListOptions.Key

- ActionsCacheListOptions.Ref

- ActionsCacheListOptions.Sort

- ActionsPolicyListOptions.HasParents

- ActiveCommittersListOptions.AdvancedSecurityProduct

- AnalysesListOptions.Ref

- AnalysesListOptions.SarifID

- BranchListOptions.Protected

- CodespaceGetDefaultAttributesOptions.ClientIP

- CodespaceGetDefaultAttributesOptions.Ref

- CommitsListOptions.Since # TODO: Repositories

- CommitsListOptions.Until # TODO: Repositories

- ConfigApplyEventsOptions.LastRequestID

- 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

- GetAuditLogOptions.Include

- GetAuditLogOptions.Order

- GetAuditLogOptions.Phrase

- GetProvisionedSCIMGroupEnterpriseOptions.ExcludedAttributes

- GistListOptions.Since # TODO: Gists

- IssueEvent.Action # TODO: Issues

- IssueListByOrgOptions.Since

- IssueListByRepoOptions.Since # TODO: Issues

- IssueListCommentsOptions.Direction

- IssueListCommentsOptions.Sort

- License.Conditions # TODO: Licenses

- License.Limitations # TODO: Licenses

- License.Permissions # TODO: Licenses

- ListAlertsOptions.Direction

- ListAlertsOptions.Ecosystem

- ListAlertsOptions.Package

- ListAlertsOptions.Scope

- ListAlertsOptions.Severity

- ListAlertsOptions.Sort

- ListAlertsOptions.State

- ListAllIssuesOptions.Since

- ListArtifactsOptions.Name

- ListCheckRunsOptions.AppID

- ListCheckRunsOptions.CheckName

- ListCheckRunsOptions.Filter

- ListCheckRunsOptions.Status

- ListCheckSuiteOptions.AppID

- ListCheckSuiteOptions.CheckName

- ListCostCenterOptions.State

- ListExternalGroupsOptions.DisplayName

- ListGlobalSecurityAdvisoriesOptions.Affects

- ListGlobalSecurityAdvisoriesOptions.CVEID

- ListGlobalSecurityAdvisoriesOptions.Ecosystem

- ListGlobalSecurityAdvisoriesOptions.GHSAID

- ListGlobalSecurityAdvisoriesOptions.IsWithdrawn

- ListGlobalSecurityAdvisoriesOptions.Modified

- ListGlobalSecurityAdvisoriesOptions.Published

- ListGlobalSecurityAdvisoriesOptions.Severity

- ListGlobalSecurityAdvisoriesOptions.Type

- ListGlobalSecurityAdvisoriesOptions.Updated

- ListLicensesOptions.Featured

- ListProvisionedSCIMGroupsEnterpriseOptions.Count # TODO: Enterprise

- ListProvisionedSCIMGroupsEnterpriseOptions.ExcludedAttributes # TODO: Enterprise

- ListProvisionedSCIMGroupsEnterpriseOptions.Filter # TODO: Enterprise

- ListProvisionedSCIMGroupsEnterpriseOptions.StartIndex # TODO: Enterprise

- ListProvisionedSCIMUsersEnterpriseOptions.Count

- ListProvisionedSCIMUsersEnterpriseOptions.Filter

- ListProvisionedSCIMUsersEnterpriseOptions.StartIndex

- ListRepoMachineTypesOptions.ClientIP

- ListRepoMachineTypesOptions.Location

- ListRepoMachineTypesOptions.Ref

- ListRunnersOptions.Name

- ListSCIMProvisionedIdentitiesOptions.Count

- ListSCIMProvisionedIdentitiesOptions.Filter

- ListSCIMProvisionedIdentitiesOptions.StartIndex

- ListUserIssuesOptions.Since

- MarketplacePlan.Bullets # TODO: Marketplaces

- NodeQueryOptions.ClusterRoles

- NodeQueryOptions.UUID

- NotificationListOptions.Before # TODO: Activities

- NotificationListOptions.Since # TODO: Activities

- PackageListOptions.PackageType

- PackageListOptions.State

- PackageListOptions.Visibility

- PremiumRequestUsageReportOptions.Day

- PremiumRequestUsageReportOptions.Model

- PremiumRequestUsageReportOptions.Month

- PremiumRequestUsageReportOptions.Product

- PremiumRequestUsageReportOptions.User

- PremiumRequestUsageReportOptions.Year

- PullRequestListCommentsOptions.Since # TODO: PullRequests

- Rate.Resource # TODO: Common

- RepositoryListRulesetsOptions.IncludesParents

- RequiredStatusChecks.Checks # TODO: Repositories

- RequiredStatusChecks.Contexts # TODO: Repositories

- SearchOptions.AdvancedSearch

- Secret.SelectedRepositoriesURL # TODO: Actions

- Secret.Visibility # TODO: Actions

- UpdateRuleParameters.UpdateAllowsFetchAndMerge # TODO: Rules

- UsageReportOptions.Day

- UsageReportOptions.Hour

- UsageReportOptions.Month

- UsageReportOptions.Year

- WorkflowRunAttemptOptions.ExcludePullRequests

exclusions:

rules:

- linters:

- dogsled

- dupl

- gosec

- unparam

path: _test\.go

# Allow fmt.Print in examples, internal tools, and tests.

- linters: [forbidigo]

path: ^(example|tools|test|scrape)\/

text: 'fmt\.Print'

# We need to pass nil Context in order to test DoBare erroring on nil ctx.

- linters: [staticcheck]

path: _test\.go

text: 'SA1012: do not pass a nil Context'

# We need to use sha1 for validating signatures

- linters: [gosec]

text: 'G505: Blocklisted import crypto/sha1: weak cryptographic primitive'

# This is adapted from golangci-lint's default exclusions. It disables linting for error checks on

# os.RemoveAll, fmt.Fprint*, fmt.Scanf, and any function ending in "Close".

- linters: [errcheck]

text: Error return value of .(.*Close|fmt\.Fprint.*|fmt\.Scanf|os\.Remove(All)?). is not checked

# We don't care about gosec issues in examples or internal tools.

- linters: [gosec]

path: ^(example|tools)\/

text: '(G304|G703|G705|G706)'

# We don't run parallel integration tests

- linters: [paralleltest, tparallel]

path: ^test/integration

# 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

# paramcheck reports multiple distinct issues on the same parameter line.

uniq-by-line: false

formatters:

enable:

- gci

- gofumpt

settings:

gofumpt:

extra:

group-params: true

clothe-returns: true

balance-calls: true

FilesExpand file tree

.golangci.yml

Latest commit

History

.golangci.yml

File metadata and controls