diff --git a/.custom-gcl.reference.yml b/.custom-gcl.reference.yml new file mode 100644 index 000000000000..08d7dfc681ec --- /dev/null +++ b/.custom-gcl.reference.yml @@ -0,0 +1,37 @@ +# The golangci-lint version used to build the custom binary. +# Require. +version: v1.56.2 + +# The name of the custom binary. +# Optional. +# Default: custom-gcl +name: custom-golangci-lint + +# The directory path used to store the custom binary. +# Optional. +# Default: . +destination: ./my/path/ + +# The list of the plugins to integrate inside the custom binary. +plugins: + # a plugin from a Go proxy + - module: 'github.com/example/plugin3' + version: v1.2.3 + + # a plugin from a Go proxy (with a specific import path) + - module: 'github.com/example/plugin4' + import: 'github.com/example/plugin4/foo' + version: v1.0.0 + + # a plugin from local source (with absolute path) + - module: 'github.com/example/plugin2' + path: /my/local/path/plugin2 + + # a plugin from local source (with relative path) + - module: 'github.com/example/plugin1' + path: ./my/local/path/plugin1 + + # a plugin from local source (with absolute path and a specific import path) + - module: 'github.com/example/plugin2' + import: 'github.com/example/plugin4/foo' + path: /my/local/path/plugin2 diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 0bad078aa8b6..780e0b81243e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,4 +1,4 @@ -name: Bug Report +name: 🐞 Bug Report description: "Create a report to help us improve." labels: [bug] body: @@ -7,14 +7,42 @@ body: attributes: label: Welcome options: - - label: Yes, I'm using a binary release within 2 latest major releases. Only such installations are supported. + - label: Yes, I'm using a binary release within 2 latest [releases](https://github.com/golangci/golangci-lint/releases). Only such installations are supported. required: true - - label: Yes, I've searched similar issues on GitHub and didn't find any. + - label: Yes, I've searched similar [issues on GitHub](https://github.com/golangci/golangci-lint/issues) and didn't find any. required: true - - label: Yes, I've read the typecheck section of the FAQ (https://golangci-lint.run/usage/faq/#why-do-you-have-typecheck-errors). + - label: Yes, I've read the `typecheck` section of the [FAQ](https://golangci-lint.run/welcome/faq/#why-do-you-have-typecheck-errors). required: true - - label: Yes, I've tried with the standalone linter if available (e.g., gocritic, go vet, etc.). (https://golangci-lint.run/usage/linters/) + - label: Yes, I've tried with the standalone [linter](https://golangci-lint.run/usage/linters/) if available (e.g., gocritic, go vet, etc.). required: true + - label: I agree to follow this project's [Code of Conduct](https://github.com/golangci/golangci-lint?tab=coc-ov-file) + required: true + + - type: dropdown + id: install + attributes: + label: How did you install golangci-lint? + options: + - I don't know + - Official GitHub Action + - Official binary + - Brew + - MacPorts + - Chocolatey + - Scoop + - Docker + - go install + - Tools pattern + - go tool + - AUR + - Nix + - Deb + - RPM + - Other Linux package manager + - Via editor/IDE + - Other + validations: + required: true - type: textarea id: problem @@ -111,3 +139,10 @@ body: options: - label: Yes, I've included all information above (version, config, etc.). required: true + + - type: checkboxes + id: supporter + attributes: + label: Supporter + options: + - label: I am a sponsor/backer through [GitHub](https://github.com/sponsors/golangci/) or [OpenCollective](https://opencollective.com/golangci-lint) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index eaab4a3ce01a..558c4b8625db 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,11 @@ blank_issues_enabled: false contact_links: - - name: Questions - url: https://github.com/golangci/golangci-lint/discussions - about: If you have a question, or are looking for advice, please post on our Discussions forum! - - name: golangci-lint documentation + - name: 📖 Documentation url: https://golangci-lint.run about: Please take a look to our documentation. + - name: ❓ Questions + url: https://github.com/golangci/golangci-lint/discussions + about: If you have a question, or are looking for advice, please post on our Discussions forum! + - name: 💬 Chat on Slack + url: https://gophers.slack.com/archives/CS0TBRKPC + about: Maybe chatting with the community can help diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 031f912fbb97..ffcd60245b95 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,12 +1,48 @@ -name: Feature request +name: 💡 Feature request description: "Suggest an idea for this project." labels: [enhancement] body: + - type: checkboxes + id: terms + attributes: + label: Welcome + options: + - label: Yes, I've searched similar [issues on GitHub](https://github.com/golangci/golangci-lint/issues) and didn't find any. + required: true + - label: I agree to follow this project's [Code of Conduct](https://github.com/golangci/golangci-lint?tab=coc-ov-file) + required: true + + - type: dropdown + id: install + attributes: + label: How did you install golangci-lint? + options: + - I don't know + - Official GitHub Action + - Official binary + - Brew + - MacPorts + - Chocolatey + - Scoop + - Docker + - go install + - Tools pattern + - go tool + - AUR + - Nix + - Deb + - RPM + - Other Linux package manager + - Via editor/IDE + - Other + validations: + required: true + - type: textarea id: problem attributes: - label: Your feature request related to a problem? Please describe. + label: Your feature request related to a problem? Please describe placeholder: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]" validations: required: true @@ -14,7 +50,7 @@ body: - type: textarea id: solution attributes: - label: Describe the solution you'd like. + label: Describe the solution you'd like placeholder: "A clear and concise description of what you want to happen." validations: required: true @@ -22,7 +58,7 @@ body: - type: textarea id: alternatives attributes: - label: Describe alternatives you've considered. + label: Describe alternatives you've considered placeholder: "A clear and concise description of any alternative solutions or features you've considered." validations: required: true @@ -30,7 +66,14 @@ body: - type: textarea id: additional attributes: - label: Additional context. + label: Additional context placeholder: "Add any other context or screenshots about the feature request here." validations: required: false + + - type: checkboxes + id: supporter + attributes: + label: Supporter + options: + - label: I am a sponsor through [GitHub](https://github.com/sponsors/golangci/) or [OpenCollective](https://opencollective.com/golangci-lint) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000000..be686a73c8c7 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,10 @@ + diff --git a/.github/contributors/.gitignore b/.github/contributors/.gitignore deleted file mode 100644 index e3ac9bcac450..000000000000 --- a/.github/contributors/.gitignore +++ /dev/null @@ -1,6 +0,0 @@ -/cache/ -/node_modules/ -*.log -*.tsbuildinfo -/*.js -/contributors.json \ No newline at end of file diff --git a/.github/contributors/.prettierrc.json b/.github/contributors/.prettierrc.json deleted file mode 100644 index 9fe5c358e0bc..000000000000 --- a/.github/contributors/.prettierrc.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "endOfLine": "lf", - "semi": false, - "singleQuote": false, - "tabWidth": 2, - "trailingComma": "es5", - "printWidth": 140, - "parser": "typescript" - } \ No newline at end of file diff --git a/.github/contributors/def.d.ts b/.github/contributors/def.d.ts deleted file mode 100644 index 6200a5adc01b..000000000000 --- a/.github/contributors/def.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -declare module "name-your-contributors" - -declare module "@octokit/graphql" diff --git a/.github/contributors/generate.ts b/.github/contributors/generate.ts deleted file mode 100644 index beef913ba7ff..000000000000 --- a/.github/contributors/generate.ts +++ /dev/null @@ -1,143 +0,0 @@ -import nyc from "name-your-contributors" -import graphql from "@octokit/graphql" -import * as fs from "fs" -import { ContributorInfo, DataJSON } from "./info" - -type WeightedContributor = { - login: string - weight: number -} - -type Contribution = { - login: string - count: number -} - -const buildWeights = (contributorStats: any[]): Map => { - const loginToTotalWeight: Map = new Map() - - const addContributions = (weight: number, contributions: Contribution[], onlyExisting: boolean) => { - for (const contr of contributions) { - if (onlyExisting && !loginToTotalWeight.has(contr.login)) { - continue - } - loginToTotalWeight.set(contr.login, (loginToTotalWeight.get(contr.login) || 0) + contr.count * weight) - } - } - - for (const stat of contributorStats) { - // totally every pull or commit should account as 10 - addContributions(5, stat.prCreators, false) - addContributions(5, stat.commitAuthors, false) // some commits are out pull requests - } - - for (const stat of contributorStats) { - addContributions(2, stat.prCommentators, true) - addContributions(2, stat.issueCreators, true) - addContributions(2, stat.issueCommentators, true) - addContributions(2, stat.reviewers, true) - addContributions(0.3, stat.reactors, true) - } - - return loginToTotalWeight -} - -const buildContributorInfo = async (contributors: WeightedContributor[]): Promise => { - const query = `{ - ${contributors.map((c, i) => `user${i}: user(login: "${c.login}") {...UserFragment}`).join(`\n`)} - } - fragment UserFragment on User { - login - name - websiteUrl - avatarUrl - }` - - try { - const resp = await graphql.graphql(query, { - headers: { - authorization: `token ${process.env.GITHUB_TOKEN}`, - }, - }) - - return contributors.map((_, i) => resp[`user${i}`]).filter((v) => v) - } catch (err) { - if (err.errors && err.data) { - console.warn(`github errors:`, err.errors) - return contributors.map((_, i) => err.data[`user${i}`]).filter((v) => v) - } - throw err - } -} - -const buildCoreTeamInfo = async (): Promise => { - const query = `{ - organization(login:"golangci"){ - team(slug:"core-team"){ - members { - nodes { - login - name - websiteUrl - avatarUrl - } - } - } - } - }` - const resp = await graphql.graphql(query, { - headers: { - authorization: `token ${process.env.GITHUB_TOKEN}`, - }, - }) - - return resp.organization.team.members.nodes -} - -const main = async () => { - try { - const repos = [`golangci-lint`, `golangci-lint-action`] - const promises = repos.map((repo) => - nyc.repoContributors({ - token: process.env.GITHUB_TOKEN, - user: `golangci`, - repo, - before: new Date(), - after: new Date(0), - commits: true, - reactions: true, - }) - ) - const contributorStats = await Promise.all(promises) - console.info(`Got stat for repos ${repos}`) - const loginToWeight = buildWeights(contributorStats) - const weightedContributors: WeightedContributor[] = [] - loginToWeight.forEach((weight, login) => weightedContributors.push({ login, weight })) - - weightedContributors.sort((a, b) => b.weight - a.weight) - const coreTeamInfo = await buildCoreTeamInfo() - const contributorsInfo = await buildContributorInfo(weightedContributors) - const exclude: any = { - golangcidev: true, - CLAassistant: true, - renovate: true, - fossabot: true, - golangcibot: true, - kortschak: true, - "golangci-releaser": true, - } - - const res: DataJSON = { - contributors: contributorsInfo.filter((c) => !exclude[c.login] && !coreTeamInfo.find((ct) => ct.login === c.login)), - coreTeam: coreTeamInfo.sort((a, b) => (loginToWeight.get(b.login) || 0) - (loginToWeight.get(a.login) || 0)), - } - console.info(res) - fs.writeFileSync("contributors.json", JSON.stringify(res, null, 2)) - } catch (err) { - console.error(`Failed to get repo contributors`, err) - process.exit(1) - } - console.info(`Success`) -} - -main() diff --git a/.github/contributors/info.ts b/.github/contributors/info.ts deleted file mode 100644 index fbb768f7a292..000000000000 --- a/.github/contributors/info.ts +++ /dev/null @@ -1,11 +0,0 @@ -export type ContributorInfo = { - login: string - name: string - avatarUrl: string - websiteUrl: string -} - -export type DataJSON = { - contributors: ContributorInfo[] - coreTeam: ContributorInfo[] -} diff --git a/.github/contributors/package-lock.json b/.github/contributors/package-lock.json deleted file mode 100644 index c14723a8d966..000000000000 --- a/.github/contributors/package-lock.json +++ /dev/null @@ -1,1541 +0,0 @@ -{ - "name": "contributors", - "version": "1.0.0", - "lockfileVersion": 2, - "requires": true, - "packages": { - "": { - "version": "1.0.0", - "license": "MIT", - "dependencies": { - "@octokit/graphql": "^4.4.0", - "@types/node": "^14.0.1", - "name-your-contributors": "^3.8.3", - "typescript": "^3.9.2" - } - }, - "node_modules/@octokit/endpoint": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.1.tgz", - "integrity": "sha512-pOPHaSz57SFT/m3R5P8MUu4wLPszokn5pXcB/pzavLTQf2jbU+6iayTvzaY6/BiotuRS0qyEUkx3QglT4U958A==", - "dependencies": { - "@octokit/types": "^2.11.1", - "is-plain-object": "^3.0.0", - "universal-user-agent": "^5.0.0" - } - }, - "node_modules/@octokit/graphql": { - "version": "4.4.0", - "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.4.0.tgz", - "integrity": "sha512-Du3hAaSROQ8EatmYoSAJjzAz3t79t9Opj/WY1zUgxVUGfIKn0AEjg+hlOLscF6fv6i/4y/CeUvsWgIfwMkTccw==", - "dependencies": { - "@octokit/request": "^5.3.0", - "@octokit/types": "^2.0.0", - "universal-user-agent": "^5.0.0" - } - }, - "node_modules/@octokit/request": { - "version": "5.4.2", - "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.4.2.tgz", - "integrity": "sha512-zKdnGuQ2TQ2vFk9VU8awFT4+EYf92Z/v3OlzRaSh4RIP0H6cvW1BFPXq4XYvNez+TPQjqN+0uSkCYnMFFhcFrw==", - "dependencies": { - "@octokit/endpoint": "^6.0.1", - "@octokit/request-error": "^2.0.0", - "@octokit/types": "^2.11.1", - "deprecation": "^2.0.0", - "is-plain-object": "^3.0.0", - "node-fetch": "^2.3.0", - "once": "^1.4.0", - "universal-user-agent": "^5.0.0" - } - }, - "node_modules/@octokit/request-error": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.0.0.tgz", - "integrity": "sha512-rtYicB4Absc60rUv74Rjpzek84UbVHGHJRu4fNVlZ1mCcyUPPuzFfG9Rn6sjHrd95DEsmjSt1Axlc699ZlbDkw==", - "dependencies": { - "@octokit/types": "^2.0.0", - "deprecation": "^2.0.0", - "once": "^1.4.0" - } - }, - "node_modules/@octokit/types": { - "version": "2.16.2", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.16.2.tgz", - "integrity": "sha512-O75k56TYvJ8WpAakWwYRN8Bgu60KrmX0z1KqFp1kNiFNkgW+JW+9EBKZ+S33PU6SLvbihqd+3drvPxKK68Ee8Q==", - "dependencies": { - "@types/node": ">= 8" - } - }, - "node_modules/@types/node": { - "version": "14.0.1", - "resolved": "https://registry.npmjs.org/@types/node/-/node-14.0.1.tgz", - "integrity": "sha512-FAYBGwC+W6F9+huFIDtn43cpy7+SzG+atzRiTfdp3inUKL2hXnd4rG8hylJLIh4+hqrQy1P17kvJByE/z825hA==" - }, - "node_modules/array-find-index": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/array-find-index/-/array-find-index-1.0.2.tgz", - "integrity": "sha1-3wEKoSh+Fku9pvlyOwqWoexBh6E=", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/arrify": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/arrify/-/arrify-1.0.1.tgz", - "integrity": "sha1-iYUI2iIm84DfkEcoRWhJwVAaSw0=", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/camelcase": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-4.1.0.tgz", - "integrity": "sha1-1UVjW+HjPFQmScaRc+Xeas+uNN0=", - "engines": { - "node": ">=4" - } - }, - "node_modules/camelcase-keys": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/camelcase-keys/-/camelcase-keys-4.2.0.tgz", - "integrity": "sha1-oqpfsa9oh1glnDLBQUJteJI7m3c=", - "dependencies": { - "camelcase": "^4.1.0", - "map-obj": "^2.0.0", - "quick-lru": "^1.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/cross-spawn": { - "version": "6.0.5", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-6.0.5.tgz", - "integrity": "sha512-eTVLrBSt7fjbDygz805pMnstIs2VTBNkRm0qxZd+M7A5XDdxVRWO5MxGBXZhjY4cqLYLdtrGqRf8mBPmzwSpWQ==", - "dependencies": { - "nice-try": "^1.0.4", - "path-key": "^2.0.1", - "semver": "^5.5.0", - "shebang-command": "^1.2.0", - "which": "^1.2.9" - }, - "engines": { - "node": ">=4.8" - } - }, - "node_modules/csv-writer": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/csv-writer/-/csv-writer-1.2.0.tgz", - "integrity": "sha512-ZU7eZ26y7oIOXwFHhTNnT/tF6RXMdQnuTGofzNTe1cvXacZm3Ixd7Oa9mOp2f1t39Ezfzg0h5tqfOjXM180BOg==" - }, - "node_modules/currently-unhandled": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/currently-unhandled/-/currently-unhandled-0.4.1.tgz", - "integrity": "sha1-mI3zP+qxke95mmE2nddsF635V+o=", - "dependencies": { - "array-find-index": "^1.0.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/decamelize": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz", - "integrity": "sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/decamelize-keys": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/decamelize-keys/-/decamelize-keys-1.1.0.tgz", - "integrity": "sha1-0XGoeTMlKAfrPLYdwcFEXQeN8tk=", - "dependencies": { - "decamelize": "^1.1.0", - "map-obj": "^1.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/decamelize-keys/node_modules/map-obj": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/map-obj/-/map-obj-1.0.1.tgz", - "integrity": "sha1-2TPOuSBdgr3PSIb2dCvcK03qFG0=", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/deprecation": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/deprecation/-/deprecation-2.3.1.tgz", - "integrity": "sha512-xmHIy4F3scKVwMsQ4WnVaS8bHOx0DmVwRywosKhaILI0ywMDWPtBSku2HNxRvF7jtwDRsoEwYQSfbxj8b7RlJQ==" - }, - "node_modules/end-of-stream": { - "version": "1.4.4", - "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz", - "integrity": "sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==", - "dependencies": { - "once": "^1.4.0" - } - }, - "node_modules/error-ex": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", - "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", - "dependencies": { - "is-arrayish": "^0.2.1" - } - }, - "node_modules/execa": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/execa/-/execa-1.0.0.tgz", - "integrity": "sha512-adbxcyWV46qiHyvSp50TKt05tB4tK3HcmF7/nxfAdhnox83seTDbwnaqKO4sXRy7roHAIFqJP/Rw/AuEbX61LA==", - "dependencies": { - "cross-spawn": "^6.0.0", - "get-stream": "^4.0.0", - "is-stream": "^1.1.0", - "npm-run-path": "^2.0.0", - "p-finally": "^1.0.0", - "signal-exit": "^3.0.0", - "strip-eof": "^1.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/find-up": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz", - "integrity": "sha1-RdG35QbHF93UgndaK3eSCjwMV6c=", - "dependencies": { - "locate-path": "^2.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/get-stream": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-4.1.0.tgz", - "integrity": "sha512-GMat4EJ5161kIy2HevLlr4luNjBgvmj413KaQA7jt4V8B4RDsfpHk7WQ9GVqfYyyx8OS/L66Kox+rJRNklLK7w==", - "dependencies": { - "pump": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/graceful-fs": { - "version": "4.2.4", - "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.4.tgz", - "integrity": "sha512-WjKPNJF79dtJAVniUlGGWHYGz2jWxT6VhN/4m1NdkbZ2nOsEF+cI1Edgql5zCRhs/VsQYRvrXctxktVXZUkixw==" - }, - "node_modules/hosted-git-info": { - "version": "2.8.8", - "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.8.tgz", - "integrity": "sha512-f/wzC2QaWBs7t9IYqB4T3sR1xviIViXJRJTWBlx2Gf3g0Xi5vI7Yy4koXQ1c9OYDGHN9sBy1DQ2AB8fqZBWhUg==" - }, - "node_modules/indent-string": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-3.2.0.tgz", - "integrity": "sha1-Sl/W0nzDMvN+VBmlBNu4NxBckok=", - "engines": { - "node": ">=4" - } - }, - "node_modules/is": { - "version": "0.2.7", - "resolved": "https://registry.npmjs.org/is/-/is-0.2.7.tgz", - "integrity": "sha1-OzSixI81mXLzUEKEkZOucmS2NWI=", - "engines": { - "node": "*" - } - }, - "node_modules/is-arrayish": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", - "integrity": "sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0=" - }, - "node_modules/is-plain-obj": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-1.1.0.tgz", - "integrity": "sha1-caUMhCnfync8kqOQpKA7OfzVHT4=", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-plain-object": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-3.0.0.tgz", - "integrity": "sha512-tZIpofR+P05k8Aocp7UI/2UTa9lTJSebCXpFFoR9aibpokDj/uXBsJ8luUu0tTVYKkMU6URDUuOfJZ7koewXvg==", - "dependencies": { - "isobject": "^4.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/is-stream": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-1.1.0.tgz", - "integrity": "sha1-EtSj3U5o4Lec6428hBc66A2RykQ=", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/isexe": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", - "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=" - }, - "node_modules/isobject": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/isobject/-/isobject-4.0.0.tgz", - "integrity": "sha512-S/2fF5wH8SJA/kmwr6HYhK/RI/OkhD84k8ntalo0iJjZikgq1XFvR5M8NPT1x5F7fBwCG3qHfnzeP/Vh/ZxCUA==", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/json-parse-better-errors": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz", - "integrity": "sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==" - }, - "node_modules/load-json-file": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-4.0.0.tgz", - "integrity": "sha1-L19Fq5HjMhYjT9U62rZo607AmTs=", - "dependencies": { - "graceful-fs": "^4.1.2", - "parse-json": "^4.0.0", - "pify": "^3.0.0", - "strip-bom": "^3.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/locate-path": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-2.0.0.tgz", - "integrity": "sha1-K1aLJl7slExtnA3pw9u7ygNUzY4=", - "dependencies": { - "p-locate": "^2.0.0", - "path-exists": "^3.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/loud-rejection": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/loud-rejection/-/loud-rejection-1.6.0.tgz", - "integrity": "sha1-W0b4AUft7leIcPCG0Eghz5mOVR8=", - "dependencies": { - "currently-unhandled": "^0.4.1", - "signal-exit": "^3.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/macos-release": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/macos-release/-/macos-release-2.3.0.tgz", - "integrity": "sha512-OHhSbtcviqMPt7yfw5ef5aghS2jzFVKEFyCJndQt2YpSQ9qRVSEv2axSJI1paVThEu+FFGs584h/1YhxjVqajA==", - "engines": { - "node": ">=6" - } - }, - "node_modules/map-obj": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/map-obj/-/map-obj-2.0.0.tgz", - "integrity": "sha1-plzSkIepJZi4eRJXpSPgISIqwfk=", - "engines": { - "node": ">=4" - } - }, - "node_modules/meow": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/meow/-/meow-4.0.1.tgz", - "integrity": "sha512-xcSBHD5Z86zaOc+781KrupuHAzeGXSLtiAOmBsiLDiPSaYSB6hdew2ng9EBAnZ62jagG9MHAOdxpDi/lWBFJ/A==", - "dependencies": { - "camelcase-keys": "^4.0.0", - "decamelize-keys": "^1.0.0", - "loud-rejection": "^1.0.0", - "minimist": "^1.1.3", - "minimist-options": "^3.0.1", - "normalize-package-data": "^2.3.4", - "read-pkg-up": "^3.0.0", - "redent": "^2.0.0", - "trim-newlines": "^2.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/minimist": { - "version": "1.2.6", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz", - "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==" - }, - "node_modules/minimist-options": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/minimist-options/-/minimist-options-3.0.2.tgz", - "integrity": "sha512-FyBrT/d0d4+uiZRbqznPXqw3IpZZG3gl3wKWiX784FycUKVwBt0uLBFkQrtE4tZOrgo78nZp2jnKz3L65T5LdQ==", - "dependencies": { - "arrify": "^1.0.1", - "is-plain-obj": "^1.1.0" - }, - "engines": { - "node": ">= 4" - } - }, - "node_modules/mkdirp-no-bin": { - "version": "0.5.1", - "resolved": "https://registry.npmjs.org/mkdirp-no-bin/-/mkdirp-no-bin-0.5.1.tgz", - "integrity": "sha1-NMYjGW02+y7i5WGrYHMFYy4AYZ8=" - }, - "node_modules/moment": { - "version": "2.29.4", - "resolved": "https://registry.npmjs.org/moment/-/moment-2.29.4.tgz", - "integrity": "sha512-5LC9SOxjSc2HF6vO2CyuTDNivEdoz2IvyJJGj6X8DJ0eFyfszE0QiEd+iXmBvUP3WHxSjFH/vIsA0EN00cgr8w==", - "engines": { - "node": "*" - } - }, - "node_modules/month-before-after": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/month-before-after/-/month-before-after-1.0.0.tgz", - "integrity": "sha512-fJDbhg6BBpZj4e+0GZMPEtMbp8SAh9/XtK75BoBRenftz7OQJKIf56G5CIH7tjYkklJnNxzjY30+CzTPcgH6AA==", - "dependencies": { - "moment": "^2.24.0" - } - }, - "node_modules/name-your-contributors": { - "version": "3.8.3", - "resolved": "https://registry.npmjs.org/name-your-contributors/-/name-your-contributors-3.8.3.tgz", - "integrity": "sha512-b1grTAd6wvuvXx4MDJlXbZEZBhGuTX6x/FsnN1PGXSkMRqntTC5/Q+XsMq1bjfTty6cQDbtgdJ5DGoCiKFjudQ==", - "dependencies": { - "csv-writer": "1.2.0", - "meow": "^4.0.0", - "month-before-after": "^1.0.0", - "persistent-cache": "^1.1.1" - }, - "bin": { - "name-your-contributors": "src/cli.js" - }, - "engines": { - "node": ">=10.0.0" - } - }, - "node_modules/nice-try": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/nice-try/-/nice-try-1.0.5.tgz", - "integrity": "sha512-1nh45deeb5olNY7eX82BkPO7SSxR5SSYJiPTrTdFUVYwAl8CKMA5N9PjTYkHiRjisVcxcQ1HXdLhx2qxxJzLNQ==" - }, - "node_modules/node-fetch": { - "version": "2.6.7", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz", - "integrity": "sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==", - "dependencies": { - "whatwg-url": "^5.0.0" - }, - "engines": { - "node": "4.x || >=6.0.0" - }, - "peerDependencies": { - "encoding": "^0.1.0" - }, - "peerDependenciesMeta": { - "encoding": { - "optional": true - } - } - }, - "node_modules/node.extend": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/node.extend/-/node.extend-1.0.8.tgz", - "integrity": "sha1-urBDefc4P0WHmQyd8Htqf2Xbdys=", - "engines": [ - "node >= 0.4.0" - ], - "dependencies": { - "is": "~0.2.6", - "object-keys": "~0.4.0" - } - }, - "node_modules/node.flow": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/node.flow/-/node.flow-1.2.3.tgz", - "integrity": "sha1-4cRKgq7KjXi0WKd/s9xkLy66Jkk=", - "engines": [ - "node >= 0.4.0" - ], - "dependencies": { - "node.extend": "1.0.8" - } - }, - "node_modules/normalize-package-data": { - "version": "2.5.0", - "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-2.5.0.tgz", - "integrity": "sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA==", - "dependencies": { - "hosted-git-info": "^2.1.4", - "resolve": "^1.10.0", - "semver": "2 || 3 || 4 || 5", - "validate-npm-package-license": "^3.0.1" - } - }, - "node_modules/npm-run-path": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-2.0.2.tgz", - "integrity": "sha1-NakjLfo11wZ7TLLd8jV7GHFTbF8=", - "dependencies": { - "path-key": "^2.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/object-keys": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-0.4.0.tgz", - "integrity": "sha1-KKaq50KN0sOpLz2V8hM13SBOAzY=" - }, - "node_modules/once": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", - "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", - "dependencies": { - "wrappy": "1" - } - }, - "node_modules/os-name": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/os-name/-/os-name-3.1.0.tgz", - "integrity": "sha512-h8L+8aNjNcMpo/mAIBPn5PXCM16iyPGjHNWo6U1YO8sJTMHtEtyczI6QJnLoplswm6goopQkqc7OAnjhWcugVg==", - "dependencies": { - "macos-release": "^2.2.0", - "windows-release": "^3.1.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/p-finally": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-finally/-/p-finally-1.0.0.tgz", - "integrity": "sha1-P7z7FbiZpEEjs0ttzBi3JDNqLK4=", - "engines": { - "node": ">=4" - } - }, - "node_modules/p-limit": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz", - "integrity": "sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==", - "dependencies": { - "p-try": "^1.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/p-locate": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-2.0.0.tgz", - "integrity": "sha1-IKAQOyIqcMj9OcwuWAaA893l7EM=", - "dependencies": { - "p-limit": "^1.1.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/p-try": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-1.0.0.tgz", - "integrity": "sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M=", - "engines": { - "node": ">=4" - } - }, - "node_modules/parse-json": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-4.0.0.tgz", - "integrity": "sha1-vjX1Qlvh9/bHRxhPmKeIy5lHfuA=", - "dependencies": { - "error-ex": "^1.3.1", - "json-parse-better-errors": "^1.0.1" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/path-exists": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", - "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", - "engines": { - "node": ">=4" - } - }, - "node_modules/path-key": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-2.0.1.tgz", - "integrity": "sha1-QRyttXTFoUDTpLGRDUDYDMn0C0A=", - "engines": { - "node": ">=4" - } - }, - "node_modules/path-parse": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.6.tgz", - "integrity": "sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw==" - }, - "node_modules/path-type": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-3.0.0.tgz", - "integrity": "sha512-T2ZUsdZFHgA3u4e5PfPbjd7HDDpxPnQb5jN0SrDsjNSuVXHJqtwTnWqG0B1jZrgmJ/7lj1EmVIByWt1gxGkWvg==", - "dependencies": { - "pify": "^3.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/persistent-cache": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/persistent-cache/-/persistent-cache-1.1.1.tgz", - "integrity": "sha1-ndiBPghcSrowmHsI4RqcqGpipUw=", - "dependencies": { - "mkdirp-no-bin": "^0.5.1", - "rmdir": "^1.2.0" - } - }, - "node_modules/pify": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/pify/-/pify-3.0.0.tgz", - "integrity": "sha1-5aSs0sEB/fPZpNB/DbxNtJ3SgXY=", - "engines": { - "node": ">=4" - } - }, - "node_modules/pump": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.0.tgz", - "integrity": "sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==", - "dependencies": { - "end-of-stream": "^1.1.0", - "once": "^1.3.1" - } - }, - "node_modules/quick-lru": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/quick-lru/-/quick-lru-1.1.0.tgz", - "integrity": "sha1-Q2CxfGETatOAeDl/8RQW4Ybc+7g=", - "engines": { - "node": ">=4" - } - }, - "node_modules/read-pkg": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-3.0.0.tgz", - "integrity": "sha1-nLxoaXj+5l0WwA4rGcI3/Pbjg4k=", - "dependencies": { - "load-json-file": "^4.0.0", - "normalize-package-data": "^2.3.2", - "path-type": "^3.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/read-pkg-up": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-3.0.0.tgz", - "integrity": "sha1-PtSWaF26D4/hGNBpHcUfSh/5bwc=", - "dependencies": { - "find-up": "^2.0.0", - "read-pkg": "^3.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/redent": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/redent/-/redent-2.0.0.tgz", - "integrity": "sha1-wbIAe0LVfrE4kHmzyDM2OdXhzKo=", - "dependencies": { - "indent-string": "^3.0.0", - "strip-indent": "^2.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/resolve": { - "version": "1.17.0", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", - "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", - "dependencies": { - "path-parse": "^1.0.6" - } - }, - "node_modules/rmdir": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/rmdir/-/rmdir-1.2.0.tgz", - "integrity": "sha1-T+A1fLBhaMJY5z6WgJPcTooPMlM=", - "engines": [ - "node >= 0.8.0" - ], - "dependencies": { - "node.flow": "1.2.3" - } - }, - "node_modules/semver": { - "version": "5.7.2", - "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.2.tgz", - "integrity": "sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g==", - "bin": { - "semver": "bin/semver" - } - }, - "node_modules/shebang-command": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-1.2.0.tgz", - "integrity": "sha1-RKrGW2lbAzmJaMOfNj/uXer98eo=", - "dependencies": { - "shebang-regex": "^1.0.0" - }, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/shebang-regex": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-1.0.0.tgz", - "integrity": "sha1-2kL0l0DAtC2yypcoVxyxkMmO/qM=", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/signal-exit": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.3.tgz", - "integrity": "sha512-VUJ49FC8U1OxwZLxIbTTrDvLnf/6TDgxZcK8wxR8zs13xpx7xbG60ndBlhNrFi2EMuFRoeDoJO7wthSLq42EjA==" - }, - "node_modules/spdx-correct": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.0.tgz", - "integrity": "sha512-lr2EZCctC2BNR7j7WzJ2FpDznxky1sjfxvvYEyzxNyb6lZXHODmEoJeFu4JupYlkfha1KZpJyoqiJ7pgA1qq8Q==", - "dependencies": { - "spdx-expression-parse": "^3.0.0", - "spdx-license-ids": "^3.0.0" - } - }, - "node_modules/spdx-exceptions": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.3.0.tgz", - "integrity": "sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A==" - }, - "node_modules/spdx-expression-parse": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz", - "integrity": "sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==", - "dependencies": { - "spdx-exceptions": "^2.1.0", - "spdx-license-ids": "^3.0.0" - } - }, - "node_modules/spdx-license-ids": { - "version": "3.0.5", - "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.5.tgz", - "integrity": "sha512-J+FWzZoynJEXGphVIS+XEh3kFSjZX/1i9gFBaWQcB+/tmpe2qUsSBABpcxqxnAxFdiUFEgAX1bjYGQvIZmoz9Q==" - }, - "node_modules/strip-bom": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", - "integrity": "sha1-IzTBjpx1n3vdVv3vfprj1YjmjtM=", - "engines": { - "node": ">=4" - } - }, - "node_modules/strip-eof": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/strip-eof/-/strip-eof-1.0.0.tgz", - "integrity": "sha1-u0P/VZim6wXYm1n80SnJgzE2Br8=", - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/strip-indent": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/strip-indent/-/strip-indent-2.0.0.tgz", - "integrity": "sha1-XvjbKV0B5u1sv3qrlpmNeCJSe2g=", - "engines": { - "node": ">=4" - } - }, - "node_modules/tr46": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", - "integrity": "sha1-gYT9NH2snNwYWZLzpmIuFLnZq2o=" - }, - "node_modules/trim-newlines": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/trim-newlines/-/trim-newlines-2.0.0.tgz", - "integrity": "sha1-tAPQuRvlDDMd/EuC7s6yLD3hbSA=", - "engines": { - "node": ">=4" - } - }, - "node_modules/typescript": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.9.2.tgz", - "integrity": "sha512-q2ktq4n/uLuNNShyayit+DTobV2ApPEo/6so68JaD5ojvc/6GClBipedB9zNWYxRSAlZXAe405Rlijzl6qDiSw==", - "bin": { - "tsc": "bin/tsc", - "tsserver": "bin/tsserver" - }, - "engines": { - "node": ">=4.2.0" - } - }, - "node_modules/universal-user-agent": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-5.0.0.tgz", - "integrity": "sha512-B5TPtzZleXyPrUMKCpEHFmVhMN6EhmJYjG5PQna9s7mXeSqGTLap4OpqLl5FCEFUI3UBmllkETwKf/db66Y54Q==", - "dependencies": { - "os-name": "^3.1.0" - } - }, - "node_modules/validate-npm-package-license": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz", - "integrity": "sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew==", - "dependencies": { - "spdx-correct": "^3.0.0", - "spdx-expression-parse": "^3.0.0" - } - }, - "node_modules/webidl-conversions": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", - "integrity": "sha1-JFNCdeKnvGvnvIZhHMFq4KVlSHE=" - }, - "node_modules/whatwg-url": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", - "integrity": "sha1-lmRU6HZUYuN2RNNib2dCzotwll0=", - "dependencies": { - "tr46": "~0.0.3", - "webidl-conversions": "^3.0.0" - } - }, - "node_modules/which": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz", - "integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==", - "dependencies": { - "isexe": "^2.0.0" - }, - "bin": { - "which": "bin/which" - } - }, - "node_modules/windows-release": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/windows-release/-/windows-release-3.3.0.tgz", - "integrity": "sha512-2HetyTg1Y+R+rUgrKeUEhAG/ZuOmTrI1NBb3ZyAGQMYmOJjBBPe4MTodghRkmLJZHwkuPi02anbeGP+Zf401LQ==", - "dependencies": { - "execa": "^1.0.0" - }, - "engines": { - "node": ">=6" - } - }, - "node_modules/wrappy": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", - "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=" - } - }, - "dependencies": { - "@octokit/endpoint": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.1.tgz", - "integrity": "sha512-pOPHaSz57SFT/m3R5P8MUu4wLPszokn5pXcB/pzavLTQf2jbU+6iayTvzaY6/BiotuRS0qyEUkx3QglT4U958A==", - "requires": { - "@octokit/types": "^2.11.1", - "is-plain-object": "^3.0.0", - "universal-user-agent": "^5.0.0" - } - }, - "@octokit/graphql": { - "version": "4.4.0", - "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.4.0.tgz", - "integrity": "sha512-Du3hAaSROQ8EatmYoSAJjzAz3t79t9Opj/WY1zUgxVUGfIKn0AEjg+hlOLscF6fv6i/4y/CeUvsWgIfwMkTccw==", - "requires": { - "@octokit/request": "^5.3.0", - "@octokit/types": "^2.0.0", - "universal-user-agent": "^5.0.0" - } - }, - "@octokit/request": { - "version": "5.4.2", - "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.4.2.tgz", - "integrity": "sha512-zKdnGuQ2TQ2vFk9VU8awFT4+EYf92Z/v3OlzRaSh4RIP0H6cvW1BFPXq4XYvNez+TPQjqN+0uSkCYnMFFhcFrw==", - "requires": { - "@octokit/endpoint": "^6.0.1", - "@octokit/request-error": "^2.0.0", - "@octokit/types": "^2.11.1", - "deprecation": "^2.0.0", - "is-plain-object": "^3.0.0", - "node-fetch": "^2.3.0", - "once": "^1.4.0", - "universal-user-agent": "^5.0.0" - } - }, - "@octokit/request-error": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.0.0.tgz", - "integrity": "sha512-rtYicB4Absc60rUv74Rjpzek84UbVHGHJRu4fNVlZ1mCcyUPPuzFfG9Rn6sjHrd95DEsmjSt1Axlc699ZlbDkw==", - "requires": { - "@octokit/types": "^2.0.0", - "deprecation": "^2.0.0", - "once": "^1.4.0" - } - }, - "@octokit/types": { - "version": "2.16.2", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.16.2.tgz", - "integrity": "sha512-O75k56TYvJ8WpAakWwYRN8Bgu60KrmX0z1KqFp1kNiFNkgW+JW+9EBKZ+S33PU6SLvbihqd+3drvPxKK68Ee8Q==", - "requires": { - "@types/node": ">= 8" - } - }, - "@types/node": { - "version": "14.0.1", - "resolved": "https://registry.npmjs.org/@types/node/-/node-14.0.1.tgz", - "integrity": "sha512-FAYBGwC+W6F9+huFIDtn43cpy7+SzG+atzRiTfdp3inUKL2hXnd4rG8hylJLIh4+hqrQy1P17kvJByE/z825hA==" - }, - "array-find-index": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/array-find-index/-/array-find-index-1.0.2.tgz", - "integrity": "sha1-3wEKoSh+Fku9pvlyOwqWoexBh6E=" - }, - "arrify": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/arrify/-/arrify-1.0.1.tgz", - "integrity": "sha1-iYUI2iIm84DfkEcoRWhJwVAaSw0=" - }, - "camelcase": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-4.1.0.tgz", - "integrity": "sha1-1UVjW+HjPFQmScaRc+Xeas+uNN0=" - }, - "camelcase-keys": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/camelcase-keys/-/camelcase-keys-4.2.0.tgz", - "integrity": "sha1-oqpfsa9oh1glnDLBQUJteJI7m3c=", - "requires": { - "camelcase": "^4.1.0", - "map-obj": "^2.0.0", - "quick-lru": "^1.0.0" - } - }, - "cross-spawn": { - "version": "6.0.5", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-6.0.5.tgz", - "integrity": "sha512-eTVLrBSt7fjbDygz805pMnstIs2VTBNkRm0qxZd+M7A5XDdxVRWO5MxGBXZhjY4cqLYLdtrGqRf8mBPmzwSpWQ==", - "requires": { - "nice-try": "^1.0.4", - "path-key": "^2.0.1", - "semver": "^5.5.0", - "shebang-command": "^1.2.0", - "which": "^1.2.9" - } - }, - "csv-writer": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/csv-writer/-/csv-writer-1.2.0.tgz", - "integrity": "sha512-ZU7eZ26y7oIOXwFHhTNnT/tF6RXMdQnuTGofzNTe1cvXacZm3Ixd7Oa9mOp2f1t39Ezfzg0h5tqfOjXM180BOg==" - }, - "currently-unhandled": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/currently-unhandled/-/currently-unhandled-0.4.1.tgz", - "integrity": "sha1-mI3zP+qxke95mmE2nddsF635V+o=", - "requires": { - "array-find-index": "^1.0.1" - } - }, - "decamelize": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz", - "integrity": "sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=" - }, - "decamelize-keys": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/decamelize-keys/-/decamelize-keys-1.1.0.tgz", - "integrity": "sha1-0XGoeTMlKAfrPLYdwcFEXQeN8tk=", - "requires": { - "decamelize": "^1.1.0", - "map-obj": "^1.0.0" - }, - "dependencies": { - "map-obj": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/map-obj/-/map-obj-1.0.1.tgz", - "integrity": "sha1-2TPOuSBdgr3PSIb2dCvcK03qFG0=" - } - } - }, - "deprecation": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/deprecation/-/deprecation-2.3.1.tgz", - "integrity": "sha512-xmHIy4F3scKVwMsQ4WnVaS8bHOx0DmVwRywosKhaILI0ywMDWPtBSku2HNxRvF7jtwDRsoEwYQSfbxj8b7RlJQ==" - }, - "end-of-stream": { - "version": "1.4.4", - "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz", - "integrity": "sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==", - "requires": { - "once": "^1.4.0" - } - }, - "error-ex": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", - "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", - "requires": { - "is-arrayish": "^0.2.1" - } - }, - "execa": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/execa/-/execa-1.0.0.tgz", - "integrity": "sha512-adbxcyWV46qiHyvSp50TKt05tB4tK3HcmF7/nxfAdhnox83seTDbwnaqKO4sXRy7roHAIFqJP/Rw/AuEbX61LA==", - "requires": { - "cross-spawn": "^6.0.0", - "get-stream": "^4.0.0", - "is-stream": "^1.1.0", - "npm-run-path": "^2.0.0", - "p-finally": "^1.0.0", - "signal-exit": "^3.0.0", - "strip-eof": "^1.0.0" - } - }, - "find-up": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz", - "integrity": "sha1-RdG35QbHF93UgndaK3eSCjwMV6c=", - "requires": { - "locate-path": "^2.0.0" - } - }, - "get-stream": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-4.1.0.tgz", - "integrity": "sha512-GMat4EJ5161kIy2HevLlr4luNjBgvmj413KaQA7jt4V8B4RDsfpHk7WQ9GVqfYyyx8OS/L66Kox+rJRNklLK7w==", - "requires": { - "pump": "^3.0.0" - } - }, - "graceful-fs": { - "version": "4.2.4", - "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.4.tgz", - "integrity": "sha512-WjKPNJF79dtJAVniUlGGWHYGz2jWxT6VhN/4m1NdkbZ2nOsEF+cI1Edgql5zCRhs/VsQYRvrXctxktVXZUkixw==" - }, - "hosted-git-info": { - "version": "2.8.8", - "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.8.tgz", - "integrity": "sha512-f/wzC2QaWBs7t9IYqB4T3sR1xviIViXJRJTWBlx2Gf3g0Xi5vI7Yy4koXQ1c9OYDGHN9sBy1DQ2AB8fqZBWhUg==" - }, - "indent-string": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-3.2.0.tgz", - "integrity": "sha1-Sl/W0nzDMvN+VBmlBNu4NxBckok=" - }, - "is": { - "version": "0.2.7", - "resolved": "https://registry.npmjs.org/is/-/is-0.2.7.tgz", - "integrity": "sha1-OzSixI81mXLzUEKEkZOucmS2NWI=" - }, - "is-arrayish": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", - "integrity": "sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0=" - }, - "is-plain-obj": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-1.1.0.tgz", - "integrity": "sha1-caUMhCnfync8kqOQpKA7OfzVHT4=" - }, - "is-plain-object": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-plain-object/-/is-plain-object-3.0.0.tgz", - "integrity": "sha512-tZIpofR+P05k8Aocp7UI/2UTa9lTJSebCXpFFoR9aibpokDj/uXBsJ8luUu0tTVYKkMU6URDUuOfJZ7koewXvg==", - "requires": { - "isobject": "^4.0.0" - } - }, - "is-stream": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-1.1.0.tgz", - "integrity": "sha1-EtSj3U5o4Lec6428hBc66A2RykQ=" - }, - "isexe": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", - "integrity": "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA=" - }, - "isobject": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/isobject/-/isobject-4.0.0.tgz", - "integrity": "sha512-S/2fF5wH8SJA/kmwr6HYhK/RI/OkhD84k8ntalo0iJjZikgq1XFvR5M8NPT1x5F7fBwCG3qHfnzeP/Vh/ZxCUA==" - }, - "json-parse-better-errors": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz", - "integrity": "sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw==" - }, - "load-json-file": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-4.0.0.tgz", - "integrity": "sha1-L19Fq5HjMhYjT9U62rZo607AmTs=", - "requires": { - "graceful-fs": "^4.1.2", - "parse-json": "^4.0.0", - "pify": "^3.0.0", - "strip-bom": "^3.0.0" - } - }, - "locate-path": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-2.0.0.tgz", - "integrity": "sha1-K1aLJl7slExtnA3pw9u7ygNUzY4=", - "requires": { - "p-locate": "^2.0.0", - "path-exists": "^3.0.0" - } - }, - "loud-rejection": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/loud-rejection/-/loud-rejection-1.6.0.tgz", - "integrity": "sha1-W0b4AUft7leIcPCG0Eghz5mOVR8=", - "requires": { - "currently-unhandled": "^0.4.1", - "signal-exit": "^3.0.0" - } - }, - "macos-release": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/macos-release/-/macos-release-2.3.0.tgz", - "integrity": "sha512-OHhSbtcviqMPt7yfw5ef5aghS2jzFVKEFyCJndQt2YpSQ9qRVSEv2axSJI1paVThEu+FFGs584h/1YhxjVqajA==" - }, - "map-obj": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/map-obj/-/map-obj-2.0.0.tgz", - "integrity": "sha1-plzSkIepJZi4eRJXpSPgISIqwfk=" - }, - "meow": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/meow/-/meow-4.0.1.tgz", - "integrity": "sha512-xcSBHD5Z86zaOc+781KrupuHAzeGXSLtiAOmBsiLDiPSaYSB6hdew2ng9EBAnZ62jagG9MHAOdxpDi/lWBFJ/A==", - "requires": { - "camelcase-keys": "^4.0.0", - "decamelize-keys": "^1.0.0", - "loud-rejection": "^1.0.0", - "minimist": "^1.1.3", - "minimist-options": "^3.0.1", - "normalize-package-data": "^2.3.4", - "read-pkg-up": "^3.0.0", - "redent": "^2.0.0", - "trim-newlines": "^2.0.0" - } - }, - "minimist": { - "version": "1.2.6", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz", - "integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==" - }, - "minimist-options": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/minimist-options/-/minimist-options-3.0.2.tgz", - "integrity": "sha512-FyBrT/d0d4+uiZRbqznPXqw3IpZZG3gl3wKWiX784FycUKVwBt0uLBFkQrtE4tZOrgo78nZp2jnKz3L65T5LdQ==", - "requires": { - "arrify": "^1.0.1", - "is-plain-obj": "^1.1.0" - } - }, - "mkdirp-no-bin": { - "version": "0.5.1", - "resolved": "https://registry.npmjs.org/mkdirp-no-bin/-/mkdirp-no-bin-0.5.1.tgz", - "integrity": "sha1-NMYjGW02+y7i5WGrYHMFYy4AYZ8=" - }, - "moment": { - "version": "2.29.4", - "resolved": "https://registry.npmjs.org/moment/-/moment-2.29.4.tgz", - "integrity": "sha512-5LC9SOxjSc2HF6vO2CyuTDNivEdoz2IvyJJGj6X8DJ0eFyfszE0QiEd+iXmBvUP3WHxSjFH/vIsA0EN00cgr8w==" - }, - "month-before-after": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/month-before-after/-/month-before-after-1.0.0.tgz", - "integrity": "sha512-fJDbhg6BBpZj4e+0GZMPEtMbp8SAh9/XtK75BoBRenftz7OQJKIf56G5CIH7tjYkklJnNxzjY30+CzTPcgH6AA==", - "requires": { - "moment": "^2.24.0" - } - }, - "name-your-contributors": { - "version": "3.8.3", - "resolved": "https://registry.npmjs.org/name-your-contributors/-/name-your-contributors-3.8.3.tgz", - "integrity": "sha512-b1grTAd6wvuvXx4MDJlXbZEZBhGuTX6x/FsnN1PGXSkMRqntTC5/Q+XsMq1bjfTty6cQDbtgdJ5DGoCiKFjudQ==", - "requires": { - "csv-writer": "1.2.0", - "meow": "^4.0.0", - "month-before-after": "^1.0.0", - "persistent-cache": "^1.1.1" - } - }, - "nice-try": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/nice-try/-/nice-try-1.0.5.tgz", - "integrity": "sha512-1nh45deeb5olNY7eX82BkPO7SSxR5SSYJiPTrTdFUVYwAl8CKMA5N9PjTYkHiRjisVcxcQ1HXdLhx2qxxJzLNQ==" - }, - "node-fetch": { - "version": "2.6.7", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz", - "integrity": "sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==", - "requires": { - "whatwg-url": "^5.0.0" - } - }, - "node.extend": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/node.extend/-/node.extend-1.0.8.tgz", - "integrity": "sha1-urBDefc4P0WHmQyd8Htqf2Xbdys=", - "requires": { - "is": "~0.2.6", - "object-keys": "~0.4.0" - } - }, - "node.flow": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/node.flow/-/node.flow-1.2.3.tgz", - "integrity": "sha1-4cRKgq7KjXi0WKd/s9xkLy66Jkk=", - "requires": { - "node.extend": "1.0.8" - } - }, - "normalize-package-data": { - "version": "2.5.0", - "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-2.5.0.tgz", - "integrity": "sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA==", - "requires": { - "hosted-git-info": "^2.1.4", - "resolve": "^1.10.0", - "semver": "2 || 3 || 4 || 5", - "validate-npm-package-license": "^3.0.1" - } - }, - "npm-run-path": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-2.0.2.tgz", - "integrity": "sha1-NakjLfo11wZ7TLLd8jV7GHFTbF8=", - "requires": { - "path-key": "^2.0.0" - } - }, - "object-keys": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-0.4.0.tgz", - "integrity": "sha1-KKaq50KN0sOpLz2V8hM13SBOAzY=" - }, - "once": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", - "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", - "requires": { - "wrappy": "1" - } - }, - "os-name": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/os-name/-/os-name-3.1.0.tgz", - "integrity": "sha512-h8L+8aNjNcMpo/mAIBPn5PXCM16iyPGjHNWo6U1YO8sJTMHtEtyczI6QJnLoplswm6goopQkqc7OAnjhWcugVg==", - "requires": { - "macos-release": "^2.2.0", - "windows-release": "^3.1.0" - } - }, - "p-finally": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-finally/-/p-finally-1.0.0.tgz", - "integrity": "sha1-P7z7FbiZpEEjs0ttzBi3JDNqLK4=" - }, - "p-limit": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz", - "integrity": "sha512-vvcXsLAJ9Dr5rQOPk7toZQZJApBl2K4J6dANSsEuh6QI41JYcsS/qhTGa9ErIUUgK3WNQoJYvylxvjqmiqEA9Q==", - "requires": { - "p-try": "^1.0.0" - } - }, - "p-locate": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-2.0.0.tgz", - "integrity": "sha1-IKAQOyIqcMj9OcwuWAaA893l7EM=", - "requires": { - "p-limit": "^1.1.0" - } - }, - "p-try": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-1.0.0.tgz", - "integrity": "sha1-y8ec26+P1CKOE/Yh8rGiN8GyB7M=" - }, - "parse-json": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-4.0.0.tgz", - "integrity": "sha1-vjX1Qlvh9/bHRxhPmKeIy5lHfuA=", - "requires": { - "error-ex": "^1.3.1", - "json-parse-better-errors": "^1.0.1" - } - }, - "path-exists": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", - "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=" - }, - "path-key": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-2.0.1.tgz", - "integrity": "sha1-QRyttXTFoUDTpLGRDUDYDMn0C0A=" - }, - "path-parse": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.6.tgz", - "integrity": "sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw==" - }, - "path-type": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-3.0.0.tgz", - "integrity": "sha512-T2ZUsdZFHgA3u4e5PfPbjd7HDDpxPnQb5jN0SrDsjNSuVXHJqtwTnWqG0B1jZrgmJ/7lj1EmVIByWt1gxGkWvg==", - "requires": { - "pify": "^3.0.0" - } - }, - "persistent-cache": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/persistent-cache/-/persistent-cache-1.1.1.tgz", - "integrity": "sha1-ndiBPghcSrowmHsI4RqcqGpipUw=", - "requires": { - "mkdirp-no-bin": "^0.5.1", - "rmdir": "^1.2.0" - } - }, - "pify": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/pify/-/pify-3.0.0.tgz", - "integrity": "sha1-5aSs0sEB/fPZpNB/DbxNtJ3SgXY=" - }, - "pump": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.0.tgz", - "integrity": "sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==", - "requires": { - "end-of-stream": "^1.1.0", - "once": "^1.3.1" - } - }, - "quick-lru": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/quick-lru/-/quick-lru-1.1.0.tgz", - "integrity": "sha1-Q2CxfGETatOAeDl/8RQW4Ybc+7g=" - }, - "read-pkg": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-3.0.0.tgz", - "integrity": "sha1-nLxoaXj+5l0WwA4rGcI3/Pbjg4k=", - "requires": { - "load-json-file": "^4.0.0", - "normalize-package-data": "^2.3.2", - "path-type": "^3.0.0" - } - }, - "read-pkg-up": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-3.0.0.tgz", - "integrity": "sha1-PtSWaF26D4/hGNBpHcUfSh/5bwc=", - "requires": { - "find-up": "^2.0.0", - "read-pkg": "^3.0.0" - } - }, - "redent": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/redent/-/redent-2.0.0.tgz", - "integrity": "sha1-wbIAe0LVfrE4kHmzyDM2OdXhzKo=", - "requires": { - "indent-string": "^3.0.0", - "strip-indent": "^2.0.0" - } - }, - "resolve": { - "version": "1.17.0", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", - "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", - "requires": { - "path-parse": "^1.0.6" - } - }, - "rmdir": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/rmdir/-/rmdir-1.2.0.tgz", - "integrity": "sha1-T+A1fLBhaMJY5z6WgJPcTooPMlM=", - "requires": { - "node.flow": "1.2.3" - } - }, - "semver": { - "version": "5.7.2", - "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.2.tgz", - "integrity": "sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g==" - }, - "shebang-command": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-1.2.0.tgz", - "integrity": "sha1-RKrGW2lbAzmJaMOfNj/uXer98eo=", - "requires": { - "shebang-regex": "^1.0.0" - } - }, - "shebang-regex": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-1.0.0.tgz", - "integrity": "sha1-2kL0l0DAtC2yypcoVxyxkMmO/qM=" - }, - "signal-exit": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.3.tgz", - "integrity": "sha512-VUJ49FC8U1OxwZLxIbTTrDvLnf/6TDgxZcK8wxR8zs13xpx7xbG60ndBlhNrFi2EMuFRoeDoJO7wthSLq42EjA==" - }, - "spdx-correct": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.0.tgz", - "integrity": "sha512-lr2EZCctC2BNR7j7WzJ2FpDznxky1sjfxvvYEyzxNyb6lZXHODmEoJeFu4JupYlkfha1KZpJyoqiJ7pgA1qq8Q==", - "requires": { - "spdx-expression-parse": "^3.0.0", - "spdx-license-ids": "^3.0.0" - } - }, - "spdx-exceptions": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.3.0.tgz", - "integrity": "sha512-/tTrYOC7PPI1nUAgx34hUpqXuyJG+DTHJTnIULG4rDygi4xu/tfgmq1e1cIRwRzwZgo4NLySi+ricLkZkw4i5A==" - }, - "spdx-expression-parse": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz", - "integrity": "sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==", - "requires": { - "spdx-exceptions": "^2.1.0", - "spdx-license-ids": "^3.0.0" - } - }, - "spdx-license-ids": { - "version": "3.0.5", - "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.5.tgz", - "integrity": "sha512-J+FWzZoynJEXGphVIS+XEh3kFSjZX/1i9gFBaWQcB+/tmpe2qUsSBABpcxqxnAxFdiUFEgAX1bjYGQvIZmoz9Q==" - }, - "strip-bom": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", - "integrity": "sha1-IzTBjpx1n3vdVv3vfprj1YjmjtM=" - }, - "strip-eof": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/strip-eof/-/strip-eof-1.0.0.tgz", - "integrity": "sha1-u0P/VZim6wXYm1n80SnJgzE2Br8=" - }, - "strip-indent": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/strip-indent/-/strip-indent-2.0.0.tgz", - "integrity": "sha1-XvjbKV0B5u1sv3qrlpmNeCJSe2g=" - }, - "tr46": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", - "integrity": "sha1-gYT9NH2snNwYWZLzpmIuFLnZq2o=" - }, - "trim-newlines": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/trim-newlines/-/trim-newlines-2.0.0.tgz", - "integrity": "sha1-tAPQuRvlDDMd/EuC7s6yLD3hbSA=" - }, - "typescript": { - "version": "3.9.2", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.9.2.tgz", - "integrity": "sha512-q2ktq4n/uLuNNShyayit+DTobV2ApPEo/6so68JaD5ojvc/6GClBipedB9zNWYxRSAlZXAe405Rlijzl6qDiSw==" - }, - "universal-user-agent": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-5.0.0.tgz", - "integrity": "sha512-B5TPtzZleXyPrUMKCpEHFmVhMN6EhmJYjG5PQna9s7mXeSqGTLap4OpqLl5FCEFUI3UBmllkETwKf/db66Y54Q==", - "requires": { - "os-name": "^3.1.0" - } - }, - "validate-npm-package-license": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz", - "integrity": "sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew==", - "requires": { - "spdx-correct": "^3.0.0", - "spdx-expression-parse": "^3.0.0" - } - }, - "webidl-conversions": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", - "integrity": "sha1-JFNCdeKnvGvnvIZhHMFq4KVlSHE=" - }, - "whatwg-url": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", - "integrity": "sha1-lmRU6HZUYuN2RNNib2dCzotwll0=", - "requires": { - "tr46": "~0.0.3", - "webidl-conversions": "^3.0.0" - } - }, - "which": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz", - "integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==", - "requires": { - "isexe": "^2.0.0" - } - }, - "windows-release": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/windows-release/-/windows-release-3.3.0.tgz", - "integrity": "sha512-2HetyTg1Y+R+rUgrKeUEhAG/ZuOmTrI1NBb3ZyAGQMYmOJjBBPe4MTodghRkmLJZHwkuPi02anbeGP+Zf401LQ==", - "requires": { - "execa": "^1.0.0" - } - }, - "wrappy": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", - "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=" - } - } -} diff --git a/.github/contributors/package.json b/.github/contributors/package.json deleted file mode 100644 index 25d22d79c9fb..000000000000 --- a/.github/contributors/package.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "name": "contributors", - "version": "1.0.0", - "description": "", - "main": "index.js", - "scripts": { - "test": "echo \"Error: no test specified\" && exit 1", - "gen": "tsc && node --trace-warnings ./generate.js", - "rewrite_readme": "tsc && node --trace-warnings ./rewrite_readme.js", - "all": "npm run gen && npm run rewrite_readme" - }, - "author": "", - "license": "MIT", - "type": "module", - "dependencies": { - "@octokit/graphql": "^4.4.0", - "@types/node": "^14.0.1", - "name-your-contributors": "^3.8.3", - "typescript": "^3.9.2" - } -} diff --git a/.github/contributors/rewrite_readme.ts b/.github/contributors/rewrite_readme.ts deleted file mode 100644 index eeccce532e2b..000000000000 --- a/.github/contributors/rewrite_readme.ts +++ /dev/null @@ -1,99 +0,0 @@ -import * as fs from "fs" -import * as path from "path" -import { ContributorInfo, DataJSON } from "./info" - -const main = async () => { - const readmePath = path.join(`..`, `..`, `README.md`) - const contentBuf = fs.readFileSync(readmePath) - const beginPattern = `\n` - const endPattern = `\n` - - const beginIndex = contentBuf.indexOf(beginPattern) - const endIndex = contentBuf.indexOf(endPattern) - if (beginIndex < 0 || endIndex < 0 || beginIndex >= endIndex) { - throw new Error(`no valid patterns in readme: beginIndex=${beginIndex}, endIndex=${endIndex}`) - } - - const contributors = buildContributorsContent() - const rewrittenContent = - contentBuf.slice(0, beginIndex + beginPattern.length).toString() + contributors + contentBuf.slice(endIndex).toString() - - // it's not atomic, TODO: use rename - fs.writeFileSync(readmePath, rewrittenContent) -} - -const colPerRow = 7 -const rowsVisible = 5 - -const buildContributorsTable = (contributors: ContributorInfo[]): string => { - type Contributors = ContributorInfo[] - const rows: Contributors[] = [] - for (let i = 0; i < contributors.length; ) { - rows.push(contributors.slice(i, i + colPerRow)) - i += colPerRow - } - - return ` -${rows - .map( - (row) => - `\n${row - .map( - (c) => - ` ` - ) - .join(`\n`)}\n` - ) - .join(`\n`)} -

${ - c.name ? c.name : `@${c.login}` - }
` -} - -const buildContributorsContent = (): string => { - const data: DataJSON = JSON.parse(fs.readFileSync(`contributors.json`).toString()) - - const visibleCount = colPerRow * rowsVisible - const hiddenCount = data.contributors.length - visibleCount - - return ` - -### Core Team - -
-About core team - -The GolangCI Core Team is a group of contributors that have demonstrated a lasting enthusiasm for the project and community. -The GolangCI Core Team has GitHub admin privileges on the repo. - -#### Responsibilities -The Core Team has the following responsibilities: - -1. Being available to answer high-level questions about vision and future. -2. Being available to review longstanding/forgotten pull requests. -3. Occasionally check issues, offer input, and categorize with GitHub issue labels. -4. Looking out for up-and-coming members of the GolangCI community who might want to serve as Core Team members. -5. Note that the Core Team – and all GolangCI contributors – are open source volunteers; membership on the Core Team is expressly not an obligation. The Core Team is distinguished as leaders in the community and while they are a good group to turn to when someone needs an answer to a question, they are still volunteering their time, and may not be available to help immediately. - -
- -${buildContributorsTable(data.coreTeam)} - -### Team - -${buildContributorsTable(data.contributors.slice(0, visibleCount))} - -
-And ${hiddenCount} more our team members - -${buildContributorsTable(data.contributors.slice(visibleCount))} - -
- - -` -} - -main() diff --git a/.github/contributors/tsconfig.json b/.github/contributors/tsconfig.json deleted file mode 100644 index 16d9c5118f2e..000000000000 --- a/.github/contributors/tsconfig.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "compilerOptions": { - "esModuleInterop": false, - "target": "es2015", - "module": "es2015", - "lib": ["es2015"], - "strict": true, - "incremental": true - } -} diff --git a/.github/dependabot.yml b/.github/dependabot.yml index d045963d5d09..32b46fe168b1 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -7,21 +7,46 @@ updates: day: "sunday" time: "11:00" # 11am UTC ignore: - # ignore forked linters because of their versioning issues. TODO: fix it. - - dependency-name: "github.com/golangci/*" + # Ignore forked linters because of their versioning issues. + - dependency-name: "github.com/golangci/dupl" + - dependency-name: "github.com/golangci/gofmt" + - dependency-name: "github.com/golangci/unconvert" - package-ecosystem: github-actions directory: "/" schedule: interval: weekly + groups: + github-actions: + patterns: + - "*" # Group all updates into a single larger pull request. - package-ecosystem: docker directory: "/build" schedule: interval: weekly + groups: + docker: + patterns: + - "*" # Group all updates into a single larger pull request. - package-ecosystem: gomod directory: "/scripts/gen_github_action_config" schedule: interval: weekly - - package-ecosystem: npm - directory: "/docs" + groups: + scripts: + patterns: + - "*" # Group all updates into a single larger pull request. + - package-ecosystem: gomod + directories: + - pkg/golinters/ginkgolinter/testdata/ + - pkg/golinters/loggercheck/testdata/ + - pkg/golinters/protogetter/testdata/ + - pkg/golinters/spancheck/testdata/ + - pkg/golinters/zerologlint/testdata/ + groups: + linter-testdata: + patterns: + - "*" # Group all updates into a single larger pull request. schedule: interval: monthly + day: "wednesday" + time: "11:00" # 11am UTC diff --git a/.github/new-linter-checklist.md b/.github/new-linter-checklist.md new file mode 100644 index 000000000000..bd82d2ebe6da --- /dev/null +++ b/.github/new-linter-checklist.md @@ -0,0 +1,73 @@ +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. +- [ ] It must use Go version <= 1.22.0 +- [ ] The linter repository must have a CI and tests. +- [ ] It must use [`go/analysis`](https://golangci-lint.run/contributing/new-linters/). +- [ ] 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 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. + +### 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. +- [ ] Use `main` as the default branch name. + +--- + +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.** diff --git a/.github/peril/README.md b/.github/peril/README.md index 492514318ade..bde7716f14c1 100644 --- a/.github/peril/README.md +++ b/.github/peril/README.md @@ -1,4 +1,4 @@ -Based on https://github.com/gatsbyjs/gatsby/tree/master/peril. +Based on https://github.com/gatsbyjs/gatsby/tree/HEAD/peril. ## Update a code diff --git a/.github/peril/package-lock.json b/.github/peril/package-lock.json index 038ea0226242..4bb363ae5281 100644 --- a/.github/peril/package-lock.json +++ b/.github/peril/package-lock.json @@ -1018,11 +1018,21 @@ } }, "braces": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", - "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", + "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", "requires": { - "fill-range": "^7.0.1" + "fill-range": "^7.1.1" + }, + "dependencies": { + "fill-range": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", + "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "requires": { + "to-regex-range": "^5.0.1" + } + } } }, "browserslist": { @@ -1135,9 +1145,9 @@ } }, "cross-spawn": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", - "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==", + "version": "7.0.5", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.5.tgz", + "integrity": "sha512-ZVJrKKYunU38/76t0RMOulHOnUcbU9GbpWKAOZ0mhjr7CX6FVrH+4FrAapSOekrgFQ3f/8gwMEuIft0aKq6Hug==", "requires": { "path-key": "^3.1.0", "shebang-command": "^2.0.0", @@ -1256,14 +1266,6 @@ "bser": "2.1.1" } }, - "fill-range": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", - "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", - "requires": { - "to-regex-range": "^5.0.1" - } - }, "find-up": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", @@ -1989,11 +1991,11 @@ "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==" }, "micromatch": { - "version": "4.0.5", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz", - "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==", + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", "requires": { - "braces": "^3.0.2", + "braces": "^3.0.3", "picomatch": "^2.3.1" } }, diff --git a/.github/peril/settings.json b/.github/peril/settings.json index 624ee5071b1e..3cfea70d4773 100644 --- a/.github/peril/settings.json +++ b/.github/peril/settings.json @@ -1,5 +1,5 @@ { - "$schema": "https://raw.githubusercontent.com/danger/peril/master/peril-settings-json.schema", + "$schema": "https://raw.githubusercontent.com/danger/peril/HEAD/peril-settings-json.schema", "settings": { "ignored_repos": [], "env_vars": ["SLACK_WEBHOOK_URL", "GITHUB_ACCESS_TOKEN"] diff --git a/.github/workflows/codeql.yaml b/.github/workflows/codeql.yaml deleted file mode 100644 index b717a003faaa..000000000000 --- a/.github/workflows/codeql.yaml +++ /dev/null @@ -1,49 +0,0 @@ -# For most projects, this workflow file will not need changing; you simply need -# to commit it to your repository. -# -# You may wish to alter this file to override the set of languages analyzed, -# or to provide custom queries or build logic. -name: "CodeQL" - -on: - push: - branches: [ master ] - pull_request: - # The branches below must be a subset of the branches above - branches: [ master ] - schedule: - - cron: '0 17 * * 5' - -jobs: - analyze: - name: Analyze - runs-on: ubuntu-latest - - permissions: - # required for all workflows - security-events: write - - strategy: - fail-fast: false - matrix: - # Override automatic language detection by changing the below list - # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python'] - # TODO: Enable for javascript later - language: [ 'go'] - - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - # Initializes the CodeQL tools for scanning. - - name: Initialize CodeQL - uses: github/codeql-action/init@v2 - with: - languages: ${{ matrix.language }} - # If you wish to specify custom queries, you can do so here or in a config file. - # By default, queries listed here will override any specified in a config file. - # Prefix the list here with "+" to use these queries and those in the config file. - # queries: ./path/to/local/query, your-org/your-repo/queries@main - - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v2 diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 000000000000..c2541d342f27 --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,53 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +name: "CodeQL" + +on: + push: + branches: + - master + - main + pull_request: + # The branches below must be a subset of the branches above + branches: + - master + - main + schedule: + - cron: '0 17 * * 5' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + + permissions: + # required for all workflows + security-events: write + + strategy: + fail-fast: false + matrix: + # Override automatic language detection by changing the below list + # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python'] + # TODO: Enable for javascript later + language: [ 'go'] + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v3 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + # queries: ./path/to/local/query, your-org/your-repo/queries@main + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v3 diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 0cf451fcd2d1..23ca9bbc7cc6 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -4,6 +4,7 @@ on: push: branches: - master + - main jobs: @@ -11,36 +12,18 @@ jobs: name: Build and deploy documentation runs-on: ubuntu-latest env: - GO_VERSION: '1.21' + # https://github.com/actions/setup-go#supported-version-syntax + # ex: + # - 1.18beta1 -> 1.18.0-beta.1 + # - 1.18rc1 -> 1.18.0-rc.1 + GO_VERSION: '1.24' NODE_VERSION: '20.x' CGO_ENABLED: 0 - steps: - - name: Check out code - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - name: Set up Go ${{ env.GO_VERSION }} - uses: actions/setup-go@v4 + - uses: actions/checkout@v4 + - uses: actions/setup-go@v5 with: go-version: ${{ env.GO_VERSION }} - - - name: Cache Go modules - uses: actions/cache@v3 - with: - # In order: - # * Module download cache - # * Build cache (Linux) - path: | - ~/go/pkg/mod - ~/.cache/go-build - key: docs-${{ runner.os }}-go-${{ hashFiles('**/go.sum') }} - restore-keys: | - docs-${{ runner.os }}-go- - - - run: go mod download - - name: Use Node.js ${{ env.NODE_VERSION }} uses: actions/setup-node@v4 with: @@ -48,15 +31,17 @@ jobs: cache: npm cache-dependency-path: docs/package-lock.json + - run: go mod download + - run: npm install --legacy-peer-deps working-directory: ./docs - name: Build Documentation - run: npm run build working-directory: ./docs + run: npm run build - name: Deploy to GitHub Pages - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: publish_dir: docs/public force_orphan: true diff --git a/.github/workflows/new-linter-checklist.yml b/.github/workflows/new-linter-checklist.yml new file mode 100644 index 000000000000..d472c960d1a9 --- /dev/null +++ b/.github/workflows/new-linter-checklist.yml @@ -0,0 +1,32 @@ +name: Add new linter checklist + +on: + workflow_dispatch: + inputs: + pr: + description: PR number + required: true + type: number + +permissions: + pull-requests: write + +jobs: + add-comment: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Add checklist + run: | + # Avoid adding multiple comments for the same PR. + comment_exist=$(gh pr view "$NUMBER" \ + --json comments \ + --jq '.comments[].author | select(.login=="github-actions") | .login' \ + | wc -l) + [ "$comment_exist" -gt 0 ] && edit_last="--edit-last" + + gh pr comment "$NUMBER" --body "$(cat .github/new-linter-checklist.md)" $edit_last + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + GH_REPO: ${{ github.repository }} + NUMBER: ${{ inputs.pr }} diff --git a/.github/workflows/post-release.yml b/.github/workflows/post-release.yml index 9640dd711c82..19b604ece9fc 100644 --- a/.github/workflows/post-release.yml +++ b/.github/workflows/post-release.yml @@ -1,44 +1,74 @@ -name: "Publish release documentation" +name: "Post release" on: release: types: - published +env: + # https://github.com/actions/setup-go#supported-version-syntax + # ex: + # - 1.18beta1 -> 1.18.0-beta.1 + # - 1.18rc1 -> 1.18.0-rc.1 + GO_VERSION: '1.24' + jobs: - update-docs-and-assets: + update-gha-assets: + name: "Update GitHub Action assets" runs-on: ubuntu-latest env: GITHUB_TOKEN: ${{ secrets.GOLANGCI_LINT_TOKEN }} steps: - uses: actions/checkout@v4 - - name: Install Go - uses: actions/setup-go@v4 + - uses: actions/setup-go@v5 with: - # https://github.com/actions/setup-go#supported-version-syntax - # ex: - # - 1.18beta1 -> 1.18.0-beta.1 - # - 1.18rc1 -> 1.18.0-rc.1 - go-version: '1.21' + go-version: ${{ env.GO_VERSION }} - - name: Update GitHub action config + - name: Update GitHub Action config run: make assets/github-action-config.json - - uses: actions/setup-node@v4 + - name: Create Pull Request + uses: peter-evans/create-pull-request@v7 + with: + base: master + token: ${{ secrets.GOLANGCI_LINT_TOKEN }} + branch-suffix: timestamp + title: "docs: update GitHub Action assets" + delete-branch: true + + update-assets: + name: "Update documentation assets" + runs-on: ubuntu-latest + env: + GITHUB_TOKEN: ${{ secrets.GOLANGCI_LINT_TOKEN }} + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-go@v5 with: - node-version: "15" - check-latest: true - - name: npm install - working-directory: .github/contributors - run: npm install - - name: Update Contributors list - run: make update_contributors_list # may take 15 min + go-version: ${{ env.GO_VERSION }} + + - name: Update reference files + run: cp .golangci.next.reference.yml .golangci.reference.yml + + - name: Update JSON schema files + run: cp jsonschema/golangci.next.jsonschema.json jsonschema/golangci.jsonschema.json + + - name: Update information + run: make website_dump_info - name: Create Pull Request - uses: peter-evans/create-pull-request@v5 + uses: peter-evans/create-pull-request@v7 with: base: master token: ${{ secrets.GOLANGCI_LINT_TOKEN }} branch-suffix: timestamp - title: "docs: Update documentation and assets" - team-reviewers: golangci/team + title: "docs: update documentation assets" delete-branch: true + + check-install-script: + name: Installation script (remote) + strategy: + matrix: + os: [ubuntu-latest, macos-latest, windows-latest] + runs-on: ${{ matrix.os }} + steps: + - run: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/HEAD/install.sh | sh -s -- -b "./install-golangci-lint" diff --git a/.github/workflows/pr-documentation.yml b/.github/workflows/pr-documentation.yml new file mode 100644 index 000000000000..bdd9043cb6b2 --- /dev/null +++ b/.github/workflows/pr-documentation.yml @@ -0,0 +1,39 @@ +name: Check Documentation + +on: + pull_request: + +jobs: + + doc: + name: Build documentation + runs-on: ubuntu-latest + env: + # https://github.com/actions/setup-go#supported-version-syntax + # ex: + # - 1.18beta1 -> 1.18.0-beta.1 + # - 1.18rc1 -> 1.18.0-rc.1 + GO_VERSION: '1.24' + NODE_VERSION: '20.x' + CGO_ENABLED: 0 + + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-go@v5 + with: + go-version: ${{ env.GO_VERSION }} + - name: Use Node.js ${{ env.NODE_VERSION }} + uses: actions/setup-node@v4 + with: + node-version: ${{ env.NODE_VERSION }} + cache: npm + cache-dependency-path: docs/package-lock.json + + - run: go mod download + + - run: npm install --legacy-peer-deps + working-directory: ./docs + + - name: Build Documentation + run: npm run build + working-directory: ./docs diff --git a/.github/workflows/pr-extra.yml b/.github/workflows/pr-extra.yml deleted file mode 100644 index 3c7faefa34af..000000000000 --- a/.github/workflows/pr-extra.yml +++ /dev/null @@ -1,24 +0,0 @@ -name: Extra -on: - push: - branches: - - master - pull_request: - -jobs: - vulns: - name: Vulnerability scanner - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-go@v4 - with: - # https://github.com/actions/setup-go#supported-version-syntax - # ex: - # - 1.18beta1 -> 1.18.0-beta.1 - # - 1.18rc1 -> 1.18.0-rc.1 - go-version: '1.21' - - name: Run go list - run: go list -json -m all > go.list - - name: Nancy - uses: sonatype-nexus-community/nancy-github-action@v1.0.3 diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index 4b72c6346f6d..a9f06c715243 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -3,30 +3,30 @@ on: push: branches: - master + - main pull_request: env: - GO_VERSION: '1.21' + # https://github.com/actions/setup-go#supported-version-syntax + # ex: + # - 1.18beta1 -> 1.18.0-beta.1 + # - 1.18rc1 -> 1.18.0-rc.1 + GO_VERSION: '1.24' jobs: # Check if there is any dirty change for go mod tidy go-mod: runs-on: ubuntu-latest steps: - - name: Install Go - uses: actions/setup-go@v4 + - uses: actions/checkout@v4 + - uses: actions/setup-go@v5 with: - # https://github.com/actions/setup-go#supported-version-syntax - # ex: - # - 1.18beta1 -> 1.18.0-beta.1 - # - 1.18rc1 -> 1.18.0-rc.1 go-version: ${{ env.GO_VERSION }} - - name: Checkout code - uses: actions/checkout@v4 - name: Check go mod run: | go mod tidy git diff --exit-code go.mod + git diff --exit-code go.sum # We already run the current golangci-lint in tests, but here we test # our GitHub action with the latest stable golangci-lint. @@ -34,8 +34,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - name: Install Go - uses: actions/setup-go@v4 + - uses: actions/setup-go@v5 with: # https://github.com/actions/setup-go#supported-version-syntax # ex: @@ -43,25 +42,17 @@ jobs: # - 1.18rc1 -> 1.18.0-rc.1 go-version: ${{ env.GO_VERSION }} - name: lint - uses: golangci/golangci-lint-action@v3.7.0 + uses: golangci/golangci-lint-action@v6.5.0 with: version: latest - # skip cache because of flaky behaviors - skip-build-cache: true - skip-pkg-cache: true tests-on-windows: needs: golangci-lint # run after golangci-lint action to not produce duplicated errors runs-on: windows-latest steps: - uses: actions/checkout@v4 - - name: Install Go - uses: actions/setup-go@v4 + - uses: actions/setup-go@v5 with: - # https://github.com/actions/setup-go#supported-version-syntax - # ex: - # - 1.18beta1 -> 1.18.0-beta.1 - # - 1.18rc1 -> 1.18.0-rc.1 go-version: ${{ env.GO_VERSION }} # test only the latest go version to speed up CI - name: Run tests run: make.exe test @@ -71,61 +62,91 @@ jobs: runs-on: macos-latest steps: - uses: actions/checkout@v4 - - name: Install Go - uses: actions/setup-go@v4 + - uses: actions/setup-go@v5 with: - # https://github.com/actions/setup-go#supported-version-syntax - # ex: - # - 1.18beta1 -> 1.18.0-beta.1 - # - 1.18rc1 -> 1.18.0-rc.1 go-version: ${{ env.GO_VERSION }} # test only the latest go version to speed up CI - name: Run tests run: make test tests-on-unix: needs: golangci-lint # run after golangci-lint action to not produce duplicated errors - runs-on: ubuntu-latest strategy: matrix: + os: + - ubuntu-latest + - ubuntu-24.04-arm golang: - - '1.20' - - '1.21' + - '1.23' + - '1.24' + runs-on: ${{ matrix.os }} steps: - uses: actions/checkout@v4 - - name: Install Go - uses: actions/setup-go@v4 + - uses: actions/setup-go@v5 with: - # https://github.com/actions/setup-go#supported-version-syntax - # ex: - # - 1.18beta1 -> 1.18.0-beta.1 - # - 1.18rc1 -> 1.18.0-rc.1 go-version: ${{ matrix.golang }} - - uses: actions/cache@v3 - with: - path: ~/go/pkg/mod - key: ${{ runner.os }}-go-${{ matrix.golang }}-${{ hashFiles('**/go.sum') }} - restore-keys: | - ${{ runner.os }}-go-${{ matrix.golang }}- - name: Run tests run: make test + # Checks: GitHub action assets check_generated: - needs: golangci-lint # run after golangci-lint action to not produce duplicated errors runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - name: Unshallow - run: git fetch --prune --unshallow - - name: Install Go - uses: actions/setup-go@v4 with: - # https://github.com/actions/setup-go#supported-version-syntax - # ex: - # - 1.18beta1 -> 1.18.0-beta.1 - # - 1.18rc1 -> 1.18.0-rc.1 + fetch-depth: 0 + - uses: actions/setup-go@v5 + with: go-version: ${{ env.GO_VERSION }} - - name: Check generated files are up to date + - name: Check generated files are up-to-date run: make fast_check_generated env: # needed for github-action-config.json generation GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + check-local-install-script: + name: Installation script (local) + strategy: + matrix: + os: [ubuntu-latest, ubuntu-24.04-arm, macos-latest, windows-latest] + runs-on: ${{ matrix.os }} + steps: + - uses: actions/checkout@v4 + - name: Check installation script + run: cat ./install.sh | sh -s -- -d -b "./install-golangci-lint" + + # Note: the command `run` is tested by the previous steps (`make test`). + commands: + needs: golangci-lint + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-go@v5 + with: + go-version: ${{ env.GO_VERSION }} + - name: Build golangci-lint + run: make build + + - run: ./golangci-lint + + - run: ./golangci-lint cache + - run: ./golangci-lint cache status + - run: ./golangci-lint cache clean + + - run: ./golangci-lint completion + - run: ./golangci-lint completion bash + - run: ./golangci-lint completion bash --no-descriptions + - run: ./golangci-lint completion zsh + - run: ./golangci-lint completion zsh --no-descriptions + - run: ./golangci-lint completion fish + - run: ./golangci-lint completion fish --no-descriptions + - run: ./golangci-lint completion powershell + - run: ./golangci-lint completion powershell --no-descriptions + + - run: ./golangci-lint config + - run: ./golangci-lint config path + - run: ./golangci-lint config verify --schema jsonschema/golangci.jsonschema.json + + - run: ./golangci-lint help + - run: ./golangci-lint help linters + - run: ./golangci-lint linters + - run: ./golangci-lint version diff --git a/.github/workflows/tag.yml b/.github/workflows/tag.yml index 8b9b7d9034db..e807c3aeaeb3 100644 --- a/.github/workflows/tag.yml +++ b/.github/workflows/tag.yml @@ -7,70 +7,55 @@ on: jobs: release: runs-on: ubuntu-latest + env: + # https://github.com/actions/setup-go#supported-version-syntax + # ex: + # - 1.18beta1 -> 1.18.0-beta.1 + # - 1.18rc1 -> 1.18.0-rc.1 + GO_VERSION: '1.24' + CHOCOLATEY_VERSION: 2.2.0 steps: - - uses: actions/checkout@v4 - - name: Install Go - uses: actions/setup-go@v4 - with: - # https://github.com/actions/setup-go#supported-version-syntax - # ex: - # - 1.18beta1 -> 1.18.0-beta.1 - # - 1.18rc1 -> 1.18.0-rc.1 - go-version: '1.21' - - name: Unshallow - run: git fetch --prune --unshallow + # temporary workaround for an error in free disk space action + # https://github.com/jlumbroso/free-disk-space/issues/14 + - name: Update Package List and Remove Dotnet + run: | + sudo apt-get update + sudo apt-get remove -y '^dotnet-.*' - - name: Create release - uses: goreleaser/goreleaser-action@v5 + # https://github.com/marketplace/actions/free-disk-space-ubuntu + - name: Free Disk Space + uses: jlumbroso/free-disk-space@main with: - version: latest - args: release --clean - env: - GITHUB_TOKEN: ${{ secrets.GOLANGCI_LINT_TOKEN }} + # this might remove tools that are actually needed + tool-cache: false - docker-release: - needs: release - runs-on: ubuntu-latest - strategy: - matrix: - target: - - Dockerfile: build/Dockerfile - - Dockerfile: build/alpine.Dockerfile - steps: - - uses: actions/checkout@v4 + # all of these default to true + android: true + dotnet: true + haskell: true + large-packages: true + docker-images: true + swap-storage: false - - name: Install Go - uses: actions/setup-go@v4 + - uses: actions/checkout@v4 with: - # https://github.com/actions/setup-go#supported-version-syntax - # ex: - # - 1.18beta1 -> 1.18.0-beta.1 - # - 1.18rc1 -> 1.18.0-rc.1 - go-version: '1.21' + fetch-depth: 0 + - uses: actions/setup-go@v5 + with: + go-version: ${{ env.GO_VERSION }} - - name: Unshallow - run: git fetch --prune --unshallow +# - name: Install chocolatey +# run: | +# mono --version +# mkdir -p /opt/chocolatey +# wget -q -O - "https://github.com/chocolatey/choco/releases/download/${CHOCOLATEY_VERSION}/chocolatey.v${CHOCOLATEY_VERSION}.tar.gz" | tar -xz -C "/opt/chocolatey" +# echo '#!/bin/bash' >> /usr/local/bin/choco +# echo 'mono /opt/chocolatey/choco.exe $@' >> /usr/local/bin/choco +# chmod +x /usr/local/bin/choco +# choco --version - - name: Prepare - id: prepare - run: | - TAG=${GITHUB_REF#refs/tags/} - MAJOR=${TAG%.*} - SHORT_COMMIT=${GITHUB_SHA::8} - DATE=$(date '+%Y-%m-%dT%H:%M:%SZ') - echo tag_name=${TAG} >> $GITHUB_OUTPUT - echo major_tag=${MAJOR} >> $GITHUB_OUTPUT - echo short_commit=${SHORT_COMMIT} >> $GITHUB_OUTPUT - echo date=${DATE} >> $GITHUB_OUTPUT - if [[ ${{ matrix.target.Dockerfile }} == *"alpine"* ]]; then - echo full_tag_name=${TAG}-alpine >> $GITHUB_OUTPUT - echo full_major_tag=${MAJOR}-alpine >> $GITHUB_OUTPUT - echo latest_tag=latest-alpine >> $GITHUB_OUTPUT - else - echo full_tag_name=${TAG} >> $GITHUB_OUTPUT - echo full_major_tag=${MAJOR} >> $GITHUB_OUTPUT - echo latest_tag=latest >> $GITHUB_OUTPUT - fi + - name: Install snapcraft + run: sudo snap install snapcraft --classic - name: Set up QEMU uses: docker/setup-qemu-action@v3 @@ -81,18 +66,13 @@ jobs: - name: Login do docker.io run: docker login -u golangci -p ${{ secrets.GOLANGCI_LINT_DOCKER_TOKEN }} - - name: Build and publish ${{ matrix.target.Dockerfile }} - uses: docker/build-push-action@v5 + - name: Create release + uses: goreleaser/goreleaser-action@v6 with: - context: . - file: ${{ matrix.target.Dockerfile }} - platforms: linux/amd64,linux/arm64 - push: true - build-args: | - VERSION=${{ steps.prepare.outputs.tag_name }} - SHORT_COMMIT=${{ steps.prepare.outputs.short_commit }} - DATE=${{ steps.prepare.outputs.date }} - tags: | - golangci/golangci-lint:${{ steps.prepare.outputs.full_tag_name }} - golangci/golangci-lint:${{ steps.prepare.outputs.full_major_tag }} - golangci/golangci-lint:${{ steps.prepare.outputs.latest_tag }} + version: latest + args: release --clean --timeout=90m + env: + AUR_KEY: ${{ secrets.AUR_KEY }} + CHOCOLATEY_API_KEY: ${{ secrets.CHOCOLATEY_API_KEY }} + SNAPCRAFT_STORE_CREDENTIALS: ${{ secrets.SNAPCRAFT_STORE_CREDENTIALS }} + GITHUB_TOKEN: ${{ secrets.GOLANGCI_LINT_TOKEN }} diff --git a/.gitignore b/.gitignore index bb2653285201..19c7ab47f1be 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ /*.pdf /*.pprof /*.txt +/test.lock /.idea/ /.vscode/ /dist/ @@ -18,3 +19,7 @@ /vendor/ coverage.out coverage.xml +/custom-golangci-lint +/custom-gcl +.custom-gcl.yml +.custom-gcl.yaml diff --git a/.golangci.next.reference.yml b/.golangci.next.reference.yml new file mode 100644 index 000000000000..fb0895eb3700 --- /dev/null +++ b/.golangci.next.reference.yml @@ -0,0 +1,4256 @@ +# This file contains all available configuration options +# with their default values (in comments). +# +# This file is not a configuration example, +# it contains the exhaustive configuration with explanations of the options. + +linters: + # Disable all linters. + # Default: false + disable-all: true + # Enable specific linter + # https://golangci-lint.run/usage/linters/#enabled-by-default + enable: + - asasalint + - asciicheck + - bidichk + - bodyclose + - canonicalheader + - containedctx + - contextcheck + - copyloopvar + - cyclop + - decorder + - depguard + - dogsled + - dupl + - dupword + - durationcheck + - err113 + - errcheck + - errchkjson + - errname + - errorlint + - exhaustive + - exhaustruct + - exptostd + - fatcontext + - forbidigo + - forcetypeassert + - funlen + - gci + - ginkgolinter + - gocheckcompilerdirectives + - gochecknoglobals + - gochecknoinits + - gochecksumtype + - gocognit + - goconst + - gocritic + - gocyclo + - godot + - godox + - gofmt + - gofumpt + - goheader + - goimports + - gomoddirectives + - gomodguard + - goprintffuncname + - gosec + - gosimple + - gosmopolitan + - govet + - grouper + - iface + - importas + - inamedparam + - ineffassign + - interfacebloat + - intrange + - ireturn + - lll + - loggercheck + - maintidx + - makezero + - mirror + - misspell + - mnd + - musttag + - nakedret + - nestif + - nilerr + - nilnesserr + - nilnil + - nlreturn + - noctx + - nolintlint + - nonamedreturns + - nosprintfhostport + - paralleltest + - perfsprint + - prealloc + - predeclared + - promlinter + - protogetter + - reassign + - recvcheck + - revive + - rowserrcheck + - sloglint + - spancheck + - sqlclosecheck + - staticcheck + - stylecheck + - tagalign + - tagliatelle + - testableexamples + - testifylint + - testpackage + - thelper + - tparallel + - unconvert + - unparam + - unused + - usestdlibvars + - usetesting + - varnamelen + - wastedassign + - whitespace + - wrapcheck + - wsl + - zerologlint + + # Enable all available linters. + # Default: false + enable-all: true + # Disable specific linter + # https://golangci-lint.run/usage/linters/#disabled-by-default + disable: + - asasalint + - asciicheck + - bidichk + - bodyclose + - canonicalheader + - containedctx + - contextcheck + - copyloopvar + - cyclop + - decorder + - depguard + - dogsled + - dupl + - dupword + - durationcheck + - err113 + - errcheck + - errchkjson + - errname + - errorlint + - exhaustive + - exhaustruct + - exptostd + - fatcontext + - forbidigo + - forcetypeassert + - funlen + - gci + - ginkgolinter + - gocheckcompilerdirectives + - gochecknoglobals + - gochecknoinits + - gochecksumtype + - gocognit + - goconst + - gocritic + - gocyclo + - godot + - godox + - gofmt + - gofumpt + - goheader + - goimports + - gomoddirectives + - gomodguard + - goprintffuncname + - gosec + - gosimple + - gosmopolitan + - govet + - grouper + - iface + - importas + - inamedparam + - ineffassign + - interfacebloat + - intrange + - ireturn + - lll + - loggercheck + - maintidx + - makezero + - mirror + - misspell + - mnd + - musttag + - nakedret + - nestif + - nilerr + - nilnesserr + - nilnil + - nlreturn + - noctx + - nolintlint + - nonamedreturns + - nosprintfhostport + - paralleltest + - perfsprint + - prealloc + - predeclared + - promlinter + - protogetter + - reassign + - recvcheck + - revive + - rowserrcheck + - sloglint + - spancheck + - sqlclosecheck + - staticcheck + - stylecheck + - tagalign + - tagliatelle + - testableexamples + - testifylint + - testpackage + - thelper + - tparallel + - unconvert + - unparam + - unused + - usestdlibvars + - usetesting + - varnamelen + - wastedassign + - whitespace + - wrapcheck + - wsl + - zerologlint + - deadcode # Deprecated + - execinquery # Deprecated + - exhaustivestruct # Deprecated + - exportloopref # Deprecated + - golint # Deprecated + - gomnd # Deprecated + - ifshort # Deprecated + - interfacer # Deprecated + - maligned # Deprecated + - nosnakecase # Deprecated + - scopelint # Deprecated + - structcheck # Deprecated + - tenv # Deprecated + - varcheck # Deprecated + + # Enable presets. + # https://golangci-lint.run/usage/linters + # Default: [] + presets: + - bugs + - comment + - complexity + - error + - format + - import + - metalinter + - module + - performance + - sql + - style + - test + - unused + + # Enable only fast linters from enabled linters set (first run won't be fast) + # Default: false + fast: true + + +# All available settings of specific linters. +linters-settings: + asasalint: + # To specify a set of function names to exclude. + # The values are merged with the builtin exclusions. + # The builtin exclusions can be disabled by setting `use-builtin-exclusions` to `false`. + # Default: ["^(fmt|log|logger|t|)\.(Print|Fprint|Sprint|Fatal|Panic|Error|Warn|Warning|Info|Debug|Log)(|f|ln)$"] + exclude: + - Append + - \.Wrapf + # To enable/disable the asasalint builtin exclusions of function names. + # See the default value of `exclude` to get the builtin exclusions. + # Default: true + use-builtin-exclusions: false + # Ignore *_test.go files. + # Default: false + ignore-test: true + + bidichk: + # The following configurations check for all mentioned invisible Unicode runes. + # All runes are enabled by default. + left-to-right-embedding: false + right-to-left-embedding: false + pop-directional-formatting: false + left-to-right-override: false + right-to-left-override: false + left-to-right-isolate: false + right-to-left-isolate: false + first-strong-isolate: false + pop-directional-isolate: false + + copyloopvar: + # Check all assigning the loop variable to another variable. + # Default: false + check-alias: true + + cyclop: + # The maximal code complexity to report. + # Default: 10 + max-complexity: 10 + # The maximal average package complexity. + # If it's higher than 0.0 (float) the check is enabled + # Default: 0.0 + package-average: 0.5 + # Should ignore tests. + # Default: false + skip-tests: true + + decorder: + # Required order of `type`, `const`, `var` and `func` declarations inside a file. + # Default: types before constants before variables before functions. + dec-order: + - type + - const + - var + - func + + # If true, underscore vars (vars with "_" as the name) will be ignored at all checks + # Default: false (underscore vars are not ignored) + ignore-underscore-vars: false + + # If true, order of declarations is not checked at all. + # Default: true (disabled) + disable-dec-order-check: false + + # If true, `init` func can be anywhere in file (does not have to be declared before all other functions). + # Default: true (disabled) + disable-init-func-first-check: false + + # If true, multiple global `type`, `const` and `var` declarations are allowed. + # Default: true (disabled) + disable-dec-num-check: false + + # If true, type declarations will be ignored for dec num check + # Default: false (type statements are not ignored) + disable-type-dec-num-check: false + + # If true, const declarations will be ignored for dec num check + # Default: false (const statements are not ignored) + disable-const-dec-num-check: false + + # If true, var declarations will be ignored for dec num check + # Default: false (var statements are not ignored) + disable-var-dec-num-check: false + + depguard: + # Rules to apply. + # + # Variables: + # - File Variables + # Use an exclamation mark `!` to negate a variable. + # Example: `!$test` matches any file that is not a go test file. + # + # `$all` - matches all go files + # `$test` - matches all go test files + # + # - Package Variables + # + # `$gostd` - matches all of go's standard library (Pulled from `GOROOT`) + # + # Default (applies if no custom rules are defined): Only allow $gostd in all files. + rules: + # Name of a rule. + main: + # Defines package matching behavior. Available modes: + # - `original`: allowed if it doesn't match the deny list and either matches the allow list or the allow list is empty. + # - `strict`: allowed only if it matches the allow list and either doesn't match the deny list or the allow rule is more specific (longer) than the deny rule. + # - `lax`: allowed if it doesn't match the deny list or the allow rule is more specific (longer) than the deny rule. + # Default: "original" + list-mode: lax + # List of file globs that will match this list of settings to compare against. + # Default: $all + files: + - "!**/*_a _file.go" + # List of allowed packages. + # Entries can be a variable (starting with $), a string prefix, or an exact match (if ending with $). + # Default: [] + allow: + - $gostd + - github.com/OpenPeeDeeP + # List of packages that are not allowed. + # Entries can be a variable (starting with $), a string prefix, or an exact match (if ending with $). + # Default: [] + deny: + - pkg: "math/rand$" + desc: use math/rand/v2 + - pkg: "github.com/sirupsen/logrus" + desc: not allowed + - pkg: "github.com/pkg/errors" + desc: Should be replaced by standard lib errors package + + dogsled: + # Checks assignments with too many blank identifiers. + # Default: 2 + max-blank-identifiers: 3 + + dupl: + # Tokens count to trigger issue. + # Default: 150 + threshold: 100 + + dupword: + # Keywords for detecting duplicate words. + # If this list is not empty, only the words defined in this list will be detected. + # Default: [] + keywords: + - "the" + - "and" + - "a" + # Keywords used to ignore detection. + # Default: [] + ignore: + - "0C0C" + + errcheck: + # Report about not checking of errors in type assertions: `a := b.(MyStruct)`. + # Such cases aren't reported by default. + # Default: false + check-type-assertions: true + + # report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`. + # Such cases aren't reported by default. + # Default: false + check-blank: true + + # To disable the errcheck built-in exclude list. + # See `-excludeonly` option in https://github.com/kisielk/errcheck#excluding-functions for details. + # Default: false + disable-default-exclusions: true + + # List of functions to exclude from checking, where each entry is a single function to exclude. + # See https://github.com/kisielk/errcheck#excluding-functions for details. + exclude-functions: + - io/ioutil.ReadFile + - io.Copy(*bytes.Buffer) + - io.Copy(os.Stdout) + + errchkjson: + # With check-error-free-encoding set to true, errchkjson does warn about errors + # from json encoding functions that are safe to be ignored, + # because they are not possible to happen. + # + # if check-error-free-encoding is set to true and errcheck linter is enabled, + # it is recommended to add the following exceptions to prevent from false positives: + # + # linters-settings: + # errcheck: + # exclude-functions: + # - encoding/json.Marshal + # - encoding/json.MarshalIndent + # + # Default: false + check-error-free-encoding: true + + # Issue on struct encoding that doesn't have exported fields. + # Default: false + report-no-exported: false + + errorlint: + # Check whether fmt.Errorf uses the %w verb for formatting errors. + # See the https://github.com/polyfloyd/go-errorlint for caveats. + # Default: true + errorf: false + # Permit more than 1 %w verb, valid per Go 1.20 (Requires errorf:true) + # Default: true + errorf-multi: false + # Check for plain type assertions and type switches. + # Default: true + asserts: false + # Check for plain error comparisons. + # Default: true + comparison: false + # Allowed errors. + # Default: [] + allowed-errors: + - err: "io.EOF" + fun: "example.com/pkg.Read" + # Allowed error "wildcards". + # Default: [] + allowed-errors-wildcard: + - err: "example.com/pkg.ErrMagic" + fun: "example.com/pkg.Magic" + + exhaustive: + # Program elements to check for exhaustiveness. + # Default: [ switch ] + check: + - switch + - map + # Check switch statements in generated files also. + # Default: false + check-generated: true + # Presence of "default" case in switch statements satisfies exhaustiveness, + # even if all enum members are not listed. + # Default: false + default-signifies-exhaustive: true + # Enum members matching the supplied regex do not have to be listed in + # switch statements to satisfy exhaustiveness. + # Default: "" + ignore-enum-members: "Example.+" + # Enum types matching the supplied regex do not have to be listed in + # switch statements to satisfy exhaustiveness. + # Default: "" + ignore-enum-types: "Example.+" + # Consider enums only in package scopes, not in inner scopes. + # Default: false + package-scope-only: true + # Only run exhaustive check on switches with "//exhaustive:enforce" comment. + # Default: false + explicit-exhaustive-switch: true + # Only run exhaustive check on map literals with "//exhaustive:enforce" comment. + # Default: false + explicit-exhaustive-map: true + # Switch statement requires default case even if exhaustive. + # Default: false + default-case-required: true + + exhaustruct: + # List of regular expressions to match struct packages and their names. + # Regular expressions must match complete canonical struct package/name/structname. + # If this list is empty, all structs are tested. + # Default: [] + include: + - '.+\.Test' + - 'example\.com/package\.ExampleStruct[\d]{1,2}' + # List of regular expressions to exclude struct packages and their names from checks. + # Regular expressions must match complete canonical struct package/name/structname. + # Default: [] + exclude: + - '.+/cobra\.Command$' + + fatcontext: + # Check for potential fat contexts in struct pointers. + # May generate false positives. + # Default: false + check-struct-pointers: true + + forbidigo: + # Forbid the following identifiers (list of regexp). + # Default: ["^(fmt\\.Print(|f|ln)|print|println)$"] + forbid: + # Built-in bootstrapping functions. + - ^print(ln)?$ + # Optional message that gets included in error reports. + - p: ^fmt\.Print.*$ + msg: Do not commit print statements. + # Alternatively, put messages at the end of the regex, surrounded by `(# )?` + # Escape any special characters. Those messages get included in error reports. + - 'fmt\.Print.*(# Do not commit print statements\.)?' + # Forbid spew Dump, whether it is called as function or method. + # Depends on analyze-types below. + - ^spew\.(ConfigState\.)?Dump$ + # The package name might be ambiguous. + # The full import path can be used as additional criteria. + # Depends on analyze-types below. + - p: ^v1.Dump$ + pkg: ^example.com/pkg/api/v1$ + # Exclude godoc examples from forbidigo checks. + # Default: true + exclude-godoc-examples: false + # Instead of matching the literal source code, + # use type information to replace expressions with strings that contain the package name + # and (for methods and fields) the type name. + # This makes it possible to handle import renaming and forbid struct fields and methods. + # Default: false + analyze-types: true + + funlen: + # Checks the number of lines in a function. + # If lower than 0, disable the check. + # Default: 60 + lines: -1 + # Checks the number of statements in a function. + # If lower than 0, disable the check. + # Default: 40 + statements: -1 + # Ignore comments when counting lines. + # Default false + ignore-comments: true + + gci: + # Section configuration to compare against. + # Section names are case-insensitive and may contain parameters in (). + # The default order of sections is `standard > default > custom > blank > dot > alias > localmodule`, + # If `custom-order` is `true`, it follows the order of `sections` option. + # Default: ["standard", "default"] + sections: + - standard # Standard section: captures all standard packages. + - default # Default section: contains all imports that could not be matched to another section type. + - prefix(github.com/org/project) # Custom section: groups all imports with the specified Prefix. + - blank # Blank section: contains all blank imports. This section is not present unless explicitly enabled. + - dot # Dot section: contains all dot imports. This section is not present unless explicitly enabled. + - alias # Alias section: contains all alias imports. This section is not present unless explicitly enabled. + - localmodule # Local module section: contains all local packages. This section is not present unless explicitly enabled. + + # Checks that no inline Comments are present. + # Default: false + no-inline-comments: true + + # Checks that no prefix Comments(comment lines above an import) are present. + # Default: false + no-prefix-comments: true + + # Skip generated files. + # Default: true + skip-generated: false + + # Enable custom order of sections. + # If `true`, make the section order the same as the order of `sections`. + # Default: false + custom-order: true + + # Drops lexical ordering for custom sections. + # Default: false + no-lex-order: true + + ginkgolinter: + # Suppress the wrong length assertion warning. + # Default: false + suppress-len-assertion: true + + # Suppress the wrong nil assertion warning. + # Default: false + suppress-nil-assertion: true + + # Suppress the wrong error assertion warning. + # Default: false + suppress-err-assertion: true + + # Suppress the wrong comparison assertion warning. + # Default: false + suppress-compare-assertion: true + + # Suppress the function all in async assertion warning. + # Default: false + suppress-async-assertion: true + + # Suppress warning for comparing values from different types, like `int32` and `uint32` + # Default: false + suppress-type-compare-assertion: true + + # Trigger warning for ginkgo focus containers like `FDescribe`, `FContext`, `FWhen` or `FIt` + # Default: false + forbid-focus-container: true + + # Don't trigger warnings for HaveLen(0) + # Default: false + allow-havelen-zero: true + + # Force using `Expect` with `To`, `ToNot` or `NotTo`. + # Reject using `Expect` with `Should` or `ShouldNot`. + # Default: false + force-expect-to: true + + # Best effort validation of async intervals (timeout and polling). + # Ignored the suppress-async-assertion is true. + # Default: false + validate-async-intervals: true + + # Trigger a warning for variable assignments in ginkgo containers like `Describe`, `Context` and `When`, instead of in `BeforeEach()`. + # Default: false + forbid-spec-pollution: true + + # Force using the Succeed matcher for error functions, and the HaveOccurred matcher for non-function error values. + # Default: false + force-succeed: true + + gochecksumtype: + # Presence of `default` case in switch statements satisfies exhaustiveness, if all members are not listed. + # Default: true + default-signifies-exhaustive: false + # Include shared interfaces in the exhaustiviness check. + # Default: false + include-shared-interfaces: true + + gocognit: + # Minimal code complexity to report. + # Default: 30 (but we recommend 10-20) + min-complexity: 10 + + goconst: + # Minimal length of string constant. + # Default: 3 + min-len: 2 + # Minimum occurrences of constant string count to trigger issue. + # Default: 3 + min-occurrences: 2 + # Ignore test files. + # Default: false + ignore-tests: true + # Look for existing constants matching the values. + # Default: true + match-constant: false + # Search also for duplicated numbers. + # Default: false + numbers: true + # Minimum value, only works with goconst.numbers + # Default: 3 + min: 2 + # Maximum value, only works with goconst.numbers + # Default: 3 + max: 2 + # Ignore when constant is not used as function argument. + # Default: true + ignore-calls: false + # Exclude strings matching the given regular expression. + # Default: "" + ignore-strings: 'foo.+' + + gocritic: + # Disable all checks. + # Default: false + disable-all: true + # Which checks should be enabled in addition to default checks; can't be combined with 'disabled-checks'. + # By default, list of stable checks is used (https://go-critic.com/overview#checks-overview): + # appendAssign, argOrder, assignOp, badCall, badCond, captLocal, caseOrder, codegenComment, commentFormatting, + # defaultCaseOrder, deprecatedComment, dupArg, dupBranchBody, dupCase, dupSubExpr, elseif, exitAfterDefer, + # flagDeref, flagName, ifElseChain, mapKey, newDeref, offBy1, regexpMust, singleCaseSwitch, sloppyLen, + # sloppyTypeAssert, switchTrue, typeSwitchVar, underef, unlambda, unslice, valSwap, wrapperFunc + # To see which checks are enabled run `GL_DEBUG=gocritic golangci-lint run --enable=gocritic`. + enabled-checks: + # Detects suspicious append result assignments. + # https://go-critic.com/overview.html#appendassign + - appendAssign + # Detects `append` chains to the same slice that can be done in a single `append` call. + # https://go-critic.com/overview.html#appendcombine + - appendCombine + # Detects suspicious arguments order. + # https://go-critic.com/overview.html#argorder + - argOrder + # Detects assignments that can be simplified by using assignment operators. + # https://go-critic.com/overview.html#assignop + - assignOp + # Detects suspicious function calls. + # https://go-critic.com/overview.html#badcall + - badCall + # Detects suspicious condition expressions. + # https://go-critic.com/overview.html#badcond + - badCond + # Detects suspicious mutex lock/unlock operations. + # https://go-critic.com/overview.html#badlock + - badLock + # Detects suspicious regexp patterns. + # https://go-critic.com/overview.html#badregexp + - badRegexp + # Detects bad usage of sort package. + # https://go-critic.com/overview.html#badsorting + - badSorting + # Detects bad usage of sync.OnceFunc. + # https://go-critic.com/overview.html#badsynconcefunc + - badSyncOnceFunc + # Detects bool expressions that can be simplified. + # https://go-critic.com/overview.html#boolexprsimplify + - boolExprSimplify + # Detects when predeclared identifiers are shadowed in assignments. + # https://go-critic.com/overview.html#builtinshadow + - builtinShadow + # Detects top-level declarations that shadow the predeclared identifiers. + # https://go-critic.com/overview.html#builtinshadowdecl + - builtinShadowDecl + # Detects capitalized names for local variables. + # https://go-critic.com/overview.html#captlocal + - captLocal + # Detects erroneous case order inside switch statements. + # https://go-critic.com/overview.html#caseorder + - caseOrder + # Detects malformed 'code generated' file comments. + # https://go-critic.com/overview.html#codegencomment + - codegenComment + # Detects comments with non-idiomatic formatting. + # https://go-critic.com/overview.html#commentformatting + - commentFormatting + # Detects commented-out code inside function bodies. + # https://go-critic.com/overview.html#commentedoutcode + - commentedOutCode + # Detects commented-out imports. + # https://go-critic.com/overview.html#commentedoutimport + - commentedOutImport + # Detects when default case in switch isn't on 1st or last position. + # https://go-critic.com/overview.html#defaultcaseorder + - defaultCaseOrder + # Detects loops inside functions that use defer. + # https://go-critic.com/overview.html#deferinloop + - deferInLoop + # Detects deferred function literals that can be simplified. + # https://go-critic.com/overview.html#deferunlambda + - deferUnlambda + # Detects malformed 'deprecated' doc-comments. + # https://go-critic.com/overview.html#deprecatedcomment + - deprecatedComment + # Detects comments that silence go lint complaints about doc-comment. + # https://go-critic.com/overview.html#docstub + - docStub + # Detects suspicious duplicated arguments. + # https://go-critic.com/overview.html#duparg + - dupArg + # Detects duplicated branch bodies inside conditional statements. + # https://go-critic.com/overview.html#dupbranchbody + - dupBranchBody + # Detects duplicated case clauses inside switch or select statements. + # https://go-critic.com/overview.html#dupcase + - dupCase + # Detects multiple imports of the same package under different aliases. + # https://go-critic.com/overview.html#dupimport + - dupImport + # Detects suspicious duplicated sub-expressions. + # https://go-critic.com/overview.html#dupsubexpr + - dupSubExpr + # Detects suspicious formatting strings usage. + # https://go-critic.com/overview.html#dynamicfmtstring + - dynamicFmtString + # Detects else with nested if statement that can be replaced with else-if. + # https://go-critic.com/overview.html#elseif + - elseif + # Detects suspicious empty declarations blocks. + # https://go-critic.com/overview.html#emptydecl + - emptyDecl + # Detects fallthrough that can be avoided by using multi case values. + # https://go-critic.com/overview.html#emptyfallthrough + - emptyFallthrough + # Detects empty string checks that can be written more idiomatically. + # https://go-critic.com/overview.html#emptystringtest + - emptyStringTest + # Detects unoptimal strings/bytes case-insensitive comparison. + # https://go-critic.com/overview.html#equalfold + - equalFold + # Detects unwanted dependencies on the evaluation order. + # https://go-critic.com/overview.html#evalorder + - evalOrder + # Detects calls to exit/fatal inside functions that use defer. + # https://go-critic.com/overview.html#exitafterdefer + - exitAfterDefer + # Detects exposed methods from sync.Mutex and sync.RWMutex. + # https://go-critic.com/overview.html#exposedsyncmutex + - exposedSyncMutex + # Detects suspicious reassignment of error from another package. + # https://go-critic.com/overview.html#externalerrorreassign + - externalErrorReassign + # Detects problems in filepath.Join() function calls. + # https://go-critic.com/overview.html#filepathjoin + - filepathJoin + # Detects immediate dereferencing of `flag` package pointers. + # https://go-critic.com/overview.html#flagderef + - flagDeref + # Detects suspicious flag names. + # https://go-critic.com/overview.html#flagname + - flagName + # Detects hex literals that have mixed case letter digits. + # https://go-critic.com/overview.html#hexliteral + - hexLiteral + # Detects nil usages in http.NewRequest calls, suggesting http.NoBody as an alternative. + # https://go-critic.com/overview.html#httpnobody + - httpNoBody + # Detects params that incur excessive amount of copying. + # https://go-critic.com/overview.html#hugeparam + - hugeParam + # Detects repeated if-else statements and suggests to replace them with switch statement. + # https://go-critic.com/overview.html#ifelsechain + - ifElseChain + # Detects when imported package names shadowed in the assignments. + # https://go-critic.com/overview.html#importshadow + - importShadow + # Detects strings.Index calls that may cause unwanted allocs. + # https://go-critic.com/overview.html#indexalloc + - indexAlloc + # Detects non-assignment statements inside if/switch init clause. + # https://go-critic.com/overview.html#initclause + - initClause + # Detects suspicious map literal keys. + # https://go-critic.com/overview.html#mapkey + - mapKey + # Detects method expression call that can be replaced with a method call. + # https://go-critic.com/overview.html#methodexprcall + - methodExprCall + # Finds where nesting level could be reduced. + # https://go-critic.com/overview.html#nestingreduce + - nestingReduce + # Detects immediate dereferencing of `new` expressions. + # https://go-critic.com/overview.html#newderef + - newDeref + # Detects return statements those results evaluate to nil. + # https://go-critic.com/overview.html#nilvalreturn + - nilValReturn + # Detects old-style octal literals. + # https://go-critic.com/overview.html#octalliteral + - octalLiteral + # Detects various off-by-one kind of errors. + # https://go-critic.com/overview.html#offby1 + - offBy1 + # Detects if function parameters could be combined by type and suggest the way to do it. + # https://go-critic.com/overview.html#paramtypecombine + - paramTypeCombine + # Detects expressions like []rune(s)[0] that may cause unwanted rune slice allocation. + # https://go-critic.com/overview.html#preferdecoderune + - preferDecodeRune + # Detects concatenation with os.PathSeparator which can be replaced with filepath.Join. + # https://go-critic.com/overview.html#preferfilepathjoin + - preferFilepathJoin + # Detects fmt.Sprint(f/ln) calls which can be replaced with fmt.Fprint(f/ln). + # https://go-critic.com/overview.html#preferfprint + - preferFprint + # Detects w.Write or io.WriteString calls which can be replaced with w.WriteString. + # https://go-critic.com/overview.html#preferstringwriter + - preferStringWriter + # Detects WriteRune calls with rune literal argument that is single byte and reports to use WriteByte instead. + # https://go-critic.com/overview.html#preferwritebyte + - preferWriteByte + # Detects input and output parameters that have a type of pointer to referential type. + # https://go-critic.com/overview.html#ptrtorefparam + - ptrToRefParam + # Detects append all its data while range it. + # https://go-critic.com/overview.html#rangeappendall + - rangeAppendAll + # Detects expensive copies of `for` loop range expressions. + # https://go-critic.com/overview.html#rangeexprcopy + - rangeExprCopy + # Detects loops that copy big objects during each iteration. + # https://go-critic.com/overview.html#rangevalcopy + - rangeValCopy + # Detects redundant fmt.Sprint calls. + # https://go-critic.com/overview.html#redundantsprint + - redundantSprint + # Detects `regexp.Compile*` that can be replaced with `regexp.MustCompile*`. + # https://go-critic.com/overview.html#regexpmust + - regexpMust + # Detects suspicious regexp patterns. + # https://go-critic.com/overview.html#regexppattern + - regexpPattern + # Detects regexp patterns that can be simplified. + # https://go-critic.com/overview.html#regexpsimplify + - regexpSimplify + # Detects suspicious http.Error call without following return. + # https://go-critic.com/overview.html#returnafterhttperror + - returnAfterHttpError + # Runs user-defined rules using ruleguard linter. + # https://go-critic.com/overview.html#ruleguard + - ruleguard + # Detects switch statements that could be better written as if statement. + # https://go-critic.com/overview.html#singlecaseswitch + - singleCaseSwitch + # Detects slice clear loops, suggests an idiom that is recognized by the Go compiler. + # https://go-critic.com/overview.html#sliceclear + - sliceClear + # Detects usage of `len` when result is obvious or doesn't make sense. + # https://go-critic.com/overview.html#sloppylen + - sloppyLen + # Detects suspicious/confusing re-assignments. + # https://go-critic.com/overview.html#sloppyreassign + - sloppyReassign + # Detects redundant type assertions. + # https://go-critic.com/overview.html#sloppytypeassert + - sloppyTypeAssert + # Detects suspicious sort.Slice calls. + # https://go-critic.com/overview.html#sortslice + - sortSlice + # Detects "%s" formatting directives that can be replaced with %q. + # https://go-critic.com/overview.html#sprintfquotedstring + - sprintfQuotedString + # Detects issue in Query() and Exec() calls. + # https://go-critic.com/overview.html#sqlquery + - sqlQuery + # Detects string concat operations that can be simplified. + # https://go-critic.com/overview.html#stringconcatsimplify + - stringConcatSimplify + # Detects redundant conversions between string and []byte. + # https://go-critic.com/overview.html#stringxbytes + - stringXbytes + # Detects strings.Compare usage. + # https://go-critic.com/overview.html#stringscompare + - stringsCompare + # Detects switch-over-bool statements that use explicit `true` tag value. + # https://go-critic.com/overview.html#switchtrue + - switchTrue + # Detects sync.Map load+delete operations that can be replaced with LoadAndDelete. + # https://go-critic.com/overview.html#syncmaploadanddelete + - syncMapLoadAndDelete + # Detects manual conversion to milli- or microseconds. + # https://go-critic.com/overview.html#timeexprsimplify + - timeExprSimplify + # Detects TODO comments without detail/assignee. + # https://go-critic.com/overview.html#todocommentwithoutdetail + - todoCommentWithoutDetail + # Detects function with too many results. + # https://go-critic.com/overview.html#toomanyresultschecker + - tooManyResultsChecker + # Detects potential truncation issues when comparing ints of different sizes. + # https://go-critic.com/overview.html#truncatecmp + - truncateCmp + # Detects repeated type assertions and suggests to replace them with type switch statement. + # https://go-critic.com/overview.html#typeassertchain + - typeAssertChain + # Detects method declarations preceding the type definition itself. + # https://go-critic.com/overview.html#typedeffirst + - typeDefFirst + # Detects type switches that can benefit from type guard clause with variable. + # https://go-critic.com/overview.html#typeswitchvar + - typeSwitchVar + # Detects unneeded parenthesis inside type expressions and suggests to remove them. + # https://go-critic.com/overview.html#typeunparen + - typeUnparen + # Detects unchecked errors in if statements. + # https://go-critic.com/overview.html#uncheckedinlineerr + - uncheckedInlineErr + # Detects dereference expressions that can be omitted. + # https://go-critic.com/overview.html#underef + - underef + # Detects redundant statement labels. + # https://go-critic.com/overview.html#unlabelstmt + - unlabelStmt + # Detects function literals that can be simplified. + # https://go-critic.com/overview.html#unlambda + - unlambda + # Detects unnamed results that may benefit from names. + # https://go-critic.com/overview.html#unnamedresult + - unnamedResult + # Detects unnecessary braced statement blocks. + # https://go-critic.com/overview.html#unnecessaryblock + - unnecessaryBlock + # Detects redundantly deferred calls. + # https://go-critic.com/overview.html#unnecessarydefer + - unnecessaryDefer + # Detects slice expressions that can be simplified to sliced expression itself. + # https://go-critic.com/overview.html#unslice + - unslice + # Detects value swapping code that are not using parallel assignment. + # https://go-critic.com/overview.html#valswap + - valSwap + # Detects conditions that are unsafe due to not being exhaustive. + # https://go-critic.com/overview.html#weakcond + - weakCond + # Ensures that `//nolint` comments include an explanation. + # https://go-critic.com/overview.html#whynolint + - whyNoLint + # Detects function calls that can be replaced with convenience wrappers. + # https://go-critic.com/overview.html#wrapperfunc + - wrapperFunc + # Detects Yoda style expressions and suggests to replace them. + # https://go-critic.com/overview.html#yodastyleexpr + - yodaStyleExpr + + # Enable all checks. + # Default: false + enable-all: true + # Which checks should be disabled; can't be combined with 'enabled-checks'. + # Default: [] + disabled-checks: + - appendAssign + - appendCombine + - argOrder + - assignOp + - badCall + - badCond + - badLock + - badRegexp + - badSorting + - badSyncOnceFunc + - boolExprSimplify + - builtinShadow + - builtinShadowDecl + - captLocal + - caseOrder + - codegenComment + - commentFormatting + - commentedOutCode + - commentedOutImport + - defaultCaseOrder + - deferInLoop + - deferUnlambda + - deprecatedComment + - docStub + - dupArg + - dupBranchBody + - dupCase + - dupImport + - dupSubExpr + - dynamicFmtString + - elseif + - emptyDecl + - emptyFallthrough + - emptyStringTest + - equalFold + - evalOrder + - exitAfterDefer + - exposedSyncMutex + - externalErrorReassign + - filepathJoin + - flagDeref + - flagName + - hexLiteral + - httpNoBody + - hugeParam + - ifElseChain + - importShadow + - indexAlloc + - initClause + - mapKey + - methodExprCall + - nestingReduce + - newDeref + - nilValReturn + - octalLiteral + - offBy1 + - paramTypeCombine + - preferDecodeRune + - preferFilepathJoin + - preferFprint + - preferStringWriter + - preferWriteByte + - ptrToRefParam + - rangeAppendAll + - rangeExprCopy + - rangeValCopy + - redundantSprint + - regexpMust + - regexpPattern + - regexpSimplify + - returnAfterHttpError + - ruleguard + - singleCaseSwitch + - sliceClear + - sloppyLen + - sloppyReassign + - sloppyTypeAssert + - sortSlice + - sprintfQuotedString + - sqlQuery + - stringConcatSimplify + - stringXbytes + - stringsCompare + - switchTrue + - syncMapLoadAndDelete + - timeExprSimplify + - todoCommentWithoutDetail + - tooManyResultsChecker + - truncateCmp + - typeAssertChain + - typeDefFirst + - typeSwitchVar + - typeUnparen + - uncheckedInlineErr + - underef + - unlabelStmt + - unlambda + - unnamedResult + - unnecessaryBlock + - unnecessaryDefer + - unslice + - valSwap + - weakCond + - whyNoLint + - wrapperFunc + - yodaStyleExpr + + # Enable multiple checks by tags in addition to default checks. + # Run `GL_DEBUG=gocritic golangci-lint run --enable=gocritic` to see all tags and checks. + # See https://github.com/go-critic/go-critic#usage -> section "Tags". + # Default: [] + enabled-tags: + - diagnostic + - style + - performance + - experimental + - opinionated + disabled-tags: + - diagnostic + - style + - performance + - experimental + - opinionated + + # Settings passed to gocritic. + # The settings key is the name of a supported gocritic checker. + # The list of supported checkers can be find in https://go-critic.com/overview. + settings: + # Must be valid enabled check name. + captLocal: + # Whether to restrict checker to params only. + # Default: true + paramsOnly: false + commentedOutCode: + # Min length of the comment that triggers a warning. + # Default: 15 + minLength: 50 + elseif: + # Whether to skip balanced if-else pairs. + # Default: true + skipBalanced: false + hugeParam: + # Size in bytes that makes the warning trigger. + # Default: 80 + sizeThreshold: 70 + ifElseChain: + # Min number of if-else blocks that makes the warning trigger. + # Default: 2 + minThreshold: 4 + nestingReduce: + # Min number of statements inside a branch to trigger a warning. + # Default: 5 + bodyWidth: 4 + rangeExprCopy: + # Size in bytes that makes the warning trigger. + # Default: 512 + sizeThreshold: 516 + # Whether to check test functions + # Default: true + skipTestFuncs: false + rangeValCopy: + # Size in bytes that makes the warning trigger. + # Default: 128 + sizeThreshold: 32 + # Whether to check test functions. + # Default: true + skipTestFuncs: false + ruleguard: + # Enable debug to identify which 'Where' condition was rejected. + # The value of the parameter is the name of a function in a ruleguard file. + # + # When a rule is evaluated: + # If: + # The Match() clause is accepted; and + # One of the conditions in the Where() clause is rejected, + # Then: + # ruleguard prints the specific Where() condition that was rejected. + # + # The option is passed to the ruleguard 'debug-group' argument. + # Default: "" + debug: 'emptyDecl' + # Determines the behavior when an error occurs while parsing ruleguard files. + # If flag is not set, log error and skip rule files that contain an error. + # If flag is set, the value must be a comma-separated list of error conditions. + # - 'all': fail on all errors. + # - 'import': ruleguard rule imports a package that cannot be found. + # - 'dsl': gorule file does not comply with the ruleguard DSL. + # Default: "" + failOn: dsl,import + # Comma-separated list of file paths containing ruleguard rules. + # If a path is relative, it is relative to the directory where the golangci-lint command is executed. + # The special '${configDir}' variable is substituted with the absolute directory containing the golangci-lint config file. + # Glob patterns such as 'rules-*.go' may be specified. + # Default: "" + rules: '${configDir}/ruleguard/rules-*.go,${configDir}/myrule1.go' + # Comma-separated list of enabled groups or skip empty to enable everything. + # Tags can be defined with # character prefix. + # Default: "" + enable: "myGroupName,#myTagName" + # Comma-separated list of disabled groups or skip empty to enable everything. + # Tags can be defined with # character prefix. + # Default: "" + disable: "myGroupName,#myTagName" + tooManyResultsChecker: + # Maximum number of results. + # Default: 5 + maxResults: 10 + truncateCmp: + # Whether to skip int/uint/uintptr types. + # Default: true + skipArchDependent: false + underef: + # Whether to skip (*x).method() calls where x is a pointer receiver. + # Default: true + skipRecvDeref: false + unnamedResult: + # Whether to check exported functions. + # Default: false + checkExported: true + + gocyclo: + # Minimal code complexity to report. + # Default: 30 (but we recommend 10-20) + min-complexity: 10 + + godot: + # Comments to be checked: `declarations`, `toplevel`, `noinline` or `all`. + # Default: declarations + scope: toplevel + # List of regexps for excluding particular comment lines from check. + # Default: [] + exclude: + # Exclude todo and fixme comments. + - "^fixme:" + - "^todo:" + # Check that each sentence ends with a period. + # Default: true + period: false + # Check that each sentence starts with a capital letter. + # Default: false + capital: true + + godox: + # Report any comments starting with keywords, this is useful for TODO or FIXME comments that + # might be left in the code accidentally and should be resolved before merging. + # Default: ["TODO", "BUG", "FIXME"] + keywords: + - NOTE + - OPTIMIZE # marks code that should be optimized before merging + - HACK # marks hack-around that should be removed before merging + + gofmt: + # Simplify code: gofmt with `-s` option. + # Default: true + simplify: false + # Apply the rewrite rules to the source before reformatting. + # https://pkg.go.dev/cmd/gofmt + # Default: [] + rewrite-rules: + - pattern: 'interface{}' + replacement: 'any' + - pattern: 'a[b:len(a)]' + replacement: 'a[b:]' + + gofumpt: + # Module path which contains the source code being formatted. + # Default: "" + module-path: github.com/org/project + + # Choose whether to use the extra rules. + # Default: false + extra-rules: true + + goheader: + # Supports two types 'const` and `regexp`. + # Values can be used recursively. + # Default: {} + values: + const: + # Define here const type values in format k:v. + # For example: + COMPANY: MY COMPANY + regexp: + # Define here regexp type values. + # for example: + AUTHOR: .*@mycompany\.com + # The template used for checking. + # Put here copyright header template for source code files + # Note: {{ YEAR }} is a builtin value that returns the year relative to the current machine time. + # Default: "" + template: |- + {{ AUTHOR }} {{ COMPANY }} {{ YEAR }} + SPDX-License-Identifier: Apache-2.0 + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at: + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + # As alternative of directive 'template', you may put the path to file with the template source. + # Useful if you need to load the template from a specific file. + # Default: "" + template-path: /path/to/my/template.tmpl + + goimports: + # A comma-separated list of prefixes, which, if set, checks import paths + # with the given prefixes are grouped after 3rd-party packages. + # Default: "" + local-prefixes: github.com/org/project + + gomoddirectives: + # Allow local `replace` directives. + # Default: false + replace-local: true + # List of allowed `replace` directives. + # Default: [] + replace-allow-list: + - launchpad.net/gocheck + # Allow to not explain why the version has been retracted in the `retract` directives. + # Default: false + retract-allow-no-explanation: true + # Forbid the use of the `exclude` directives. + # Default: false + exclude-forbidden: true + # Forbid the use of the `toolchain` directive. + # Default: false + toolchain-forbidden: true + # Defines a pattern to validate `toolchain` directive. + # Default: '' (no match) + toolchain-pattern: 'go1\.23\.\d+$' + # Forbid the use of the `tool` directives. + # Default: false + tool-forbidden: true + # Forbid the use of the `godebug` directive. + # Default: false + go-debug-forbidden: true + # Defines a pattern to validate `go` minimum version directive. + # Default: '' (no match) + go-version-pattern: '\d\.\d+(\.0)?' + + gomodguard: + allowed: + # List of allowed modules. + # Default: [] + modules: + - gopkg.in/yaml.v2 + # List of allowed module domains. + # Default: [] + domains: + - golang.org + blocked: + # List of blocked modules. + # Default: [] + modules: + # Blocked module. + - github.com/uudashr/go-module: + # Recommended modules that should be used instead. (Optional) + recommendations: + - golang.org/x/mod + # Reason why the recommended module should be used. (Optional) + reason: "`mod` is the official go.mod parser library." + # List of blocked module version constraints. + # Default: [] + versions: + # Blocked module with version constraint. + - github.com/mitchellh/go-homedir: + # Version constraint, see https://github.com/Masterminds/semver#basic-comparisons. + version: "< 1.1.0" + # Reason why the version constraint exists. (Optional) + reason: "testing if blocked version constraint works." + # Set to true to raise lint issues for packages that are loaded from a local path via replace directive. + # Default: false + local_replace_directives: false + + gosimple: + # Sxxxx checks in https://staticcheck.dev/docs/configuration/options/#checks + # Default: ["*"] + checks: + # Use plain channel send or receive instead of single-case select. + # https://staticcheck.dev/docs/checks/#S1000 + - S1000 + # Replace for loop with call to copy. + # https://staticcheck.dev/docs/checks/#S1001 + - S1001 + # Omit comparison with boolean constant. + # https://staticcheck.dev/docs/checks/#S1002 + - S1002 + # Replace call to 'strings.Index' with 'strings.Contains'. + # https://staticcheck.dev/docs/checks/#S1003 + - S1003 + # Replace call to 'bytes.Compare' with 'bytes.Equal'. + # https://staticcheck.dev/docs/checks/#S1004 + - S1004 + # Drop unnecessary use of the blank identifier. + # https://staticcheck.dev/docs/checks/#S1005 + - S1005 + # Use "for { ... }" for infinite loops. + # https://staticcheck.dev/docs/checks/#S1006 + - S1006 + # Simplify regular expression by using raw string literal. + # https://staticcheck.dev/docs/checks/#S1007 + - S1007 + # Simplify returning boolean expression. + # https://staticcheck.dev/docs/checks/#S1008 + - S1008 + # Omit redundant nil check on slices, maps, and channels. + # https://staticcheck.dev/docs/checks/#S1009 + - S1009 + # Omit default slice index. + # https://staticcheck.dev/docs/checks/#S1010 + - S1010 + # Use a single 'append' to concatenate two slices. + # https://staticcheck.dev/docs/checks/#S1011 + - S1011 + # Replace 'time.Now().Sub(x)' with 'time.Since(x)'. + # https://staticcheck.dev/docs/checks/#S1012 + - S1012 + # Use a type conversion instead of manually copying struct fields. + # https://staticcheck.dev/docs/checks/#S1016 + - S1016 + # Replace manual trimming with 'strings.TrimPrefix'. + # https://staticcheck.dev/docs/checks/#S1017 + - S1017 + # Use "copy" for sliding elements. + # https://staticcheck.dev/docs/checks/#S1018 + - S1018 + # Simplify "make" call by omitting redundant arguments. + # https://staticcheck.dev/docs/checks/#S1019 + - S1019 + # Omit redundant nil check in type assertion. + # https://staticcheck.dev/docs/checks/#S1020 + - S1020 + # Merge variable declaration and assignment. + # https://staticcheck.dev/docs/checks/#S1021 + - S1021 + # Omit redundant control flow. + # https://staticcheck.dev/docs/checks/#S1023 + - S1023 + # Replace 'x.Sub(time.Now())' with 'time.Until(x)'. + # https://staticcheck.dev/docs/checks/#S1024 + - S1024 + # Don't use 'fmt.Sprintf("%s", x)' unnecessarily. + # https://staticcheck.dev/docs/checks/#S1025 + - S1025 + # Simplify error construction with 'fmt.Errorf'. + # https://staticcheck.dev/docs/checks/#S1028 + - S1028 + # Range over the string directly. + # https://staticcheck.dev/docs/checks/#S1029 + - S1029 + # Use 'bytes.Buffer.String' or 'bytes.Buffer.Bytes'. + # https://staticcheck.dev/docs/checks/#S1030 + - S1030 + # Omit redundant nil check around loop. + # https://staticcheck.dev/docs/checks/#S1031 + - S1031 + # Use 'sort.Ints(x)', 'sort.Float64s(x)', and 'sort.Strings(x)'. + # https://staticcheck.dev/docs/checks/#S1032 + - S1032 + # Unnecessary guard around call to "delete". + # https://staticcheck.dev/docs/checks/#S1033 + - S1033 + # Use result of type assertion to simplify cases. + # https://staticcheck.dev/docs/checks/#S1034 + - S1034 + # Redundant call to 'net/http.CanonicalHeaderKey' in method call on 'net/http.Header'. + # https://staticcheck.dev/docs/checks/#S1035 + - S1035 + # Unnecessary guard around map access. + # https://staticcheck.dev/docs/checks/#S1036 + - S1036 + # Elaborate way of sleeping. + # https://staticcheck.dev/docs/checks/#S1037 + - S1037 + # Unnecessarily complex way of printing formatted string. + # https://staticcheck.dev/docs/checks/#S1038 + - S1038 + # Unnecessary use of 'fmt.Sprint'. + # https://staticcheck.dev/docs/checks/#S1039 + - S1039 + # Type assertion to current type. + # https://staticcheck.dev/docs/checks/#S1040 + - S1040 + + gosec: + # To select a subset of rules to run. + # Available rules: https://github.com/securego/gosec#available-rules + # Default: [] - means include all rules + includes: + - G101 # Look for hard coded credentials + - G102 # Bind to all interfaces + - G103 # Audit the use of unsafe block + - G104 # Audit errors not checked + - G106 # Audit the use of ssh.InsecureIgnoreHostKey + - G107 # Url provided to HTTP request as taint input + - G108 # Profiling endpoint automatically exposed on /debug/pprof + - G109 # Potential Integer overflow made by strconv.Atoi result conversion to int16/32 + - G110 # Potential DoS vulnerability via decompression bomb + - G111 # Potential directory traversal + - G112 # Potential slowloris attack + - G113 # Usage of Rat.SetString in math/big with an overflow (CVE-2022-23772) + - G114 # Use of net/http serve function that has no support for setting timeouts + - G115 # Potential integer overflow when converting between integer types + - G201 # SQL query construction using format string + - G202 # SQL query construction using string concatenation + - G203 # Use of unescaped data in HTML templates + - G204 # Audit use of command execution + - G301 # Poor file permissions used when creating a directory + - G302 # Poor file permissions used with chmod + - G303 # Creating tempfile using a predictable path + - G304 # File path provided as taint input + - G305 # File traversal when extracting zip/tar archive + - G306 # Poor file permissions used when writing to a new file + - G307 # Poor file permissions used when creating a file with os.Create + - G401 # Detect the usage of MD5 or SHA1 + - G402 # Look for bad TLS connection settings + - G403 # Ensure minimum RSA key length of 2048 bits + - G404 # Insecure random number source (rand) + - G405 # Detect the usage of DES or RC4 + - G406 # Detect the usage of MD4 or RIPEMD160 + - G501 # Import blocklist: crypto/md5 + - G502 # Import blocklist: crypto/des + - G503 # Import blocklist: crypto/rc4 + - G504 # Import blocklist: net/http/cgi + - G505 # Import blocklist: crypto/sha1 + - G506 # Import blocklist: golang.org/x/crypto/md4 + - G507 #Import blocklist: golang.org/x/crypto/ripemd160 + - G601 # Implicit memory aliasing of items from a range statement + - G602 # Slice access out of bounds + + # To specify a set of rules to explicitly exclude. + # Available rules: https://github.com/securego/gosec#available-rules + # Default: [] + excludes: + - G101 # Look for hard coded credentials + - G102 # Bind to all interfaces + - G103 # Audit the use of unsafe block + - G104 # Audit errors not checked + - G106 # Audit the use of ssh.InsecureIgnoreHostKey + - G107 # Url provided to HTTP request as taint input + - G108 # Profiling endpoint automatically exposed on /debug/pprof + - G109 # Potential Integer overflow made by strconv.Atoi result conversion to int16/32 + - G110 # Potential DoS vulnerability via decompression bomb + - G111 # Potential directory traversal + - G112 # Potential slowloris attack + - G113 # Usage of Rat.SetString in math/big with an overflow (CVE-2022-23772) + - G114 # Use of net/http serve function that has no support for setting timeouts + - G115 # Potential integer overflow when converting between integer types + - G201 # SQL query construction using format string + - G202 # SQL query construction using string concatenation + - G203 # Use of unescaped data in HTML templates + - G204 # Audit use of command execution + - G301 # Poor file permissions used when creating a directory + - G302 # Poor file permissions used with chmod + - G303 # Creating tempfile using a predictable path + - G304 # File path provided as taint input + - G305 # File traversal when extracting zip/tar archive + - G306 # Poor file permissions used when writing to a new file + - G307 # Poor file permissions used when creating a file with os.Create + - G401 # Detect the usage of MD5 or SHA1 + - G402 # Look for bad TLS connection settings + - G403 # Ensure minimum RSA key length of 2048 bits + - G404 # Insecure random number source (rand) + - G405 # Detect the usage of DES or RC4 + - G406 # Detect the usage of MD4 or RIPEMD160 + - G501 # Import blocklist: crypto/md5 + - G502 # Import blocklist: crypto/des + - G503 # Import blocklist: crypto/rc4 + - G504 # Import blocklist: net/http/cgi + - G505 # Import blocklist: crypto/sha1 + - G506 # Import blocklist: golang.org/x/crypto/md4 + - G507 #Import blocklist: golang.org/x/crypto/ripemd160 + - G601 # Implicit memory aliasing of items from a range statement + - G602 # Slice access out of bounds + + # Exclude generated files + # Default: false + exclude-generated: true + + # Filter out the issues with a lower severity than the given value. + # Valid options are: low, medium, high. + # Default: low + severity: medium + + # Filter out the issues with a lower confidence than the given value. + # Valid options are: low, medium, high. + # Default: low + confidence: medium + + # Concurrency value. + # Default: the number of logical CPUs usable by the current process. + concurrency: 12 + + # To specify the configuration of rules. + config: + # Globals are applicable to all rules. + global: + # If true, ignore #nosec in comments (and an alternative as well). + # Default: false + nosec: true + # Add an alternative comment prefix to #nosec (both will work at the same time). + # Default: "" + "#nosec": "#my-custom-nosec" + # Define whether nosec issues are counted as finding or not. + # Default: false + show-ignored: true + # Audit mode enables addition checks that for normal code analysis might be too nosy. + # Default: false + audit: true + G101: + # Regexp pattern for variables and constants to find. + # Default: "(?i)passwd|pass|password|pwd|secret|token|pw|apiKey|bearer|cred" + pattern: "(?i)example" + # If true, complain about all cases (even with low entropy). + # Default: false + ignore_entropy: false + # Maximum allowed entropy of the string. + # Default: "80.0" + entropy_threshold: "80.0" + # Maximum allowed value of entropy/string length. + # Is taken into account if entropy >= entropy_threshold/2. + # Default: "3.0" + per_char_threshold: "3.0" + # Calculate entropy for first N chars of the string. + # Default: "16" + truncate: "32" + # Additional functions to ignore while checking unhandled errors. + # Following functions always ignored: + # bytes.Buffer: + # - Write + # - WriteByte + # - WriteRune + # - WriteString + # fmt: + # - Print + # - Printf + # - Println + # - Fprint + # - Fprintf + # - Fprintln + # strings.Builder: + # - Write + # - WriteByte + # - WriteRune + # - WriteString + # io.PipeWriter: + # - CloseWithError + # hash.Hash: + # - Write + # os: + # - Unsetenv + # Default: {} + G104: + fmt: + - Fscanf + G111: + # Regexp pattern to find potential directory traversal. + # Default: "http\\.Dir\\(\"\\/\"\\)|http\\.Dir\\('\\/'\\)" + pattern: "custom\\.Dir\\(\\)" + # Maximum allowed permissions mode for os.Mkdir and os.MkdirAll + # Default: "0750" + G301: "0750" + # Maximum allowed permissions mode for os.OpenFile and os.Chmod + # Default: "0600" + G302: "0600" + # Maximum allowed permissions mode for os.WriteFile and ioutil.WriteFile + # Default: "0600" + G306: "0600" + + gosmopolitan: + # Allow and ignore `time.Local` usages. + # + # Default: false + allow-time-local: true + # List of fully qualified names in the `full/pkg/path.name` form, to act as "i18n escape hatches". + # String literals inside call-like expressions to, or struct literals of those names, + # are exempt from the writing system check. + # + # Default: [] + escape-hatches: + - 'github.com/nicksnyder/go-i18n/v2/i18n.Message' + - 'example.com/your/project/i18n/markers.Raw' + - 'example.com/your/project/i18n/markers.OK' + - 'example.com/your/project/i18n/markers.TODO' + - 'command-line-arguments.Simple' + # Ignore test files. + # + # Default: true + ignore-tests: false + # List of Unicode scripts to watch for any usage in string literals. + # https://pkg.go.dev/unicode#pkg-variables + # + # Default: ["Han"] + watch-for-scripts: + - Devanagari + - Han + - Hangul + - Hiragana + - Katakana + + govet: + # Disable all analyzers. + # Default: false + disable-all: true + # Enable analyzers by name. + # (in addition to default: + # appends, asmdecl, assign, atomic, bools, buildtag, cgocall, composites, copylocks, defers, directive, errorsas, + # framepointer, httpresponse, ifaceassert, loopclosure, lostcancel, nilfunc, printf, shift, sigchanyzer, slog, + # stdmethods, stringintconv, structtag, testinggoroutine, tests, timeformat, unmarshal, unreachable, unsafeptr, + # unusedresult + # ). + # Run `GL_DEBUG=govet golangci-lint run --enable=govet` to see default, all available analyzers, and enabled analyzers. + # Default: [] + enable: + # Check for missing values after append. + - appends + # Report mismatches between assembly files and Go declarations. + - asmdecl + # Check for useless assignments. + - assign + # Check for common mistakes using the sync/atomic package. + - atomic + # Check for non-64-bits-aligned arguments to sync/atomic functions. + - atomicalign + # Check for common mistakes involving boolean operators. + - bools + # Check //go:build and // +build directives. + - buildtag + # Detect some violations of the cgo pointer passing rules. + - cgocall + # Check for unkeyed composite literals. + - composites + # Check for locks erroneously passed by value. + - copylocks + # Check for calls of reflect.DeepEqual on error values. + - deepequalerrors + # Report common mistakes in defer statements. + - defers + # Check Go toolchain directives such as //go:debug. + - directive + # Report passing non-pointer or non-error values to errors.As. + - errorsas + # Find structs that would use less memory if their fields were sorted. + - fieldalignment + # Find calls to a particular function. + - findcall + # Report assembly that clobbers the frame pointer before saving it. + - framepointer + # Check for mistakes using HTTP responses. + - httpresponse + # Detect impossible interface-to-interface type assertions. + - ifaceassert + # Check references to loop variables from within nested functions. + - loopclosure + # Check cancel func returned by context.WithCancel is called. + - lostcancel + # Check for useless comparisons between functions and nil. + - nilfunc + # Check for redundant or impossible nil comparisons. + - nilness + # Check consistency of Printf format strings and arguments. + - printf + # Check for comparing reflect.Value values with == or reflect.DeepEqual. + - reflectvaluecompare + # Check for possible unintended shadowing of variables. + - shadow + # Check for shifts that equal or exceed the width of the integer. + - shift + # Check for unbuffered channel of os.Signal. + - sigchanyzer + # Check for invalid structured logging calls. + - slog + # Check the argument type of sort.Slice. + - sortslice + # Check signature of methods of well-known interfaces. + - stdmethods + # Report uses of too-new standard library symbols. + - stdversion + # Check for string(int) conversions. + - stringintconv + # Check that struct field tags conform to reflect.StructTag.Get. + - structtag + # Report calls to (*testing.T).Fatal from goroutines started by a test. + - testinggoroutine + # Check for common mistaken usages of tests and examples. + - tests + # Check for calls of (time.Time).Format or time.Parse with 2006-02-01. + - timeformat + # Report passing non-pointer or non-interface values to unmarshal. + - unmarshal + # Check for unreachable code. + - unreachable + # Check for invalid conversions of uintptr to unsafe.Pointer. + - unsafeptr + # Check for unused results of calls to some functions. + - unusedresult + # Checks for unused writes. + - unusedwrite + # Check for misuses of sync.WaitGroup. + - waitgroup + + # Enable all analyzers. + # Default: false + enable-all: true + # Disable analyzers by name. + # (in addition to default + # atomicalign, deepequalerrors, fieldalignment, findcall, nilness, reflectvaluecompare, shadow, sortslice, + # timeformat, unusedwrite + # ). + # Run `GL_DEBUG=govet golangci-lint run --enable=govet` to see default, all available analyzers, and enabled analyzers. + # Default: [] + disable: + - appends + - asmdecl + - assign + - atomic + - atomicalign + - bools + - buildtag + - cgocall + - composites + - copylocks + - deepequalerrors + - defers + - directive + - errorsas + - fieldalignment + - findcall + - framepointer + - httpresponse + - ifaceassert + - loopclosure + - lostcancel + - nilfunc + - nilness + - printf + - reflectvaluecompare + - shadow + - shift + - sigchanyzer + - slog + - sortslice + - stdmethods + - stdversion + - stringintconv + - structtag + - testinggoroutine + - tests + - timeformat + - unmarshal + - unreachable + - unsafeptr + - unusedresult + - unusedwrite + - waitgroup + + # Settings per analyzer. + settings: + # Analyzer name, run `go tool vet help` to see all analyzers. + printf: + # Comma-separated list of print function names to check (in addition to default, see `go tool vet help printf`). + # Default: [] + funcs: + - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof + - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf + - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf + - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf + shadow: + # Whether to be strict about shadowing; can be noisy. + # Default: false + strict: true + unusedresult: + # Comma-separated list of functions whose results must be used + # (in addition to default: + # context.WithCancel, context.WithDeadline, context.WithTimeout, context.WithValue, errors.New, fmt.Errorf, + # fmt.Sprint, fmt.Sprintf, sort.Reverse + # ). + # Default: [] + funcs: + - pkg.MyFunc + # Comma-separated list of names of methods of type func() string whose results must be used + # (in addition to default Error,String) + # Default: [] + stringmethods: + - MyMethod + + grouper: + # Require the use of a single global 'const' declaration only. + # Default: false + const-require-single-const: true + # Require the use of grouped global 'const' declarations. + # Default: false + const-require-grouping: true + + # Require the use of a single 'import' declaration only. + # Default: false + import-require-single-import: true + # Require the use of grouped 'import' declarations. + # Default: false + import-require-grouping: true + + # Require the use of a single global 'type' declaration only. + # Default: false + type-require-single-type: true + # Require the use of grouped global 'type' declarations. + # Default: false + type-require-grouping: true + + # Require the use of a single global 'var' declaration only. + # Default: false + var-require-single-var: true + # Require the use of grouped global 'var' declarations. + # Default: false + var-require-grouping: true + + iface: + # List of analyzers. + # Default: ["identical"] + enable: + - identical # Identifies interfaces in the same package that have identical method sets. + - unused # Identifies interfaces that are not used anywhere in the same package where the interface is defined. + - opaque # Identifies functions that return interfaces, but the actual returned value is always a single concrete implementation. + settings: + unused: + # List of packages path to exclude from the check. + # Default: [] + exclude: + - github.com/example/log + + importas: + # Do not allow unaliased imports of aliased packages. + # Default: false + no-unaliased: true + # Do not allow non-required aliases. + # Default: false + no-extra-aliases: true + # List of aliases + # Default: [] + alias: + # Using `servingv1` alias for `knative.dev/serving/pkg/apis/serving/v1` package. + - pkg: knative.dev/serving/pkg/apis/serving/v1 + alias: servingv1 + # Using `autoscalingv1alpha1` alias for `knative.dev/serving/pkg/apis/autoscaling/v1alpha1` package. + - pkg: knative.dev/serving/pkg/apis/autoscaling/v1alpha1 + alias: autoscalingv1alpha1 + # You can specify the package path by regular expression, + # and alias by regular expression expansion syntax like below. + # see https://github.com/julz/importas#use-regular-expression for details + - pkg: knative.dev/serving/pkg/apis/(\w+)/(v[\w\d]+) + alias: $1$2 + # An explicit empty alias can be used to ensure no aliases are used for a package. + # This can be useful if `no-extra-aliases: true` doesn't fit your need. + # Multiple packages can use an empty alias. + - pkg: errors + alias: "" + + inamedparam: + # Skips check for interface methods with only a single parameter. + # Default: false + skip-single-param: true + + interfacebloat: + # The maximum number of methods allowed for an interface. + # Default: 10 + max: 5 + + ireturn: + # List of interfaces to allow. + # Lists of the keywords and regular expressions matched to interface or package names can be used. + # `allow` and `reject` settings cannot be used at the same time. + # + # Keywords: + # - `empty` for `interface{}` + # - `error` for errors + # - `stdlib` for standard library + # - `anon` for anonymous interfaces + # - `generic` for generic interfaces added in go 1.18 + # + # Default: [anon, error, empty, stdlib] + allow: + - anon + # You can specify idiomatic endings for interface + - (or|er)$ + + # List of interfaces to reject. + # Lists of the keywords and regular expressions matched to interface or package names can be used. + # `allow` and `reject` settings cannot be used at the same time. + # + # Keywords: + # - `empty` for `interface{}` + # - `error` for errors + # - `stdlib` for standard library + # - `anon` for anonymous interfaces + # - `generic` for generic interfaces added in go 1.18 + # + # Default: [] + reject: + - github.com\/user\/package\/v4\.Type + + lll: + # Max line length, lines longer will be reported. + # '\t' is counted as 1 character by default, and can be changed with the tab-width option. + # Default: 120. + line-length: 120 + # Tab width in spaces. + # Default: 1 + tab-width: 1 + + loggercheck: + # Allow check for the github.com/go-kit/log library. + # Default: true + kitlog: false + # Allow check for the k8s.io/klog/v2 library. + # Default: true + klog: false + # Allow check for the github.com/go-logr/logr library. + # Default: true + logr: false + # Allow check for the log/slog library. + # Default: true + slog: false + # Allow check for the "sugar logger" from go.uber.org/zap library. + # Default: true + zap: false + # Require all logging keys to be inlined constant strings. + # Default: false + require-string-key: true + # Require printf-like format specifier (%s, %d for example) not present. + # Default: false + no-printf-like: true + # List of custom rules to check against, where each rule is a single logger pattern, useful for wrapped loggers. + # For example: https://github.com/timonwong/loggercheck/blob/7395ab86595781e33f7afba27ad7b55e6956ebcd/testdata/custom-rules.txt + # Default: empty + rules: + - k8s.io/klog/v2.InfoS # package level exported functions + - (github.com/go-logr/logr.Logger).Error # "Methods" + - (*go.uber.org/zap.SugaredLogger).With # Also "Methods", but with a pointer receiver + + maintidx: + # Show functions with maintainability index lower than N. + # A high index indicates better maintainability (it's kind of the opposite of complexity). + # Default: 20 + under: 100 + + makezero: + # Allow only slices initialized with a length of zero. + # Default: false + always: true + + misspell: + # Correct spellings using locale preferences for US or UK. + # Setting locale to US will correct the British spelling of 'colour' to 'color'. + # Default is to use a neutral variety of English. + locale: US + # Typos to ignore. + # Should be in lower case. + # Default: [] + ignore-words: + - someword + # Extra word corrections. + # `typo` and `correction` should only contain letters. + # The words are case-insensitive. + # Default: [] + extra-words: + - typo: "iff" + correction: "if" + - typo: "cancelation" + correction: "cancellation" + # Mode of the analysis: + # - default: checks all the file content. + # - restricted: checks only comments. + # Default: "" + mode: restricted + + mnd: + # List of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description. + # Default: ["argument", "case", "condition", "operation", "return", "assign"] + checks: + - argument + - case + - condition + - operation + - return + - assign + # List of numbers to exclude from analysis. + # The numbers should be written as string. + # Values always ignored: "1", "1.0", "0" and "0.0" + # Default: [] + ignored-numbers: + - '0666' + - '0755' + - '42' + # List of file patterns to exclude from analysis. + # Values always ignored: `.+_test.go` + # Default: [] + ignored-files: + - 'magic1_.+\.go$' + # List of function patterns to exclude from analysis. + # Following functions are always ignored: `time.Date`, + # `strconv.FormatInt`, `strconv.FormatUint`, `strconv.FormatFloat`, + # `strconv.ParseInt`, `strconv.ParseUint`, `strconv.ParseFloat`. + # Default: [] + ignored-functions: + - '^math\.' + - '^http\.StatusText$' + + musttag: + # A set of custom functions to check in addition to the builtin ones. + # Default: json, xml, gopkg.in/yaml.v3, BurntSushi/toml, mitchellh/mapstructure, jmoiron/sqlx + functions: + # The full name of the function, including the package. + - name: github.com/hashicorp/hcl/v2/hclsimple.DecodeFile + # The struct tag whose presence should be ensured. + tag: hcl + # The position of the argument to check. + arg-pos: 2 + + nakedret: + # Make an issue if func has more lines of code than this setting, and it has naked returns. + # Default: 30 + max-func-lines: 31 + + nestif: + # Minimal complexity of if statements to report. + # Default: 5 + min-complexity: 4 + + nilnil: + # In addition, detect opposite situation (simultaneous return of non-nil error and valid value). + # Default: false + detect-opposite: true + # List of return types to check. + # Default: ["chan", "func", "iface", "map", "ptr", "uintptr", "unsafeptr"] + checked-types: + - chan + - func + - iface + - map + - ptr + - uintptr + - unsafeptr + + nlreturn: + # Size of the block (including return statement that is still "OK") + # so no return split required. + # Default: 1 + block-size: 2 + + nolintlint: + # Disable to ensure that all nolint directives actually have an effect. + # Default: false + allow-unused: true + # Exclude following linters from requiring an explanation. + # Default: [] + allow-no-explanation: [ ] + # Enable to require an explanation of nonzero length after each nolint directive. + # Default: false + require-explanation: true + # Enable to require nolint directives to mention the specific linter being suppressed. + # Default: false + require-specific: true + + nonamedreturns: + # Report named error if it is assigned inside defer. + # Default: false + report-error-in-defer: true + + paralleltest: + # Ignore missing calls to `t.Parallel()` and only report incorrect uses of it. + # Default: false + ignore-missing: true + # Ignore missing calls to `t.Parallel()` in subtests. Top-level tests are + # still required to have `t.Parallel`, but subtests are allowed to skip it. + # Default: false + ignore-missing-subtests: true + perfsprint: + # Enable/disable optimization of integer formatting. + # Default: true + integer-format: false + # Optimizes even if it requires an int or uint type cast. + # Default: true + int-conversion: false + # Enable/disable optimization of error formatting. + # Default: true + error-format: false + # Optimizes into `err.Error()` even if it is only equivalent for non-nil errors. + # Default: false + err-error: true + # Optimizes `fmt.Errorf`. + # Default: true + errorf: false + # Enable/disable optimization of string formatting. + # Default: true + string-format: false + # Optimizes `fmt.Sprintf` with only one argument. + # Default: true + sprintf1: false + # Optimizes into strings concatenation. + # Default: true + strconcat: false + # Enable/disable optimization of bool formatting. + # Default: true + bool-format: false + # Enable/disable optimization of hex formatting. + # Default: true + hex-format: false + + prealloc: + # IMPORTANT: we don't recommend using this linter before doing performance profiling. + # For most programs usage of prealloc will be a premature optimization. + + # Report pre-allocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them. + # Default: true + simple: false + # Report pre-allocation suggestions on range loops. + # Default: true + range-loops: false + # Report pre-allocation suggestions on for loops. + # Default: false + for-loops: true + + predeclared: + # Comma-separated list of predeclared identifiers to not report on. + # Default: "" + ignore: "new,int" + # Include method names and field names (i.e., qualified names) in checks. + # Default: false + q: true + + promlinter: + # Promlinter cannot infer all metrics name in static analysis. + # Enable strict mode will also include the errors caused by failing to parse the args. + # Default: false + strict: true + # Please refer to https://github.com/yeya24/promlinter#usage for detailed usage. + # Default: [] + disabled-linters: + # Help detects issues related to the help text for a metric. + - Help + # MetricUnits detects issues with metric unit names. + - MetricUnits + # Counter detects issues specific to counters, as well as patterns that should only be used with counters. + - Counter + # HistogramSummaryReserved detects when other types of metrics use names or labels reserved for use by histograms and/or summaries. + - HistogramSummaryReserved + # MetricTypeInName detects when metric types are included in the metric name. + - MetricTypeInName + # ReservedChars detects colons in metric names. + - ReservedChars + # CamelCase detects metric names and label names written in camelCase. + - CamelCase + # UnitAbbreviations detects abbreviated units in the metric name. + - UnitAbbreviations + + + protogetter: + # Skip files generated by specified generators from the checking. + # Checks only the file's initial comment, which must follow the format: "// Code generated by ". + # Files generated by protoc-gen-go, protoc-gen-go-grpc, and protoc-gen-grpc-gateway are always excluded automatically. + # Default: [] + skip-generated-by: ["protoc-gen-go-my-own-generator"] + # Skip files matching the specified glob pattern from the checking. + # Default: [] + skip-files: + - "*.pb.go" + - "*/vendor/*" + - "/full/path/to/file.go" + # Skip any generated files from the checking. + # Default: false + skip-any-generated: true + # Skip first argument of append function. + # Default: false + replace-first-arg-in-append: true + + reassign: + # Patterns for global variable names that are checked for reassignment. + # See https://github.com/curioswitch/go-reassign#usage + # Default: ["EOF", "Err.*"] + patterns: + - ".*" + + recvcheck: + # Disables the built-in method exclusions: + # - `MarshalText` + # - `MarshalJSON` + # - `MarshalYAML` + # - `MarshalXML` + # - `MarshalBinary` + # - `GobEncode` + # Default: false + disable-builtin: true + # User-defined method exclusions. + # The format is `struct_name.method_name` (ex: `Foo.MethodName`). + # A wildcard `*` can use as a struct name (ex: `*.MethodName`). + # Default: [] + exclusions: + - "*.Value" + + revive: + # Maximum number of open files at the same time. + # See https://github.com/mgechev/revive#command-line-flags + # Defaults to unlimited. + max-open-files: 2048 + + # When set to false, ignores files with "GENERATED" header, similar to golint. + # See https://github.com/mgechev/revive#configuration for details. + # Default: false + ignore-generated-header: true + + # Sets the default severity. + # See https://github.com/mgechev/revive#configuration + # Default: warning + severity: error + + # Enable all available rules. + # Default: false + enable-all-rules: true + + # Enable validation of comment directives. + # See https://github.com/mgechev/revive#comment-directives + directives: + - name: specify-disable-reason + severity: error + + # Sets the default failure confidence. + # This means that linting errors with less than 0.8 confidence will be ignored. + # Default: 0.8 + confidence: 0.1 + # Run `GL_DEBUG=revive golangci-lint run --enable-only=revive` to see default, all available rules, and enabled rules. + rules: + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#add-constant + - name: add-constant + severity: warning + disabled: false + exclude: [""] + arguments: + - maxLitCount: "3" + allowStrs: '""' + allowInts: "0,1,2" + allowFloats: "0.0,0.,1.0,1.,2.0,2." + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#argument-limit + - name: argument-limit + severity: warning + disabled: false + exclude: [""] + arguments: [ 4 ] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#atomic + - name: atomic + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#banned-characters + - name: banned-characters + severity: warning + disabled: false + exclude: [""] + arguments: [ "Ω","Σ","σ", "7" ] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#bare-return + - name: bare-return + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#blank-imports + - name: blank-imports + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#bool-literal-in-expr + - name: bool-literal-in-expr + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#call-to-gc + - name: call-to-gc + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#cognitive-complexity + - name: cognitive-complexity + severity: warning + disabled: false + exclude: [""] + arguments: [ 7 ] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#comment-spacings + - name: comment-spacings + severity: warning + disabled: false + exclude: [""] + arguments: + - mypragma + - otherpragma + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#comments-density + - name: comments-density + severity: warning + disabled: false + exclude: [""] + arguments: [ 15 ] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#confusing-naming + - name: confusing-naming + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#confusing-results + - name: confusing-results + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#constant-logical-expr + - name: constant-logical-expr + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#context-as-argument + - name: context-as-argument + severity: warning + disabled: false + exclude: [""] + arguments: + - allowTypesBefore: "*testing.T,*github.com/user/repo/testing.Harness" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#context-keys-type + - name: context-keys-type + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#cyclomatic + - name: cyclomatic + severity: warning + disabled: false + exclude: [""] + arguments: [ 3 ] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#datarace + - name: datarace + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#deep-exit + - name: deep-exit + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#defer + - name: defer + severity: warning + disabled: false + exclude: [""] + arguments: + - [ "call-chain", "loop" ] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#dot-imports + - name: dot-imports + severity: warning + disabled: false + exclude: [""] + arguments: [ ] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#duplicated-imports + - name: duplicated-imports + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#early-return + - name: early-return + severity: warning + disabled: false + exclude: [""] + arguments: + - "preserveScope" + - "allowJump" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#empty-block + - name: empty-block + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#empty-lines + - name: empty-lines + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#enforce-map-style + - name: enforce-map-style + severity: warning + disabled: false + exclude: [""] + arguments: + - "make" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#enforce-repeated-arg-type-style + - name: enforce-repeated-arg-type-style + severity: warning + disabled: false + exclude: [""] + arguments: + - "short" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#enforce-slice-style + - name: enforce-slice-style + severity: warning + disabled: false + exclude: [""] + arguments: + - "make" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#error-naming + - name: error-naming + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#error-return + - name: error-return + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#error-strings + - name: error-strings + severity: warning + disabled: false + exclude: [""] + arguments: + - "xerrors.New" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#errorf + - name: errorf + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#exported + - name: exported + severity: warning + disabled: false + exclude: [""] + arguments: + - "checkPrivateReceivers" + - "disableStutteringCheck" + - "checkPublicInterface" + - "disableChecksOnFunctions" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#file-header + - name: file-header + severity: warning + disabled: false + exclude: [""] + arguments: + - This is the text that must appear at the top of source files. + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#file-length-limit + - name: file-length-limit + severity: warning + disabled: false + exclude: [""] + arguments: + - max: 100 + skipComments: true + skipBlankLines: true + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#filename-format + - name: filename-format + severity: warning + disabled: false + exclude: [""] + arguments: + - "^[_a-z][_a-z0-9]*\\.go$" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#flag-parameter + - name: flag-parameter + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#function-length + - name: function-length + severity: warning + disabled: false + exclude: [""] + arguments: [ 10, 0 ] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#function-result-limit + - name: function-result-limit + severity: warning + disabled: false + exclude: [""] + arguments: [ 3 ] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#get-return + - name: get-return + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#identical-branches + - name: identical-branches + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#if-return + - name: if-return + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#import-alias-naming + - name: import-alias-naming + severity: warning + disabled: false + exclude: [""] + arguments: + - "^[a-z][a-z0-9]{0,}$" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#import-shadowing + - name: import-shadowing + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#imports-blocklist + - name: imports-blocklist + severity: warning + disabled: false + exclude: [""] + arguments: + - "crypto/md5" + - "crypto/sha1" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#increment-decrement + - name: increment-decrement + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#indent-error-flow + - name: indent-error-flow + severity: warning + disabled: false + exclude: [""] + arguments: + - "preserveScope" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#line-length-limit + - name: line-length-limit + severity: warning + disabled: false + exclude: [""] + arguments: [ 80 ] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#max-control-nesting + - name: max-control-nesting + severity: warning + disabled: false + exclude: [""] + arguments: [ 3 ] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#max-public-structs + - name: max-public-structs + severity: warning + disabled: false + exclude: [""] + arguments: [ 3 ] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#modifies-parameter + - name: modifies-parameter + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#modifies-value-receiver + - name: modifies-value-receiver + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#nested-structs + - name: nested-structs + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#optimize-operands-order + - name: optimize-operands-order + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#package-comments + - name: package-comments + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#range + - name: range + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#range-val-address + - name: range-val-address + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#range-val-in-closure + - name: range-val-in-closure + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#receiver-naming + - name: receiver-naming + severity: warning + disabled: false + exclude: [""] + arguments: + - maxLength: 2 + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#redefines-builtin-id + - name: redefines-builtin-id + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#redundant-build-tag + - name: redundant-build-tag + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#redundant-import-alias + - name: redundant-import-alias + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#string-format + - name: string-format + severity: warning + disabled: false + exclude: [""] + arguments: + - - 'core.WriteError[1].Message' + - '/^([^A-Z]|$)/' + - must not start with a capital letter + - - 'fmt.Errorf[0]' + - '/(^|[^\.!?])$/' + - must not end in punctuation + - - panic + - '/^[^\n]*$/' + - must not contain line breaks + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#string-of-int + - name: string-of-int + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#struct-tag + - name: struct-tag + severity: warning + disabled: false + exclude: [""] + arguments: + - "json,inline" + - "bson,outline,gnu" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#superfluous-else + - name: superfluous-else + severity: warning + disabled: false + exclude: [""] + arguments: + - "preserveScope" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#time-equal + - name: time-equal + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#time-naming + - name: time-naming + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unchecked-type-assertion + - name: unchecked-type-assertion + severity: warning + disabled: false + exclude: [""] + arguments: + - acceptIgnoredAssertionResult: true + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unconditional-recursion + - name: unconditional-recursion + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unexported-naming + - name: unexported-naming + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unexported-return + - name: unexported-return + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unhandled-error + - name: unhandled-error + severity: warning + disabled: false + exclude: [""] + arguments: + - "fmt.Printf" + - "myFunction" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unnecessary-stmt + - name: unnecessary-stmt + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unreachable-code + - name: unreachable-code + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unused-parameter + - name: unused-parameter + severity: warning + disabled: false + exclude: [""] + arguments: + - allowRegex: "^_" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unused-receiver + - name: unused-receiver + severity: warning + disabled: false + exclude: [""] + arguments: + - allowRegex: "^_" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#use-any + - name: use-any + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#use-errors-new + - name: use-errors-new + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#useless-break + - name: useless-break + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#var-declaration + - name: var-declaration + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#var-naming + - name: var-naming + severity: warning + disabled: false + exclude: [""] + arguments: + - [ "ID" ] # AllowList + - [ "VM" ] # DenyList + - - upperCaseConst: true # Extra parameter (upperCaseConst|skipPackageNameChecks) + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#waitgroup-by-value + - name: waitgroup-by-value + severity: warning + disabled: false + exclude: [""] + + rowserrcheck: + # database/sql is always checked + # Default: [] + packages: + - github.com/jmoiron/sqlx + + sloglint: + # Enforce not mixing key-value pairs and attributes. + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#no-mixed-arguments + # Default: true + no-mixed-args: false + # Enforce using key-value pairs only (overrides no-mixed-args, incompatible with attr-only). + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#key-value-pairs-only + # Default: false + kv-only: true + # Enforce using attributes only (overrides no-mixed-args, incompatible with kv-only). + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#attributes-only + # Default: false + attr-only: true + # Enforce not using global loggers. + # Values: + # - "": disabled + # - "all": report all global loggers + # - "default": report only the default slog logger + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#no-global + # Default: "" + no-global: "all" + # Enforce using methods that accept a context. + # Values: + # - "": disabled + # - "all": report all contextless calls + # - "scope": report only if a context exists in the scope of the outermost function + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#context-only + # Default: "" + context: "all" + # Enforce using static values for log messages. + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#static-messages + # Default: false + static-msg: true + # Enforce using constants instead of raw keys. + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#no-raw-keys + # Default: false + no-raw-keys: true + # Enforce a single key naming convention. + # Values: snake, kebab, camel, pascal + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#key-naming-convention + # Default: "" + key-naming-case: snake + # Enforce not using specific keys. + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#forbidden-keys + # Default: [] + forbidden-keys: + - time + - level + - msg + - source + - foo + # Enforce putting arguments on separate lines. + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#arguments-on-separate-lines + # Default: false + args-on-sep-lines: true + + spancheck: + # Checks to enable. + # Options include: + # - `end`: check that `span.End()` is called + # - `record-error`: check that `span.RecordError(err)` is called when an error is returned + # - `set-status`: check that `span.SetStatus(codes.Error, msg)` is called when an error is returned + # Default: ["end"] + checks: + - end + - record-error + - set-status + # A list of regexes for function signatures that silence `record-error` and `set-status` reports + # if found in the call path to a returned error. + # https://github.com/jjti/go-spancheck#ignore-check-signatures + # Default: [] + ignore-check-signatures: + - "telemetry.RecordError" + # A list of regexes for additional function signatures that create spans. + # This is useful if you have a utility method to create spans. + # Each entry should be of the form `:`, where `telemetry-type` can be `opentelemetry` or `opencensus`. + # https://github.com/jjti/go-spancheck#extra-start-span-signatures + # Default: [] + extra-start-span-signatures: + - "github.com/user/repo/telemetry/trace.Start:opentelemetry" + staticcheck: + # SAxxxx checks in https://staticcheck.dev/docs/configuration/options/#checks + # Example (to disable some checks): [ "all", "-SA1000", "-SA1001"] + # Default: ["*"] + checks: + # Invalid regular expression. + # https://staticcheck.dev/docs/checks/#SA1000 + - SA1000 + # Invalid template. + # https://staticcheck.dev/docs/checks/#SA1001 + - SA1001 + # Invalid format in 'time.Parse'. + # https://staticcheck.dev/docs/checks/#SA1002 + - SA1002 + # Unsupported argument to functions in 'encoding/binary'. + # https://staticcheck.dev/docs/checks/#SA1003 + - SA1003 + # Suspiciously small untyped constant in 'time.Sleep'. + # https://staticcheck.dev/docs/checks/#SA1004 + - SA1004 + # Invalid first argument to 'exec.Command'. + # https://staticcheck.dev/docs/checks/#SA1005 + - SA1005 + # 'Printf' with dynamic first argument and no further arguments. + # https://staticcheck.dev/docs/checks/#SA1006 + - SA1006 + # Invalid URL in 'net/url.Parse'. + # https://staticcheck.dev/docs/checks/#SA1007 + - SA1007 + # Non-canonical key in 'http.Header' map. + # https://staticcheck.dev/docs/checks/#SA1008 + - SA1008 + # '(*regexp.Regexp).FindAll' called with 'n == 0', which will always return zero results. + # https://staticcheck.dev/docs/checks/#SA1010 + - SA1010 + # Various methods in the "strings" package expect valid UTF-8, but invalid input is provided. + # https://staticcheck.dev/docs/checks/#SA1011 + - SA1011 + # A nil 'context.Context' is being passed to a function, consider using 'context.TODO' instead. + # https://staticcheck.dev/docs/checks/#SA1012 + - SA1012 + # 'io.Seeker.Seek' is being called with the whence constant as the first argument, but it should be the second. + # https://staticcheck.dev/docs/checks/#SA1013 + - SA1013 + # Non-pointer value passed to 'Unmarshal' or 'Decode'. + # https://staticcheck.dev/docs/checks/#SA1014 + - SA1014 + # Using 'time.Tick' in a way that will leak. Consider using 'time.NewTicker', and only use 'time.Tick' in tests, commands and endless functions. + # https://staticcheck.dev/docs/checks/#SA1015 + - SA1015 + # Trapping a signal that cannot be trapped. + # https://staticcheck.dev/docs/checks/#SA1016 + - SA1016 + # Channels used with 'os/signal.Notify' should be buffered. + # https://staticcheck.dev/docs/checks/#SA1017 + - SA1017 + # 'strings.Replace' called with 'n == 0', which does nothing. + # https://staticcheck.dev/docs/checks/#SA1018 + - SA1018 + # Using a deprecated function, variable, constant or field. + # https://staticcheck.dev/docs/checks/#SA1019 + - SA1019 + # Using an invalid host:port pair with a 'net.Listen'-related function. + # https://staticcheck.dev/docs/checks/#SA1020 + - SA1020 + # Using 'bytes.Equal' to compare two 'net.IP'. + # https://staticcheck.dev/docs/checks/#SA1021 + - SA1021 + # Modifying the buffer in an 'io.Writer' implementation. + # https://staticcheck.dev/docs/checks/#SA1023 + - SA1023 + # A string cutset contains duplicate characters. + # https://staticcheck.dev/docs/checks/#SA1024 + - SA1024 + # It is not possible to use '(*time.Timer).Reset''s return value correctly. + # https://staticcheck.dev/docs/checks/#SA1025 + - SA1025 + # Cannot marshal channels or functions. + # https://staticcheck.dev/docs/checks/#SA1026 + - SA1026 + # Atomic access to 64-bit variable must be 64-bit aligned. + # https://staticcheck.dev/docs/checks/#SA1027 + - SA1027 + # 'sort.Slice' can only be used on slices. + # https://staticcheck.dev/docs/checks/#SA1028 + - SA1028 + # Inappropriate key in call to 'context.WithValue'. + # https://staticcheck.dev/docs/checks/#SA1029 + - SA1029 + # Invalid argument in call to a 'strconv' function. + # https://staticcheck.dev/docs/checks/#SA1030 + - SA1030 + # Overlapping byte slices passed to an encoder. + # https://staticcheck.dev/docs/checks/#SA1031 + - SA1031 + # Wrong order of arguments to 'errors.Is'. + # https://staticcheck.dev/docs/checks/#SA1032 + - SA1032 + # 'sync.WaitGroup.Add' called inside the goroutine, leading to a race condition. + # https://staticcheck.dev/docs/checks/#SA2000 + - SA2000 + # Empty critical section, did you mean to defer the unlock?. + # https://staticcheck.dev/docs/checks/#SA2001 + - SA2001 + # Called 'testing.T.FailNow' or 'SkipNow' in a goroutine, which isn't allowed. + # https://staticcheck.dev/docs/checks/#SA2002 + - SA2002 + # Deferred 'Lock' right after locking, likely meant to defer 'Unlock' instead. + # https://staticcheck.dev/docs/checks/#SA2003 + - SA2003 + # 'TestMain' doesn't call 'os.Exit', hiding test failures. + # https://staticcheck.dev/docs/checks/#SA3000 + - SA3000 + # Assigning to 'b.N' in benchmarks distorts the results. + # https://staticcheck.dev/docs/checks/#SA3001 + - SA3001 + # Binary operator has identical expressions on both sides. + # https://staticcheck.dev/docs/checks/#SA4000 + - SA4000 + # '&*x' gets simplified to 'x', it does not copy 'x'. + # https://staticcheck.dev/docs/checks/#SA4001 + - SA4001 + # Comparing unsigned values against negative values is pointless. + # https://staticcheck.dev/docs/checks/#SA4003 + - SA4003 + # The loop exits unconditionally after one iteration. + # https://staticcheck.dev/docs/checks/#SA4004 + - SA4004 + # Field assignment that will never be observed. Did you mean to use a pointer receiver?. + # https://staticcheck.dev/docs/checks/#SA4005 + - SA4005 + # A value assigned to a variable is never read before being overwritten. Forgotten error check or dead code?. + # https://staticcheck.dev/docs/checks/#SA4006 + - SA4006 + # The variable in the loop condition never changes, are you incrementing the wrong variable?. + # https://staticcheck.dev/docs/checks/#SA4008 + - SA4008 + # A function argument is overwritten before its first use. + # https://staticcheck.dev/docs/checks/#SA4009 + - SA4009 + # The result of 'append' will never be observed anywhere. + # https://staticcheck.dev/docs/checks/#SA4010 + - SA4010 + # Break statement with no effect. Did you mean to break out of an outer loop?. + # https://staticcheck.dev/docs/checks/#SA4011 + - SA4011 + # Comparing a value against NaN even though no value is equal to NaN. + # https://staticcheck.dev/docs/checks/#SA4012 + - SA4012 + # Negating a boolean twice ('!!b') is the same as writing 'b'. This is either redundant, or a typo. + # https://staticcheck.dev/docs/checks/#SA4013 + - SA4013 + # An if/else if chain has repeated conditions and no side-effects; if the condition didn't match the first time, it won't match the second time, either. + # https://staticcheck.dev/docs/checks/#SA4014 + - SA4014 + # Calling functions like 'math.Ceil' on floats converted from integers doesn't do anything useful. + # https://staticcheck.dev/docs/checks/#SA4015 + - SA4015 + # Certain bitwise operations, such as 'x ^ 0', do not do anything useful. + # https://staticcheck.dev/docs/checks/#SA4016 + - SA4016 + # Discarding the return values of a function without side effects, making the call pointless. + # https://staticcheck.dev/docs/checks/#SA4017 + - SA4017 + # Self-assignment of variables. + # https://staticcheck.dev/docs/checks/#SA4018 + - SA4018 + # Multiple, identical build constraints in the same file. + # https://staticcheck.dev/docs/checks/#SA4019 + - SA4019 + # Unreachable case clause in a type switch. + # https://staticcheck.dev/docs/checks/#SA4020 + - SA4020 + # "x = append(y)" is equivalent to "x = y". + # https://staticcheck.dev/docs/checks/#SA4021 + - SA4021 + # Comparing the address of a variable against nil. + # https://staticcheck.dev/docs/checks/#SA4022 + - SA4022 + # Impossible comparison of interface value with untyped nil. + # https://staticcheck.dev/docs/checks/#SA4023 + - SA4023 + # Checking for impossible return value from a builtin function. + # https://staticcheck.dev/docs/checks/#SA4024 + - SA4024 + # Integer division of literals that results in zero. + # https://staticcheck.dev/docs/checks/#SA4025 + - SA4025 + # Go constants cannot express negative zero. + # https://staticcheck.dev/docs/checks/#SA4026 + - SA4026 + # '(*net/url.URL).Query' returns a copy, modifying it doesn't change the URL. + # https://staticcheck.dev/docs/checks/#SA4027 + - SA4027 + # 'x % 1' is always zero. + # https://staticcheck.dev/docs/checks/#SA4028 + - SA4028 + # Ineffective attempt at sorting slice. + # https://staticcheck.dev/docs/checks/#SA4029 + - SA4029 + # Ineffective attempt at generating random number. + # https://staticcheck.dev/docs/checks/#SA4030 + - SA4030 + # Checking never-nil value against nil. + # https://staticcheck.dev/docs/checks/#SA4031 + - SA4031 + # Comparing 'runtime.GOOS' or 'runtime.GOARCH' against impossible value. + # https://staticcheck.dev/docs/checks/#SA4032 + - SA4032 + # Assignment to nil map. + # https://staticcheck.dev/docs/checks/#SA5000 + - SA5000 + # Deferring 'Close' before checking for a possible error. + # https://staticcheck.dev/docs/checks/#SA5001 + - SA5001 + # The empty for loop ("for {}") spins and can block the scheduler. + # https://staticcheck.dev/docs/checks/#SA5002 + - SA5002 + # Defers in infinite loops will never execute. + # https://staticcheck.dev/docs/checks/#SA5003 + - SA5003 + # "for { select { ..." with an empty default branch spins. + # https://staticcheck.dev/docs/checks/#SA5004 + - SA5004 + # The finalizer references the finalized object, preventing garbage collection. + # https://staticcheck.dev/docs/checks/#SA5005 + - SA5005 + # Infinite recursive call. + # https://staticcheck.dev/docs/checks/#SA5007 + - SA5007 + # Invalid struct tag. + # https://staticcheck.dev/docs/checks/#SA5008 + - SA5008 + # Invalid Printf call. + # https://staticcheck.dev/docs/checks/#SA5009 + - SA5009 + # Impossible type assertion. + # https://staticcheck.dev/docs/checks/#SA5010 + - SA5010 + # Possible nil pointer dereference. + # https://staticcheck.dev/docs/checks/#SA5011 + - SA5011 + # Passing odd-sized slice to function expecting even size. + # https://staticcheck.dev/docs/checks/#SA5012 + - SA5012 + # Using 'regexp.Match' or related in a loop, should use 'regexp.Compile'. + # https://staticcheck.dev/docs/checks/#SA6000 + - SA6000 + # Missing an optimization opportunity when indexing maps by byte slices. + # https://staticcheck.dev/docs/checks/#SA6001 + - SA6001 + # Storing non-pointer values in 'sync.Pool' allocates memory. + # https://staticcheck.dev/docs/checks/#SA6002 + - SA6002 + # Converting a string to a slice of runes before ranging over it. + # https://staticcheck.dev/docs/checks/#SA6003 + - SA6003 + # Inefficient string comparison with 'strings.ToLower' or 'strings.ToUpper'. + # https://staticcheck.dev/docs/checks/#SA6005 + - SA6005 + # Using io.WriteString to write '[]byte'. + # https://staticcheck.dev/docs/checks/#SA6006 + - SA6006 + # Defers in range loops may not run when you expect them to. + # https://staticcheck.dev/docs/checks/#SA9001 + - SA9001 + # Using a non-octal 'os.FileMode' that looks like it was meant to be in octal. + # https://staticcheck.dev/docs/checks/#SA9002 + - SA9002 + # Empty body in an if or else branch. + # https://staticcheck.dev/docs/checks/#SA9003 + - SA9003 + # Only the first constant has an explicit type. + # https://staticcheck.dev/docs/checks/#SA9004 + - SA9004 + # Trying to marshal a struct with no public fields nor custom marshaling. + # https://staticcheck.dev/docs/checks/#SA9005 + - SA9005 + # Dubious bit shifting of a fixed size integer value. + # https://staticcheck.dev/docs/checks/#SA9006 + - SA9006 + # Deleting a directory that shouldn't be deleted. + # https://staticcheck.dev/docs/checks/#SA9007 + - SA9007 + # 'else' branch of a type assertion is probably not reading the right value. + # https://staticcheck.dev/docs/checks/#SA9008 + - SA9008 + # Ineffectual Go compiler directive. + # https://staticcheck.dev/docs/checks/#SA9009 + - SA9009 + + stylecheck: + # https://staticcheck.dev/docs/configuration/options/#dot_import_whitelist + # Default: ["github.com/mmcloughlin/avo/build", "github.com/mmcloughlin/avo/operand", "github.com/mmcloughlin/avo/reg"] + dot-import-whitelist: + - fmt + # https://staticcheck.dev/docs/configuration/options/#initialisms + # Default: ["ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS", "SIP", "RTP", "AMQP", "DB", "TS"] + initialisms: [ "ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS", "SIP", "RTP", "AMQP", "DB", "TS" ] + # https://staticcheck.dev/docs/configuration/options/#http_status_code_whitelist + # Default: ["200", "400", "404", "500"] + http-status-code-whitelist: [ "200", "400", "404", "500" ] + # STxxxx checks in https://staticcheck.dev/docs/configuration/options/#checks + # Example (to disable some checks): [ "all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022" ] + # Default: ["*"] + checks: + # Incorrect or missing package comment. + # https://staticcheck.dev/docs/checks/#ST1000 + - ST1000 + # Dot imports are discouraged. + # https://staticcheck.dev/docs/checks/#ST1001 + - ST1001 + # Poorly chosen identifier. + # https://staticcheck.dev/docs/checks/#ST1003 + - ST1003 + # Incorrectly formatted error string. + # https://staticcheck.dev/docs/checks/#ST1005 + - ST1005 + # Poorly chosen receiver name. + # https://staticcheck.dev/docs/checks/#ST1006 + - ST1006 + # A function's error value should be its last return value. + # https://staticcheck.dev/docs/checks/#ST1008 + - ST1008 + # Poorly chosen name for variable of type 'time.Duration'. + # https://staticcheck.dev/docs/checks/#ST1011 + - ST1011 + # Poorly chosen name for error variable. + # https://staticcheck.dev/docs/checks/#ST1012 + - ST1012 + # Should use constants for HTTP error codes, not magic numbers. + # https://staticcheck.dev/docs/checks/#ST1013 + - ST1013 + # A switch's default case should be the first or last case. + # https://staticcheck.dev/docs/checks/#ST1015 + - ST1015 + # Use consistent method receiver names. + # https://staticcheck.dev/docs/checks/#ST1016 + - ST1016 + # Don't use Yoda conditions. + # https://staticcheck.dev/docs/checks/#ST1017 + - ST1017 + # Avoid zero-width and control characters in string literals. + # https://staticcheck.dev/docs/checks/#ST1018 + - ST1018 + # Importing the same package multiple times. + # https://staticcheck.dev/docs/checks/#ST1019 + - ST1019 + # The documentation of an exported function should start with the function's name. + # https://staticcheck.dev/docs/checks/#ST1020 + - ST1020 + # The documentation of an exported type should start with type's name. + # https://staticcheck.dev/docs/checks/#ST1021 + - ST1021 + # The documentation of an exported variable or constant should start with variable's name. + # https://staticcheck.dev/docs/checks/#ST1022 + - ST1022 + # Redundant type in variable declaration. + # https://staticcheck.dev/docs/checks/#ST1023 + - ST1023 + + tagalign: + # Align and sort can be used together or separately. + # + # Whether enable align. If true, the struct tags will be aligned. + # e.g.: + # type FooBar struct { + # Bar string `json:"bar" validate:"required"` + # FooFoo int8 `json:"foo_foo" validate:"required"` + # } + # will be formatted to: + # type FooBar struct { + # Bar string `json:"bar" validate:"required"` + # FooFoo int8 `json:"foo_foo" validate:"required"` + # } + # Default: true. + align: false + # Whether enable tags sort. + # If true, the tags will be sorted by name in ascending order. + # e.g.: `xml:"bar" json:"bar" validate:"required"` -> `json:"bar" validate:"required" xml:"bar"` + # Default: true + sort: false + # Specify the order of tags, the other tags will be sorted by name. + # This option will be ignored if `sort` is false. + # Default: [] + order: + - json + - yaml + - yml + - toml + - mapstructure + - binding + - validate + # Whether enable strict style. + # In this style, the tags will be sorted and aligned in the dictionary order, + # and the tags with the same name will be aligned together. + # Note: This option will be ignored if 'align' or 'sort' is false. + # Default: false + strict: true + + tagliatelle: + # Checks the struct tag name case. + case: + # Defines the association between tag name and case. + # Any struct tag name can be used. + # Supported string cases: + # - `camel` + # - `pascal` + # - `kebab` + # - `snake` + # - `upperSnake` + # - `goCamel` + # - `goPascal` + # - `goKebab` + # - `goSnake` + # - `upper` + # - `lower` + # - `header` + rules: + json: camel + yaml: camel + xml: camel + toml: camel + bson: camel + avro: snake + mapstructure: kebab + env: upperSnake + envconfig: upperSnake + whatever: snake + # Defines the association between tag name and case. + # Important: the `extended-rules` overrides `rules`. + # Default: empty + extended-rules: + json: + # Supported string cases: + # - `camel` + # - `pascal` + # - `kebab` + # - `snake` + # - `upperSnake` + # - `goCamel` + # - `goPascal` + # - `goKebab` + # - `goSnake` + # - `header` + # - `lower` + # - `header` + # + # Required + case: camel + # Adds 'AMQP', 'DB', 'GID', 'RTP', 'SIP', 'TS' to initialisms, + # and removes 'LHS', 'RHS' from initialisms. + # Default: false + extra-initialisms: true + # Defines initialism additions and overrides. + # Default: empty + initialism-overrides: + DB: true # add a new initialism + LHS: false # disable a default initialism. + # ... + # Uses the struct field name to check the name of the struct tag. + # Default: false + use-field-name: true + # The field names to ignore. + # Default: [] + ignored-fields: + - Bar + - Foo + # Overrides the default/root configuration. + # Default: [] + overrides: + - + # The package path (uses `/` only as a separator). + # Required + pkg: foo/bar + # Default: empty or the same as the default/root configuration. + rules: + json: snake + xml: pascal + # Default: empty or the same as the default/root configuration. + extended-rules: + # Same options as the base `extended-rules`. + # Default: false (WARNING: it doesn't follow the default/root configuration) + use-field-name: true + # The field names to ignore. + # Default: [] or the same as the default/root configuration. + ignored-fields: + - Bar + - Foo + # Ignore the package (takes precedence over all other configurations). + # Default: false + ignore: true + + tenv: + # The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures. + # Otherwise, only methods that take `*testing.T`, `*testing.B`, and `testing.TB` as arguments are checked. + # Default: false + all: false + + testifylint: + # Enable all checkers (https://github.com/Antonboom/testifylint#checkers). + # Default: false + enable-all: true + # Disable checkers by name + # (in addition to default + # suite-thelper + # ). + disable: + - blank-import + - bool-compare + - compares + - contains + - empty + - encoded-compare + - error-is-as + - error-nil + - expected-actual + - float-compare + - formatter + - go-require + - len + - negative-positive + - nil-compare + - regexp + - require-error + - suite-broken-parallel + - suite-dont-use-pkg + - suite-extra-assert-call + - suite-subtest-run + - suite-thelper + - useless-assert + + # Disable all checkers (https://github.com/Antonboom/testifylint#checkers). + # Default: false + disable-all: true + # Enable checkers by name + # (in addition to default + # blank-import, bool-compare, compares, contains, empty, encoded-compare, error-is-as, error-nil, expected-actual, + # go-require, float-compare, formatter, len, negative-positive, nil-compare, regexp, require-error, + # suite-broken-parallel, suite-dont-use-pkg, suite-extra-assert-call, suite-subtest-run, useless-assert + # ). + enable: + - blank-import + - bool-compare + - compares + - contains + - empty + - encoded-compare + - error-is-as + - error-nil + - expected-actual + - float-compare + - formatter + - go-require + - len + - negative-positive + - nil-compare + - regexp + - require-error + - suite-broken-parallel + - suite-dont-use-pkg + - suite-extra-assert-call + - suite-subtest-run + - suite-thelper + - useless-assert + + bool-compare: + # To ignore user defined types (over builtin bool). + # Default: false + ignore-custom-types: true + expected-actual: + # Regexp for expected variable name. + # Default: (^(exp(ected)?|want(ed)?)([A-Z]\w*)?$)|(^(\w*[a-z])?(Exp(ected)?|Want(ed)?)$) + pattern: ^expected + formatter: + # To enable go vet's printf checks. + # Default: true + check-format-string: false + # To require f-assertions (e.g. `assert.Equalf`) if format string is used, even if there are no variable-length + # variables, i.e. it requires `require.NoErrorf` for both these cases: + # - require.NoErrorf(t, err, "unexpected error") + # - require.NoErrorf(t, err, "unexpected error for sid: %v", sid) + # To understand this behavior, please read the + # https://github.com/Antonboom/testifylint?tab=readme-ov-file#historical-reference-of-formatter. + # Default: false + require-f-funcs: true + go-require: + # To ignore HTTP handlers (like http.HandlerFunc). + # Default: false + ignore-http-handlers: true + require-error: + # Regexp for assertions to analyze. If defined, then only matched error assertions will be reported. + # Default: "" + fn-pattern: ^(Errorf?|NoErrorf?)$ + suite-extra-assert-call: + # To require or remove extra Assert() call? + # Default: remove + mode: require + + testpackage: + # Regexp pattern to skip files. + # Default: "(export|internal)_test\\.go" + skip-regexp: (export|internal)_test\.go + # List of packages that don't end with _test that tests are allowed to be in. + # Default: "main" + allow-packages: + - example + - main + + thelper: + test: + # Check *testing.T is first param (or after context.Context) of helper function. + # Default: true + first: false + # Check *testing.T param has name t. + # Default: true + name: false + # Check t.Helper() begins helper function. + # Default: true + begin: false + benchmark: + # Check *testing.B is first param (or after context.Context) of helper function. + # Default: true + first: false + # Check *testing.B param has name b. + # Default: true + name: false + # Check b.Helper() begins helper function. + # Default: true + begin: false + tb: + # Check *testing.TB is first param (or after context.Context) of helper function. + # Default: true + first: false + # Check *testing.TB param has name tb. + # Default: true + name: false + # Check tb.Helper() begins helper function. + # Default: true + begin: false + fuzz: + # Check *testing.F is first param (or after context.Context) of helper function. + # Default: true + first: false + # Check *testing.F param has name f. + # Default: true + name: false + # Check f.Helper() begins helper function. + # Default: true + begin: false + + usestdlibvars: + # Suggest the use of http.MethodXX. + # Default: true + http-method: false + # Suggest the use of http.StatusXX. + # Default: true + http-status-code: false + # Suggest the use of time.Weekday.String(). + # Default: true + time-weekday: true + # Suggest the use of time.Month.String(). + # Default: false + time-month: true + # Suggest the use of time.Layout. + # Default: false + time-layout: true + # Suggest the use of crypto.Hash.String(). + # Default: false + crypto-hash: true + # Suggest the use of rpc.DefaultXXPath. + # Default: false + default-rpc-path: true + # Suggest the use of sql.LevelXX.String(). + # Default: false + sql-isolation-level: true + # Suggest the use of tls.SignatureScheme.String(). + # Default: false + tls-signature-scheme: true + # Suggest the use of constant.Kind.String(). + # Default: false + constant-kind: true + + usetesting: + # Enable/disable `os.CreateTemp("", ...)` detections. + # Default: true + os-create-temp: false + + # Enable/disable `os.MkdirTemp()` detections. + # Default: true + os-mkdir-temp: false + + # Enable/disable `os.Setenv()` detections. + # Default: true + os-setenv: false + + # Enable/disable `os.TempDir()` detections. + # Default: false + os-temp-dir: true + + # Enable/disable `os.Chdir()` detections. + # Disabled if Go < 1.24. + # Default: true + os-chdir: false + + # Enable/disable `context.Background()` detections. + # Disabled if Go < 1.24. + # Default: true + context-background: false + + # Enable/disable `context.TODO()` detections. + # Disabled if Go < 1.24. + # Default: true + context-todo: false + + unconvert: + # Remove conversions that force intermediate rounding. + # Default: false + fast-math: true + # Be more conservative (experimental). + # Default: false + safe: true + + unparam: + # Inspect exported functions. + # + # Set to true if no external program/library imports your code. + # XXX: if you enable this setting, unparam will report a lot of false-positives in text editors: + # if it's called for subdir of a project it can't find external interfaces. All text editor integrations + # with golangci-lint call it on a directory with the changed file. + # + # Default: false + check-exported: true + + unused: + # Mark all struct fields that have been written to as used. + # Default: true + field-writes-are-uses: false + # Treat IncDec statement (e.g. `i++` or `i--`) as both read and write operation instead of just write. + # Default: false + post-statements-are-reads: true + # Mark all exported fields as used. + # default: true + exported-fields-are-used: false + # Mark all function parameters as used. + # default: true + parameters-are-used: false + # Mark all local variables as used. + # default: true + local-variables-are-used: false + # Mark all identifiers inside generated files as used. + # Default: true + generated-is-used: false + + varnamelen: + # The longest distance, in source lines, that is being considered a "small scope". + # Variables used in at most this many lines will be ignored. + # Default: 5 + max-distance: 6 + # The minimum length of a variable's name that is considered "long". + # Variable names that are at least this long will be ignored. + # Default: 3 + min-name-length: 2 + # Check method receivers. + # Default: false + check-receiver: true + # Check named return values. + # Default: false + check-return: true + # Check type parameters. + # Default: false + check-type-param: true + # Ignore "ok" variables that hold the bool return value of a type assertion. + # Default: false + ignore-type-assert-ok: true + # Ignore "ok" variables that hold the bool return value of a map index. + # Default: false + ignore-map-index-ok: true + # Ignore "ok" variables that hold the bool return value of a channel receive. + # Default: false + ignore-chan-recv-ok: true + # Optional list of variable names that should be ignored completely. + # Default: [] + ignore-names: + - err + # Optional list of variable declarations that should be ignored completely. + # Entries must be in one of the following forms (see below for examples): + # - for variables, parameters, named return values, method receivers, or type parameters: + # ( can also be a pointer/slice/map/chan/...) + # - for constants: const + # + # Default: [] + ignore-decls: + - c echo.Context + - t testing.T + - f *foo.Bar + - e error + - i int + - const C + - T any + - m map[string]int + + whitespace: + # Enforces newlines (or comments) after every multi-line if statement. + # Default: false + multi-if: true + # Enforces newlines (or comments) after every multi-line function signature. + # Default: false + multi-func: true + + wrapcheck: + # An array of strings specifying additional substrings of signatures to ignore. + # Unlike 'ignoreSigs', this option extends the default set (or the set specified in 'ignoreSigs') without replacing it entirely. + # This allows you to add specific signatures to the ignore list + # while retaining the defaults or any items in 'ignoreSigs'. + # Default: [] + extra-ignore-sigs: + - .CustomError( + - .SpecificWrap( + + # An array of strings that specify substrings of signatures to ignore. + # If this set, it will override the default set of ignored signatures. + # See https://github.com/tomarrell/wrapcheck#configuration for more information. + # Default: [".Errorf(", "errors.New(", "errors.Unwrap(", "errors.Join(", ".Wrap(", ".Wrapf(", ".WithMessage(", ".WithMessagef(", ".WithStack("] + ignoreSigs: + - .Errorf( + - errors.New( + - errors.Unwrap( + - errors.Join( + - .Wrap( + - .Wrapf( + - .WithMessage( + - .WithMessagef( + - .WithStack( + # An array of strings that specify regular expressions of signatures to ignore. + # Default: [] + ignoreSigRegexps: + - \.New.*Error\( + # An array of strings that specify globs of packages to ignore. + # Default: [] + ignorePackageGlobs: + - encoding/* + - github.com/pkg/* + # An array of strings that specify regular expressions of interfaces to ignore. + # Default: [] + ignoreInterfaceRegexps: + - ^(?i)c(?-i)ach(ing|e) + + wsl: + # Do strict checking when assigning from append (x = append(x, y)). + # If this is set to true - the append call must append either a variable + # assigned, called or used on the line above. + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#strict-append + # Default: true + strict-append: false + + # Allows assignments to be cuddled with variables used in calls on + # line above and calls to be cuddled with assignments of variables + # used in call on line above. + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#allow-assign-and-call + # Default: true + allow-assign-and-call: false + + # Allows assignments to be cuddled with anything. + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#allow-assign-and-anything + # Default: false + allow-assign-and-anything: true + + # Allows cuddling to assignments even if they span over multiple lines. + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#allow-multiline-assign + # Default: true + allow-multiline-assign: false + + # If the number of lines in a case block is equal to or lager than this number, + # the case *must* end white a newline. + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#force-case-trailing-whitespace + # Default: 0 + force-case-trailing-whitespace: 1 + + # Allow blocks to end with comments. + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#allow-trailing-comment + # Default: false + allow-trailing-comment: true + + # Allow multiple comments in the beginning of a block separated with newline. + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#allow-separated-leading-comment + # Default: false + allow-separated-leading-comment: true + + # Allow multiple var/declaration statements to be cuddled. + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#allow-cuddle-declarations + # Default: false + allow-cuddle-declarations: true + + # A list of call idents that everything can be cuddled with. + # Defaults: [ "Lock", "RLock" ] + allow-cuddle-with-calls: [ "Foo", "Bar" ] + + # AllowCuddleWithRHS is a list of right hand side variables that is allowed + # to be cuddled with anything. + # Defaults: [ "Unlock", "RUnlock" ] + allow-cuddle-with-rhs: [ "Foo", "Bar" ] + + # Causes an error when an If statement that checks an error variable doesn't + # cuddle with the assignment of that variable. + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#force-err-cuddling + # Default: false + force-err-cuddling: true + + # When force-err-cuddling is enabled this is a list of names + # used for error variables to check for in the conditional. + # Default: [ "err" ] + error-variable-names: [ "foo" ] + + # Causes an error if a short declaration (:=) cuddles with anything other than + # another short declaration. + # This logic overrides force-err-cuddling among others. + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#force-short-decl-cuddling + # Default: false + force-short-decl-cuddling: true + + # The custom section can be used to define linter plugins to be loaded at runtime. + # See README documentation for more info. + custom: + # Each custom linter should have a unique name. + example: + # The plugin type. + # It can be `goplugin` or `module`. + # Default: goplugin + type: module + # The path to the plugin *.so. Can be absolute or local. + # Required for each custom linter. + path: /path/to/example.so + # The description of the linter. + # Optional. + description: This is an example usage of a plugin linter. + # Intended to point to the repo location of the linter. + # Optional. + original-url: github.com/golangci/example-linter + # Plugins settings/configuration. + # Only work with plugin based on `linterdb.PluginConstructor`. + # Optional. + settings: + foo: bar + + +issues: + # List of regexps of issue texts to exclude. + # + # But independently of this option we use default exclude patterns, + # it can be disabled by `exclude-use-default: false`. + # To list all excluded by default patterns execute `golangci-lint run --help` + # + # Default: https://golangci-lint.run/usage/false-positives/#default-exclusions + exclude: + - abcdef + + # Excluding configuration per-path, per-linter, per-text and per-source + exclude-rules: + # Exclude some linters from running on tests files. + - path: _test\.go + linters: + - gocyclo + - errcheck + - dupl + - gosec + + # Run some linter only for test files by excluding its issues for everything else. + - path-except: _test\.go + linters: + - forbidigo + + # Exclude known linters from partially hard-vendored code, + # which is impossible to exclude via `nolint` comments. + # `/` will be replaced by current OS file path separator to properly work on Windows. + - path: internal/hmac/ + text: "weak cryptographic primitive" + linters: + - gosec + + # Exclude some `staticcheck` messages. + - linters: + - staticcheck + text: "SA9003:" + + # Exclude `lll` issues for long lines with `go:generate`. + - linters: + - lll + source: "^//go:generate " + + # Independently of option `exclude` we use default exclude patterns, + # it can be disabled by this option. + # To list all excluded by default patterns execute `golangci-lint run --help`. + # Default: true + exclude-use-default: false + + # If set to true, `exclude` and `exclude-rules` regular expressions become case-sensitive. + # Default: false + exclude-case-sensitive: false + + # Which dirs to exclude: issues from them won't be reported. + # Can use regexp here: `generated.*`, regexp is applied on full path, + # including the path prefix if one is set. + # Default dirs are skipped independently of this option's value (see exclude-dirs-use-default). + # "/" will be replaced by current OS file path separator to properly work on Windows. + # Default: [] + exclude-dirs: + - src/external_libs + - autogenerated_by_my_lib + + # Enables exclude of directories: + # - vendor$, third_party$, testdata$, examples$, Godeps$, builtin$ + # Default: true + exclude-dirs-use-default: false + + # Which files to exclude: they will be analyzed, but issues from them won't be reported. + # There is no need to include all autogenerated files, + # we confidently recognize autogenerated files. + # If it's not, please let us know. + # "/" will be replaced by current OS file path separator to properly work on Windows. + # Default: [] + exclude-files: + - ".*\\.my\\.go$" + - lib/bad.go + + # Mode of the generated files analysis. + # + # - `strict`: sources are excluded by following strictly the Go generated file convention. + # Source files that have lines matching only the following regular expression will be excluded: `^// Code generated .* DO NOT EDIT\.$` + # This line must appear before the first non-comment, non-blank text in the file. + # https://go.dev/s/generatedcode + # - `lax`: sources are excluded if they contain lines `autogenerated file`, `code generated`, `do not edit`, etc. + # - `disable`: disable the generated files exclusion. + # + # Default: lax + exclude-generated: strict + + # The list of ids of default excludes to include or disable. + # https://golangci-lint.run/usage/false-positives/#default-exclusions + # Default: [] + include: + - EXC0001 + - EXC0002 + - EXC0003 + - EXC0004 + - EXC0005 + - EXC0006 + - EXC0007 + - EXC0008 + - EXC0009 + - EXC0010 + - EXC0011 + - EXC0012 + - EXC0013 + - EXC0014 + - EXC0015 + + # Maximum issues count per one linter. + # Set to 0 to disable. + # Default: 50 + max-issues-per-linter: 0 + + # Maximum count of issues with the same text. + # Set to 0 to disable. + # Default: 3 + max-same-issues: 0 + + # Make issues output unique by line. + # Default: true + uniq-by-line: false + + # Show only new issues: if there are unstaged changes or untracked files, + # only those changes are analyzed, else only changes in HEAD~ are analyzed. + # It's a super-useful option for integration of golangci-lint into existing large codebase. + # It's not practical to fix all existing issues at the moment of integration: + # much better don't allow issues in new code. + # + # Default: false + new: true + + # Show only new issues created after the best common ancestor (merge-base against HEAD). + # Default: "" + new-from-merge-base: main + + # Show only new issues created after git revision `REV`. + # Default: "" + new-from-rev: HEAD + + # Show only new issues created in git patch with set file path. + # Default: "" + new-from-patch: path/to/patch/file + + # Show issues in any part of update files (requires new-from-rev or new-from-patch). + # Default: false + whole-files: true + + # Fix found issues (if it's supported by the linter). + # Default: false + fix: true + + +# output configuration options +output: + # The formats used to render issues. + # Formats: + # - `colored-line-number` + # - `line-number` + # - `json` + # - `colored-tab` + # - `tab` + # - `html` + # - `checkstyle` + # - `code-climate` + # - `junit-xml` + # - `junit-xml-extended` + # - `github-actions` + # - `teamcity` + # - `sarif` + # Output path can be either `stdout`, `stderr` or path to the file to write to. + # + # For the CLI flag (`--out-format`), multiple formats can be specified by separating them by comma. + # The output can be specified for each of them by separating format name and path by colon symbol. + # Example: "--out-format=checkstyle:report.xml,json:stdout,colored-line-number" + # The CLI flag (`--out-format`) override the configuration file. + # + # Default: + # formats: + # - format: colored-line-number + # path: stdout + formats: + - format: json + path: stderr + - format: checkstyle + path: report.xml + - format: colored-line-number + + # Print lines of code with issue. + # Default: true + print-issued-lines: false + + # Print linter name in the end of issue text. + # Default: true + print-linter-name: false + + # Add a prefix to the output file references. + # Default: "" + path-prefix: "" + + # Sort results by the order defined in `sort-order`. + # Default: false + sort-results: true + + # Order to use when sorting results. + # Require `sort-results` to `true`. + # Possible values: `file`, `linter`, and `severity`. + # + # If the severity values are inside the following list, they are ordered in this order: + # 1. error + # 2. warning + # 3. high + # 4. medium + # 5. low + # Either they are sorted alphabetically. + # + # Default: ["file"] + sort-order: + - linter + - severity + - file # filepath, line, and column. + + # Show statistics per linter. + # Default: false + show-stats: true + + +# Options for analysis running. +run: + # Timeout for analysis, e.g. 30s, 5m, 5m30s. + # If the value is lower or equal to 0, the timeout is disabled. + # Default: 1m + timeout: 5m + + # The mode used to evaluate relative paths. + # It's used by exclusions, Go plugins, and some linters. + # The value can be: + # - `gomod`: the paths will be relative to the directory of the `go.mod` file. + # - `gitroot`: the paths will be relative to the git root (the parent directory of `.git`). + # - `cfg`: the paths will be relative to the configuration file. + # - `wd` (NOT recommended): the paths will be relative to the place where golangci-lint is run. + # Default: wd + relative-path-mode: gomod + + # Exit code when at least one issue was found. + # Default: 1 + issues-exit-code: 2 + + # Include test files or not. + # Default: true + tests: false + + # List of build tags, all linters use it. + # Default: [] + build-tags: + - mytag + + # If set, we pass it to "go list -mod={option}". From "go help modules": + # If invoked with -mod=readonly, the go command is disallowed from the implicit + # automatic updating of go.mod described above. Instead, it fails when any changes + # to go.mod are needed. This setting is most useful to check that go.mod does + # not need updates, such as in a continuous integration and testing system. + # If invoked with -mod=vendor, the go command assumes that the vendor + # directory holds the correct copies of dependencies and ignores + # the dependency descriptions in go.mod. + # + # Allowed values: readonly|vendor|mod + # Default: "" + modules-download-mode: readonly + + # Allow multiple parallel golangci-lint instances running. + # If false, golangci-lint acquires file lock on start. + # Default: false + allow-parallel-runners: true + + # Allow multiple golangci-lint instances running, but serialize them around a lock. + # If false, golangci-lint exits with an error if it fails to acquire file lock on start. + # Default: false + allow-serial-runners: true + + # Define the Go version limit. + # Mainly related to generics support since go1.18. + # Default: use Go version from the go.mod file, fallback on the env var `GOVERSION`, fallback on 1.17 + go: '1.19' + + # Number of operating system threads (`GOMAXPROCS`) that can execute golangci-lint simultaneously. + # If it is explicitly set to 0 (i.e. not the default) then golangci-lint will automatically set the value to match Linux container CPU quota. + # Default: the number of logical CPUs in the machine + concurrency: 4 + + +severity: + # Set the default severity for issues. + # + # If severity rules are defined and the issues do not match or no severity is provided to the rule + # this will be the default severity applied. + # Severities should match the supported severity names of the selected out format. + # - Code climate: https://docs.codeclimate.com/docs/issues#issue-severity + # - Checkstyle: https://checkstyle.sourceforge.io/property_types.html#SeverityLevel + # - GitHub: https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message + # - TeamCity: https://www.jetbrains.com/help/teamcity/service-messages.html#Inspection+Instance + # + # `@linter` can be used as severity value to keep the severity from linters (e.g. revive, gosec, ...) + # + # Default: "" + default-severity: error + + # If set to true `severity-rules` regular expressions become case-sensitive. + # Default: false + case-sensitive: true + + # When a list of severity rules are provided, severity information will be added to lint issues. + # Severity rules have the same filtering capability as exclude rules + # except you are allowed to specify one matcher per severity rule. + # + # `@linter` can be used as severity value to keep the severity from linters (e.g. revive, gosec, ...) + # + # Only affects out formats that support setting severity information. + # + # Default: [] + rules: + - linters: + - dupl + severity: info diff --git a/.golangci.reference.yml b/.golangci.reference.yml index 8e8823758879..fb0895eb3700 100644 --- a/.golangci.reference.yml +++ b/.golangci.reference.yml @@ -4,106 +4,274 @@ # This file is not a configuration example, # it contains the exhaustive configuration with explanations of the options. -# Options for analysis running. -run: - # The default concurrency value is the number of available CPU. - concurrency: 4 - - # Timeout for analysis, e.g. 30s, 5m. - # Default: 1m - timeout: 5m - - # Exit code when at least one issue was found. - # Default: 1 - issues-exit-code: 2 - - # Include test files or not. - # Default: true - tests: false - - # List of build tags, all linters use it. - # Default: []. - build-tags: - - mytag - - # Which dirs to skip: issues from them won't be reported. - # Can use regexp here: `generated.*`, regexp is applied on full path, - # including the path prefix if one is set. - # Default value is empty list, - # but default dirs are skipped independently of this option's value (see skip-dirs-use-default). - # "/" will be replaced by current OS file path separator to properly work on Windows. - skip-dirs: - - src/external_libs - - autogenerated_by_my_lib - - # Enables skipping of directories: - # - vendor$, third_party$, testdata$, examples$, Godeps$, builtin$ - # Default: true - skip-dirs-use-default: false - - # Which files to skip: they will be analyzed, but issues from them won't be reported. - # Default value is empty list, - # but there is no need to include all autogenerated files, - # we confidently recognize autogenerated files. - # If it's not please let us know. - # "/" will be replaced by current OS file path separator to properly work on Windows. - skip-files: - - ".*\\.my\\.go$" - - lib/bad.go - - # If set we pass it to "go list -mod={option}". From "go help modules": - # If invoked with -mod=readonly, the go command is disallowed from the implicit - # automatic updating of go.mod described above. Instead, it fails when any changes - # to go.mod are needed. This setting is most useful to check that go.mod does - # not need updates, such as in a continuous integration and testing system. - # If invoked with -mod=vendor, the go command assumes that the vendor - # directory holds the correct copies of dependencies and ignores - # the dependency descriptions in go.mod. - # - # Allowed values: readonly|vendor|mod - # By default, it isn't set. - modules-download-mode: readonly - - # Allow multiple parallel golangci-lint instances running. - # If false (default) - golangci-lint acquires file lock on start. - allow-parallel-runners: false - - # Define the Go version limit. - # Mainly related to generics support since go1.18. - # Default: use Go version from the go.mod file, fallback on the env var `GOVERSION`, fallback on 1.18 - go: '1.19' - - -# output configuration options -output: - # Format: colored-line-number|line-number|json|colored-tab|tab|checkstyle|code-climate|junit-xml|github-actions|teamcity - # - # Multiple can be specified by separating them by comma, output can be provided - # for each of them by separating format name and path by colon symbol. - # Output path can be either `stdout`, `stderr` or path to the file to write to. - # Example: "checkstyle:report.xml,json:stdout,colored-line-number" - # - # Default: colored-line-number - format: json - - # Print lines of code with issue. - # Default: true - print-issued-lines: false - - # Print linter name in the end of issue text. - # Default: true - print-linter-name: false +linters: + # Disable all linters. + # Default: false + disable-all: true + # Enable specific linter + # https://golangci-lint.run/usage/linters/#enabled-by-default + enable: + - asasalint + - asciicheck + - bidichk + - bodyclose + - canonicalheader + - containedctx + - contextcheck + - copyloopvar + - cyclop + - decorder + - depguard + - dogsled + - dupl + - dupword + - durationcheck + - err113 + - errcheck + - errchkjson + - errname + - errorlint + - exhaustive + - exhaustruct + - exptostd + - fatcontext + - forbidigo + - forcetypeassert + - funlen + - gci + - ginkgolinter + - gocheckcompilerdirectives + - gochecknoglobals + - gochecknoinits + - gochecksumtype + - gocognit + - goconst + - gocritic + - gocyclo + - godot + - godox + - gofmt + - gofumpt + - goheader + - goimports + - gomoddirectives + - gomodguard + - goprintffuncname + - gosec + - gosimple + - gosmopolitan + - govet + - grouper + - iface + - importas + - inamedparam + - ineffassign + - interfacebloat + - intrange + - ireturn + - lll + - loggercheck + - maintidx + - makezero + - mirror + - misspell + - mnd + - musttag + - nakedret + - nestif + - nilerr + - nilnesserr + - nilnil + - nlreturn + - noctx + - nolintlint + - nonamedreturns + - nosprintfhostport + - paralleltest + - perfsprint + - prealloc + - predeclared + - promlinter + - protogetter + - reassign + - recvcheck + - revive + - rowserrcheck + - sloglint + - spancheck + - sqlclosecheck + - staticcheck + - stylecheck + - tagalign + - tagliatelle + - testableexamples + - testifylint + - testpackage + - thelper + - tparallel + - unconvert + - unparam + - unused + - usestdlibvars + - usetesting + - varnamelen + - wastedassign + - whitespace + - wrapcheck + - wsl + - zerologlint - # Make issues output unique by line. - # Default: true - uniq-by-line: false + # Enable all available linters. + # Default: false + enable-all: true + # Disable specific linter + # https://golangci-lint.run/usage/linters/#disabled-by-default + disable: + - asasalint + - asciicheck + - bidichk + - bodyclose + - canonicalheader + - containedctx + - contextcheck + - copyloopvar + - cyclop + - decorder + - depguard + - dogsled + - dupl + - dupword + - durationcheck + - err113 + - errcheck + - errchkjson + - errname + - errorlint + - exhaustive + - exhaustruct + - exptostd + - fatcontext + - forbidigo + - forcetypeassert + - funlen + - gci + - ginkgolinter + - gocheckcompilerdirectives + - gochecknoglobals + - gochecknoinits + - gochecksumtype + - gocognit + - goconst + - gocritic + - gocyclo + - godot + - godox + - gofmt + - gofumpt + - goheader + - goimports + - gomoddirectives + - gomodguard + - goprintffuncname + - gosec + - gosimple + - gosmopolitan + - govet + - grouper + - iface + - importas + - inamedparam + - ineffassign + - interfacebloat + - intrange + - ireturn + - lll + - loggercheck + - maintidx + - makezero + - mirror + - misspell + - mnd + - musttag + - nakedret + - nestif + - nilerr + - nilnesserr + - nilnil + - nlreturn + - noctx + - nolintlint + - nonamedreturns + - nosprintfhostport + - paralleltest + - perfsprint + - prealloc + - predeclared + - promlinter + - protogetter + - reassign + - recvcheck + - revive + - rowserrcheck + - sloglint + - spancheck + - sqlclosecheck + - staticcheck + - stylecheck + - tagalign + - tagliatelle + - testableexamples + - testifylint + - testpackage + - thelper + - tparallel + - unconvert + - unparam + - unused + - usestdlibvars + - usetesting + - varnamelen + - wastedassign + - whitespace + - wrapcheck + - wsl + - zerologlint + - deadcode # Deprecated + - execinquery # Deprecated + - exhaustivestruct # Deprecated + - exportloopref # Deprecated + - golint # Deprecated + - gomnd # Deprecated + - ifshort # Deprecated + - interfacer # Deprecated + - maligned # Deprecated + - nosnakecase # Deprecated + - scopelint # Deprecated + - structcheck # Deprecated + - tenv # Deprecated + - varcheck # Deprecated - # Add a prefix to the output file references. - # Default is no prefix. - path-prefix: "" + # Enable presets. + # https://golangci-lint.run/usage/linters + # Default: [] + presets: + - bugs + - comment + - complexity + - error + - format + - import + - metalinter + - module + - performance + - sql + - style + - test + - unused - # Sort results by: filepath, line and column. - sort-results: false + # Enable only fast linters from enabled linters set (first run won't be fast) + # Default: false + fast: true # All available settings of specific linters. @@ -125,7 +293,7 @@ linters-settings: ignore-test: true bidichk: - # The following configurations check for all mentioned invisible unicode runes. + # The following configurations check for all mentioned invisible Unicode runes. # All runes are enabled by default. left-to-right-embedding: false right-to-left-embedding: false @@ -137,6 +305,11 @@ linters-settings: first-strong-isolate: false pop-directional-isolate: false + copyloopvar: + # Check all assigning the loop variable to another variable. + # Default: false + check-alias: true + cyclop: # The maximal code complexity to report. # Default: 10 @@ -191,30 +364,42 @@ linters-settings: # # Variables: # - File Variables - # you can still use and exclamation mark ! in front of a variable to say not to use it. - # Example !$test will match any file that is not a go test file. + # Use an exclamation mark `!` to negate a variable. + # Example: `!$test` matches any file that is not a go test file. # # `$all` - matches all go files # `$test` - matches all go test files # # - Package Variables # - # `$gostd` - matches all of go's standard library (Pulled from `GOROOT`) + # `$gostd` - matches all of go's standard library (Pulled from `GOROOT`) # - # Default: Only allow $gostd in all files. + # Default (applies if no custom rules are defined): Only allow $gostd in all files. rules: # Name of a rule. main: + # Defines package matching behavior. Available modes: + # - `original`: allowed if it doesn't match the deny list and either matches the allow list or the allow list is empty. + # - `strict`: allowed only if it matches the allow list and either doesn't match the deny list or the allow rule is more specific (longer) than the deny rule. + # - `lax`: allowed if it doesn't match the deny list or the allow rule is more specific (longer) than the deny rule. + # Default: "original" + list-mode: lax # List of file globs that will match this list of settings to compare against. # Default: $all files: - "!**/*_a _file.go" # List of allowed packages. + # Entries can be a variable (starting with $), a string prefix, or an exact match (if ending with $). + # Default: [] allow: - $gostd - github.com/OpenPeeDeeP - # Packages that are not allowed where the value is a suggestion. + # List of packages that are not allowed. + # Entries can be a variable (starting with $), a string prefix, or an exact match (if ending with $). + # Default: [] deny: + - pkg: "math/rand$" + desc: use math/rand/v2 - pkg: "github.com/sirupsen/logrus" desc: not allowed - pkg: "github.com/pkg/errors" @@ -254,23 +439,11 @@ linters-settings: # Default: false check-blank: true - # DEPRECATED comma-separated list of pairs of the form pkg:regex - # - # the regex is used to ignore names within pkg. (default "fmt:.*"). - # see https://github.com/kisielk/errcheck#the-deprecated-method for details - ignore: fmt:.*,io/ioutil:^Read.* - # To disable the errcheck built-in exclude list. # See `-excludeonly` option in https://github.com/kisielk/errcheck#excluding-functions for details. # Default: false disable-default-exclusions: true - # DEPRECATED use exclude-functions instead. - # - # Path to a file containing a list of functions to exclude from checking. - # See https://github.com/kisielk/errcheck#excluding-functions for details. - exclude: /path/to/file.txt - # List of functions to exclude from checking, where each entry is a single function to exclude. # See https://github.com/kisielk/errcheck#excluding-functions for details. exclude-functions: @@ -313,6 +486,16 @@ linters-settings: # Check for plain error comparisons. # Default: true comparison: false + # Allowed errors. + # Default: [] + allowed-errors: + - err: "io.EOF" + fun: "example.com/pkg.Read" + # Allowed error "wildcards". + # Default: [] + allowed-errors-wildcard: + - err: "example.com/pkg.ErrMagic" + fun: "example.com/pkg.Magic" exhaustive: # Program elements to check for exhaustiveness. @@ -344,35 +527,36 @@ linters-settings: # Only run exhaustive check on map literals with "//exhaustive:enforce" comment. # Default: false explicit-exhaustive-map: true - - exhaustivestruct: - # Struct Patterns is list of expressions to match struct packages and names. - # The struct packages have the form `example.com/package.ExampleStruct`. - # The matching patterns can use matching syntax from https://pkg.go.dev/path#Match. - # If this list is empty, all structs are tested. - # Default: [] - struct-patterns: - - '*.Test' - - 'example.com/package.ExampleStruct' + # Switch statement requires default case even if exhaustive. + # Default: false + default-case-required: true exhaustruct: - # List of regular expressions to match struct packages and names. + # List of regular expressions to match struct packages and their names. + # Regular expressions must match complete canonical struct package/name/structname. # If this list is empty, all structs are tested. # Default: [] include: - - '.*\.Test' + - '.+\.Test' - 'example\.com/package\.ExampleStruct[\d]{1,2}' - # List of regular expressions to exclude struct packages and names from check. + # List of regular expressions to exclude struct packages and their names from checks. + # Regular expressions must match complete canonical struct package/name/structname. # Default: [] exclude: - - 'cobra\.Command$' + - '.+/cobra\.Command$' + + fatcontext: + # Check for potential fat contexts in struct pointers. + # May generate false positives. + # Default: false + check-struct-pointers: true forbidigo: # Forbid the following identifiers (list of regexp). # Default: ["^(fmt\\.Print(|f|ln)|print|println)$"] forbid: - # Builtin function: - - ^print.*$ + # Built-in bootstrapping functions. + - ^print(ln)?$ # Optional message that gets included in error reports. - p: ^fmt\.Print.*$ msg: Do not commit print statements. @@ -411,12 +595,9 @@ linters-settings: ignore-comments: true gci: - # DEPRECATED: use `sections` and `prefix(github.com/org/project)` instead. - local-prefixes: github.com/org/project - # Section configuration to compare against. # Section names are case-insensitive and may contain parameters in (). - # The default order of sections is `standard > default > custom > blank > dot`, + # The default order of sections is `standard > default > custom > blank > dot > alias > localmodule`, # If `custom-order` is `true`, it follows the order of `sections` option. # Default: ["standard", "default"] sections: @@ -425,6 +606,16 @@ linters-settings: - prefix(github.com/org/project) # Custom section: groups all imports with the specified Prefix. - blank # Blank section: contains all blank imports. This section is not present unless explicitly enabled. - dot # Dot section: contains all dot imports. This section is not present unless explicitly enabled. + - alias # Alias section: contains all alias imports. This section is not present unless explicitly enabled. + - localmodule # Local module section: contains all local packages. This section is not present unless explicitly enabled. + + # Checks that no inline Comments are present. + # Default: false + no-inline-comments: true + + # Checks that no prefix Comments(comment lines above an import) are present. + # Default: false + no-prefix-comments: true # Skip generated files. # Default: true @@ -435,6 +626,10 @@ linters-settings: # Default: false custom-order: true + # Drops lexical ordering for custom sections. + # Default: false + no-lex-order: true + ginkgolinter: # Suppress the wrong length assertion warning. # Default: false @@ -456,11 +651,11 @@ linters-settings: # Default: false suppress-async-assertion: true - # Suppress warning for comparing values from different types, like int32 and uint32 + # Suppress warning for comparing values from different types, like `int32` and `uint32` # Default: false suppress-type-compare-assertion: true - # Trigger warning for ginkgo focus containers like FDescribe, FContext, FWhen or FIt + # Trigger warning for ginkgo focus containers like `FDescribe`, `FContext`, `FWhen` or `FIt` # Default: false forbid-focus-container: true @@ -468,6 +663,32 @@ linters-settings: # Default: false allow-havelen-zero: true + # Force using `Expect` with `To`, `ToNot` or `NotTo`. + # Reject using `Expect` with `Should` or `ShouldNot`. + # Default: false + force-expect-to: true + + # Best effort validation of async intervals (timeout and polling). + # Ignored the suppress-async-assertion is true. + # Default: false + validate-async-intervals: true + + # Trigger a warning for variable assignments in ginkgo containers like `Describe`, `Context` and `When`, instead of in `BeforeEach()`. + # Default: false + forbid-spec-pollution: true + + # Force using the Succeed matcher for error functions, and the HaveOccurred matcher for non-function error values. + # Default: false + force-succeed: true + + gochecksumtype: + # Presence of `default` case in switch statements satisfies exhaustiveness, if all members are not listed. + # Default: true + default-signifies-exhaustive: false + # Include shared interfaces in the exhaustiviness check. + # Default: false + include-shared-interfaces: true + gocognit: # Minimal code complexity to report. # Default: 30 (but we recommend 10-20) @@ -498,24 +719,456 @@ linters-settings: # Ignore when constant is not used as function argument. # Default: true ignore-calls: false + # Exclude strings matching the given regular expression. + # Default: "" + ignore-strings: 'foo.+' gocritic: - # Which checks should be enabled; can't be combined with 'disabled-checks'. - # See https://go-critic.github.io/overview#checks-overview. - # To check which checks are enabled run `GL_DEBUG=gocritic golangci-lint run`. - # By default, list of stable checks is used. + # Disable all checks. + # Default: false + disable-all: true + # Which checks should be enabled in addition to default checks; can't be combined with 'disabled-checks'. + # By default, list of stable checks is used (https://go-critic.com/overview#checks-overview): + # appendAssign, argOrder, assignOp, badCall, badCond, captLocal, caseOrder, codegenComment, commentFormatting, + # defaultCaseOrder, deprecatedComment, dupArg, dupBranchBody, dupCase, dupSubExpr, elseif, exitAfterDefer, + # flagDeref, flagName, ifElseChain, mapKey, newDeref, offBy1, regexpMust, singleCaseSwitch, sloppyLen, + # sloppyTypeAssert, switchTrue, typeSwitchVar, underef, unlambda, unslice, valSwap, wrapperFunc + # To see which checks are enabled run `GL_DEBUG=gocritic golangci-lint run --enable=gocritic`. enabled-checks: + # Detects suspicious append result assignments. + # https://go-critic.com/overview.html#appendassign + - appendAssign + # Detects `append` chains to the same slice that can be done in a single `append` call. + # https://go-critic.com/overview.html#appendcombine + - appendCombine + # Detects suspicious arguments order. + # https://go-critic.com/overview.html#argorder + - argOrder + # Detects assignments that can be simplified by using assignment operators. + # https://go-critic.com/overview.html#assignop + - assignOp + # Detects suspicious function calls. + # https://go-critic.com/overview.html#badcall + - badCall + # Detects suspicious condition expressions. + # https://go-critic.com/overview.html#badcond + - badCond + # Detects suspicious mutex lock/unlock operations. + # https://go-critic.com/overview.html#badlock + - badLock + # Detects suspicious regexp patterns. + # https://go-critic.com/overview.html#badregexp + - badRegexp + # Detects bad usage of sort package. + # https://go-critic.com/overview.html#badsorting + - badSorting + # Detects bad usage of sync.OnceFunc. + # https://go-critic.com/overview.html#badsynconcefunc + - badSyncOnceFunc + # Detects bool expressions that can be simplified. + # https://go-critic.com/overview.html#boolexprsimplify + - boolExprSimplify + # Detects when predeclared identifiers are shadowed in assignments. + # https://go-critic.com/overview.html#builtinshadow + - builtinShadow + # Detects top-level declarations that shadow the predeclared identifiers. + # https://go-critic.com/overview.html#builtinshadowdecl + - builtinShadowDecl + # Detects capitalized names for local variables. + # https://go-critic.com/overview.html#captlocal + - captLocal + # Detects erroneous case order inside switch statements. + # https://go-critic.com/overview.html#caseorder + - caseOrder + # Detects malformed 'code generated' file comments. + # https://go-critic.com/overview.html#codegencomment + - codegenComment + # Detects comments with non-idiomatic formatting. + # https://go-critic.com/overview.html#commentformatting + - commentFormatting + # Detects commented-out code inside function bodies. + # https://go-critic.com/overview.html#commentedoutcode + - commentedOutCode + # Detects commented-out imports. + # https://go-critic.com/overview.html#commentedoutimport + - commentedOutImport + # Detects when default case in switch isn't on 1st or last position. + # https://go-critic.com/overview.html#defaultcaseorder + - defaultCaseOrder + # Detects loops inside functions that use defer. + # https://go-critic.com/overview.html#deferinloop + - deferInLoop + # Detects deferred function literals that can be simplified. + # https://go-critic.com/overview.html#deferunlambda + - deferUnlambda + # Detects malformed 'deprecated' doc-comments. + # https://go-critic.com/overview.html#deprecatedcomment + - deprecatedComment + # Detects comments that silence go lint complaints about doc-comment. + # https://go-critic.com/overview.html#docstub + - docStub + # Detects suspicious duplicated arguments. + # https://go-critic.com/overview.html#duparg + - dupArg + # Detects duplicated branch bodies inside conditional statements. + # https://go-critic.com/overview.html#dupbranchbody + - dupBranchBody + # Detects duplicated case clauses inside switch or select statements. + # https://go-critic.com/overview.html#dupcase + - dupCase + # Detects multiple imports of the same package under different aliases. + # https://go-critic.com/overview.html#dupimport + - dupImport + # Detects suspicious duplicated sub-expressions. + # https://go-critic.com/overview.html#dupsubexpr + - dupSubExpr + # Detects suspicious formatting strings usage. + # https://go-critic.com/overview.html#dynamicfmtstring + - dynamicFmtString + # Detects else with nested if statement that can be replaced with else-if. + # https://go-critic.com/overview.html#elseif + - elseif + # Detects suspicious empty declarations blocks. + # https://go-critic.com/overview.html#emptydecl + - emptyDecl + # Detects fallthrough that can be avoided by using multi case values. + # https://go-critic.com/overview.html#emptyfallthrough + - emptyFallthrough + # Detects empty string checks that can be written more idiomatically. + # https://go-critic.com/overview.html#emptystringtest + - emptyStringTest + # Detects unoptimal strings/bytes case-insensitive comparison. + # https://go-critic.com/overview.html#equalfold + - equalFold + # Detects unwanted dependencies on the evaluation order. + # https://go-critic.com/overview.html#evalorder + - evalOrder + # Detects calls to exit/fatal inside functions that use defer. + # https://go-critic.com/overview.html#exitafterdefer + - exitAfterDefer + # Detects exposed methods from sync.Mutex and sync.RWMutex. + # https://go-critic.com/overview.html#exposedsyncmutex + - exposedSyncMutex + # Detects suspicious reassignment of error from another package. + # https://go-critic.com/overview.html#externalerrorreassign + - externalErrorReassign + # Detects problems in filepath.Join() function calls. + # https://go-critic.com/overview.html#filepathjoin + - filepathJoin + # Detects immediate dereferencing of `flag` package pointers. + # https://go-critic.com/overview.html#flagderef + - flagDeref + # Detects suspicious flag names. + # https://go-critic.com/overview.html#flagname + - flagName + # Detects hex literals that have mixed case letter digits. + # https://go-critic.com/overview.html#hexliteral + - hexLiteral + # Detects nil usages in http.NewRequest calls, suggesting http.NoBody as an alternative. + # https://go-critic.com/overview.html#httpnobody + - httpNoBody + # Detects params that incur excessive amount of copying. + # https://go-critic.com/overview.html#hugeparam + - hugeParam + # Detects repeated if-else statements and suggests to replace them with switch statement. + # https://go-critic.com/overview.html#ifelsechain + - ifElseChain + # Detects when imported package names shadowed in the assignments. + # https://go-critic.com/overview.html#importshadow + - importShadow + # Detects strings.Index calls that may cause unwanted allocs. + # https://go-critic.com/overview.html#indexalloc + - indexAlloc + # Detects non-assignment statements inside if/switch init clause. + # https://go-critic.com/overview.html#initclause + - initClause + # Detects suspicious map literal keys. + # https://go-critic.com/overview.html#mapkey + - mapKey + # Detects method expression call that can be replaced with a method call. + # https://go-critic.com/overview.html#methodexprcall + - methodExprCall + # Finds where nesting level could be reduced. + # https://go-critic.com/overview.html#nestingreduce - nestingReduce - - unnamedResult + # Detects immediate dereferencing of `new` expressions. + # https://go-critic.com/overview.html#newderef + - newDeref + # Detects return statements those results evaluate to nil. + # https://go-critic.com/overview.html#nilvalreturn + - nilValReturn + # Detects old-style octal literals. + # https://go-critic.com/overview.html#octalliteral + - octalLiteral + # Detects various off-by-one kind of errors. + # https://go-critic.com/overview.html#offby1 + - offBy1 + # Detects if function parameters could be combined by type and suggest the way to do it. + # https://go-critic.com/overview.html#paramtypecombine + - paramTypeCombine + # Detects expressions like []rune(s)[0] that may cause unwanted rune slice allocation. + # https://go-critic.com/overview.html#preferdecoderune + - preferDecodeRune + # Detects concatenation with os.PathSeparator which can be replaced with filepath.Join. + # https://go-critic.com/overview.html#preferfilepathjoin + - preferFilepathJoin + # Detects fmt.Sprint(f/ln) calls which can be replaced with fmt.Fprint(f/ln). + # https://go-critic.com/overview.html#preferfprint + - preferFprint + # Detects w.Write or io.WriteString calls which can be replaced with w.WriteString. + # https://go-critic.com/overview.html#preferstringwriter + - preferStringWriter + # Detects WriteRune calls with rune literal argument that is single byte and reports to use WriteByte instead. + # https://go-critic.com/overview.html#preferwritebyte + - preferWriteByte + # Detects input and output parameters that have a type of pointer to referential type. + # https://go-critic.com/overview.html#ptrtorefparam + - ptrToRefParam + # Detects append all its data while range it. + # https://go-critic.com/overview.html#rangeappendall + - rangeAppendAll + # Detects expensive copies of `for` loop range expressions. + # https://go-critic.com/overview.html#rangeexprcopy + - rangeExprCopy + # Detects loops that copy big objects during each iteration. + # https://go-critic.com/overview.html#rangevalcopy + - rangeValCopy + # Detects redundant fmt.Sprint calls. + # https://go-critic.com/overview.html#redundantsprint + - redundantSprint + # Detects `regexp.Compile*` that can be replaced with `regexp.MustCompile*`. + # https://go-critic.com/overview.html#regexpmust + - regexpMust + # Detects suspicious regexp patterns. + # https://go-critic.com/overview.html#regexppattern + - regexpPattern + # Detects regexp patterns that can be simplified. + # https://go-critic.com/overview.html#regexpsimplify + - regexpSimplify + # Detects suspicious http.Error call without following return. + # https://go-critic.com/overview.html#returnafterhttperror + - returnAfterHttpError + # Runs user-defined rules using ruleguard linter. + # https://go-critic.com/overview.html#ruleguard - ruleguard + # Detects switch statements that could be better written as if statement. + # https://go-critic.com/overview.html#singlecaseswitch + - singleCaseSwitch + # Detects slice clear loops, suggests an idiom that is recognized by the Go compiler. + # https://go-critic.com/overview.html#sliceclear + - sliceClear + # Detects usage of `len` when result is obvious or doesn't make sense. + # https://go-critic.com/overview.html#sloppylen + - sloppyLen + # Detects suspicious/confusing re-assignments. + # https://go-critic.com/overview.html#sloppyreassign + - sloppyReassign + # Detects redundant type assertions. + # https://go-critic.com/overview.html#sloppytypeassert + - sloppyTypeAssert + # Detects suspicious sort.Slice calls. + # https://go-critic.com/overview.html#sortslice + - sortSlice + # Detects "%s" formatting directives that can be replaced with %q. + # https://go-critic.com/overview.html#sprintfquotedstring + - sprintfQuotedString + # Detects issue in Query() and Exec() calls. + # https://go-critic.com/overview.html#sqlquery + - sqlQuery + # Detects string concat operations that can be simplified. + # https://go-critic.com/overview.html#stringconcatsimplify + - stringConcatSimplify + # Detects redundant conversions between string and []byte. + # https://go-critic.com/overview.html#stringxbytes + - stringXbytes + # Detects strings.Compare usage. + # https://go-critic.com/overview.html#stringscompare + - stringsCompare + # Detects switch-over-bool statements that use explicit `true` tag value. + # https://go-critic.com/overview.html#switchtrue + - switchTrue + # Detects sync.Map load+delete operations that can be replaced with LoadAndDelete. + # https://go-critic.com/overview.html#syncmaploadanddelete + - syncMapLoadAndDelete + # Detects manual conversion to milli- or microseconds. + # https://go-critic.com/overview.html#timeexprsimplify + - timeExprSimplify + # Detects TODO comments without detail/assignee. + # https://go-critic.com/overview.html#todocommentwithoutdetail + - todoCommentWithoutDetail + # Detects function with too many results. + # https://go-critic.com/overview.html#toomanyresultschecker + - tooManyResultsChecker + # Detects potential truncation issues when comparing ints of different sizes. + # https://go-critic.com/overview.html#truncatecmp - truncateCmp - + # Detects repeated type assertions and suggests to replace them with type switch statement. + # https://go-critic.com/overview.html#typeassertchain + - typeAssertChain + # Detects method declarations preceding the type definition itself. + # https://go-critic.com/overview.html#typedeffirst + - typeDefFirst + # Detects type switches that can benefit from type guard clause with variable. + # https://go-critic.com/overview.html#typeswitchvar + - typeSwitchVar + # Detects unneeded parenthesis inside type expressions and suggests to remove them. + # https://go-critic.com/overview.html#typeunparen + - typeUnparen + # Detects unchecked errors in if statements. + # https://go-critic.com/overview.html#uncheckedinlineerr + - uncheckedInlineErr + # Detects dereference expressions that can be omitted. + # https://go-critic.com/overview.html#underef + - underef + # Detects redundant statement labels. + # https://go-critic.com/overview.html#unlabelstmt + - unlabelStmt + # Detects function literals that can be simplified. + # https://go-critic.com/overview.html#unlambda + - unlambda + # Detects unnamed results that may benefit from names. + # https://go-critic.com/overview.html#unnamedresult + - unnamedResult + # Detects unnecessary braced statement blocks. + # https://go-critic.com/overview.html#unnecessaryblock + - unnecessaryBlock + # Detects redundantly deferred calls. + # https://go-critic.com/overview.html#unnecessarydefer + - unnecessaryDefer + # Detects slice expressions that can be simplified to sliced expression itself. + # https://go-critic.com/overview.html#unslice + - unslice + # Detects value swapping code that are not using parallel assignment. + # https://go-critic.com/overview.html#valswap + - valSwap + # Detects conditions that are unsafe due to not being exhaustive. + # https://go-critic.com/overview.html#weakcond + - weakCond + # Ensures that `//nolint` comments include an explanation. + # https://go-critic.com/overview.html#whynolint + - whyNoLint + # Detects function calls that can be replaced with convenience wrappers. + # https://go-critic.com/overview.html#wrapperfunc + - wrapperFunc + # Detects Yoda style expressions and suggests to replace them. + # https://go-critic.com/overview.html#yodastyleexpr + - yodaStyleExpr + + # Enable all checks. + # Default: false + enable-all: true # Which checks should be disabled; can't be combined with 'enabled-checks'. # Default: [] disabled-checks: + - appendAssign + - appendCombine + - argOrder + - assignOp + - badCall + - badCond + - badLock + - badRegexp + - badSorting + - badSyncOnceFunc + - boolExprSimplify + - builtinShadow + - builtinShadowDecl + - captLocal + - caseOrder + - codegenComment + - commentFormatting + - commentedOutCode + - commentedOutImport + - defaultCaseOrder + - deferInLoop + - deferUnlambda + - deprecatedComment + - docStub + - dupArg + - dupBranchBody + - dupCase + - dupImport + - dupSubExpr + - dynamicFmtString + - elseif + - emptyDecl + - emptyFallthrough + - emptyStringTest + - equalFold + - evalOrder + - exitAfterDefer + - exposedSyncMutex + - externalErrorReassign + - filepathJoin + - flagDeref + - flagName + - hexLiteral + - httpNoBody + - hugeParam + - ifElseChain + - importShadow + - indexAlloc + - initClause + - mapKey + - methodExprCall + - nestingReduce + - newDeref + - nilValReturn + - octalLiteral + - offBy1 + - paramTypeCombine + - preferDecodeRune + - preferFilepathJoin + - preferFprint + - preferStringWriter + - preferWriteByte + - ptrToRefParam + - rangeAppendAll + - rangeExprCopy + - rangeValCopy + - redundantSprint - regexpMust - - # Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks. + - regexpPattern + - regexpSimplify + - returnAfterHttpError + - ruleguard + - singleCaseSwitch + - sliceClear + - sloppyLen + - sloppyReassign + - sloppyTypeAssert + - sortSlice + - sprintfQuotedString + - sqlQuery + - stringConcatSimplify + - stringXbytes + - stringsCompare + - switchTrue + - syncMapLoadAndDelete + - timeExprSimplify + - todoCommentWithoutDetail + - tooManyResultsChecker + - truncateCmp + - typeAssertChain + - typeDefFirst + - typeSwitchVar + - typeUnparen + - uncheckedInlineErr + - underef + - unlabelStmt + - unlambda + - unnamedResult + - unnecessaryBlock + - unnecessaryDefer + - unslice + - valSwap + - weakCond + - whyNoLint + - wrapperFunc + - yodaStyleExpr + + # Enable multiple checks by tags in addition to default checks. + # Run `GL_DEBUG=gocritic golangci-lint run --enable=gocritic` to see all tags and checks. # See https://github.com/go-critic/go-critic#usage -> section "Tags". # Default: [] enabled-tags: @@ -533,13 +1186,17 @@ linters-settings: # Settings passed to gocritic. # The settings key is the name of a supported gocritic checker. - # The list of supported checkers can be find in https://go-critic.github.io/overview. + # The list of supported checkers can be find in https://go-critic.com/overview. settings: # Must be valid enabled check name. captLocal: # Whether to restrict checker to params only. # Default: true paramsOnly: false + commentedOutCode: + # Min length of the comment that triggers a warning. + # Default: 15 + minLength: 50 elseif: # Whether to skip balanced if-else pairs. # Default: true @@ -548,6 +1205,10 @@ linters-settings: # Size in bytes that makes the warning trigger. # Default: 80 sizeThreshold: 70 + ifElseChain: + # Min number of if-else blocks that makes the warning trigger. + # Default: 2 + minThreshold: 4 nestingReduce: # Min number of statements inside a branch to trigger a warning. # Default: 5 @@ -577,12 +1238,9 @@ linters-settings: # Then: # ruleguard prints the specific Where() condition that was rejected. # - # The flag is passed to the ruleguard 'debug-group' argument. + # The option is passed to the ruleguard 'debug-group' argument. # Default: "" debug: 'emptyDecl' - # Deprecated, use 'failOn' param. - # If set to true, identical to failOn='all', otherwise failOn='' - failOnError: false # Determines the behavior when an error occurs while parsing ruleguard files. # If flag is not set, log error and skip rule files that contain an error. # If flag is set, the value must be a comma-separated list of error conditions. @@ -590,10 +1248,10 @@ linters-settings: # - 'import': ruleguard rule imports a package that cannot be found. # - 'dsl': gorule file does not comply with the ruleguard DSL. # Default: "" - failOn: dsl + failOn: dsl,import # Comma-separated list of file paths containing ruleguard rules. # If a path is relative, it is relative to the directory where the golangci-lint command is executed. - # The special '${configDir}' variable is substituted with the absolute directory containing the golangci config file. + # The special '${configDir}' variable is substituted with the absolute directory containing the golangci-lint config file. # Glob patterns such as 'rules-*.go' may be specified. # Default: "" rules: '${configDir}/ruleguard/rules-*.go,${configDir}/myrule1.go' @@ -628,7 +1286,7 @@ linters-settings: min-complexity: 10 godot: - # Comments to be checked: `declarations`, `toplevel`, or `all`. + # Comments to be checked: `declarations`, `toplevel`, `noinline` or `all`. # Default: declarations scope: toplevel # List of regexps for excluding particular comment lines from check. @@ -667,9 +1325,6 @@ linters-settings: replacement: 'a[b:]' gofumpt: - # Deprecated: use the global `run.go` instead. - lang-version: "1.17" - # Module path which contains the source code being formatted. # Default: "" module-path: github.com/org/project @@ -691,27 +1346,25 @@ linters-settings: # Define here regexp type values. # for example: AUTHOR: .*@mycompany\.com - # The template use for checking. + # The template used for checking. + # Put here copyright header template for source code files + # Note: {{ YEAR }} is a builtin value that returns the year relative to the current machine time. # Default: "" template: |- - # Put here copyright header template for source code files - # For example: - # Note: {{ YEAR }} is a builtin value that returns the year relative to the current machine time. - # - # {{ AUTHOR }} {{ COMPANY }} {{ YEAR }} - # SPDX-License-Identifier: Apache-2.0 - - # Licensed under the Apache License, Version 2.0 (the "License"); - # you may not use this file except in compliance with the License. - # You may obtain a copy of the License at: - - # http://www.apache.org/licenses/LICENSE-2.0 - - # Unless required by applicable law or agreed to in writing, software - # distributed under the License is distributed on an "AS IS" BASIS, - # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - # See the License for the specific language governing permissions and - # limitations under the License. + {{ AUTHOR }} {{ COMPANY }} {{ YEAR }} + SPDX-License-Identifier: Apache-2.0 + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at: + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. # As alternative of directive 'template', you may put the path to file with the template source. # Useful if you need to load the template from a specific file. # Default: "" @@ -723,57 +1376,35 @@ linters-settings: # Default: "" local-prefixes: github.com/org/project - golint: - # Minimal confidence for issues. - # Default: 0.8 - min-confidence: 0.7 - - gomnd: - # List of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description. - # Default: ["argument", "case", "condition", "operation", "return", "assign"] - checks: - - argument - - case - - condition - - operation - - return - - assign - # List of numbers to exclude from analysis. - # The numbers should be written as string. - # Values always ignored: "1", "1.0", "0" and "0.0" - # Default: [] - ignored-numbers: - - '0666' - - '0755' - - '42' - # List of file patterns to exclude from analysis. - # Values always ignored: `.+_test.go` - # Default: [] - ignored-files: - - 'magic1_.+\.go$' - # List of function patterns to exclude from analysis. - # Following functions are always ignored: `time.Date`, - # `strconv.FormatInt`, `strconv.FormatUint`, `strconv.FormatFloat`, - # `strconv.ParseInt`, `strconv.ParseUint`, `strconv.ParseFloat`. - # Default: [] - ignored-functions: - - '^math\.' - - '^http\.StatusText$' - gomoddirectives: # Allow local `replace` directives. # Default: false - replace-local: false + replace-local: true # List of allowed `replace` directives. # Default: [] replace-allow-list: - launchpad.net/gocheck # Allow to not explain why the version has been retracted in the `retract` directives. # Default: false - retract-allow-no-explanation: false + retract-allow-no-explanation: true # Forbid the use of the `exclude` directives. # Default: false - exclude-forbidden: false + exclude-forbidden: true + # Forbid the use of the `toolchain` directive. + # Default: false + toolchain-forbidden: true + # Defines a pattern to validate `toolchain` directive. + # Default: '' (no match) + toolchain-pattern: 'go1\.23\.\d+$' + # Forbid the use of the `tool` directives. + # Default: false + tool-forbidden: true + # Forbid the use of the `godebug` directive. + # Default: false + go-debug-forbidden: true + # Defines a pattern to validate `go` minimum version directive. + # Default: '' (no match) + go-version-pattern: '\d\.\d+(\.0)?' gomodguard: allowed: @@ -810,11 +1441,114 @@ linters-settings: local_replace_directives: false gosimple: - # Deprecated: use the global `run.go` instead. - go: "1.15" - # Sxxxx checks in https://staticcheck.io/docs/configuration/options/#checks + # Sxxxx checks in https://staticcheck.dev/docs/configuration/options/#checks # Default: ["*"] - checks: [ "all" ] + checks: + # Use plain channel send or receive instead of single-case select. + # https://staticcheck.dev/docs/checks/#S1000 + - S1000 + # Replace for loop with call to copy. + # https://staticcheck.dev/docs/checks/#S1001 + - S1001 + # Omit comparison with boolean constant. + # https://staticcheck.dev/docs/checks/#S1002 + - S1002 + # Replace call to 'strings.Index' with 'strings.Contains'. + # https://staticcheck.dev/docs/checks/#S1003 + - S1003 + # Replace call to 'bytes.Compare' with 'bytes.Equal'. + # https://staticcheck.dev/docs/checks/#S1004 + - S1004 + # Drop unnecessary use of the blank identifier. + # https://staticcheck.dev/docs/checks/#S1005 + - S1005 + # Use "for { ... }" for infinite loops. + # https://staticcheck.dev/docs/checks/#S1006 + - S1006 + # Simplify regular expression by using raw string literal. + # https://staticcheck.dev/docs/checks/#S1007 + - S1007 + # Simplify returning boolean expression. + # https://staticcheck.dev/docs/checks/#S1008 + - S1008 + # Omit redundant nil check on slices, maps, and channels. + # https://staticcheck.dev/docs/checks/#S1009 + - S1009 + # Omit default slice index. + # https://staticcheck.dev/docs/checks/#S1010 + - S1010 + # Use a single 'append' to concatenate two slices. + # https://staticcheck.dev/docs/checks/#S1011 + - S1011 + # Replace 'time.Now().Sub(x)' with 'time.Since(x)'. + # https://staticcheck.dev/docs/checks/#S1012 + - S1012 + # Use a type conversion instead of manually copying struct fields. + # https://staticcheck.dev/docs/checks/#S1016 + - S1016 + # Replace manual trimming with 'strings.TrimPrefix'. + # https://staticcheck.dev/docs/checks/#S1017 + - S1017 + # Use "copy" for sliding elements. + # https://staticcheck.dev/docs/checks/#S1018 + - S1018 + # Simplify "make" call by omitting redundant arguments. + # https://staticcheck.dev/docs/checks/#S1019 + - S1019 + # Omit redundant nil check in type assertion. + # https://staticcheck.dev/docs/checks/#S1020 + - S1020 + # Merge variable declaration and assignment. + # https://staticcheck.dev/docs/checks/#S1021 + - S1021 + # Omit redundant control flow. + # https://staticcheck.dev/docs/checks/#S1023 + - S1023 + # Replace 'x.Sub(time.Now())' with 'time.Until(x)'. + # https://staticcheck.dev/docs/checks/#S1024 + - S1024 + # Don't use 'fmt.Sprintf("%s", x)' unnecessarily. + # https://staticcheck.dev/docs/checks/#S1025 + - S1025 + # Simplify error construction with 'fmt.Errorf'. + # https://staticcheck.dev/docs/checks/#S1028 + - S1028 + # Range over the string directly. + # https://staticcheck.dev/docs/checks/#S1029 + - S1029 + # Use 'bytes.Buffer.String' or 'bytes.Buffer.Bytes'. + # https://staticcheck.dev/docs/checks/#S1030 + - S1030 + # Omit redundant nil check around loop. + # https://staticcheck.dev/docs/checks/#S1031 + - S1031 + # Use 'sort.Ints(x)', 'sort.Float64s(x)', and 'sort.Strings(x)'. + # https://staticcheck.dev/docs/checks/#S1032 + - S1032 + # Unnecessary guard around call to "delete". + # https://staticcheck.dev/docs/checks/#S1033 + - S1033 + # Use result of type assertion to simplify cases. + # https://staticcheck.dev/docs/checks/#S1034 + - S1034 + # Redundant call to 'net/http.CanonicalHeaderKey' in method call on 'net/http.Header'. + # https://staticcheck.dev/docs/checks/#S1035 + - S1035 + # Unnecessary guard around map access. + # https://staticcheck.dev/docs/checks/#S1036 + - S1036 + # Elaborate way of sleeping. + # https://staticcheck.dev/docs/checks/#S1037 + - S1037 + # Unnecessarily complex way of printing formatted string. + # https://staticcheck.dev/docs/checks/#S1038 + - S1038 + # Unnecessary use of 'fmt.Sprint'. + # https://staticcheck.dev/docs/checks/#S1039 + - S1039 + # Type assertion to current type. + # https://staticcheck.dev/docs/checks/#S1040 + - S1040 gosec: # To select a subset of rules to run. @@ -834,6 +1568,7 @@ linters-settings: - G112 # Potential slowloris attack - G113 # Usage of Rat.SetString in math/big with an overflow (CVE-2022-23772) - G114 # Use of net/http serve function that has no support for setting timeouts + - G115 # Potential integer overflow when converting between integer types - G201 # SQL query construction using format string - G202 # SQL query construction using string concatenation - G203 # Use of unescaped data in HTML templates @@ -845,15 +1580,19 @@ linters-settings: - G305 # File traversal when extracting zip/tar archive - G306 # Poor file permissions used when writing to a new file - G307 # Poor file permissions used when creating a file with os.Create - - G401 # Detect the usage of DES, RC4, MD5 or SHA1 + - G401 # Detect the usage of MD5 or SHA1 - G402 # Look for bad TLS connection settings - G403 # Ensure minimum RSA key length of 2048 bits - G404 # Insecure random number source (rand) + - G405 # Detect the usage of DES or RC4 + - G406 # Detect the usage of MD4 or RIPEMD160 - G501 # Import blocklist: crypto/md5 - G502 # Import blocklist: crypto/des - G503 # Import blocklist: crypto/rc4 - G504 # Import blocklist: net/http/cgi - G505 # Import blocklist: crypto/sha1 + - G506 # Import blocklist: golang.org/x/crypto/md4 + - G507 #Import blocklist: golang.org/x/crypto/ripemd160 - G601 # Implicit memory aliasing of items from a range statement - G602 # Slice access out of bounds @@ -874,6 +1613,7 @@ linters-settings: - G112 # Potential slowloris attack - G113 # Usage of Rat.SetString in math/big with an overflow (CVE-2022-23772) - G114 # Use of net/http serve function that has no support for setting timeouts + - G115 # Potential integer overflow when converting between integer types - G201 # SQL query construction using format string - G202 # SQL query construction using string concatenation - G203 # Use of unescaped data in HTML templates @@ -885,15 +1625,19 @@ linters-settings: - G305 # File traversal when extracting zip/tar archive - G306 # Poor file permissions used when writing to a new file - G307 # Poor file permissions used when creating a file with os.Create - - G401 # Detect the usage of DES, RC4, MD5 or SHA1 + - G401 # Detect the usage of MD5 or SHA1 - G402 # Look for bad TLS connection settings - G403 # Ensure minimum RSA key length of 2048 bits - G404 # Insecure random number source (rand) + - G405 # Detect the usage of DES or RC4 + - G406 # Detect the usage of MD4 or RIPEMD160 - G501 # Import blocklist: crypto/md5 - G502 # Import blocklist: crypto/des - G503 # Import blocklist: crypto/rc4 - G504 # Import blocklist: net/http/cgi - G505 # Import blocklist: crypto/sha1 + - G506 # Import blocklist: golang.org/x/crypto/md4 + - G507 #Import blocklist: golang.org/x/crypto/ripemd160 - G601 # Implicit memory aliasing of items from a range statement - G602 # Slice access out of bounds @@ -1023,40 +1767,6 @@ linters-settings: - Katakana govet: - # Report about shadowed variables. - # Default: false - check-shadowing: true - - # Settings per analyzer. - settings: - # Analyzer name, run `go tool vet help` to see all analyzers. - printf: - # Comma-separated list of print function names to check (in addition to default, see `go tool vet help printf`). - # Default: [] - funcs: - - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof - - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf - - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf - - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf - shadow: - # Whether to be strict about shadowing; can be noisy. - # Default: false - strict: true - unusedresult: - # Comma-separated list of functions whose results must be used - # (in addition to default: - # context.WithCancel, context.WithDeadline, context.WithTimeout, context.WithValue, errors.New, fmt.Errorf, - # fmt.Sprint, fmt.Sprintf, sort.Reverse - # ). - # Default: [] - funcs: - - pkg.MyFunc - # Comma-separated list of names of methods of type func() string whose results must be used - # (in addition to default Error,String) - # Default: [] - stringmethods: - - MyMethod - # Disable all analyzers. # Default: false disable-all: true @@ -1067,49 +1777,95 @@ linters-settings: # stdmethods, stringintconv, structtag, testinggoroutine, tests, timeformat, unmarshal, unreachable, unsafeptr, # unusedresult # ). - # Run `go tool vet help` to see all analyzers. + # Run `GL_DEBUG=govet golangci-lint run --enable=govet` to see default, all available analyzers, and enabled analyzers. # Default: [] enable: + # Check for missing values after append. - appends + # Report mismatches between assembly files and Go declarations. - asmdecl + # Check for useless assignments. - assign + # Check for common mistakes using the sync/atomic package. - atomic + # Check for non-64-bits-aligned arguments to sync/atomic functions. - atomicalign + # Check for common mistakes involving boolean operators. - bools + # Check //go:build and // +build directives. - buildtag + # Detect some violations of the cgo pointer passing rules. - cgocall + # Check for unkeyed composite literals. - composites + # Check for locks erroneously passed by value. - copylocks + # Check for calls of reflect.DeepEqual on error values. - deepequalerrors + # Report common mistakes in defer statements. - defers + # Check Go toolchain directives such as //go:debug. - directive + # Report passing non-pointer or non-error values to errors.As. - errorsas + # Find structs that would use less memory if their fields were sorted. - fieldalignment + # Find calls to a particular function. - findcall + # Report assembly that clobbers the frame pointer before saving it. - framepointer + # Check for mistakes using HTTP responses. - httpresponse + # Detect impossible interface-to-interface type assertions. - ifaceassert + # Check references to loop variables from within nested functions. - loopclosure + # Check cancel func returned by context.WithCancel is called. - lostcancel + # Check for useless comparisons between functions and nil. - nilfunc + # Check for redundant or impossible nil comparisons. - nilness + # Check consistency of Printf format strings and arguments. - printf + # Check for comparing reflect.Value values with == or reflect.DeepEqual. - reflectvaluecompare + # Check for possible unintended shadowing of variables. - shadow + # Check for shifts that equal or exceed the width of the integer. - shift + # Check for unbuffered channel of os.Signal. - sigchanyzer + # Check for invalid structured logging calls. - slog + # Check the argument type of sort.Slice. - sortslice + # Check signature of methods of well-known interfaces. - stdmethods + # Report uses of too-new standard library symbols. + - stdversion + # Check for string(int) conversions. - stringintconv + # Check that struct field tags conform to reflect.StructTag.Get. - structtag + # Report calls to (*testing.T).Fatal from goroutines started by a test. - testinggoroutine + # Check for common mistaken usages of tests and examples. - tests + # Check for calls of (time.Time).Format or time.Parse with 2006-02-01. + - timeformat + # Report passing non-pointer or non-interface values to unmarshal. - unmarshal + # Check for unreachable code. - unreachable + # Check for invalid conversions of uintptr to unsafe.Pointer. - unsafeptr + # Check for unused results of calls to some functions. - unusedresult + # Checks for unused writes. - unusedwrite + # Check for misuses of sync.WaitGroup. + - waitgroup # Enable all analyzers. # Default: false @@ -1119,7 +1875,7 @@ linters-settings: # atomicalign, deepequalerrors, fieldalignment, findcall, nilness, reflectvaluecompare, shadow, sortslice, # timeformat, unusedwrite # ). - # Run `go tool vet help` to see all analyzers. + # Run `GL_DEBUG=govet golangci-lint run --enable=govet` to see default, all available analyzers, and enabled analyzers. # Default: [] disable: - appends @@ -1153,15 +1909,48 @@ linters-settings: - slog - sortslice - stdmethods + - stdversion - stringintconv - structtag - testinggoroutine - tests + - timeformat - unmarshal - unreachable - unsafeptr - unusedresult - unusedwrite + - waitgroup + + # Settings per analyzer. + settings: + # Analyzer name, run `go tool vet help` to see all analyzers. + printf: + # Comma-separated list of print function names to check (in addition to default, see `go tool vet help printf`). + # Default: [] + funcs: + - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof + - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf + - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf + - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf + shadow: + # Whether to be strict about shadowing; can be noisy. + # Default: false + strict: true + unusedresult: + # Comma-separated list of functions whose results must be used + # (in addition to default: + # context.WithCancel, context.WithDeadline, context.WithTimeout, context.WithValue, errors.New, fmt.Errorf, + # fmt.Sprint, fmt.Sprintf, sort.Reverse + # ). + # Default: [] + funcs: + - pkg.MyFunc + # Comma-separated list of names of methods of type func() string whose results must be used + # (in addition to default Error,String) + # Default: [] + stringmethods: + - MyMethod grouper: # Require the use of a single global 'const' declaration only. @@ -1192,14 +1981,19 @@ linters-settings: # Default: false var-require-grouping: true - ifshort: - # Maximum length of variable declaration measured in number of lines, after which linter won't suggest using short syntax. - # Has higher priority than max-decl-chars. - # Default: 1 - max-decl-lines: 2 - # Maximum length of variable declaration measured in number of characters, after which linter won't suggest using short syntax. - # Default: 30 - max-decl-chars: 40 + iface: + # List of analyzers. + # Default: ["identical"] + enable: + - identical # Identifies interfaces in the same package that have identical method sets. + - unused # Identifies interfaces that are not used anywhere in the same package where the interface is defined. + - opaque # Identifies functions that return interfaces, but the actual returned value is always a single concrete implementation. + settings: + unused: + # List of packages path to exclude from the check. + # Default: [] + exclude: + - github.com/example/log importas: # Do not allow unaliased imports of aliased packages. @@ -1222,6 +2016,16 @@ linters-settings: # see https://github.com/julz/importas#use-regular-expression for details - pkg: knative.dev/serving/pkg/apis/(\w+)/(v[\w\d]+) alias: $1$2 + # An explicit empty alias can be used to ensure no aliases are used for a package. + # This can be useful if `no-extra-aliases: true` doesn't fit your need. + # Multiple packages can use an empty alias. + - pkg: errors + alias: "" + + inamedparam: + # Skips check for interface methods with only a single parameter. + # Default: false + skip-single-param: true interfacebloat: # The maximum number of methods allowed for an interface. @@ -1229,26 +2033,35 @@ linters-settings: max: 5 ireturn: - # ireturn does not allow using `allow` and `reject` settings at the same time. - # Both settings are lists of the keywords and regular expressions matched to interface or package names. - # keywords: + # List of interfaces to allow. + # Lists of the keywords and regular expressions matched to interface or package names can be used. + # `allow` and `reject` settings cannot be used at the same time. + # + # Keywords: # - `empty` for `interface{}` # - `error` for errors # - `stdlib` for standard library # - `anon` for anonymous interfaces # - `generic` for generic interfaces added in go 1.18 - - # By default, it allows using errors, empty interfaces, anonymous interfaces, - # and interfaces provided by the standard library. + # + # Default: [anon, error, empty, stdlib] allow: - anon - - error - - empty - - stdlib # You can specify idiomatic endings for interface - (or|er)$ - # reject-list of interfaces + # List of interfaces to reject. + # Lists of the keywords and regular expressions matched to interface or package names can be used. + # `allow` and `reject` settings cannot be used at the same time. + # + # Keywords: + # - `empty` for `interface{}` + # - `error` for errors + # - `stdlib` for standard library + # - `anon` for anonymous interfaces + # - `generic` for generic interfaces added in go 1.18 + # + # Default: [] reject: - github.com\/user\/package\/v4\.Type @@ -1271,6 +2084,9 @@ linters-settings: # Allow check for the github.com/go-logr/logr library. # Default: true logr: false + # Allow check for the log/slog library. + # Default: true + slog: false # Allow check for the "sugar logger" from go.uber.org/zap library. # Default: true zap: false @@ -1299,25 +2115,68 @@ linters-settings: # Default: false always: true - maligned: - # Print struct with more effective memory layout or not. - # Default: false - suggest-new: true - misspell: # Correct spellings using locale preferences for US or UK. # Setting locale to US will correct the British spelling of 'colour' to 'color'. # Default is to use a neutral variety of English. locale: US + # Typos to ignore. + # Should be in lower case. # Default: [] ignore-words: - someword + # Extra word corrections. + # `typo` and `correction` should only contain letters. + # The words are case-insensitive. + # Default: [] + extra-words: + - typo: "iff" + correction: "if" + - typo: "cancelation" + correction: "cancellation" + # Mode of the analysis: + # - default: checks all the file content. + # - restricted: checks only comments. + # Default: "" + mode: restricted + + mnd: + # List of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description. + # Default: ["argument", "case", "condition", "operation", "return", "assign"] + checks: + - argument + - case + - condition + - operation + - return + - assign + # List of numbers to exclude from analysis. + # The numbers should be written as string. + # Values always ignored: "1", "1.0", "0" and "0.0" + # Default: [] + ignored-numbers: + - '0666' + - '0755' + - '42' + # List of file patterns to exclude from analysis. + # Values always ignored: `.+_test.go` + # Default: [] + ignored-files: + - 'magic1_.+\.go$' + # List of function patterns to exclude from analysis. + # Following functions are always ignored: `time.Date`, + # `strconv.FormatInt`, `strconv.FormatUint`, `strconv.FormatFloat`, + # `strconv.ParseInt`, `strconv.ParseUint`, `strconv.ParseFloat`. + # Default: [] + ignored-functions: + - '^math\.' + - '^http\.StatusText$' musttag: # A set of custom functions to check in addition to the builtin ones. # Default: json, xml, gopkg.in/yaml.v3, BurntSushi/toml, mitchellh/mapstructure, jmoiron/sqlx functions: - # The full name of the function, including the package. + # The full name of the function, including the package. - name: github.com/hashicorp/hcl/v2/hclsimple.DecodeFile # The struct tag whose presence should be ensured. tag: hcl @@ -1335,14 +2194,19 @@ linters-settings: min-complexity: 4 nilnil: - # Checks that there is no simultaneous return of `nil` error and an invalid value. - # Default: ["ptr", "func", "iface", "map", "chan"] + # In addition, detect opposite situation (simultaneous return of non-nil error and valid value). + # Default: false + detect-opposite: true + # List of return types to check. + # Default: ["chan", "func", "iface", "map", "ptr", "uintptr", "unsafeptr"] checked-types: - - ptr + - chan - func - iface - map - - chan + - ptr + - uintptr + - unsafeptr nlreturn: # Size of the block (including return statement that is still "OK") @@ -1377,6 +2241,37 @@ linters-settings: # still required to have `t.Parallel`, but subtests are allowed to skip it. # Default: false ignore-missing-subtests: true + perfsprint: + # Enable/disable optimization of integer formatting. + # Default: true + integer-format: false + # Optimizes even if it requires an int or uint type cast. + # Default: true + int-conversion: false + # Enable/disable optimization of error formatting. + # Default: true + error-format: false + # Optimizes into `err.Error()` even if it is only equivalent for non-nil errors. + # Default: false + err-error: true + # Optimizes `fmt.Errorf`. + # Default: true + errorf: false + # Enable/disable optimization of string formatting. + # Default: true + string-format: false + # Optimizes `fmt.Sprintf` with only one argument. + # Default: true + sprintf1: false + # Optimizes into strings concatenation. + # Default: true + strconcat: false + # Enable/disable optimization of bool formatting. + # Default: true + bool-format: false + # Enable/disable optimization of hex formatting. + # Default: true + hex-format: false prealloc: # IMPORTANT: we don't recommend using this linter before doing performance profiling. @@ -1408,15 +2303,43 @@ linters-settings: # Please refer to https://github.com/yeya24/promlinter#usage for detailed usage. # Default: [] disabled-linters: + # Help detects issues related to the help text for a metric. - Help + # MetricUnits detects issues with metric unit names. - MetricUnits + # Counter detects issues specific to counters, as well as patterns that should only be used with counters. - Counter + # HistogramSummaryReserved detects when other types of metrics use names or labels reserved for use by histograms and/or summaries. - HistogramSummaryReserved + # MetricTypeInName detects when metric types are included in the metric name. - MetricTypeInName + # ReservedChars detects colons in metric names. - ReservedChars + # CamelCase detects metric names and label names written in camelCase. - CamelCase + # UnitAbbreviations detects abbreviated units in the metric name. - UnitAbbreviations + + protogetter: + # Skip files generated by specified generators from the checking. + # Checks only the file's initial comment, which must follow the format: "// Code generated by ". + # Files generated by protoc-gen-go, protoc-gen-go-grpc, and protoc-gen-grpc-gateway are always excluded automatically. + # Default: [] + skip-generated-by: ["protoc-gen-go-my-own-generator"] + # Skip files matching the specified glob pattern from the checking. + # Default: [] + skip-files: + - "*.pb.go" + - "*/vendor/*" + - "/full/path/to/file.go" + # Skip any generated files from the checking. + # Default: false + skip-any-generated: true + # Skip first argument of append function. + # Default: false + replace-first-arg-in-append: true + reassign: # Patterns for global variable names that are checked for reassignment. # See https://github.com/curioswitch/go-reassign#usage @@ -1424,6 +2347,23 @@ linters-settings: patterns: - ".*" + recvcheck: + # Disables the built-in method exclusions: + # - `MarshalText` + # - `MarshalJSON` + # - `MarshalYAML` + # - `MarshalXML` + # - `MarshalBinary` + # - `GobEncode` + # Default: false + disable-builtin: true + # User-defined method exclusions. + # The format is `struct_name.method_name` (ex: `Foo.MethodName`). + # A wildcard `*` can use as a struct name (ex: `*.MethodName`). + # Default: [] + exclusions: + - "*.Value" + revive: # Maximum number of open files at the same time. # See https://github.com/mgechev/revive#command-line-flags @@ -1431,7 +2371,7 @@ linters-settings: max-open-files: 2048 # When set to false, ignores files with "GENERATED" header, similar to golint. - # See https://github.com/mgechev/revive#available-rules for details. + # See https://github.com/mgechev/revive#configuration for details. # Default: false ignore-generated-header: true @@ -1444,277 +2384,389 @@ linters-settings: # Default: false enable-all-rules: true + # Enable validation of comment directives. + # See https://github.com/mgechev/revive#comment-directives + directives: + - name: specify-disable-reason + severity: error + # Sets the default failure confidence. # This means that linting errors with less than 0.8 confidence will be ignored. # Default: 0.8 confidence: 0.1 - + # Run `GL_DEBUG=revive golangci-lint run --enable-only=revive` to see default, all available rules, and enabled rules. rules: - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#add-constant + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#add-constant - name: add-constant severity: warning disabled: false + exclude: [""] arguments: - maxLitCount: "3" allowStrs: '""' allowInts: "0,1,2" allowFloats: "0.0,0.,1.0,1.,2.0,2." - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#argument-limit + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#argument-limit - name: argument-limit severity: warning disabled: false + exclude: [""] arguments: [ 4 ] - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#atomic + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#atomic - name: atomic severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#banned-characters + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#banned-characters - name: banned-characters severity: warning disabled: false + exclude: [""] arguments: [ "Ω","Σ","σ", "7" ] - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#bare-return + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#bare-return - name: bare-return severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#blank-imports + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#blank-imports - name: blank-imports severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#bool-literal-in-expr + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#bool-literal-in-expr - name: bool-literal-in-expr severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#call-to-gc + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#call-to-gc - name: call-to-gc severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#cognitive-complexity + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#cognitive-complexity - name: cognitive-complexity severity: warning disabled: false + exclude: [""] arguments: [ 7 ] - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#comment-spacings + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#comment-spacings - name: comment-spacings severity: warning disabled: false + exclude: [""] arguments: - mypragma - otherpragma - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#confusing-naming + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#comments-density + - name: comments-density + severity: warning + disabled: false + exclude: [""] + arguments: [ 15 ] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#confusing-naming - name: confusing-naming severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#confusing-results + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#confusing-results - name: confusing-results severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#constant-logical-expr + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#constant-logical-expr - name: constant-logical-expr severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#context-as-argument + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#context-as-argument - name: context-as-argument severity: warning disabled: false + exclude: [""] arguments: - allowTypesBefore: "*testing.T,*github.com/user/repo/testing.Harness" - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#context-keys-type + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#context-keys-type - name: context-keys-type severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#cyclomatic + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#cyclomatic - name: cyclomatic severity: warning disabled: false + exclude: [""] arguments: [ 3 ] - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#datarace + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#datarace - name: datarace severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#deep-exit + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#deep-exit - name: deep-exit severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#defer + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#defer - name: defer severity: warning disabled: false + exclude: [""] arguments: - [ "call-chain", "loop" ] - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#dot-imports + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#dot-imports - name: dot-imports severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#duplicated-imports + exclude: [""] + arguments: [ ] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#duplicated-imports - name: duplicated-imports severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#early-return + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#early-return - name: early-return severity: warning disabled: false + exclude: [""] arguments: - "preserveScope" - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#empty-block + - "allowJump" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#empty-block - name: empty-block severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#empty-lines + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#empty-lines - name: empty-lines severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#enforce-map-style + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#enforce-map-style - name: enforce-map-style severity: warning disabled: false + exclude: [""] + arguments: + - "make" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#enforce-repeated-arg-type-style + - name: enforce-repeated-arg-type-style + severity: warning + disabled: false + exclude: [""] + arguments: + - "short" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#enforce-slice-style + - name: enforce-slice-style + severity: warning + disabled: false + exclude: [""] arguments: - "make" - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-naming + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#error-naming - name: error-naming severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-return + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#error-return - name: error-return severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-strings + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#error-strings - name: error-strings severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#errorf + exclude: [""] + arguments: + - "xerrors.New" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#errorf - name: errorf severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#exported + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#exported - name: exported severity: warning disabled: false + exclude: [""] arguments: - - "preserveScope" - "checkPrivateReceivers" - - "sayRepetitiveInsteadOfStutters" - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#file-header + - "disableStutteringCheck" + - "checkPublicInterface" + - "disableChecksOnFunctions" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#file-header - name: file-header severity: warning disabled: false + exclude: [""] arguments: - This is the text that must appear at the top of source files. - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#flag-parameter - - name: flag-parameter + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#file-length-limit + - name: file-length-limit severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#function-result-limit - - name: function-result-limit + exclude: [""] + arguments: + - max: 100 + skipComments: true + skipBlankLines: true + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#filename-format + - name: filename-format severity: warning disabled: false - arguments: [ 2 ] - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#function-length + exclude: [""] + arguments: + - "^[_a-z][_a-z0-9]*\\.go$" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#flag-parameter + - name: flag-parameter + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#function-length - name: function-length severity: warning disabled: false + exclude: [""] arguments: [ 10, 0 ] - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#get-return + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#function-result-limit + - name: function-result-limit + severity: warning + disabled: false + exclude: [""] + arguments: [ 3 ] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#get-return - name: get-return severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#identical-branches + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#identical-branches - name: identical-branches severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#if-return + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#if-return - name: if-return severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#increment-decrement - - name: increment-decrement + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#import-alias-naming + - name: import-alias-naming severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#indent-error-flow - - name: indent-error-flow + exclude: [""] + arguments: + - "^[a-z][a-z0-9]{0,}$" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#import-shadowing + - name: import-shadowing severity: warning disabled: false - arguments: - - "preserveScope" - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#import-alias-naming - - name: import-alias-naming + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#imports-blocklist + - name: imports-blocklist severity: warning disabled: false + exclude: [""] arguments: - - "^[a-z][a-z0-9]{0,}$" - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#imports-blacklist - - name: imports-blacklist + - "crypto/md5" + - "crypto/sha1" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#increment-decrement + - name: increment-decrement + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#indent-error-flow + - name: indent-error-flow severity: warning disabled: false + exclude: [""] arguments: - - "crypto/md5" - - "crypto/sha1" - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#import-shadowing - - name: import-shadowing - severity: warning - disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#line-length-limit + - "preserveScope" + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#line-length-limit - name: line-length-limit severity: warning disabled: false + exclude: [""] arguments: [ 80 ] - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#max-public-structs + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#max-control-nesting + - name: max-control-nesting + severity: warning + disabled: false + exclude: [""] + arguments: [ 3 ] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#max-public-structs - name: max-public-structs severity: warning disabled: false + exclude: [""] arguments: [ 3 ] - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#modifies-parameter + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#modifies-parameter - name: modifies-parameter severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#modifies-value-receiver + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#modifies-value-receiver - name: modifies-value-receiver severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#nested-structs + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#nested-structs - name: nested-structs severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#optimize-operands-order + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#optimize-operands-order - name: optimize-operands-order severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#package-comments + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#package-comments - name: package-comments severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#range - name: range severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range-val-in-closure - - name: range-val-in-closure + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#range-val-address + - name: range-val-address severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range-val-address - - name: range-val-address + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#range-val-in-closure + - name: range-val-in-closure severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#receiver-naming + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#receiver-naming - name: receiver-naming severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#redundant-import-alias - - name: redundant-import-alias + exclude: [""] + arguments: + - maxLength: 2 + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#redefines-builtin-id + - name: redefines-builtin-id severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#redefines-builtin-id - - name: redefines-builtin-id + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#redundant-build-tag + - name: redundant-build-tag severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#string-of-int - - name: string-of-int + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#redundant-import-alias + - name: redundant-import-alias severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#string-format + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#string-format - name: string-format severity: warning disabled: false + exclude: [""] arguments: - - 'core.WriteError[1].Message' - '/^([^A-Z]|$)/' @@ -1725,86 +2777,124 @@ linters-settings: - - panic - '/^[^\n]*$/' - must not contain line breaks - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#struct-tag + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#string-of-int + - name: string-of-int + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#struct-tag - name: struct-tag + severity: warning + disabled: false + exclude: [""] arguments: - "json,inline" - "bson,outline,gnu" - severity: warning - disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#superfluous-else + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#superfluous-else - name: superfluous-else severity: warning disabled: false + exclude: [""] arguments: - "preserveScope" - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#time-equal + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#time-equal - name: time-equal severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#time-naming + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#time-naming - name: time-naming severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#var-naming - - name: var-naming + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unchecked-type-assertion + - name: unchecked-type-assertion severity: warning disabled: false + exclude: [""] arguments: - - [ "ID" ] # AllowList - - [ "VM" ] # DenyList - - - upperCaseConst: true - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#var-declaration - - name: var-declaration - severity: warning - disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unconditional-recursion + - acceptIgnoredAssertionResult: true + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unconditional-recursion - name: unconditional-recursion severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unexported-naming + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unexported-naming - name: unexported-naming severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unexported-return + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unexported-return - name: unexported-return severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unhandled-error + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unhandled-error - name: unhandled-error severity: warning disabled: false + exclude: [""] arguments: - "fmt.Printf" - "myFunction" - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unnecessary-stmt + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unnecessary-stmt - name: unnecessary-stmt severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unreachable-code + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unreachable-code - name: unreachable-code severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-parameter + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unused-parameter - name: unused-parameter severity: warning disabled: false + exclude: [""] arguments: - allowRegex: "^_" - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-receiver + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#unused-receiver - name: unused-receiver severity: warning disabled: false + exclude: [""] arguments: - allowRegex: "^_" - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#useless-break + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#use-any + - name: use-any + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#use-errors-new + - name: use-errors-new + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#useless-break - name: useless-break severity: warning disabled: false - # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#waitgroup-by-value + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#var-declaration + - name: var-declaration + severity: warning + disabled: false + exclude: [""] + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#var-naming + - name: var-naming + severity: warning + disabled: false + exclude: [""] + arguments: + - [ "ID" ] # AllowList + - [ "VM" ] # DenyList + - - upperCaseConst: true # Extra parameter (upperCaseConst|skipPackageNameChecks) + # https://github.com/mgechev/revive/blob/HEAD/RULES_DESCRIPTIONS.md#waitgroup-by-value - name: waitgroup-by-value severity: warning disabled: false + exclude: [""] rowserrcheck: # database/sql is always checked @@ -1813,48 +2903,451 @@ linters-settings: - github.com/jmoiron/sqlx sloglint: - # Enforce using key-value pairs only (incompatible with attr-only). + # Enforce not mixing key-value pairs and attributes. + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#no-mixed-arguments + # Default: true + no-mixed-args: false + # Enforce using key-value pairs only (overrides no-mixed-args, incompatible with attr-only). + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#key-value-pairs-only # Default: false kv-only: true - # Enforce using attributes only (incompatible with kv-only). + # Enforce using attributes only (overrides no-mixed-args, incompatible with kv-only). + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#attributes-only # Default: false attr-only: true + # Enforce not using global loggers. + # Values: + # - "": disabled + # - "all": report all global loggers + # - "default": report only the default slog logger + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#no-global + # Default: "" + no-global: "all" + # Enforce using methods that accept a context. + # Values: + # - "": disabled + # - "all": report all contextless calls + # - "scope": report only if a context exists in the scope of the outermost function + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#context-only + # Default: "" + context: "all" + # Enforce using static values for log messages. + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#static-messages + # Default: false + static-msg: true # Enforce using constants instead of raw keys. + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#no-raw-keys # Default: false no-raw-keys: true + # Enforce a single key naming convention. + # Values: snake, kebab, camel, pascal + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#key-naming-convention + # Default: "" + key-naming-case: snake + # Enforce not using specific keys. + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#forbidden-keys + # Default: [] + forbidden-keys: + - time + - level + - msg + - source + - foo # Enforce putting arguments on separate lines. + # https://github.com/go-simpler/sloglint?tab=readme-ov-file#arguments-on-separate-lines # Default: false args-on-sep-lines: true + spancheck: + # Checks to enable. + # Options include: + # - `end`: check that `span.End()` is called + # - `record-error`: check that `span.RecordError(err)` is called when an error is returned + # - `set-status`: check that `span.SetStatus(codes.Error, msg)` is called when an error is returned + # Default: ["end"] + checks: + - end + - record-error + - set-status + # A list of regexes for function signatures that silence `record-error` and `set-status` reports + # if found in the call path to a returned error. + # https://github.com/jjti/go-spancheck#ignore-check-signatures + # Default: [] + ignore-check-signatures: + - "telemetry.RecordError" + # A list of regexes for additional function signatures that create spans. + # This is useful if you have a utility method to create spans. + # Each entry should be of the form `:`, where `telemetry-type` can be `opentelemetry` or `opencensus`. + # https://github.com/jjti/go-spancheck#extra-start-span-signatures + # Default: [] + extra-start-span-signatures: + - "github.com/user/repo/telemetry/trace.Start:opentelemetry" staticcheck: - # Deprecated: use the global `run.go` instead. - go: "1.15" - # SAxxxx checks in https://staticcheck.io/docs/configuration/options/#checks + # SAxxxx checks in https://staticcheck.dev/docs/configuration/options/#checks + # Example (to disable some checks): [ "all", "-SA1000", "-SA1001"] # Default: ["*"] - checks: [ "all" ] + checks: + # Invalid regular expression. + # https://staticcheck.dev/docs/checks/#SA1000 + - SA1000 + # Invalid template. + # https://staticcheck.dev/docs/checks/#SA1001 + - SA1001 + # Invalid format in 'time.Parse'. + # https://staticcheck.dev/docs/checks/#SA1002 + - SA1002 + # Unsupported argument to functions in 'encoding/binary'. + # https://staticcheck.dev/docs/checks/#SA1003 + - SA1003 + # Suspiciously small untyped constant in 'time.Sleep'. + # https://staticcheck.dev/docs/checks/#SA1004 + - SA1004 + # Invalid first argument to 'exec.Command'. + # https://staticcheck.dev/docs/checks/#SA1005 + - SA1005 + # 'Printf' with dynamic first argument and no further arguments. + # https://staticcheck.dev/docs/checks/#SA1006 + - SA1006 + # Invalid URL in 'net/url.Parse'. + # https://staticcheck.dev/docs/checks/#SA1007 + - SA1007 + # Non-canonical key in 'http.Header' map. + # https://staticcheck.dev/docs/checks/#SA1008 + - SA1008 + # '(*regexp.Regexp).FindAll' called with 'n == 0', which will always return zero results. + # https://staticcheck.dev/docs/checks/#SA1010 + - SA1010 + # Various methods in the "strings" package expect valid UTF-8, but invalid input is provided. + # https://staticcheck.dev/docs/checks/#SA1011 + - SA1011 + # A nil 'context.Context' is being passed to a function, consider using 'context.TODO' instead. + # https://staticcheck.dev/docs/checks/#SA1012 + - SA1012 + # 'io.Seeker.Seek' is being called with the whence constant as the first argument, but it should be the second. + # https://staticcheck.dev/docs/checks/#SA1013 + - SA1013 + # Non-pointer value passed to 'Unmarshal' or 'Decode'. + # https://staticcheck.dev/docs/checks/#SA1014 + - SA1014 + # Using 'time.Tick' in a way that will leak. Consider using 'time.NewTicker', and only use 'time.Tick' in tests, commands and endless functions. + # https://staticcheck.dev/docs/checks/#SA1015 + - SA1015 + # Trapping a signal that cannot be trapped. + # https://staticcheck.dev/docs/checks/#SA1016 + - SA1016 + # Channels used with 'os/signal.Notify' should be buffered. + # https://staticcheck.dev/docs/checks/#SA1017 + - SA1017 + # 'strings.Replace' called with 'n == 0', which does nothing. + # https://staticcheck.dev/docs/checks/#SA1018 + - SA1018 + # Using a deprecated function, variable, constant or field. + # https://staticcheck.dev/docs/checks/#SA1019 + - SA1019 + # Using an invalid host:port pair with a 'net.Listen'-related function. + # https://staticcheck.dev/docs/checks/#SA1020 + - SA1020 + # Using 'bytes.Equal' to compare two 'net.IP'. + # https://staticcheck.dev/docs/checks/#SA1021 + - SA1021 + # Modifying the buffer in an 'io.Writer' implementation. + # https://staticcheck.dev/docs/checks/#SA1023 + - SA1023 + # A string cutset contains duplicate characters. + # https://staticcheck.dev/docs/checks/#SA1024 + - SA1024 + # It is not possible to use '(*time.Timer).Reset''s return value correctly. + # https://staticcheck.dev/docs/checks/#SA1025 + - SA1025 + # Cannot marshal channels or functions. + # https://staticcheck.dev/docs/checks/#SA1026 + - SA1026 + # Atomic access to 64-bit variable must be 64-bit aligned. + # https://staticcheck.dev/docs/checks/#SA1027 + - SA1027 + # 'sort.Slice' can only be used on slices. + # https://staticcheck.dev/docs/checks/#SA1028 + - SA1028 + # Inappropriate key in call to 'context.WithValue'. + # https://staticcheck.dev/docs/checks/#SA1029 + - SA1029 + # Invalid argument in call to a 'strconv' function. + # https://staticcheck.dev/docs/checks/#SA1030 + - SA1030 + # Overlapping byte slices passed to an encoder. + # https://staticcheck.dev/docs/checks/#SA1031 + - SA1031 + # Wrong order of arguments to 'errors.Is'. + # https://staticcheck.dev/docs/checks/#SA1032 + - SA1032 + # 'sync.WaitGroup.Add' called inside the goroutine, leading to a race condition. + # https://staticcheck.dev/docs/checks/#SA2000 + - SA2000 + # Empty critical section, did you mean to defer the unlock?. + # https://staticcheck.dev/docs/checks/#SA2001 + - SA2001 + # Called 'testing.T.FailNow' or 'SkipNow' in a goroutine, which isn't allowed. + # https://staticcheck.dev/docs/checks/#SA2002 + - SA2002 + # Deferred 'Lock' right after locking, likely meant to defer 'Unlock' instead. + # https://staticcheck.dev/docs/checks/#SA2003 + - SA2003 + # 'TestMain' doesn't call 'os.Exit', hiding test failures. + # https://staticcheck.dev/docs/checks/#SA3000 + - SA3000 + # Assigning to 'b.N' in benchmarks distorts the results. + # https://staticcheck.dev/docs/checks/#SA3001 + - SA3001 + # Binary operator has identical expressions on both sides. + # https://staticcheck.dev/docs/checks/#SA4000 + - SA4000 + # '&*x' gets simplified to 'x', it does not copy 'x'. + # https://staticcheck.dev/docs/checks/#SA4001 + - SA4001 + # Comparing unsigned values against negative values is pointless. + # https://staticcheck.dev/docs/checks/#SA4003 + - SA4003 + # The loop exits unconditionally after one iteration. + # https://staticcheck.dev/docs/checks/#SA4004 + - SA4004 + # Field assignment that will never be observed. Did you mean to use a pointer receiver?. + # https://staticcheck.dev/docs/checks/#SA4005 + - SA4005 + # A value assigned to a variable is never read before being overwritten. Forgotten error check or dead code?. + # https://staticcheck.dev/docs/checks/#SA4006 + - SA4006 + # The variable in the loop condition never changes, are you incrementing the wrong variable?. + # https://staticcheck.dev/docs/checks/#SA4008 + - SA4008 + # A function argument is overwritten before its first use. + # https://staticcheck.dev/docs/checks/#SA4009 + - SA4009 + # The result of 'append' will never be observed anywhere. + # https://staticcheck.dev/docs/checks/#SA4010 + - SA4010 + # Break statement with no effect. Did you mean to break out of an outer loop?. + # https://staticcheck.dev/docs/checks/#SA4011 + - SA4011 + # Comparing a value against NaN even though no value is equal to NaN. + # https://staticcheck.dev/docs/checks/#SA4012 + - SA4012 + # Negating a boolean twice ('!!b') is the same as writing 'b'. This is either redundant, or a typo. + # https://staticcheck.dev/docs/checks/#SA4013 + - SA4013 + # An if/else if chain has repeated conditions and no side-effects; if the condition didn't match the first time, it won't match the second time, either. + # https://staticcheck.dev/docs/checks/#SA4014 + - SA4014 + # Calling functions like 'math.Ceil' on floats converted from integers doesn't do anything useful. + # https://staticcheck.dev/docs/checks/#SA4015 + - SA4015 + # Certain bitwise operations, such as 'x ^ 0', do not do anything useful. + # https://staticcheck.dev/docs/checks/#SA4016 + - SA4016 + # Discarding the return values of a function without side effects, making the call pointless. + # https://staticcheck.dev/docs/checks/#SA4017 + - SA4017 + # Self-assignment of variables. + # https://staticcheck.dev/docs/checks/#SA4018 + - SA4018 + # Multiple, identical build constraints in the same file. + # https://staticcheck.dev/docs/checks/#SA4019 + - SA4019 + # Unreachable case clause in a type switch. + # https://staticcheck.dev/docs/checks/#SA4020 + - SA4020 + # "x = append(y)" is equivalent to "x = y". + # https://staticcheck.dev/docs/checks/#SA4021 + - SA4021 + # Comparing the address of a variable against nil. + # https://staticcheck.dev/docs/checks/#SA4022 + - SA4022 + # Impossible comparison of interface value with untyped nil. + # https://staticcheck.dev/docs/checks/#SA4023 + - SA4023 + # Checking for impossible return value from a builtin function. + # https://staticcheck.dev/docs/checks/#SA4024 + - SA4024 + # Integer division of literals that results in zero. + # https://staticcheck.dev/docs/checks/#SA4025 + - SA4025 + # Go constants cannot express negative zero. + # https://staticcheck.dev/docs/checks/#SA4026 + - SA4026 + # '(*net/url.URL).Query' returns a copy, modifying it doesn't change the URL. + # https://staticcheck.dev/docs/checks/#SA4027 + - SA4027 + # 'x % 1' is always zero. + # https://staticcheck.dev/docs/checks/#SA4028 + - SA4028 + # Ineffective attempt at sorting slice. + # https://staticcheck.dev/docs/checks/#SA4029 + - SA4029 + # Ineffective attempt at generating random number. + # https://staticcheck.dev/docs/checks/#SA4030 + - SA4030 + # Checking never-nil value against nil. + # https://staticcheck.dev/docs/checks/#SA4031 + - SA4031 + # Comparing 'runtime.GOOS' or 'runtime.GOARCH' against impossible value. + # https://staticcheck.dev/docs/checks/#SA4032 + - SA4032 + # Assignment to nil map. + # https://staticcheck.dev/docs/checks/#SA5000 + - SA5000 + # Deferring 'Close' before checking for a possible error. + # https://staticcheck.dev/docs/checks/#SA5001 + - SA5001 + # The empty for loop ("for {}") spins and can block the scheduler. + # https://staticcheck.dev/docs/checks/#SA5002 + - SA5002 + # Defers in infinite loops will never execute. + # https://staticcheck.dev/docs/checks/#SA5003 + - SA5003 + # "for { select { ..." with an empty default branch spins. + # https://staticcheck.dev/docs/checks/#SA5004 + - SA5004 + # The finalizer references the finalized object, preventing garbage collection. + # https://staticcheck.dev/docs/checks/#SA5005 + - SA5005 + # Infinite recursive call. + # https://staticcheck.dev/docs/checks/#SA5007 + - SA5007 + # Invalid struct tag. + # https://staticcheck.dev/docs/checks/#SA5008 + - SA5008 + # Invalid Printf call. + # https://staticcheck.dev/docs/checks/#SA5009 + - SA5009 + # Impossible type assertion. + # https://staticcheck.dev/docs/checks/#SA5010 + - SA5010 + # Possible nil pointer dereference. + # https://staticcheck.dev/docs/checks/#SA5011 + - SA5011 + # Passing odd-sized slice to function expecting even size. + # https://staticcheck.dev/docs/checks/#SA5012 + - SA5012 + # Using 'regexp.Match' or related in a loop, should use 'regexp.Compile'. + # https://staticcheck.dev/docs/checks/#SA6000 + - SA6000 + # Missing an optimization opportunity when indexing maps by byte slices. + # https://staticcheck.dev/docs/checks/#SA6001 + - SA6001 + # Storing non-pointer values in 'sync.Pool' allocates memory. + # https://staticcheck.dev/docs/checks/#SA6002 + - SA6002 + # Converting a string to a slice of runes before ranging over it. + # https://staticcheck.dev/docs/checks/#SA6003 + - SA6003 + # Inefficient string comparison with 'strings.ToLower' or 'strings.ToUpper'. + # https://staticcheck.dev/docs/checks/#SA6005 + - SA6005 + # Using io.WriteString to write '[]byte'. + # https://staticcheck.dev/docs/checks/#SA6006 + - SA6006 + # Defers in range loops may not run when you expect them to. + # https://staticcheck.dev/docs/checks/#SA9001 + - SA9001 + # Using a non-octal 'os.FileMode' that looks like it was meant to be in octal. + # https://staticcheck.dev/docs/checks/#SA9002 + - SA9002 + # Empty body in an if or else branch. + # https://staticcheck.dev/docs/checks/#SA9003 + - SA9003 + # Only the first constant has an explicit type. + # https://staticcheck.dev/docs/checks/#SA9004 + - SA9004 + # Trying to marshal a struct with no public fields nor custom marshaling. + # https://staticcheck.dev/docs/checks/#SA9005 + - SA9005 + # Dubious bit shifting of a fixed size integer value. + # https://staticcheck.dev/docs/checks/#SA9006 + - SA9006 + # Deleting a directory that shouldn't be deleted. + # https://staticcheck.dev/docs/checks/#SA9007 + - SA9007 + # 'else' branch of a type assertion is probably not reading the right value. + # https://staticcheck.dev/docs/checks/#SA9008 + - SA9008 + # Ineffectual Go compiler directive. + # https://staticcheck.dev/docs/checks/#SA9009 + - SA9009 stylecheck: - # Deprecated: use the global `run.go` instead. - go: "1.15" - # STxxxx checks in https://staticcheck.io/docs/configuration/options/#checks - # Default: ["*"] - checks: [ "all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022" ] - # https://staticcheck.io/docs/configuration/options/#dot_import_whitelist + # https://staticcheck.dev/docs/configuration/options/#dot_import_whitelist # Default: ["github.com/mmcloughlin/avo/build", "github.com/mmcloughlin/avo/operand", "github.com/mmcloughlin/avo/reg"] dot-import-whitelist: - fmt - # https://staticcheck.io/docs/configuration/options/#initialisms + # https://staticcheck.dev/docs/configuration/options/#initialisms # Default: ["ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS", "SIP", "RTP", "AMQP", "DB", "TS"] initialisms: [ "ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS", "SIP", "RTP", "AMQP", "DB", "TS" ] - # https://staticcheck.io/docs/configuration/options/#http_status_code_whitelist + # https://staticcheck.dev/docs/configuration/options/#http_status_code_whitelist # Default: ["200", "400", "404", "500"] http-status-code-whitelist: [ "200", "400", "404", "500" ] + # STxxxx checks in https://staticcheck.dev/docs/configuration/options/#checks + # Example (to disable some checks): [ "all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022" ] + # Default: ["*"] + checks: + # Incorrect or missing package comment. + # https://staticcheck.dev/docs/checks/#ST1000 + - ST1000 + # Dot imports are discouraged. + # https://staticcheck.dev/docs/checks/#ST1001 + - ST1001 + # Poorly chosen identifier. + # https://staticcheck.dev/docs/checks/#ST1003 + - ST1003 + # Incorrectly formatted error string. + # https://staticcheck.dev/docs/checks/#ST1005 + - ST1005 + # Poorly chosen receiver name. + # https://staticcheck.dev/docs/checks/#ST1006 + - ST1006 + # A function's error value should be its last return value. + # https://staticcheck.dev/docs/checks/#ST1008 + - ST1008 + # Poorly chosen name for variable of type 'time.Duration'. + # https://staticcheck.dev/docs/checks/#ST1011 + - ST1011 + # Poorly chosen name for error variable. + # https://staticcheck.dev/docs/checks/#ST1012 + - ST1012 + # Should use constants for HTTP error codes, not magic numbers. + # https://staticcheck.dev/docs/checks/#ST1013 + - ST1013 + # A switch's default case should be the first or last case. + # https://staticcheck.dev/docs/checks/#ST1015 + - ST1015 + # Use consistent method receiver names. + # https://staticcheck.dev/docs/checks/#ST1016 + - ST1016 + # Don't use Yoda conditions. + # https://staticcheck.dev/docs/checks/#ST1017 + - ST1017 + # Avoid zero-width and control characters in string literals. + # https://staticcheck.dev/docs/checks/#ST1018 + - ST1018 + # Importing the same package multiple times. + # https://staticcheck.dev/docs/checks/#ST1019 + - ST1019 + # The documentation of an exported function should start with the function's name. + # https://staticcheck.dev/docs/checks/#ST1020 + - ST1020 + # The documentation of an exported type should start with type's name. + # https://staticcheck.dev/docs/checks/#ST1021 + - ST1021 + # The documentation of an exported variable or constant should start with variable's name. + # https://staticcheck.dev/docs/checks/#ST1022 + - ST1022 + # Redundant type in variable declaration. + # https://staticcheck.dev/docs/checks/#ST1023 + - ST1023 tagalign: # Align and sort can be used together or separately. # # Whether enable align. If true, the struct tags will be aligned. - # eg: + # e.g.: # type FooBar struct { # Bar string `json:"bar" validate:"required"` # FooFoo int8 `json:"foo_foo" validate:"required"` @@ -1868,7 +3361,7 @@ linters-settings: align: false # Whether enable tags sort. # If true, the tags will be sorted by name in ascending order. - # eg: `xml:"bar" json:"bar" validate:"required"` -> `json:"bar" validate:"required" xml:"bar"` + # e.g.: `xml:"bar" json:"bar" validate:"required"` -> `json:"bar" validate:"required" xml:"bar"` # Default: true sort: false # Specify the order of tags, the other tags will be sorted by name. @@ -1890,24 +3383,97 @@ linters-settings: strict: true tagliatelle: - # Check the struct tag name case. + # Checks the struct tag name case. case: - # Use the struct field name to check the name of the struct tag. - # Default: false - use-field-name: true - # `camel` is used for `json` and `yaml`, and `header` is used for `header` (can be overridden) - # Default: {} + # Defines the association between tag name and case. + # Any struct tag name can be used. + # Supported string cases: + # - `camel` + # - `pascal` + # - `kebab` + # - `snake` + # - `upperSnake` + # - `goCamel` + # - `goPascal` + # - `goKebab` + # - `goSnake` + # - `upper` + # - `lower` + # - `header` rules: - # Any struct tag type can be used. - # Support string case: `camel`, `pascal`, `kebab`, `snake`, `upperSnake`, `goCamel`, `goPascal`, `goKebab`, `goSnake`, `upper`, `lower`, `header` json: camel yaml: camel xml: camel + toml: camel bson: camel avro: snake mapstructure: kebab env: upperSnake envconfig: upperSnake + whatever: snake + # Defines the association between tag name and case. + # Important: the `extended-rules` overrides `rules`. + # Default: empty + extended-rules: + json: + # Supported string cases: + # - `camel` + # - `pascal` + # - `kebab` + # - `snake` + # - `upperSnake` + # - `goCamel` + # - `goPascal` + # - `goKebab` + # - `goSnake` + # - `header` + # - `lower` + # - `header` + # + # Required + case: camel + # Adds 'AMQP', 'DB', 'GID', 'RTP', 'SIP', 'TS' to initialisms, + # and removes 'LHS', 'RHS' from initialisms. + # Default: false + extra-initialisms: true + # Defines initialism additions and overrides. + # Default: empty + initialism-overrides: + DB: true # add a new initialism + LHS: false # disable a default initialism. + # ... + # Uses the struct field name to check the name of the struct tag. + # Default: false + use-field-name: true + # The field names to ignore. + # Default: [] + ignored-fields: + - Bar + - Foo + # Overrides the default/root configuration. + # Default: [] + overrides: + - + # The package path (uses `/` only as a separator). + # Required + pkg: foo/bar + # Default: empty or the same as the default/root configuration. + rules: + json: snake + xml: pascal + # Default: empty or the same as the default/root configuration. + extended-rules: + # Same options as the base `extended-rules`. + # Default: false (WARNING: it doesn't follow the default/root configuration) + use-field-name: true + # The field names to ignore. + # Default: [] or the same as the default/root configuration. + ignored-fields: + - Bar + - Foo + # Ignore the package (takes precedence over all other configurations). + # Default: false + ignore: true tenv: # The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures. @@ -1916,29 +3482,100 @@ linters-settings: all: false testifylint: - # Enable all checkers. + # Enable all checkers (https://github.com/Antonboom/testifylint#checkers). # Default: false enable-all: true - # Enable specific checkers. - # https://github.com/Antonboom/testifylint#checkers - # Default: ["bool-compare", "compares", "empty", "error-is-as", "error-nil", "expected-actual", "float-compare", "len", "require-error", "suite-dont-use-pkg", "suite-extra-assert-call"] + # Disable checkers by name + # (in addition to default + # suite-thelper + # ). + disable: + - blank-import + - bool-compare + - compares + - contains + - empty + - encoded-compare + - error-is-as + - error-nil + - expected-actual + - float-compare + - formatter + - go-require + - len + - negative-positive + - nil-compare + - regexp + - require-error + - suite-broken-parallel + - suite-dont-use-pkg + - suite-extra-assert-call + - suite-subtest-run + - suite-thelper + - useless-assert + + # Disable all checkers (https://github.com/Antonboom/testifylint#checkers). + # Default: false + disable-all: true + # Enable checkers by name + # (in addition to default + # blank-import, bool-compare, compares, contains, empty, encoded-compare, error-is-as, error-nil, expected-actual, + # go-require, float-compare, formatter, len, negative-positive, nil-compare, regexp, require-error, + # suite-broken-parallel, suite-dont-use-pkg, suite-extra-assert-call, suite-subtest-run, useless-assert + # ). enable: + - blank-import - bool-compare - compares + - contains - empty + - encoded-compare - error-is-as - error-nil - expected-actual - float-compare + - formatter + - go-require - len + - negative-positive + - nil-compare + - regexp - require-error + - suite-broken-parallel - suite-dont-use-pkg - suite-extra-assert-call + - suite-subtest-run - suite-thelper + - useless-assert + + bool-compare: + # To ignore user defined types (over builtin bool). + # Default: false + ignore-custom-types: true expected-actual: # Regexp for expected variable name. # Default: (^(exp(ected)?|want(ed)?)([A-Z]\w*)?$)|(^(\w*[a-z])?(Exp(ected)?|Want(ed)?)$) pattern: ^expected + formatter: + # To enable go vet's printf checks. + # Default: true + check-format-string: false + # To require f-assertions (e.g. `assert.Equalf`) if format string is used, even if there are no variable-length + # variables, i.e. it requires `require.NoErrorf` for both these cases: + # - require.NoErrorf(t, err, "unexpected error") + # - require.NoErrorf(t, err, "unexpected error for sid: %v", sid) + # To understand this behavior, please read the + # https://github.com/Antonboom/testifylint?tab=readme-ov-file#historical-reference-of-formatter. + # Default: false + require-f-funcs: true + go-require: + # To ignore HTTP handlers (like http.HandlerFunc). + # Default: false + ignore-http-handlers: true + require-error: + # Regexp for assertions to analyze. If defined, then only matched error assertions will be reported. + # Default: "" + fn-pattern: ^(Errorf?|NoErrorf?)$ suite-extra-assert-call: # To require or remove extra Assert() call? # Default: remove @@ -2018,9 +3655,6 @@ linters-settings: # Suggest the use of rpc.DefaultXXPath. # Default: false default-rpc-path: true - # DEPRECATED Suggest the use of os.DevNull. - # Default: false - os-dev-null: true # Suggest the use of sql.LevelXX.String(). # Default: false sql-isolation-level: true @@ -2030,9 +3664,46 @@ linters-settings: # Suggest the use of constant.Kind.String(). # Default: false constant-kind: true - # DEPRECATED Suggest the use of syslog.Priority. + + usetesting: + # Enable/disable `os.CreateTemp("", ...)` detections. + # Default: true + os-create-temp: false + + # Enable/disable `os.MkdirTemp()` detections. + # Default: true + os-mkdir-temp: false + + # Enable/disable `os.Setenv()` detections. + # Default: true + os-setenv: false + + # Enable/disable `os.TempDir()` detections. + # Default: false + os-temp-dir: true + + # Enable/disable `os.Chdir()` detections. + # Disabled if Go < 1.24. + # Default: true + os-chdir: false + + # Enable/disable `context.Background()` detections. + # Disabled if Go < 1.24. + # Default: true + context-background: false + + # Enable/disable `context.TODO()` detections. + # Disabled if Go < 1.24. + # Default: true + context-todo: false + + unconvert: + # Remove conversions that force intermediate rounding. # Default: false - syslog-priority: true + fast-math: true + # Be more conservative (experimental). + # Default: false + safe: true unparam: # Inspect exported functions. @@ -2052,9 +3723,6 @@ linters-settings: # Treat IncDec statement (e.g. `i++` or `i--`) as both read and write operation instead of just write. # Default: false post-statements-are-reads: true - # Mark all exported identifiers as used. - # Default: true - exported-is-used: false # Mark all exported fields as used. # default: true exported-fields-are-used: false @@ -2068,11 +3736,6 @@ linters-settings: # Default: true generated-is-used: false - varcheck: - # Check usage of exported fields and variables. - # Default: false - exported-fields: true - varnamelen: # The longest distance, in source lines, that is being considered a "small scope". # Variables used in at most this many lines will be ignored. @@ -2130,14 +3793,24 @@ linters-settings: multi-func: true wrapcheck: + # An array of strings specifying additional substrings of signatures to ignore. + # Unlike 'ignoreSigs', this option extends the default set (or the set specified in 'ignoreSigs') without replacing it entirely. + # This allows you to add specific signatures to the ignore list + # while retaining the defaults or any items in 'ignoreSigs'. + # Default: [] + extra-ignore-sigs: + - .CustomError( + - .SpecificWrap( + # An array of strings that specify substrings of signatures to ignore. # If this set, it will override the default set of ignored signatures. # See https://github.com/tomarrell/wrapcheck#configuration for more information. - # Default: [".Errorf(", "errors.New(", "errors.Unwrap(", ".Wrap(", ".Wrapf(", ".WithMessage(", ".WithMessagef(", ".WithStack("] + # Default: [".Errorf(", "errors.New(", "errors.Unwrap(", "errors.Join(", ".Wrap(", ".Wrapf(", ".WithMessage(", ".WithMessagef(", ".WithStack("] ignoreSigs: - .Errorf( - errors.New( - errors.Unwrap( + - errors.Join( - .Wrap( - .Wrapf( - .WithMessage( @@ -2158,337 +3831,101 @@ linters-settings: - ^(?i)c(?-i)ach(ing|e) wsl: - # See https://github.com/bombsimon/wsl/blob/master/doc/configuration.md for documentation of available settings. - # These are the defaults for `golangci-lint`. - - # Do strict checking when assigning from append (x = append(x, y)). If - # this is set to true - the append call must append either a variable + # Do strict checking when assigning from append (x = append(x, y)). + # If this is set to true - the append call must append either a variable # assigned, called or used on the line above. - strict-append: true + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#strict-append + # Default: true + strict-append: false # Allows assignments to be cuddled with variables used in calls on # line above and calls to be cuddled with assignments of variables # used in call on line above. - allow-assign-and-call: true + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#allow-assign-and-call + # Default: true + allow-assign-and-call: false # Allows assignments to be cuddled with anything. - allow-assign-and-anything: false + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#allow-assign-and-anything + # Default: false + allow-assign-and-anything: true # Allows cuddling to assignments even if they span over multiple lines. - allow-multiline-assign: true + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#allow-multiline-assign + # Default: true + allow-multiline-assign: false - # If the number of lines in a case block is equal to or lager than this - # number, the case *must* end white a newline. - force-case-trailing-whitespace: 0 + # If the number of lines in a case block is equal to or lager than this number, + # the case *must* end white a newline. + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#force-case-trailing-whitespace + # Default: 0 + force-case-trailing-whitespace: 1 # Allow blocks to end with comments. - allow-trailing-comment: false - - # Allow multiple comments in the beginning of a block separated with newline. - allow-separated-leading-comment: false - - # Allow multiple var/declaration statements to be cuddled. - allow-cuddle-declarations: false - - # A list of call idents that everything can be cuddled with. - # Defaults to calls looking like locks. - allow-cuddle-with-calls: [ "Lock", "RLock" ] - - # AllowCuddleWithRHS is a list of right hand side variables that is allowed - # to be cuddled with anything. Defaults to assignments or calls looking - # like unlocks. - allow-cuddle-with-rhs: [ "Unlock", "RUnlock" ] - - # Causes an error when an If statement that checks an error variable doesn't - # cuddle with the assignment of that variable. - force-err-cuddling: false - - # When force-err-cuddling is enabled this is a list of names - # used for error variables to check for in the conditional. - error-variable-names: [ "err" ] - - # Causes an error if a short declaration (:=) cuddles with anything other than - # another short declaration. - # This logic overrides force-err-cuddling among others. - force-short-decl-cuddling: false - - # The custom section can be used to define linter plugins to be loaded at runtime. - # See README documentation for more info. - custom: - # Each custom linter should have a unique name. - example: - # The path to the plugin *.so. Can be absolute or local. - # Required for each custom linter. - path: /path/to/example.so - # The description of the linter. - # Optional. - description: This is an example usage of a plugin linter. - # Intended to point to the repo location of the linter. - # Optional. - original-url: github.com/golangci/example-linter - - -linters: - # Disable all linters. - # Default: false - disable-all: true - # Enable specific linter - # https://golangci-lint.run/usage/linters/#enabled-by-default - enable: - - asasalint - - asciicheck - - bidichk - - bodyclose - - containedctx - - contextcheck - - cyclop - - deadcode - - decorder - - depguard - - dogsled - - dupl - - dupword - - durationcheck - - errcheck - - errchkjson - - errname - - errorlint - - execinquery - - exhaustive - - exhaustivestruct - - exhaustruct - - exportloopref - - forbidigo - - forcetypeassert - - funlen - - gci - - ginkgolinter - - gocheckcompilerdirectives - - gochecknoglobals - - gochecknoinits - - gochecksumtype - - gocognit - - goconst - - gocritic - - gocyclo - - godot - - godox - - goerr113 - - gofmt - - gofumpt - - goheader - - goimports - - golint - - gomnd - - gomoddirectives - - gomodguard - - goprintffuncname - - gosec - - gosimple - - gosmopolitan - - govet - - grouper - - ifshort - - importas - - inamedparam - - ineffassign - - interfacebloat - - interfacer - - ireturn - - lll - - loggercheck - - maintidx - - makezero - - maligned - - mirror - - misspell - - musttag - - nakedret - - nestif - - nilerr - - nilnil - - nlreturn - - noctx - - nolintlint - - nonamedreturns - - nosnakecase - - nosprintfhostport - - paralleltest - - perfsprint - - prealloc - - predeclared - - promlinter - - protogetter - - reassign - - revive - - rowserrcheck - - scopelint - - sloglint - - sqlclosecheck - - staticcheck - - structcheck - - stylecheck - - tagalign - - tagliatelle - - tenv - - testableexamples - - testifylint - - testpackage - - thelper - - tparallel - - typecheck - - unconvert - - unparam - - unused - - usestdlibvars - - varcheck - - varnamelen - - wastedassign - - whitespace - - wrapcheck - - wsl - - zerologlint + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#allow-trailing-comment + # Default: false + allow-trailing-comment: true - # Enable all available linters. - # Default: false - enable-all: true - # Disable specific linter - # https://golangci-lint.run/usage/linters/#disabled-by-default - disable: - - asasalint - - asciicheck - - bidichk - - bodyclose - - containedctx - - contextcheck - - cyclop - - deadcode - - decorder - - depguard - - dogsled - - dupl - - dupword - - durationcheck - - errcheck - - errchkjson - - errname - - errorlint - - execinquery - - exhaustive - - exhaustivestruct - - exhaustruct - - exportloopref - - forbidigo - - forcetypeassert - - funlen - - gci - - ginkgolinter - - gocheckcompilerdirectives - - gochecknoglobals - - gochecknoinits - - gochecksumtype - - gocognit - - goconst - - gocritic - - gocyclo - - godot - - godox - - goerr113 - - gofmt - - gofumpt - - goheader - - goimports - - golint - - gomnd - - gomoddirectives - - gomodguard - - goprintffuncname - - gosec - - gosimple - - gosmopolitan - - govet - - grouper - - ifshort - - importas - - inamedparam - - ineffassign - - interfacebloat - - interfacer - - ireturn - - lll - - loggercheck - - maintidx - - makezero - - maligned - - mirror - - misspell - - musttag - - nakedret - - nestif - - nilerr - - nilnil - - nlreturn - - noctx - - nolintlint - - nonamedreturns - - nosnakecase - - nosprintfhostport - - paralleltest - - perfsprint - - prealloc - - predeclared - - promlinter - - protogetter - - reassign - - revive - - rowserrcheck - - scopelint - - sloglint - - sqlclosecheck - - staticcheck - - structcheck - - stylecheck - - tagalign - - tagliatelle - - tenv - - testableexamples - - testifylint - - testpackage - - thelper - - tparallel - - typecheck - - unconvert - - unparam - - unused - - usestdlibvars - - varcheck - - varnamelen - - wastedassign - - whitespace - - wrapcheck - - wsl - - zerologlint + # Allow multiple comments in the beginning of a block separated with newline. + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#allow-separated-leading-comment + # Default: false + allow-separated-leading-comment: true - # Enable presets. - # https://golangci-lint.run/usage/linters - presets: - - bugs - - comment - - complexity - - error - - format - - import - - metalinter - - module - - performance - - sql - - style - - test - - unused + # Allow multiple var/declaration statements to be cuddled. + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#allow-cuddle-declarations + # Default: false + allow-cuddle-declarations: true - # Run only fast linters from enabled linters set (first run won't be fast) - # Default: false - fast: true + # A list of call idents that everything can be cuddled with. + # Defaults: [ "Lock", "RLock" ] + allow-cuddle-with-calls: [ "Foo", "Bar" ] + + # AllowCuddleWithRHS is a list of right hand side variables that is allowed + # to be cuddled with anything. + # Defaults: [ "Unlock", "RUnlock" ] + allow-cuddle-with-rhs: [ "Foo", "Bar" ] + + # Causes an error when an If statement that checks an error variable doesn't + # cuddle with the assignment of that variable. + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#force-err-cuddling + # Default: false + force-err-cuddling: true + + # When force-err-cuddling is enabled this is a list of names + # used for error variables to check for in the conditional. + # Default: [ "err" ] + error-variable-names: [ "foo" ] + + # Causes an error if a short declaration (:=) cuddles with anything other than + # another short declaration. + # This logic overrides force-err-cuddling among others. + # https://github.com/bombsimon/wsl/blob/HEAD/doc/configuration.md#force-short-decl-cuddling + # Default: false + force-short-decl-cuddling: true + + # The custom section can be used to define linter plugins to be loaded at runtime. + # See README documentation for more info. + custom: + # Each custom linter should have a unique name. + example: + # The plugin type. + # It can be `goplugin` or `module`. + # Default: goplugin + type: module + # The path to the plugin *.so. Can be absolute or local. + # Required for each custom linter. + path: /path/to/example.so + # The description of the linter. + # Optional. + description: This is an example usage of a plugin linter. + # Intended to point to the repo location of the linter. + # Optional. + original-url: github.com/golangci/example-linter + # Plugins settings/configuration. + # Only work with plugin based on `linterdb.PluginConstructor`. + # Optional. + settings: + foo: bar issues: @@ -2538,13 +3975,50 @@ issues: # Independently of option `exclude` we use default exclude patterns, # it can be disabled by this option. # To list all excluded by default patterns execute `golangci-lint run --help`. - # Default: true. + # Default: true exclude-use-default: false - # If set to true exclude and exclude-rules regular expressions become case-sensitive. + # If set to true, `exclude` and `exclude-rules` regular expressions become case-sensitive. # Default: false exclude-case-sensitive: false + # Which dirs to exclude: issues from them won't be reported. + # Can use regexp here: `generated.*`, regexp is applied on full path, + # including the path prefix if one is set. + # Default dirs are skipped independently of this option's value (see exclude-dirs-use-default). + # "/" will be replaced by current OS file path separator to properly work on Windows. + # Default: [] + exclude-dirs: + - src/external_libs + - autogenerated_by_my_lib + + # Enables exclude of directories: + # - vendor$, third_party$, testdata$, examples$, Godeps$, builtin$ + # Default: true + exclude-dirs-use-default: false + + # Which files to exclude: they will be analyzed, but issues from them won't be reported. + # There is no need to include all autogenerated files, + # we confidently recognize autogenerated files. + # If it's not, please let us know. + # "/" will be replaced by current OS file path separator to properly work on Windows. + # Default: [] + exclude-files: + - ".*\\.my\\.go$" + - lib/bad.go + + # Mode of the generated files analysis. + # + # - `strict`: sources are excluded by following strictly the Go generated file convention. + # Source files that have lines matching only the following regular expression will be excluded: `^// Code generated .* DO NOT EDIT\.$` + # This line must appear before the first non-comment, non-blank text in the file. + # https://go.dev/s/generatedcode + # - `lax`: sources are excluded if they contain lines `autogenerated file`, `code generated`, `do not edit`, etc. + # - `disable`: disable the generated files exclusion. + # + # Default: lax + exclude-generated: strict + # The list of ids of default excludes to include or disable. # https://golangci-lint.run/usage/false-positives/#default-exclusions # Default: [] @@ -2575,25 +4049,178 @@ issues: # Default: 3 max-same-issues: 0 + # Make issues output unique by line. + # Default: true + uniq-by-line: false + # Show only new issues: if there are unstaged changes or untracked files, # only those changes are analyzed, else only changes in HEAD~ are analyzed. # It's a super-useful option for integration of golangci-lint into existing large codebase. # It's not practical to fix all existing issues at the moment of integration: # much better don't allow issues in new code. # - # Default: false. + # Default: false new: true + # Show only new issues created after the best common ancestor (merge-base against HEAD). + # Default: "" + new-from-merge-base: main + # Show only new issues created after git revision `REV`. + # Default: "" new-from-rev: HEAD # Show only new issues created in git patch with set file path. + # Default: "" new-from-patch: path/to/patch/file + # Show issues in any part of update files (requires new-from-rev or new-from-patch). + # Default: false + whole-files: true + # Fix found issues (if it's supported by the linter). + # Default: false fix: true +# output configuration options +output: + # The formats used to render issues. + # Formats: + # - `colored-line-number` + # - `line-number` + # - `json` + # - `colored-tab` + # - `tab` + # - `html` + # - `checkstyle` + # - `code-climate` + # - `junit-xml` + # - `junit-xml-extended` + # - `github-actions` + # - `teamcity` + # - `sarif` + # Output path can be either `stdout`, `stderr` or path to the file to write to. + # + # For the CLI flag (`--out-format`), multiple formats can be specified by separating them by comma. + # The output can be specified for each of them by separating format name and path by colon symbol. + # Example: "--out-format=checkstyle:report.xml,json:stdout,colored-line-number" + # The CLI flag (`--out-format`) override the configuration file. + # + # Default: + # formats: + # - format: colored-line-number + # path: stdout + formats: + - format: json + path: stderr + - format: checkstyle + path: report.xml + - format: colored-line-number + + # Print lines of code with issue. + # Default: true + print-issued-lines: false + + # Print linter name in the end of issue text. + # Default: true + print-linter-name: false + + # Add a prefix to the output file references. + # Default: "" + path-prefix: "" + + # Sort results by the order defined in `sort-order`. + # Default: false + sort-results: true + + # Order to use when sorting results. + # Require `sort-results` to `true`. + # Possible values: `file`, `linter`, and `severity`. + # + # If the severity values are inside the following list, they are ordered in this order: + # 1. error + # 2. warning + # 3. high + # 4. medium + # 5. low + # Either they are sorted alphabetically. + # + # Default: ["file"] + sort-order: + - linter + - severity + - file # filepath, line, and column. + + # Show statistics per linter. + # Default: false + show-stats: true + + +# Options for analysis running. +run: + # Timeout for analysis, e.g. 30s, 5m, 5m30s. + # If the value is lower or equal to 0, the timeout is disabled. + # Default: 1m + timeout: 5m + + # The mode used to evaluate relative paths. + # It's used by exclusions, Go plugins, and some linters. + # The value can be: + # - `gomod`: the paths will be relative to the directory of the `go.mod` file. + # - `gitroot`: the paths will be relative to the git root (the parent directory of `.git`). + # - `cfg`: the paths will be relative to the configuration file. + # - `wd` (NOT recommended): the paths will be relative to the place where golangci-lint is run. + # Default: wd + relative-path-mode: gomod + + # Exit code when at least one issue was found. + # Default: 1 + issues-exit-code: 2 + + # Include test files or not. + # Default: true + tests: false + + # List of build tags, all linters use it. + # Default: [] + build-tags: + - mytag + + # If set, we pass it to "go list -mod={option}". From "go help modules": + # If invoked with -mod=readonly, the go command is disallowed from the implicit + # automatic updating of go.mod described above. Instead, it fails when any changes + # to go.mod are needed. This setting is most useful to check that go.mod does + # not need updates, such as in a continuous integration and testing system. + # If invoked with -mod=vendor, the go command assumes that the vendor + # directory holds the correct copies of dependencies and ignores + # the dependency descriptions in go.mod. + # + # Allowed values: readonly|vendor|mod + # Default: "" + modules-download-mode: readonly + + # Allow multiple parallel golangci-lint instances running. + # If false, golangci-lint acquires file lock on start. + # Default: false + allow-parallel-runners: true + + # Allow multiple golangci-lint instances running, but serialize them around a lock. + # If false, golangci-lint exits with an error if it fails to acquire file lock on start. + # Default: false + allow-serial-runners: true + + # Define the Go version limit. + # Mainly related to generics support since go1.18. + # Default: use Go version from the go.mod file, fallback on the env var `GOVERSION`, fallback on 1.17 + go: '1.19' + + # Number of operating system threads (`GOMAXPROCS`) that can execute golangci-lint simultaneously. + # If it is explicitly set to 0 (i.e. not the default) then golangci-lint will automatically set the value to match Linux container CPU quota. + # Default: the number of logical CPUs in the machine + concurrency: 4 + + severity: # Set the default severity for issues. # @@ -2605,7 +4232,9 @@ severity: # - GitHub: https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message # - TeamCity: https://www.jetbrains.com/help/teamcity/service-messages.html#Inspection+Instance # - # Default value is an empty string. + # `@linter` can be used as severity value to keep the severity from linters (e.g. revive, gosec, ...) + # + # Default: "" default-severity: error # If set to true `severity-rules` regular expressions become case-sensitive. @@ -2615,6 +4244,9 @@ severity: # When a list of severity rules are provided, severity information will be added to lint issues. # Severity rules have the same filtering capability as exclude rules # except you are allowed to specify one matcher per severity rule. + # + # `@linter` can be used as severity value to keep the severity from linters (e.g. revive, gosec, ...) + # # Only affects out formats that support setting severity information. # # Default: [] diff --git a/.golangci.yml b/.golangci.yml index 6ff473a36471..b2c0240c7805 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -1,13 +1,75 @@ +# This configuration file is not a recommendation. +# +# We intentionally use a limited set of linters. +# This configuration file is used with different version of golangci-lint to avoid regressions: +# the linters can change between version, +# their configuration may be not compatible or their reports can be different, +# and this can break some of our tests. +# Also, some linters are not relevant for the project (e.g. linters related to SQL). +# +# We have specific constraints, so we use a specific configuration. +# +# See the file `.golangci.reference.yml` to have a list of all available configuration options. + +linters: + disable-all: true + # This list of linters is not a recommendation (same thing for all this configuration file). + # We intentionally use a limited set of linters. + # See the comment on top of this file. + enable: + - bodyclose + - copyloopvar + - depguard + - dogsled + - dupl + - errcheck + - errorlint + - funlen + - gocheckcompilerdirectives + - gochecknoinits + - goconst + - gocritic + - gocyclo + - godox + - gofmt + - goimports + - mnd + - goprintffuncname + - gosec + - gosimple + - govet + - intrange + - ineffassign + - lll + - misspell + - nakedret + - noctx + - nolintlint + - revive + - staticcheck + - stylecheck + - testifylint + - unconvert + - unparam + - unused + - whitespace + + linters-settings: depguard: - # new configuration rules: logger: deny: # logging is allowed only by logutils.Log, - # logrus is allowed to use only in logutils package. - pkg: "github.com/sirupsen/logrus" - desc: logging is allowed only by logutils.Log + desc: logging is allowed only by logutils.Log. + - pkg: "github.com/pkg/errors" + desc: Should be replaced by standard lib errors package. + - pkg: "github.com/instana/testify" + desc: It's a fork of github.com/stretchr/testify. + files: + # logrus is allowed to use only in logutils package. + - "!**/pkg/logutils/**.go" dupl: threshold: 100 funlen: @@ -30,13 +92,16 @@ linters-settings: - whyNoLint gocyclo: min-complexity: 15 + godox: + keywords: + - FIXME gofmt: rewrite-rules: - pattern: 'interface{}' replacement: 'any' goimports: local-prefixes: github.com/golangci/golangci-lint - gomnd: + mnd: # don't include the "operation" and "assign" checks: - argument @@ -50,9 +115,7 @@ linters-settings: - '3' ignored-functions: - strings.SplitN - govet: - check-shadowing: true settings: printf: funcs: @@ -60,101 +123,76 @@ linters-settings: - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf + enable: + - nilness + - shadow + errorlint: + asserts: false lll: line-length: 140 misspell: locale: US + ignore-words: + - "importas" # linter name nolintlint: allow-unused: false # report any unused nolint directives - require-explanation: false # don't require an explanation for nolint directives - require-specific: false # don't require nolint directives to be specific about which linter is being skipped + require-explanation: true # require an explanation for nolint directives + require-specific: true # require nolint directives to be specific about which linter is being skipped revive: rules: + - name: indent-error-flow - name: unexported-return disabled: true - name: unused-parameter - -linters: - disable-all: true - enable: - - bodyclose - - depguard - - dogsled - - dupl - - errcheck - - exportloopref - - funlen - - gocheckcompilerdirectives - - gochecknoinits - - goconst - - gocritic - - gocyclo - - gofmt - - goimports - - gomnd - - goprintffuncname - - gosec - - gosimple - - govet - - ineffassign - - lll - - misspell - - nakedret - - noctx - - nolintlint - - revive - - staticcheck - - stylecheck - - typecheck - - unconvert - - unparam - - unused - - whitespace - - # don't enable: - # - asciicheck - # - scopelint - # - gochecknoglobals - # - gocognit - # - godot - # - godox - # - goerr113 - # - interfacer - # - maligned - # - nestif - # - prealloc - # - testpackage - # - wsl + - name: unused-receiver issues: - # Excluding configuration per-path, per-linter, per-text and per-source exclude-rules: - - path: _test\.go + - path: (.+)_test\.go linters: - - gomnd + - dupl + - mnd + - lll - - path: pkg/golinters/errcheck.go + # Deprecated linter options. + - path: pkg/golinters/errcheck/errcheck.go + linters: [staticcheck] text: "SA1019: errCfg.Exclude is deprecated: use ExcludeFunctions instead" - - path: pkg/commands/run.go - text: "SA1019: lsc.Errcheck.Exclude is deprecated: use ExcludeFunctions instead" - - path: pkg/commands/run.go - text: "SA1019: e.cfg.Run.Deadline is deprecated: Deadline exists for historical compatibility and should not be used." + - path: pkg/golinters/errcheck/errcheck.go + linters: [staticcheck] + text: "SA1019: errCfg.Ignore is deprecated: use ExcludeFunctions instead" + - path: pkg/golinters/govet/govet.go + linters: [staticcheck] + text: "SA1019: cfg.CheckShadowing is deprecated: the linter should be enabled inside Enable." + - path: pkg/golinters/godot/godot.go + linters: [staticcheck] + text: "SA1019: settings.CheckAll is deprecated: use Scope instead" + - path: pkg/goformatters/gci/gci.go + linters: [staticcheck] + text: "SA1019: settings.LocalPrefixes is deprecated: use Sections instead." - - path: pkg/golinters/gofumpt.go + # Related to `run.go`, it cannot be removed. + - path: pkg/golinters/gofumpt/gofumpt.go + linters: [staticcheck] text: "SA1019: settings.LangVersion is deprecated: use the global `run.go` instead." - - path: pkg/golinters/staticcheck_common.go - text: "SA1019: settings.GoVersion is deprecated: use the global `run.go` instead." - - path: pkg/lint/lintersdb/manager.go - text: "SA1019: (.+).(GoVersion|LangVersion) is deprecated: use the global `run.go` instead." - - path: pkg/golinters/unused.go + + # Based on existing code, the modifications should be limited to make maintenance easier. + - path: pkg/golinters/unused/unused.go + linters: [gocritic] text: "rangeValCopy: each iteration copies 160 bytes \\(consider pointers or indexing\\)" - - path: test/(fix|linters)_test.go - text: "string `gocritic.go` has 3 occurrences, make it a constant" + + # Related to the result of computation but divided multiple times by 1024. + - path: test/bench/bench_test.go + linters: [gosec] + text: "G115: integer overflow conversion uint64 -> int" + + exclude-dirs: + - test/testdata_etc # test files + - internal/go # extracted from Go code + - internal/x # extracted from x/tools code + - pkg/goformatters/gci/internal # extracted from gci code + exclude-files: + - pkg/goanalysis/runner_checker.go # extracted from x/tools code run: timeout: 5m - skip-dirs: - - test/testdata_etc # test files - - internal/cache # extracted from Go code - - internal/renameio # extracted from Go code - - internal/robustio # extracted from Go code diff --git a/.goreleaser.yml b/.goreleaser.yml index 4463f37cfa8c..98346da5f7fd 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -1,13 +1,15 @@ ---- -project_name: golangci-lint +version: 2 -release: - github: - owner: golangci - name: golangci-lint +project_name: golangci-lint builds: - binary: golangci-lint + main: ./cmd/golangci-lint/ + flags: + - -trimpath + ldflags: -s -w -X main.version={{.Version}} -X main.commit={{.ShortCommit}} -X main.date={{.Date}} + env: + - CGO_ENABLED=0 goos: - darwin - windows @@ -31,33 +33,28 @@ builds: - 7 gomips: - hardfloat - env: - - CGO_ENABLED=0 ignore: - goos: darwin goarch: 386 - goos: freebsd goarch: arm64 - main: ./cmd/golangci-lint/ - flags: - - -trimpath - ldflags: -s -w -X main.version={{.Version}} -X main.commit={{.ShortCommit}} -X main.date={{.Date}} archives: - - format: tar.gz + - formats: [ 'tar.gz' ] wrap_in_directory: true format_overrides: - goos: windows - format: zip + formats: [ 'zip' ] name_template: '{{ .ProjectName }}-{{ .Version }}-{{ .Os }}-{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}' files: - LICENSE - README.md snapshot: - name_template: SNAPSHOT-{{ .Commit }} + version_template: SNAPSHOT-{{ .Commit }} checksum: + disable: false name_template: '{{ .ProjectName }}-{{ .Version }}-checksums.txt' changelog: @@ -69,22 +66,42 @@ changelog: - '(?i)^docs\[[^:]+\]:' - '^tests?:' - '(?i)^dev:' + - '(?i)^chore:' - '^build\(deps\): bump .* in /docs \(#\d+\)' - '^build\(deps\): bump .* in /\.github/peril \(#\d+\)' + - '^build\(deps\): bump .* in /scripts/gen_github_action_config \(#\d+\)' - Merge pull request - Merge branch +release: + skip_upload: false + github: + owner: golangci + name: golangci-lint + header: | + `golangci-lint` is a free and open-source project built by volunteers. + + If you value it, consider supporting us, the [maintainers](https://opencollective.com/golangci-lint) and [linter authors](https://golangci-lint.run/product/thanks/). + + We appreciate it! :heart: + + For key updates, see the [changelog](https://golangci-lint.run/product/changelog/#{{ .Major }}{{ .Minor }}{{ .Patch }}). + source: enabled: true name_template: '{{ .ProjectName }}-{{ .Version }}-source' brews: - - tap: + - description: Fast linters runner for Go. + homepage: https://golangci.com + skip_upload: false + repository: owner: golangci name: homebrew-tap - folder: Formula - homepage: https://golangci.com - description: Fast linters runner for Go. + commit_author: + name: golangci-releaser + email: 65486276+golangci-releaser@users.noreply.github.com + directory: Formula install: | bin.install "golangci-lint" output = Utils.popen_read("#{bin}/golangci-lint completion bash") @@ -97,15 +114,125 @@ brews: test: | system "#{bin}/golangci-lint --version" +#chocolateys: +# - summary: Fast linters Runner for Go +# description: | +# {{ .ProjectName }} installer package. +# Fast linters Runner for Go. +# project_url: https://golangci-lint.run +# skip_publish: false +# name: golangci-lint +# title: Golangci-lint +# owners: golangci +# authors: golangci +# copyright: 2024 GolangCI +# url_template: "https://github.com/golangci/golangci-lint/releases/download/{{ .Tag }}/{{ .ArtifactName }}" +# icon_url: "https://cdn.rawgit.com/golangci/golangci-lint/HEAD/assets/go.png" +# license_url: https://github.com/golangci/golangci-lint/blob/HEAD/LICENSE +# require_license_acceptance: false +# project_source_url: https://github.com/golangci/golangci-lint +# package_source_url: https://github.com/golangci/golangci-lint +# docs_url: https://golangci-lint.run +# bug_tracker_url: https://github.com/golangci/golangci-lint/issues +# tags: "go golang lint linter" +# release_notes: "https://github.com/golangci/golangci-lint/releases/tag/v{{ .Version }}" +# api_key: "{{ .Env.CHOCOLATEY_API_KEY }}" +# source_repo: "https://push.chocolatey.org/" +# goamd64: v1 + +aurs: + - description: Fast linters runner for Go. + skip_upload: false + homepage: https://golangci.com + provides: + - "golangci-lint-bin" + maintainers: + - "Fernandez Ludovic " + license: GPL-3.0 + private_key: "{{ .Env.AUR_KEY }}" + git_url: "ssh://aur@aur.archlinux.org/golangci-lint-bin.git" + commit_author: + name: golangci-releaser + email: 65486276+golangci-releaser@users.noreply.github.com + package: |- + local x86_64=amd64 i686=386 aarch64=arm64 armv6h=armv6 armv7h=armv7 + cd "golangci-lint-${pkgver}-linux-${!CARCH}" + + # bin + install -Dm755 "./golangci-lint" "${pkgdir}/usr/bin/golangci-lint" + + # license + install -Dm644 "./LICENSE" "${pkgdir}/usr/share/licenses/golangci-lint/LICENSE" + + # completions + mkdir -p "${pkgdir}/usr/share/bash-completion/completions/" + mkdir -p "${pkgdir}/usr/share/zsh/site-functions/" + mkdir -p "${pkgdir}/usr/share/fish/vendor_completions.d/" + ./golangci-lint completion bash | install -Dm644 /dev/stdin "${pkgdir}/usr/share/bash-completion/completions/golangci-lint" + ./golangci-lint completion zsh | install -Dm644 /dev/stdin "${pkgdir}/usr/share/zsh/site-functions/_golangci-lint" + ./golangci-lint completion fish | install -Dm644 /dev/stdin "${pkgdir}/usr/share/fish/vendor_completions.d/golangci-lint.fish" + +aur_sources: + - description: Fast linters runner for Go. + skip_upload: false + homepage: https://golangci.com + provides: + - "golangci-lint" + maintainers: + - "Fernandez Ludovic " + license: GPL-3.0 + private_key: "{{ .Env.AUR_KEY }}" + git_url: "ssh://aur@aur.archlinux.org/golangci-lint.git" + commit_author: + name: golangci-releaser + email: 65486276+golangci-releaser@users.noreply.github.com + build: |- + local _commit _flags + _commit=$(bsdcat "${pkgname}_${pkgver}.tar.gz" | git get-tar-commit-id) + _flags=( + -X=main.version="$pkgver" + -X=main.commit="${_commit::7}" + -X=main.date="$(date -u -d "@${SOURCE_DATE_EPOCH}" +'%FT%TZ')" + -linkmode=external + ) + export CGO_ENABLED=1 + export CGO_CFLAGS="${CFLAGS}" + export CGO_CPPFLAGS="$CPPFLAGS" + export CGO_CXXFLAGS="$CXXFLAGS" + export CGO_LDFLAGS="${LDFLAGS}" + export GOFLAGS='-buildmode=pie -trimpath -modcacherw' + + go build -o "$pkgname" -ldflags="${_flags[*]}" ./cmd/"$pkgname" + ./"$pkgname" completion bash > completion.bash + ./"$pkgname" completion zsh > completion.zsh + ./"$pkgname" completion fish > completion.fish + package: |- + install -Dm755 "$pkgname" -t "$pkgdir"/usr/bin + install -Dm644 completion.bash "$pkgdir"/usr/share/bash-completion/completions/"$pkgname" + install -Dm644 completion.zsh "$pkgdir"/usr/share/zsh/site-functions/_"$pkgname" + install -Dm644 completion.fish "$pkgdir"/usr/share/fish/vendor_completions.d/"$pkgname".fish + +snapcrafts: + - summary: Fast linters runner for Go. + description: | + It runs linters in parallel, uses caching, supports YAML configuration, integrates with all major IDEs, and includes over a hundred linters. + disable: false + publish: true + name_template: "{{ .ProjectName }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}" + grade: stable + confinement: classic + license: GPL-3.0 + base: core22 + nfpms: - - + - description: Fast linters Runner for Go + homepage: https://golangci-lint.run/ id: golangci-lint-nfpms package_name: golangci-lint file_name_template: "{{ .ProjectName }}-{{ .Version }}-{{ .Os }}-{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}" - homepage: https://golangci-lint.run/ - maintainer: "golangci-lint Team " - description: Fast linters Runner for Go + maintainer: "Golangci-lint Maintainers <65486276+golangci-releaser@users.noreply.github.com>" license: GPLv3 + vendor: golangci section: golang formats: - deb @@ -132,3 +259,122 @@ nfpms: - /usr/bin/go rpm: group: Development/Tools + +docker_manifests: + # basic + - name_template: 'golangci/golangci-lint:latest' + image_templates: + - 'golangci/golangci-lint:{{ .Tag }}-amd64' + - 'golangci/golangci-lint:{{ .Tag }}-arm64' + + - name_template: 'golangci/golangci-lint:v{{ .Major }}.{{ .Minor }}' + image_templates: + - 'golangci/golangci-lint:v{{ .Major }}.{{ .Minor }}-amd64' + - 'golangci/golangci-lint:v{{ .Major }}.{{ .Minor }}-arm64' + + - name_template: 'golangci/golangci-lint:{{ .Tag }}' + image_templates: + - 'golangci/golangci-lint:{{ .Tag }}-amd64' + - 'golangci/golangci-lint:{{ .Tag }}-arm64' + + # alpine + - name_template: 'golangci/golangci-lint:latest-alpine' + image_templates: + - 'golangci/golangci-lint:{{ .Tag }}-alpine-amd64' + - 'golangci/golangci-lint:{{ .Tag }}-alpine-arm64' + + - name_template: 'golangci/golangci-lint:v{{ .Major }}.{{ .Minor }}-alpine' + image_templates: + - 'golangci/golangci-lint:v{{ .Major }}.{{ .Minor }}-alpine-amd64' + - 'golangci/golangci-lint:v{{ .Major }}.{{ .Minor }}-alpine-arm64' + + - name_template: 'golangci/golangci-lint:{{ .Tag }}-alpine' + image_templates: + - 'golangci/golangci-lint:{{ .Tag }}-alpine-amd64' + - 'golangci/golangci-lint:{{ .Tag }}-alpine-arm64' + +dockers: + - use: buildx + skip_push: false + goos: linux + goarch: amd64 + dockerfile: build/buildx.Dockerfile + image_templates: + - 'golangci/golangci-lint:latest-amd64' + - 'golangci/golangci-lint:{{ .Tag }}-amd64' + - 'golangci/golangci-lint:v{{ .Major }}.{{ .Minor }}-amd64' + build_flag_templates: + - '--pull' + # https://github.com/opencontainers/image-spec/blob/main/annotations.md#pre-defined-annotation-keys + - '--label=org.opencontainers.image.title={{.ProjectName}}' + - '--label=org.opencontainers.image.description=Fast linters Runner for Go' + - '--label=org.opencontainers.image.source={{.GitURL}}' + - '--label=org.opencontainers.image.url={{.GitURL}}' + - '--label=org.opencontainers.image.documentation=https://golangci-lint.run' + - '--label=org.opencontainers.image.created={{.Date}}' + - '--label=org.opencontainers.image.revision={{.FullCommit}}' + - '--label=org.opencontainers.image.version={{.Version}}' + - '--platform=linux/amd64' + + - use: buildx + goos: linux + goarch: arm64 + dockerfile: build/buildx.Dockerfile + image_templates: + - 'golangci/golangci-lint:latest-arm64' + - 'golangci/golangci-lint:{{ .Tag }}-arm64' + - 'golangci/golangci-lint:v{{ .Major }}.{{ .Minor }}-arm64' + build_flag_templates: + - '--pull' + # https://github.com/opencontainers/image-spec/blob/main/annotations.md#pre-defined-annotation-keys + - '--label=org.opencontainers.image.title={{.ProjectName}}' + - '--label=org.opencontainers.image.description=Fast linters Runner for Go' + - '--label=org.opencontainers.image.source={{.GitURL}}' + - '--label=org.opencontainers.image.url={{.GitURL}}' + - '--label=org.opencontainers.image.documentation=https://golangci-lint.run' + - '--label=org.opencontainers.image.created={{.Date}}' + - '--label=org.opencontainers.image.revision={{.FullCommit}}' + - '--label=org.opencontainers.image.version={{.Version}}' + - '--platform=linux/arm64' + + - use: buildx + goos: linux + goarch: amd64 + dockerfile: build/buildx-alpine.Dockerfile + image_templates: + - 'golangci/golangci-lint:latest-alpine-amd64' + - 'golangci/golangci-lint:{{ .Tag }}-alpine-amd64' + - 'golangci/golangci-lint:v{{ .Major }}.{{ .Minor }}-alpine-amd64' + build_flag_templates: + - '--pull' + # https://github.com/opencontainers/image-spec/blob/main/annotations.md#pre-defined-annotation-keys + - '--label=org.opencontainers.image.title={{.ProjectName}}' + - '--label=org.opencontainers.image.description=Fast linters Runner for Go' + - '--label=org.opencontainers.image.source={{.GitURL}}' + - '--label=org.opencontainers.image.url={{.GitURL}}' + - '--label=org.opencontainers.image.documentation=https://golangci-lint.run' + - '--label=org.opencontainers.image.created={{.Date}}' + - '--label=org.opencontainers.image.revision={{.FullCommit}}' + - '--label=org.opencontainers.image.version={{.Version}}' + - '--platform=linux/amd64' + + - use: buildx + goos: linux + goarch: arm64 + dockerfile: build/buildx-alpine.Dockerfile + image_templates: + - 'golangci/golangci-lint:latest-alpine-arm64' + - 'golangci/golangci-lint:{{ .Tag }}-alpine-arm64' + - 'golangci/golangci-lint:v{{ .Major }}.{{ .Minor }}-alpine-arm64' + build_flag_templates: + - '--pull' + # https://github.com/opencontainers/image-spec/blob/main/annotations.md#pre-defined-annotation-keys + - '--label=org.opencontainers.image.title={{.ProjectName}}' + - '--label=org.opencontainers.image.description=Fast linters Runner for Go' + - '--label=org.opencontainers.image.source={{.GitURL}}' + - '--label=org.opencontainers.image.url={{.GitURL}}' + - '--label=org.opencontainers.image.documentation=https://golangci-lint.run' + - '--label=org.opencontainers.image.created={{.Date}}' + - '--label=org.opencontainers.image.revision={{.FullCommit}}' + - '--label=org.opencontainers.image.version={{.Version}}' + - '--platform=linux/arm64' diff --git a/.markdownlint.yaml b/.markdownlint.yaml deleted file mode 100644 index 27414b89658b..000000000000 --- a/.markdownlint.yaml +++ /dev/null @@ -1,2 +0,0 @@ -MD013: false -MD033: false \ No newline at end of file diff --git a/.nancy-ignore b/.nancy-ignore deleted file mode 100644 index 14640b03c4cd..000000000000 --- a/.nancy-ignore +++ /dev/null @@ -1,27 +0,0 @@ -# Skip for indirect dependency github.com/coreos/etcd@3.3.13 -CVE-2020-15114 -CVE-2020-15115 -CVE-2020-15136 - -# Skip for indirect dependency github.com/gogo/protobuf@1.3.1 -CVE-2021-3121 - -# Skip for indirect dependency github.com/dgrijalva/jwt-go@3.2.0 -CVE-2020-26160 - -# Skip for indirect dependencies: -# golang/github.com/hashicorp/consul/api@v1.12.0 -# golang/github.com/hashicorp/consul/sdk@v0.8.0 -CVE-2022-29153 -CVE-2022-24687 -CVE-2021-41803 - -# Skip for indirect dependencies golang/github.com/valyala/fasthttp@v1.30.0 -CVE-2022-21221 - -# Skip for indirect dependencies golang/golang.org/x/net -CVE-2022-41723 -CVE-2023-3978 - -# Skip for indirect dependencies golang/google.golang.org/grpc@v1.46.2 -CVE-2023-32731 diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml index 2e622bc5df3c..dea4b598a090 100644 --- a/.pre-commit-hooks.yaml +++ b/.pre-commit-hooks.yaml @@ -14,3 +14,10 @@ language: golang require_serial: true pass_filenames: false +- id: golangci-lint-config-verify + name: golangci-lint-config-verify + description: Verifies the configuration file + entry: golangci-lint config verify + files: '\.golangci\.(?:yml|yaml|toml|json)' + language: golang + pass_filenames: false diff --git a/CHANGELOG.md b/CHANGELOG.md index aa174f9ca21a..e633c1509c85 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,628 @@ -Follow the news and releases on [Mastodon](https://fosstodon.org/@golangcilint) and on [Twitter](https://twitter.com/golangci). +Follow the news and releases on [Mastodon](https://fosstodon.org/@golangcilint) and on [Bluesky](https://bsky.app/profile/golangci-lint.run). + +`golangci-lint` is a free and open-source project built by volunteers. + +If you value it, consider supporting us, we appreciate it! ❤️ + +[![Open Collective backers and sponsors](https://img.shields.io/badge/OpenCollective-Donate-blue?logo=opencollective&style=for-the-badge)](https://opencollective.com/golangci-lint) +[![GitHub Sponsors](https://img.shields.io/badge/GitHub-Donate-blue?logo=github&style=for-the-badge)](https://github.com/sponsors/golangci) + +### v1.64.8 + +* Detects use pf configuration files from golangci-lint v2 + +### v1.64.7 + +1. Linters bug fixes + * `depguard`: from 2.2.0 to 2.2.1 + * `dupl`: from 3e9179ac440a to f665c8d69b32 + * `gosec`: from 2.22.1 to 2.22.2 + * `staticcheck`: from 0.6.0 to 0.6.1 +2. Documentation + * Add GitLab documentation -There is the most valuable changes log: +### v1.64.6 + +1. Linters bug fixes + * `asciicheck`: from 0.4.0 to 0.4.1 + * `contextcheck`: from 1.1.5 to 1.1.6 + * `errcheck`: from 1.8.0 to 1.9.0 + * `exptostd`: from 0.4.1 to 0.4.2 + * `ginkgolinter`: from 0.19.0 to 0.19.1 + * `go-exhaustruct`: from 3.3.0 to 3.3.1 + * `gocheckcompilerdirectives`: from 1.2.1 to 1.3.0 + * `godot`: from 1.4.20 to 1.5.0 + * `perfsprint`: from 0.8.1 to 0.8.2 + * `revive`: from 1.6.1 to 1.7.0 + * `tagalign`: from 1.4.1 to 1.4.2 + +### v1.64.5 + +1. Bug fixes + * Add missing flag `new-from-merge-base-flag` +2. Linters bug fixes + * `asciicheck`: from 0.3.0 to 0.4.0 + * `forcetypeassert`: from 0.1.0 to 0.2.0 + * `gosec`: from 2.22.0 to 2.22.1 + +### v1.64.4 + +1. Linters bug fixes + * `gci`: fix standard packages list for go1.24 + +### v1.64.3 + +1. Linters bug fixes + * `ginkgolinter`: from 0.18.4 to 0.19.0 + * `go-critic`: from 0.11.5 to 0.12.0 + * `revive`: from 1.6.0 to 1.6.1 + * `gci`: fix standard packages list for go1.24 +2. Misc. + * Build Docker images with go1.24 + +### v1.64.2 + +This is the last minor release of golangci-lint v1. +The next release will be golangci-lint [v2](https://github.com/golangci/golangci-lint/issues/5300). + +1. Enhancements + * 🎉 go1.24 support + * New `issues.new-from-merge-base` option + * New `run.relative-path-mode` option +2. Linters new features + * `copyloopvar`: from 1.1.0 to 1.2.1 (support suggested fixes) + * `exptostd`: from 0.3.1 to 0.4.1 (handles `golang.org/x/exp/constraints.Ordered`) + * `fatcontext`: from 0.5.3 to 0.7.1 (new option: `check-struct-pointers`) + * `perfsprint`: from 0.7.1 to 0.8.1 (new options: `integer-format`, `error-format`, `string-format`, `bool-format`, and `hex-format`) + * `revive`: from 1.5.1 to 1.6.0 (new rules: `redundant-build-tag`, `use-errors-new`. New option `early-return.early-return`) +3. Linters bug fixes + * `go-errorlint`: from 1.7.0 to 1.7.1 + * `gochecknoglobals`: from 0.2.1 to 0.2.2 + * `godox`: from 006bad1f9d26 to 1.1.0 + * `gosec`: from 2.21.4 to 2.22.0 + * `iface`: from 1.3.0 to 1.3.1 + * `nilnesserr`: from 0.1.1 to 0.1.2 + * `protogetter`: from 0.3.8 to 0.3.9 + * `sloglint`: from 0.7.2 to 0.9.0 + * `spancheck`: fix default `StartSpanMatchersSlice` values + * `staticcheck`: from 0.5.1 to 0.6.0 +4. Deprecations + * ⚠️ `tenv` is deprecated and replaced by `usetesting.os-setenv: true`. + * ⚠️ `exportloopref` deprecation step 2 +5. Misc. + * Sanitize severities by output format + * Avoid panic with plugin without description +6. Documentation + * Clarify `depguard` configuration + +### v1.64.1 + +Cancelled due to CI failure. + +### v1.64.0 + +Cancelled due to CI failure. + +### v1.63.4 + +1. Linters bug fixes + * `dupl`, `gomodguard`, `revive`: keep only Go-files. + +### v1.63.3 + +1. Linters bug fixes + * `gofmt`, `gofumpt`, `goimports`, `gci`: panic with several trailing EOL + * `goheader`: skip issues with invalid positions + +### v1.63.2 + +1. Linters bug fixes + * `gofmt`, `gofumpt`, `goimports`, `gci`: panic with missing trailing EOL + +### v1.63.1 + +1. Linters bug fixes + * `cgi`: invalid reports with cgo + * `gofumpt`: panic with autofix and cgo + +### v1.63.0 + +1. Enhancements + * Add support for SuggestedFixes 🎉 (35 linters can "autofix" reports). + * Formatters (`gofmt`, `goimports`, `gofumpt`, `gci`) are applied after the suggested fixes. +2. New linters + * Add `exptostd` linter https://github.com/ldez/exptostd + * Add `nilnesserr` linter https://github.com/alingse/nilnesserr + * Add `usetesting` linter https://github.com/ldez/usetesting +3. Linters new features + * `gci`: new options: `no-inline-comments`, `no-prefix-comments` + * `gomoddirectives`: from 0.2.4 to 0.6.0 (new options: `go-version-pattern`, `toolchain-pattern`,`toolchain-forbidden`, `tool-forbidden`, `go-debug-forbidden`) + * `govet`: new `stdversion`, `waitgroup` analyzers + * `importas`: allow multiple empty aliases + * `loggercheck`: new `slog` option + * `recvcheck`: from 0.1.2 to 0.2.0 (new options: `disable-builtin`, `exclusions`) + * `tagliatelle`: from 0.5.0 to 0.7.1 (new options: `ignored-fields`, `extended-rules`,`overrides`, `pkg`, `ignore`) + * `usestdlibvars`: from 1.27.0 to 1.28.0 (autofix) + * `wrapcheck`: from 2.9.0 to 2.10.0 (new option: `extra-ignore-sigs`) +4. Linters bug fixes + * `asciicheck`: from 0.2.0 to 0.3.0 + * `bodyclose`: from 574207250966 to ed6a65f985e + * `funlen`: from 0.1.0 to 0.2.0 + * `ginkgolinter`: from 0.18.3 to 0.18.4 + * `gochecksumtype`: from 0.2.0 to 0.3.1 + * `gocognit`: from 1.1.3 to 1.2.0 + * `godot`: from 1.4.18 to 1.4.20 + * `goheader`: report position improvement + * `gosec`: handling of global nosec option when it is false + * `iface`: from 1.2.1 to 1.3.0 + * `importas`: from 0.1.0 to 0.2.0 + * `intrange`: from 0.2.1 to 0.3.0 + * `makezero`: from 1.1.1 to 1.2.0 + * `mirror`: from 1.2.0 to 1.3.0 + * `nilnil`: from 1.0.0 to 1.0.1 + * `nosprintfhostport`: from 0.1.1 to 0.2.0 + * `reassign`: from 0.2.0 to 0.3.0 + * `spancheck`: from 0.6.2 to 0.6.4 + * `tagalign`: from 1.3.4 to 1.4.1 + * `wastedassign`: from 2.0.7 to 2.1.0 + * `whitespace`: from 0.1.1 to 0.2.0 + * `wsl`: from 4.4.1 to 4.5.0 +5. Deprecations + * ⚠️ `output.uniq-by-line` is deprecated and replaced by `issues.uniq-by-line`. +6. Misc. + * Improvements of the help command (color and JSON support). + * Removes `decoder`, `sloglint`, `tagalign` from `format` preset. + * Enables paths with junction inside Windows. + * The timeout is disabled if `run.timeout` <= 0. + +### v1.62.2 + +1. Linters bug fixes + * `fatcontext`: from 0.5.2 to 0.5.3 + * `ginkgolinter`: from 0.18.0 to 0.18.3 + * `errorlint`: from 1.6.0 to 1.7.0 + * `iface`: from 1.2.0 to 1.2.1 + * `revive`: from 1.5.0 to 1.5.1 + * `testifylint`: from 1.5.0 to 1.5.2 +2. Misc. + * fix: ignore cache error when file not found + +### v1.62.1 + +Cancelled due to CI failure. + +### v1.62.0 + +1. New linters + * Add `recvcheck` linter https://github.com/raeperd/recvcheck + * Add `iface` linter https://github.com/uudashr/iface +2. Linters new features + * `ginkgolinter`: from 0.17.0 to 0.18.0 (new option: `force-succeed`) + * `gochecksumtype`: from 0.1.4 to 0.2.0 (new option: `default-signifies-exhaustive`) + * `loggercheck`: from 0.9.4 to 0.10.1 (`log/slog` support) + * `nilnil`: from 0.1.9 to 1.0.0 (new option: `detect-opposite`) + * `revive`: from 1.3.9 to 1.5.0 (new rules: `filename-format`, and `file-length-limit`) + * `tenv`: from 1.10.0 to 1.12.1 (handle dot import) + * `testifylint`: from 1.4.3 to 1.5.0 (new checkers: `contains`, `encoded-compare`, `regexp`) +3. Linters bug fixes + * `bidichk`: from 0.2.7 to 0.3.2 (important performance improvement) + * `canonicalheader`: from 1.1.1 to 1.1.2 + * `cyclop`: from 1.2.1 to 1.2.3 + * `dupword`: from 0.1.1 to 0.1.3 + * `errcheck`: from 1.7.0 to 1.8.0 + * `errchkjson`: from 0.3.6 to 0.4.0 + * `errname`: from 0.1.13 to 1.0.0 + * `gocritic`: from 0.11.4 to 0.11.5 + * `goprintffuncname`: from 7558a9eaa5af to v0.1.0 + * `godot`: from 1.4.17 to 1.4.18 + * `gosec`: from 2.21.2 to 2.21.4 + * `intrange`: from 0.2.0 to 0.2.1 + * `musttag`: from 0.12.2 to 0.13.0 + * `nakedret`: from 2.0.4 to 2.0.5 + * `noctx`: from 0.0.2 to 0.1.0 + * `protogetter`: from 0.3.6 to 0.3.8 +4. Deprecations + * ⚠️ `execinquery`: deprecation step 2 + * ⚠️ `gomnd`: deprecation step 2 (replaced by `mnd`) +5. Misc. + * Type sizing when cross-compiling (32-bit). + * code-climate: add check_name field + * Improve Go version detection + * Fix Go version propagation +6. Documentation + * Adds a section about `exclude-dirs-use-default` + * Improve 'install from sources' section + * Improve FAQ about Go versions + * Improve linter/rule/check docs + * Improve new linter section + * Improve `forbidigo` pattern examples for built-in functions + +### v1.61.0 + +1. Enhancements + * Add `junit-xml-extended` format + * Exclude Swagger Codegen files by default +2. Linters new features + * `gci`: from 0.13.4 to 0.13.5 (new option `no-lex-order`) + * `nolintlint`: remove the empty line in the directive replacement +3. Linters bug fixes + * `dupword`: from 0.0.14 to 0.1.1 + * `fatcontext`: from 0.4.0 to 0.5.2 + * `go-ruleguard`: from 0.4.2 to 0fe6f58b47b1 (fix panic with custom linters) + * `godot`: from 1.4.16 to 1.4.17 + * `gomodguard`: from 1.3.3 to 1.3.5 + * `gosec`: disable temporarily `G407` + * `gosec`: from ab3f6c1c83a0 to 2.21.2 (partially fix `G115`) + * `intrange`: from 0.1.2 to 0.2.0 +4. Misc. + * Improve runtime version parsing +5. Documentation + * Add additional info about `typecheck` + +### v1.60.3 + +1. Updated linters + * `gosec`: from 81cda2f91fbe to ab3f6c1c83a0 (fix `G115` false positives) +2. Misc. + * Check that the Go version use to build is greater or equals to the Go version of the project + +### v1.60.2 + +1. Linters new features + * `gosec`: from 5f0084eb01a9 to 81cda2f91fbe (adds `G115`, `G405`, `G406`, `G506`, `G507`) +2. Linters bug fixes + * `gofmt`: update to HEAD (go1.22) + * `gofumpt`: from 0.6.0 to 0.7.0 + * `gosec`: fix G602 analyzer + * `staticcheck`: from 0.5.0 to 0.5.1 + * `staticcheck`: propagate Go version + * `wrapcheck`: from 2.8.3 to 2.9.0 +3. Deprecations + * ⚠️ `exportloopref`: deprecation + +### v1.60.1 + +1. Misc. + * 🎉 go1.23 support +2. Linters new features + * `exhaustruct`: from 3.2.0 to 3.3.0 (recognize custom error values in return) + * `govet` (`printf`): report non-constant format, no args + * `lll`: advertise max line length instead of just reporting failure + * `revive`: from 1.3.7 to 1.3.9 (new rule: `comments-density`) + * `staticcheck`: from 0.4.7 to 0.5.0 + * `testifylint`: from 1.3.1 to 1.4.3 (new options: `formatter`, `suite-broken-parallel`, `suite-subtest-run`) +3. Linters bug fixes + * `errorlint`: from 1.5.2 to 1.6.0 + * `fatcontext`: from 0.2.2 to 0.4.0 (fix false positives for context stored in structs) + * `gocognit`: from 1.1.2 to 1.1.3 + * `gomodguard`: from 1.3.2 to 1.3.3 + * `sloglint`: from 0.7.1 to 0.7.2 + * `spancheck`: from 0.6.1 to 0.6.2 + * `tenv`: from 1.7.1 to 1.10.0 (remove reports on fuzzing) + * `tparallel`: from 0.3.1 to 0.3.2 + * `usestdlibvars`: from 1.26.0 to 1.27.0 (fix false-positive with number used inside a mathematical operations) + * `wsl`: from 4.2.1 to 4.4.1 +4. Deprecations + * ️⚠️ `unused`: remove `exported-is-used` option +5. Fixes + * SARIF: sanitize level property + * ️⚠️ `typecheck` issues should never be ignored +6. Documentation + * Add link on linter without configuration + * Remove 'trusted by' page + * `wsl` update documentation of the configuration + +### v1.60.0 + +Cancelled due to a CI problem. + +### v1.59.1 + +1. Updated linters + * `errorlint`: from 1.5.1 to 1.5.2 + * `gomnd`: deprecated configuration compatibility + * `intrange`: add `style` preset + * `misspell`: from 0.5.1 to 0.6.0 + * `sloglint`: from 0.7.0 to 0.7.1 + * `testifylint`: from 1.3.0 to 1.3.1 + * `unparam`: bump to HEAD + * `usestdlibvars`: from 1.25.0 to 1.26.0 +2. Fixes + * SARIF: init empty result slice + * SARIF: issue column >= 1 +3. Documentation + * `revive`: update documentation of the configuration + +### v1.59.0 + +1. Enhancements + * Add SARIF output format + * Allow the analysis of generated files (`issues.exclude-generated: disable`) +2. Updated linters + * `errcheck`: fix deprecation warning + * `gocritic`: from 0.11.3 to 0.11.4 + * `gosec`: from 2.20.0 to 5f0084eb01a9 (fix G601 and G113 performance issues) + * `sloglint`: from 0.6.0 to 0.7.0 (new option `forbidden-keys`) + * `testifylint`: from 1.2.0 to 1.3.0 (new checker `negative-positive` and new option `go-require.ignore-http-handlers`) +3. Misc. + * ️️⚠️ Deprecate `github-action` output format + * ️️⚠️ Deprecate `issues.exclude-generated-strict` option (replaced by `issues.exclude-generated: strict`) + * ️️⚠️ Add warning about disabled and deprecated linters (level 2) + +### v1.58.2 + +1. Updated linters + * `canonicalheader`: from 1.0.6 to 1.1.1 + * `gosec`: from 2.19.0 to 2.20.0 + * `musttag`: from 0.12.1 to 0.12.2 + * `nilnil`: from 0.1.8 to 0.1.9 +2. Documentation + * Improve integrations and install pages + +### v1.58.1 + +1. Updated linters + * `tagalign`: from 1.3.3 to 1.3.4 + * `protogetter`: from 0.3.5 to 0.3.6 + * `gochecknoinits`: fix analyzer name +2. Fixes + * Restores previous `github-actions` output format (removes GitHub Action problem matchers) + +### v1.58.0 + +1. New linters + * `fatcontext`: https://github.com/Crocmagnon/fatcontext + * `canonicalheader`: https://github.com/lasiar/canonicalheader +2. Updated linters + * `copyloopvar`: from 1.0.10 to 1.1.0 (`ignore-alias` is replaced by `check-alias` with the opposite behavior) + * `decorder`: from 0.4.1 to 0.4.2 + * `errname`: from 0.1.12 to 0.1.13 + * `errorlint`: from 1.4.8 to 1.5.1 (new options `allowed-errors` and `allowed-errors-wildcard`) + * `execinquery`: deprecate linter ⚠️ + * `gci`: from 0.12.3 to 0.13.4 (new section `localModule`) + * `gocritic`: from 0.11.2 to 0.11.3 + * `spancheck`: from 0.5.3 to 0.6.1 + * `goerr113` is replaced by `err113` ⚠️ + * `gomnd` is replaced by `mnd` ⚠️ + * `gomodguard`: from 1.3.1 to 1.3.2 + * `grouper`: from 1.1.1 to 1.1.2 + * `intrange`: from 0.1.1 to 0.1.2 + * `mirror`: from 1.1.0 to 1.2.0 + * `misspell`: from 0.4.1 to 0.5.1 + * `musttag`: from 0.9.0 to 0.12.1 + * `nilnil`: from 0.1.7 to 0.1.8 + * `nonamedreturns`: from 1.0.4 to 1.0.5 + * `promlinter`: from 0.2.0 to 0.3.0 + * `sloglint`: from 0.5.0 to 0.6.0 + * `unparam`: bump to HEAD (063aff900ca150b80930c8de76f11d7e6488222f) + * `whitespace`: from 0.1.0 to 0.1.1 +3. Enhancements + * Speed up "fast" linters when only "fast" linters are run: between 40% and 80% faster at first run (i.e. without cache) +4. Fixes + * Use version with module plugins + * Skip `go.mod` report inside autogenerated processor + * Keep only `typecheck` issues when needed + * Don't hide `typecheck` errors inside diff processor +5. Misc. + * ⚠️ log an error when using previously deprecated linters ([Linter Deprecation Cycle](https://golangci-lint.run/product/roadmap/#linter-deprecation-cycle)) + * [`deadcode`](https://github.com/remyoudompheng/go-misc/tree/HEAD/deadcode): deprecated since v1.49.0 (2022-08-23). + * [`exhaustivestruct`](https://github.com/mbilski/exhaustivestruct): deprecated since v1.46.0 (2022-05-08). + * [`golint`](https://github.com/golang/lint): deprecated since v1.41.0 (2021-06-15). + * [`ifshort`](https://github.com/esimonov/ifshort): deprecated since v1.48.0 (2022-08-04). + * [`interfacer`](https://github.com/mvdan/interfacer): deprecated since v1.38.0 (2021-03-03). + * [`maligned`](https://github.com/mdempsky/maligned): deprecated since v1.38.0 (2021-03-03). + * [`nosnakecase`](https://github.com/sivchari/nosnakecase): deprecated since v1.48.0 (2022-08-04). + * [`scopelint`](https://github.com/kyoh86/scopelint): deprecated since v1.39.0 (2021-03-25). + * [`structcheck`](https://github.com/opennota/check): deprecated since v1.49.0 (2022-08-23). + * [`varcheck`](https://github.com/opennota/check): deprecated since v1.49.0 (2022-08-23). + * ⚠️ Deprecate usage of linter alternative names + * Remove help display on errors with `config verify` command + * Add `pre-commit` hook to run `config verify` + * Improve `github-action` output +6. Documentation + * Remove deprecated Atom from Editor Integrations + +GitHub Action (v5.1.0) for golangci-lint: +- supports for `pull`, `pull_request_target`, and `merge_group` events with the option `only-new-issues`. +- ️️⚠️ `skip-pkg-cache` and `skip-build-cache` have been removed because the cache related to Go itself is already handled by `actions/setup-go`. +- with golangci-lint v1.58, the file information (path and position) will be displayed on the log. + +### v1.57.2 + +1. Updated linters + * `contextcheck`: from 1.1.4 to 1.1.5 + * `copyloopvar`: from 1.0.8 to 1.0.10 + * `ginkgolinter`: from 0.16.1 to 0.16.2 + * `goconst`: from 1.7.0 to 1.7.1 + * `gomoddirectives`: from 0.2.3 to 0.2.4 + * `intrange`: from 0.1.0 to 0.1.1 +2. Misc. + * Display warnings on deprecated linter options + * Fix missing `colored-tab` output format + * Fix TeamCity `inspectionType` service message +3. Documentation + * Remove invalid example about mixing files and directory + * Improve linters page + +### v1.57.1 + +1. Fixes + * Ignore issues with invalid position (e.g. `contextcheck`). + +### v1.57.0 + +1. New linters + * `copyloopvar`: https://github.com/karamaru-alpha/copyloopvar + * `intrange`: https://github.com/ckaznocha/intrange +2. Updated linters + * `dupword`: from 0.0.13 to 0.0.14 + * `gci`: from 0.12.1 to 0.12.3 + * `ginkgolinter`: from 0.15.2 to 0.16.1 (new option `force-expect-to`, `validate-async-intervals`, and `forbid-spec-pollution`) + * `go-critic`: from 0.11.1 to 0.11.2 + * `go-critic`: support of `enable-all` and `disable-all` options + * `go-spancheck`: from 0.5.2 to 0.5.3 + * `gomodguard`: from 1.3.0 to 1.3.1 + * `govet`: deprecation of `check-shadowing` ⚠️ + * `govet`: disable temporarily `httpresponse` because of a bug https://github.com/golang/go/issues/66259 + * `misspell`: add `extra-words` + * `musttag`: from 0.8.0 to 0.9.0 + * `nakedret`: from 2.0.2 to 2.0.4 + * `paralleltest`: from 1.0.9 to 1.0.10 + * `perfsprint`: from 0.6.0 to 0.7.1 (new option `strconcat`) + * `protogetter`: from 0.3.4 to 0.3.5 + * `revive`: add `exclude` option + * `sloglint`: from 0.4.0 to 0.5.0 (new option `no-global`) + * `staticcheck`: from 0.4.6 to 0.4.7 + * `testifylint`: from 1.1.2 to 1.2.0 (new option `bool-compare`) + * `unconvert`: to HEAD (new options `fast-math` and `safe`) + * `wrapcheck`: from 2.8.1 to 2.8.3 + * Disable `copyloopvar` and `intrange` on Go < 1.22 +3. Enhancements + * 🧩New custom linters system https://golangci-lint.run/plugins/module-plugins/ + * Allow running only a specific linter without modifying the file configuration (`--enable-only`) + * Allow custom sort order for the reports (`output.sort-order`) + * Automatically adjust the maximum concurrency to the container CPU quota if `run.concurrency=0` + * Add `config verify` command to check the configuration against the JSON Schema + * Option to strictly follow Go generated file convention (`issues.exclude-generated-strict`) + * Syntax to not override `severity` from linters (`@linter`) + * Use severities from `gosec` + * Create automatically directory related to `output.formats.path` + * Use the first issue without inline on `mergeLineIssues` on multiple issues +4. Misc. + * ⚠️ Inactivate deprecated linters (`deadcode`, `exhaustivestruct`, `golint`, `ifshort`, `interfacer`, `maligned`, `nosnakecase`, `scopelint`, `structcheck`, `varcheck`) + * ⚠️ Deprecated CLI flags have been removed (deprecated since 2018) + * ⚠️ Move `show-stats` option from `run` to `output` configuration section + * ⚠️ Replace `run.skip-xxx` options by `issues.exclude-xxx` options + * ⚠️ Replace `output.format` by `output.formats` with a new file configuration syntax + * Internal rewrite of the CLI + * Improve 'no go files to analyze' message + * Use `GOTOOLCHAIN=auto` inside the Docker images +5. Documentation + * ⚠️ Define the linter deprecation cycle https://golangci-lint.run/product/roadmap/#linter-deprecation-cycle + * 🎉Use information from the previous release to create linter pages + * Publish JSON schema on https://golangci-lint.run/jsonschema/golangci.jsonschema.json + * Reorganize documentation pages + * Add an explanation about the configuration file inside golangci-lint repository + +**⚠️ Important ⚠️** + +1. Deprecated linters are inactivated, you still need to disable them if you are using `enable-all`. +2. Deprecated CLI flags (about linter settings and `deadline`) have been removed. + +### v1.56.2 + +1. updated linters + * `go-critic`: from 0.11.0 to 0.11.1 + * `gosec`: from 2.18.2 to 2.19.0 + * `testifylint`: from 1.1.1 to 1.1.2 + * `usestdlibvars`: from 1.24.0 to 1.25.0 + * `wsl`: from 4.2.0 to 4.2.1 +2. misc. + * Fix missing version in Docker image +3. Documentation + * Explain the limitation of `new-from-rev` and `new-from-patch` + +### v1.56.1 + +1. updated linters + * `errcheck`: from 1.6.3 to 1.7.0 + * `govet`: disable `loopclosure` with go1.22 + * `revive`: from 1.3.6 to 1.3.7 + * `testifylint`: from 1.1.0 to 1.1.1 + +### v1.56.0 + +1. new linters + * `spancheck`: https://github.com/jjti/go-spancheck +2. updated linters + * `depguard`: from 2.1.0 to 2.2.0 + * `exhaustive`: from 0.11.0 to 0.12.0 + * `exhaustruct`: from 3.1.0 to 3.2.0 + * `gci`: from 0.11.2 to 0.12.1 + * `ginkgolinter`: from 0.14.1 to 0.15.2 + * `go-check-sumtype`: from 0.1.3 to 0.1.4 + * `go-critic`: from 0.9.0 to 0.11.0 + * `go-errorlint`: from 1.4.5 to 1.4.8 + * `go-spancheck`: from 0.4.2 to 0.5.2 + * `goconst`: from 1.6.0 to 1.7.0 + * `godot`: from 1.4.15 to 1.4.16 + * `gofumpt`: from 0.5.0 to 0.6.0 + * `inamedparam`: from 0.1.2 to 0.1.3 + * `ineffassign`: from 0.0.0-20230610083614-0e73809eb601 to 0.1.0 + * `ireturn`: from 0.2.2 to 0.3.0 + * `misspell`: add mode option + * `musttag`: from v0.7.2 to v0.8.0 + * `paralleltest`: from 1.0.8 to 1.0.9 + * `perfsprint`: from 0.2.0 to 0.6.0 + * `protogetter`: from 0.2.3 to 0.3.4 + * `revive`: from 1.3.4 to 1.3.6 + * `sloglint`: add static-msg option + * `sloglint`: from 0.1.2 to 0.4.0 + * `testifylint`: from 0.2.3 to 1.1.0 + * `unparam`: from 20221223090309-7455f1af531d to 20240104100049-c549a3470d14 + * `whitespace`: update after moving to the `analysis` package + * `wsl`: from 3.4.0 to 4.2.0 + * `zerologlint`: from 0.1.3 to 0.1.5 +3. misc. + * 🎉 go1.22 support + * Implement stats per linter with a flag + * Make versioning inside Docker image consistent with binaries + * Parse Go RC version +4. Documentation + * Fix `noctx` description + * Add missing fields to `.golangci.reference.yml` + * Improve `.golangci.reference.yml` defaults + * `typecheck`: improve FAQ + * `exhaustruct`: note that struct regular expressions are expected to match the entire `package/name/structname` + * `wrapcheck`: adjust `ignoreSigs` to new defaults + +**Important** + +`testifylint` has [breaking changes](https://github.com/Antonboom/testifylint/releases/tag/v1.0.0) about enabling/disabling checks: + +- If you were using the option `enable` with a filtered list of checks, you should either add `disable-all: true` (1) or use `disable` field (2). + + ```yml + # Example (1) + testifylint: + disable-all: true + enable: + - bool-compare + - compares + - empty + - error-is-as + - error-nil + - expected-actual + - go-require + - float-compare + - len + - nil-compare + - require-error + # - suite-dont-use-pkg + - suite-extra-assert-call + - suite-thelper + ``` + + ```yml + # Example (2) + testifylint: + disable: + - suite-dont-use-pkg + ``` + +### v1.55.2 + +1. updated linters + * `ireturn`: from 0.2.1 to 0.2.2 + * `ginkgolinter`: from 0.14.0 to 0.14.1 + +### v1.55.1 + +1. updated linters + * `gosec`: from 2.18.1 to 2.18.2 +2. misc. + * `revgrep`: from v0.5.0 to v0.5.2 (support git < 2.41.0) + * output: convert backslashes to forward slashes for GitHub Action annotations printer ### v1.55.0 @@ -859,7 +1481,7 @@ IMPORTANT: `varcheck` and `deadcode` has been removed of default linters. 3. CLI: truncate multiline descriptions 4. fix: new-from-rev for a large repository 5. Support RelatedInformation for analysis Diagnostic -6. use go1.16 to create binaries +6. use go1.16 to create binaries 7. fix: MIPS release 8. documentation: * bump documentation dependencies @@ -1068,7 +1690,7 @@ IMPORTANT: `varcheck` and `deadcode` has been removed of default linters. ### April 2020 1. Add new linters: `testpackage`, `nestif`, `godot`, `gomodguard`, `asciicheck` -2. Add github actions output format +2. Add GitHub Actions output format 3. Update linters: `wsl`, `gomodguard`, `gosec` 4. Support `disabled-tags` setting for `gocritic` 5. Mitigate OOM and "failed prerequisites" @@ -1082,7 +1704,7 @@ IMPORTANT: `varcheck` and `deadcode` has been removed of default linters. 2. Add new linters: `funlen`, `whitespace` (with auto-fix) and `godox` 3. Update linters: `gochecknoglobals`, `scopelint`, `gosec` 4. Provide pre-built binary for ARM and FreeBSD -5. 2. Fix false-positives in `unused` +5. Fix false-positives in `unused` 6. Support `--skip-dirs-use-default` 7. Add support for bash completions diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 31dc61eced52..000000000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,76 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, sex characteristics, gender identity and expression, -level of experience, education, socio-economic status, nationality, personal -appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at info@golangci.com. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq diff --git a/Makefile b/Makefile index b3939327ddc4..911465f4e2da 100644 --- a/Makefile +++ b/Makefile @@ -22,35 +22,33 @@ clean: rm -f $(BINARY) rm -f test/path rm -f tools/Dracula.itermcolors - rm -f tools/goreleaser rm -f tools/svg-term rm -rf tools/node_modules .PHONY: clean # Test test: export GOLANGCI_LINT_INSTALLED = true +test: CGO_ENABLED=1 test: build GL_TEST_RUN=1 ./$(BINARY) run -v GL_TEST_RUN=1 go test -v -parallel 2 ./... .PHONY: test -# ex: T=gofmt.go make test_fix -# the value of `T` is the name of a file from `test/testdata/fix` -test_fix: build - GL_TEST_RUN=1 go test -v ./test -count 1 -run TestFix/$T -.PHONY: test_fix - test_race: build_race GL_TEST_RUN=1 ./$(BINARY) run -v --timeout=5m .PHONY: test_race -test_linters: +# ex: T=output.go make test_integration +# the value of `T` is the name of a file from `test/testdata` +test_integration: GL_TEST_RUN=1 go test -v ./test -count 1 -run TestSourcesFromTestdata/$T -.PHONY: test_linters +.PHONY: test_integration -test_linters_sub: - GL_TEST_RUN=1 go test -v ./test -count 1 -run TestSourcesFromTestdataSubDir/$T -.PHONY: test_linters_sub +# ex: T=multiple-issues-fix.go make test_integration_fix +# the value of `T` is the name of a file from `test/testdata/fix` +test_integration_fix: build + GL_TEST_RUN=1 go test -v ./test -count 1 -run TestFix/$T +.PHONY: test_integration_fix # Maintenance @@ -62,49 +60,68 @@ fast_check_generated: git checkout -- go.mod go.sum # can differ between go1.16 and go1.17 git diff --exit-code # check no changes -release: .goreleaser.yml tools/goreleaser - ./tools/goreleaser -.PHONY: release +# Benchmark + +# Benchmark with a local version +# LINTER=gosec VERSION=v1.59.0 make bench_local +bench_local: hyperfine + @:$(call check_defined, LINTER VERSION, 'missing parameter(s)') + @./scripts/bench/bench_local.sh $(LINTER) $(VERSION) +.PHONY: bench_local -snapshot: .goreleaser.yml tools/goreleaser - ./tools/goreleaser --snapshot --rm-dist -.PHONY: snapshot +# Benchmark between 2 existing versions +# make bench_version LINTER=gosec VERSION_OLD=v1.58.2 VERSION_NEW=v1.59.0 +bench_version: hyperfine + @:$(call check_defined, LINTER VERSION_OLD VERSION_NEW, 'missing parameter(s)') + @./scripts/bench/bench_version.sh $(LINTER) $(VERSION_OLD) $(VERSION_NEW) +.PHONY: bench_version + +hyperfine: + @which hyperfine > /dev/null || (echo "Please install hyperfine https://github.com/sharkdp/hyperfine#installation" && exit 1) +.PHONY: hyperfine # Non-PHONY targets (real files) $(BINARY): FORCE go build -o $@ ./cmd/golangci-lint -tools/goreleaser: export GOFLAGS = -mod=readonly -tools/goreleaser: tools/go.mod tools/go.sum - cd tools && go build github.com/goreleaser/goreleaser - -# TODO: migrate to docs/ -tools/svg-term: tools/package.json tools/package-lock.json - cd tools && npm ci - ln -sf node_modules/.bin/svg-term $@ - -# TODO: migrate to docs/ -tools/Dracula.itermcolors: - curl -fL -o $@ https://raw.githubusercontent.com/dracula/iterm/master/Dracula.itermcolors - -# TODO: migrate to docs/ -assets/demo.svg: tools/svg-term tools/Dracula.itermcolors - ./tools/svg-term --cast=183662 --out assets/demo.svg --window --width 110 --height 30 --from 2000 --to 20000 --profile ./tools/Dracula.itermcolors --term iterm2 +docs/static/demo.gif: FORCE + vhs docs/golangci-lint.tape assets/github-action-config.json: FORCE $(BINARY) # go run ./scripts/gen_github_action_config/main.go $@ - cd ./scripts/gen_github_action_config/; go run ./main.go ../../$@ + cd ./scripts/gen_github_action_config/; go run . ../../$@ go.mod: FORCE go mod tidy go mod verify go.sum: go.mod -expand_website_templates: - go run ./scripts/expand_website_templates/main.go -.PHONY: expand_website_templates - -update_contributors_list: - cd .github/contributors && npm run all - +website_copy_jsonschema: + go run ./scripts/website/copy_jsonschema/ +.PHONY: website_copy_jsonschema + +website_expand_templates: + go run ./scripts/website/expand_templates/ +.PHONY: website_expand_templates + +website_dump_info: + go run ./scripts/website/dump_info/ +.PHONY: website_dump_info + +# Functions + +# Check that given variables are set and all have non-empty values, +# die with an error otherwise. +# +# Params: +# 1. Variable name(s) to test. +# 2. (optional) Error message to print. +# +# https://stackoverflow.com/a/10858332/8228109 +check_defined = \ + $(strip $(foreach 1,$1, \ + $(call __check_defined,$1,$(strip $(value 2))))) +__check_defined = \ + $(if $(value $1),, \ + $(error Undefined $1$(if $2, ($2)))) diff --git a/README.md b/README.md index 09ca7b732e4b..ad489c5c01cd 100644 --- a/README.md +++ b/README.md @@ -6,18 +6,37 @@ --- -`golangci-lint` is a fast Go linters runner. It runs linters in parallel, uses caching, supports `yaml` config, has integrations -with all major IDE and has dozens of linters included. +`golangci-lint` is a fast Go linters runner. + +It runs linters in parallel, uses caching, supports YAML configuration, +integrates with all major IDEs, and includes over a hundred linters. ## Install `golangci-lint` -- [On my machine](https://golangci-lint.run/usage/install/#local-installation); -- [On CI/CD systems](https://golangci-lint.run/usage/install/#ci-installation). +- [On my machine](https://golangci-lint.run/welcome/install/#local-installation); +- [On CI/CD systems](https://golangci-lint.run/welcome/install/#ci-installation). ## Documentation Documentation is hosted at https://golangci-lint.run. +## Social Networks + +[![Join Slack](https://img.shields.io/badge/Slack-4285F4?logo=slack&logoColor=white)](https://gophers.slack.com/archives/CS0TBRKPC) +[![Follow on Mastodon](https://img.shields.io/badge/Mastodon-6364FF?logo=mastodon&logoColor=white)](https://fosstodon.org/@golangcilint) +[![Follow on Bluesky](https://img.shields.io/badge/Bluesky-0a7aff?logo=bluesky&logoColor=white)](https://bsky.app/profile/golangci-lint.run) +[![Follow on Twitter](https://img.shields.io/badge/Twitter-1DA1F2?logo=x&logoColor=white)](https://twitter.com/golangci) + +## Supporting Us + +[![Open Collective backers and sponsors](https://img.shields.io/badge/OpenCollective-Donate-blue?logo=opencollective&style=for-the-badge)](https://opencollective.com/golangci-lint) +[![GitHub Sponsors](https://img.shields.io/badge/GitHub-Donate-blue?logo=github&style=for-the-badge)](https://github.com/sponsors/golangci) +[![Linter Authors](https://img.shields.io/badge/Linter_Authors-Donate-blue?style=for-the-badge)](https://golangci-lint.run/product/thanks/) + +`golangci-lint` is a free and open-source project built by volunteers. + +If you value it, consider supporting us, we appreciate it! :heart: + ## Badges ![Build Status](https://github.com/golangci/golangci-lint/workflows/CI/badge.svg) @@ -30,652 +49,16 @@ Documentation is hosted at https://golangci-lint.run. This project exists thanks to all the people who contribute. [How to contribute](https://golangci-lint.run/contributing/quick-start/). - - - -### Core Team - -
-About core team - -The GolangCI Core Team is a group of contributors that have demonstrated a lasting enthusiasm for the project and community. -The GolangCI Core Team has GitHub admin privileges on the repo. + + + -#### Responsibilities -The Core Team has the following responsibilities: +## Sponsors -1. Being available to answer high-level questions about vision and future. -2. Being available to review longstanding/forgotten pull requests. -3. Occasionally check issues, offer input, and categorize with GitHub issue labels. -4. Looking out for up-and-coming members of the GolangCI community who might want to serve as Core Team members. -5. Note that the Core Team – and all GolangCI contributors – are open source volunteers; membership on the Core Team is expressly not an obligation. The Core Team is distinguished as leaders in the community and while they are a good group to turn to when someone needs an answer to a question, they are still volunteering their time, and may not be available to help immediately. - -
- - - - - - - -

Ludovic Fernandez
Denis Isaev
Aleksandr Razumov
- -### Team - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Sergey Vilgelm
Simon Sawert
Tam Mach
Trevor Pounds
Loong Dai
Kamil Samigullin
Oleg Butuzov

Sascha Grunert
Oleksandr Redko
@iwankgb
Andrew Shannon Brown
@golangci-releaser
Marat Reymers
sivchari

Pierre Durand
Ryan Currah
Sebastien Rosset
@leonklingele
Sasha Melentyev
Anton Telyshev
Denis Tingaikin

Patrick Ohly
David Lobe
Alexey Palazhchenko
Ville Skyttä
Duco van Amstel
Nishanth Shanmugham
Kensei Nakada

Melvin
quasilyte
Denis Krivak
Mitsuo Heijo
Alec Thomas
Maik Schreiber
Steve Coffman
- -
-And 431 more our team members - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Nahshon Unna Tsameret
Matouš Dzivjak
Will Dixon
Mateusz Gozdek
Michael Mulligan
Nuruddin Ashr
Joe Wilner

Soichiro Kashima
Peter Mescalchin
Lucas Bremgartner
Florian Bosdorff
Kir Kolyshkin
@alingse
Tim Heckman

Oleg Kovalov
James
Colin Arnott
Anton Zinovyev
Luke T. Shumaker
Aleksey Bakin
Márk Sági-Kazár

Rski
Ryan Boehning
Gustavo Bazan
Eugene Simonov
Steven Hartland
Timon Wong
Nate Finch

Aliaksandr Mianzhynski
ferhat elmas
Leigh McCulloch
Tom
sonatard
ZhangYunHao
Aneesh Agrawal

Vladimir Evgrafov
gaojingyu
@odidev
Denis Limarev
NiseVoid
Christian Mehlmauer
Sean DuBois

Viktoras
Fabian Holler
Yifei Liu
Agniva De Sarker
Adam Shannon
SystemGlitch
Henrik Johansson

Tom Arrell
Choko
John Starich
Koichi Shiraishi
Bart
Neha Viswanathan
Florent Viel

Lukas Malkmus
David Braley
Chris Bandy
Patrick Kuca
Viacheslav Poturaev
Zik Aeroh
sylvia

Robert Liebowitz
Zeal Wierslee
Tim Kral
Hiroyuki Yagihashi
Kyoh
Jiangnan Jia
Kunwardeep

Pierre R
Martin Desrumaux
Stephan Renatus
Ivan
tdakkota
Carlos Henrique Guardão Gandarez
Diego Pontoriero

Daniel Helfand
Benjamin Wang
Adam Jones
Paweł Żak
Faisal Alam
Alex Collins
Ryo Nakao

Ryan Olds
Tommy Mühle
Sebastiaan van Stijn
Sam Zaydel
Carlos Alexandro Becker
@Dominik-K
Craig Silverstein

Sindre Røkenes Myren
Bartłomiej Klimczak
M. Ángel Jimeno
Jan Oopkaup
Chris Drew
Teiva Harsanyi
Brian Flad

Chris Suszynski
@chenfeining
Kailun Qin
Misha Gusarov
@Abirdcfly
Ariel Mashraki
Shulhan

Oscar
Denis Isaev
Dreamacro
Tom Payne
@fsouza
Koya IWAMURA
Hiroki Suezawa

Lauris BH
Sean McGinnis
Fabrice
Christoph Blecker
Mateusz Bilski
Jakub Chábek
Ben Ye

lufe
@sg0hsmt
Stephanie Wilde-Hobbs
Cory LaNou
Vitaly Isaev
Pete Wagner
Renato Suero

Buyanov Vladimir
Sven Anderson
Ben Wells
Jonathan Chappelow
Siarhei Navatski
Yuki Okushi
hbc

WÁNG Xuěruì
Eric Wohltman
Borja Clemente
Ethan Reesor
Mattias de Zalenski
@AlduLonghi
masibw

Sonia Hamilton
@black-06
Gianguido Sorà
Derek Perkins
Oksana Grishchenko
Berezhnoy Pavel
Henry

Aofei Sheng
jessetang
Maksym Pavlenko
Ivan Prisyazhnyy
@ngehrsitz
John Reese
Matthew Gabeler-Lee

James Lucktaylor
Dale Hui
Ondrej Fabry
Aris Tzoumas
Gabor Javorszky
hori-ryota
Kishan B

proton
Eric Jain
Ghvst Code
Son Luong Ngoc
Markus
Sebastian Spaink
Andrew Lavery

Mark Fine
Rory Prendergast
Tariq Ibrahim
Peter Štibraný
kaixiang zhong
@ced42
David Bariod

Stephen Benjamin
@kkHAIKE
Hsing-Yu (David) Chen
Batuhan Apaydın
过客龙门
Eldar Rakhimberdin
Toon Schoenmakers

Cezar Sá Espinola
Ben Paxton
Connor Adams
Draven
David Cuadrado
Max Riveiro
Martins Irbe

Yilong Li
Rodrigo Brito
@techknowlogick
takaya
Craig Furman
@ttys3
Mark Sart

Joshua Rubin
Danil Ovchinnikov
Rafael Franco
Ksenia Rogova
Paul Vaughan
Linus Arver
Glen Mailer

Ian Howell
Chris K
Grigory Zubankov
@xxpxxxxp
subham sarkar
Ryan Leung
Donal Byrne

Yusuke Kadowaki
@CfirTsabari
@ImprintNav
Jared Allard
Marko
Chris Lewis
Muhammad Ikhsan

Anton Braer
Jaegu Kim
David Gleich
Fata Nugraha
mattu
Dan Richelson
Denis Titusov

Terdunov Vyacheslav
Sean Chittenden
Hui Zhu
@Harsimran1
rinsuki
Anton Antonov
@hn8

Kevin Gillette
Milas Bowman
@credativ-dar
☃ Elliot Shepherd
@nvartolomei
Martin Etmajer
Fisher Xu

Matthew Poer
Cody Ley-Han
@darklore
@to6ka
@evalexpr
Collin Kreklow
Marcin Owsiany

C.J. Jameson
Jacek
paul fisher
@ofw
Rafik Draoui
Miles Delahunty
Anton Kachurin

Nico Ismaili
Benjamin Kane
@trajan0x
Philip Linell
Herman van Zyl
Jongwoo Han
Chaliy Roman Aleksandrovich

Ryo Sato
Eric Zimanyi
Ben Bernays
Boban Acimovic
Viktor Alenkov
Dima
David Hill

Troy Ronda
Florian Gessner
Osamu TONOMORI
Bo Liu
Steven Allen
Colin Arnott
Eran Levy

Roman Leventov
Hugo
Mathias Weber
Naveen
@maxsond
Maksim Meshkov
@raffepaffe

Dejan Benedik
Adam Bouqdib
Brandur Leach
Michael
Evgeniy Kulikov
Chris Nesbitt-Smith
Daniel Caballero

Igor Zibarev
Carl Henderson
Shintaro Anazawa
Matt Braymer-Hayes
Arjen van der Ende
David Beitey
Pete Davison

Tomas Dabasinskas
@xuri
Charl Matthee
Sriram Venkatesh
Peter Schuller
David Golub
Alexander Morozov

Pastoh
Liam White
Alex Dupre
Juanito
Jinming Yue
@wxdao
Kévin Dunglas

Sijie Yang
Stephen
Thang Minh Vu
Julia Ogris
Greg Curtis
@ac-rappi
Dudás Ádám

Abhishek | अभिषेक
Daniele
Takumasa Sakao
Ben Drucker
Stephen Brown II
Matthew Cobbing
@Darlez

Kirill Danshin
mook
Kyungmin Bae
Dylan Arbour
Cory Miller
Ben Brown
Dor

sink
João Freitas
nick
David Bendory
@znley
Jonathan Colby
@andreykuchin

Irina
Petr Pučil
Aaron Bennett
zaunist
Daniil Suvorov
Yuki Watanabe
Aisuko

Tung Bui (Leo)
Kunal Singh
Alexandre Vilain
Federico Guerinoni
Matias Lahti
Thirukumaran Vaseeharan
Matheus Macabu

Alessio Treglia
Alay Patel
Martin Hutchinson
Emanuel Bennici
Mayo
smantic
@connorszczepaniak-wk

Sebastian Crane
Alexander Else
@vladopajic
Lucas Ramage
Trim21
Catena cyber
Christian Clauss

Johanan Liebermann
Korjavin Ivan
Eng Zer Jun
Mateus Esdras
Devin Gunay
Hilário Coelho
Thomas Cave

Tibo Delor
@chainchad
Francois Parquet
Robert Kopaczewski
Marc Tudurí
@opennota
@pohang

Cyrille Meichel
neglect-yp
Felix
Adrien
Joe Bergevin
Axetroy
Guillaume JG

cnmade
Evan Cordell
靳灿奇
Nassos Kat
hitzhangjie
Jesse Donat
Abhinav Gupta

KADOTA, Kyohei
Conor Evans
Anirudh Sylendranath
@jumpeiMano
Alex Rodin
Oliver Gugger
Bryan Andrews

Wei Jian Gan
Tamás Gulácsi
Jack Wilsdon
Michał Suchwałko
Alexander Apalikov
Domas Tamašauskas
Stéphane Chausson

neo_sli
@srdhoni
@derekhuizhang
takaokanbe
Sean Schneeweiss
pprzekwas
madflow

Arman Tarkhanian
John Adler
@licraft2019
@mlueckest
Malte Ehrlen
@golangaccount
Tyler Dorn

Enmanuel Moreira
@eiffel-fl
Sylvain Rabot
Piotr Persona
Han Gyoung-Su
Harry Tennent
Kamyar Mirzavaziri

Thomas Bonfort
Matthieu MOREL
Egor Kovetskiy
Jared Szechy
- -
- - - - +

 

+

+ The complete IDE crafted for professional Go developers. +

## Stargazers over time diff --git a/assets/cli-help.json b/assets/cli-help.json new file mode 100644 index 000000000000..4850452aa773 --- /dev/null +++ b/assets/cli-help.json @@ -0,0 +1,4 @@ +{ + "enable": "Enabled by default linters:\nerrcheck: Errcheck is a program for checking for unchecked errors in Go code. These unchecked errors can be critical bugs in some cases.\ngosimple: Linter for Go source code that specializes in simplifying code. [auto-fix]\ngovet: Vet examines Go source code and reports suspicious constructs. It is roughly the same as 'go vet' and uses its passes. [auto-fix]\nineffassign: Detects when assignments to existing variables are not used. [fast]\nstaticcheck: It's a set of rules from staticcheck. It's not the same thing as the staticcheck binary. The author of staticcheck doesn't support or approve the use of staticcheck as a library inside golangci-lint. [auto-fix]\nunused: Checks Go code for unused constants, variables, functions and types.", + "help": "Usage:\n golangci-lint run [flags]\n\nFlags:\n -c, --config PATH Read config from file path PATH\n --no-config Don't read config file\n -D, --disable strings Disable specific linter\n --disable-all Disable all linters\n -E, --enable strings Enable specific linter\n --enable-all Enable all linters\n --fast Enable only fast linters from enabled linters set (first run won't be fast)\n -p, --presets strings Enable presets of linters:\n - bugs\n - comment\n - complexity\n - error\n - format\n - import\n - metalinter\n - module\n - performance\n - sql\n - style\n - test\n - unused\n Run 'golangci-lint help linters' to see them.\n This option implies option --disable-all\n --enable-only strings Override linters configuration section to only run the specific linter(s)\n -j, --concurrency int Number of CPUs to use (Default: number of logical CPUs) (default 8)\n --modules-download-mode string Modules download mode. If not empty, passed as -mod=\u003cmode\u003e to go tools\n --issues-exit-code int Exit code when issues were found (default 1)\n --go string Targeted Go version\n --build-tags strings Build tags\n --timeout duration Timeout for total work. If \u003c= 0, the timeout is disabled (default 1m0s)\n --tests Analyze tests (*_test.go) (default true)\n --allow-parallel-runners Allow multiple parallel golangci-lint instances running.\n If false (default) - golangci-lint acquires file lock on start.\n --allow-serial-runners Allow multiple golangci-lint instances running, but serialize them around a lock.\n If false (default) - golangci-lint exits with an error if it fails to acquire file lock on start.\n --out-format string Formats of output:\n - json\n - line-number\n - colored-line-number\n - tab\n - colored-tab\n - checkstyle\n - code-climate\n - html\n - junit-xml\n - junit-xml-extended\n - github-actions\n - teamcity\n - sarif\n (default \"colored-line-number\")\n --print-issued-lines Print lines of code with issue (default true)\n --print-linter-name Print linter name in issue line (default true)\n --sort-results Sort linter results\n --sort-order strings Sort order of linter results\n --path-prefix string Path prefix to add to output\n --show-stats Show statistics per linter\n -e, --exclude strings Exclude issue by regexp\n --exclude-use-default Use or not use default excludes:\n - EXC0001 (errcheck): Almost all programs ignore errors on these functions and in most cases it's ok.\n Pattern: 'Error return value of .((os\\.)?std(out|err)\\..*|.*Close|.*Flush|os\\.Remove(All)?|.*print(f|ln)?|os\\.(Un)?Setenv). is not checked'\n - EXC0002 (golint): Annoying issue about not having a comment. The rare codebase has such comments.\n Pattern: '(comment on exported (method|function|type|const)|should have( a package)? comment|comment should be of the form)'\n - EXC0003 (golint): False positive when tests are defined in package 'test'.\n Pattern: 'func name will be used as test\\.Test.* by other packages, and that stutters; consider calling this'\n - EXC0004 (govet): Common false positives.\n Pattern: '(possible misuse of unsafe.Pointer|should have signature)'\n - EXC0005 (staticcheck): Developers tend to write in C-style with an explicit 'break' in a 'switch', so it's ok to ignore.\n Pattern: 'SA4011'\n - EXC0006 (gosec): Too many false-positives on 'unsafe' usage.\n Pattern: 'G103: Use of unsafe calls should be audited'\n - EXC0007 (gosec): Too many false-positives for parametrized shell calls.\n Pattern: 'G204: Subprocess launched with variable'\n - EXC0008 (gosec): Duplicated errcheck checks.\n Pattern: 'G104'\n - EXC0009 (gosec): Too many issues in popular repos.\n Pattern: '(G301|G302|G307): Expect (directory permissions to be 0750|file permissions to be 0600) or less'\n - EXC0010 (gosec): False positive is triggered by 'src, err := ioutil.ReadFile(filename)'.\n Pattern: 'G304: Potential file inclusion via variable'\n - EXC0011 (stylecheck): Annoying issue about not having a comment. The rare codebase has such comments.\n Pattern: '(ST1000|ST1020|ST1021|ST1022)'\n - EXC0012 (revive): Annoying issue about not having a comment. The rare codebase has such comments.\n Pattern: 'exported (.+) should have comment( \\(or a comment on this block\\))? or be unexported'\n - EXC0013 (revive): Annoying issue about not having a comment. The rare codebase has such comments.\n Pattern: 'package comment should be of the form \"(.+)...\"'\n - EXC0014 (revive): Annoying issue about not having a comment. The rare codebase has such comments.\n Pattern: 'comment on exported (.+) should be of the form \"(.+)...\"'\n - EXC0015 (revive): Annoying issue about not having a comment. The rare codebase has such comments.\n Pattern: 'should have a package comment' (default true)\n --exclude-case-sensitive If set to true exclude and exclude rules regular expressions are case-sensitive\n --max-issues-per-linter int Maximum issues count per one linter. Set to 0 to disable (default 50)\n --max-same-issues int Maximum count of issues with the same text. Set to 0 to disable (default 3)\n --uniq-by-line Make issues output unique by line (default true)\n --exclude-files strings Regexps of files to exclude\n --exclude-dirs strings Regexps of directories to exclude\n --exclude-dirs-use-default Use or not use default excluded directories:\n - (^|/)vendor($|/)\n - (^|/)third_party($|/)\n - (^|/)testdata($|/)\n - (^|/)examples($|/)\n - (^|/)Godeps($|/)\n - (^|/)builtin($|/)\n (default true)\n --exclude-generated string Mode of the generated files analysis (default \"lax\")\n -n, --new Show only new issues: if there are unstaged changes or untracked files, only those changes are analyzed, else only changes in HEAD~ are analyzed.\n It's a super-useful option for integration of golangci-lint into existing large codebase.\n It's not practical to fix all existing issues at the moment of integration: much better to not allow issues in new code.\n For CI setups, prefer --new-from-rev=HEAD~, as --new can skip linting the current patch if any scripts generate unstaged files before golangci-lint runs.\n --new-from-rev REV Show only new issues created after git revision REV\n --new-from-patch PATH Show only new issues created in git patch with file path PATH\n --new-from-merge-base string Show only new issues created after the best common ancestor (merge-base against HEAD)\n --whole-files Show issues in any part of update files (requires new-from-rev or new-from-patch)\n --fix Fix found issues (if it's supported by the linter)\n --cpu-profile-path string Path to CPU profile output file\n --mem-profile-path string Path to memory profile output file\n --print-resources-usage Print avg and max memory usage of golangci-lint and total time\n --trace-path string Path to trace output file\n\nGlobal Flags:\n --color string Use color when printing; can be 'always', 'auto', or 'never' (default \"auto\")\n -h, --help Help for a command\n -v, --verbose Verbose output\n" +} diff --git a/assets/default-exclusions.json b/assets/default-exclusions.json new file mode 100644 index 000000000000..5b985e5496a0 --- /dev/null +++ b/assets/default-exclusions.json @@ -0,0 +1,92 @@ +[ + { + "id": "EXC0001", + "pattern": "Error return value of .((os\\.)?std(out|err)\\..*|.*Close|.*Flush|os\\.Remove(All)?|.*print(f|ln)?|os\\.(Un)?Setenv). is not checked", + "linter": "errcheck", + "why": "Almost all programs ignore errors on these functions and in most cases it's ok." + }, + { + "id": "EXC0002", + "pattern": "(comment on exported (method|function|type|const)|should have( a package)? comment|comment should be of the form)", + "linter": "golint", + "why": "Annoying issue about not having a comment. The rare codebase has such comments." + }, + { + "id": "EXC0003", + "pattern": "func name will be used as test\\.Test.* by other packages, and that stutters; consider calling this", + "linter": "golint", + "why": "False positive when tests are defined in package 'test'." + }, + { + "id": "EXC0004", + "pattern": "(possible misuse of unsafe.Pointer|should have signature)", + "linter": "govet", + "why": "Common false positives." + }, + { + "id": "EXC0005", + "pattern": "SA4011", + "linter": "staticcheck", + "why": "Developers tend to write in C-style with an explicit 'break' in a 'switch', so it's ok to ignore." + }, + { + "id": "EXC0006", + "pattern": "G103: Use of unsafe calls should be audited", + "linter": "gosec", + "why": "Too many false-positives on 'unsafe' usage." + }, + { + "id": "EXC0007", + "pattern": "G204: Subprocess launched with variable", + "linter": "gosec", + "why": "Too many false-positives for parametrized shell calls." + }, + { + "id": "EXC0008", + "pattern": "G104", + "linter": "gosec", + "why": "Duplicated errcheck checks." + }, + { + "id": "EXC0009", + "pattern": "(G301|G302|G307): Expect (directory permissions to be 0750|file permissions to be 0600) or less", + "linter": "gosec", + "why": "Too many issues in popular repos." + }, + { + "id": "EXC0010", + "pattern": "G304: Potential file inclusion via variable", + "linter": "gosec", + "why": "False positive is triggered by 'src, err := ioutil.ReadFile(filename)'." + }, + { + "id": "EXC0011", + "pattern": "(ST1000|ST1020|ST1021|ST1022)", + "linter": "stylecheck", + "why": "Annoying issue about not having a comment. The rare codebase has such comments." + }, + { + "id": "EXC0012", + "pattern": "exported (.+) should have comment( \\(or a comment on this block\\))? or be unexported", + "linter": "revive", + "why": "Annoying issue about not having a comment. The rare codebase has such comments." + }, + { + "id": "EXC0013", + "pattern": "package comment should be of the form \"(.+)...\"", + "linter": "revive", + "why": "Annoying issue about not having a comment. The rare codebase has such comments." + }, + { + "id": "EXC0014", + "pattern": "comment on exported (.+) should be of the form \"(.+)...\"", + "linter": "revive", + "why": "Annoying issue about not having a comment. The rare codebase has such comments." + }, + { + "id": "EXC0015", + "pattern": "should have a package comment", + "linter": "revive", + "why": "Annoying issue about not having a comment. The rare codebase has such comments." + } +] diff --git a/assets/github-action-config-v1.json b/assets/github-action-config-v1.json new file mode 100644 index 000000000000..32fe14b58fb6 --- /dev/null +++ b/assets/github-action-config-v1.json @@ -0,0 +1,193 @@ +{ + "MinorVersionToConfig": { + "latest": { + "TargetVersion": "v1.64.8" + }, + "v1.10": { + "Error": "golangci-lint version 'v1.10' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.11": { + "Error": "golangci-lint version 'v1.11' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.12": { + "Error": "golangci-lint version 'v1.12' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.13": { + "Error": "golangci-lint version 'v1.13' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.14": { + "Error": "golangci-lint version 'v1.14' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.15": { + "Error": "golangci-lint version 'v1.15' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.16": { + "Error": "golangci-lint version 'v1.16' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.17": { + "Error": "golangci-lint version 'v1.17' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.18": { + "Error": "golangci-lint version 'v1.18' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.19": { + "Error": "golangci-lint version 'v1.19' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.20": { + "Error": "golangci-lint version 'v1.20' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.21": { + "Error": "golangci-lint version 'v1.21' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.22": { + "Error": "golangci-lint version 'v1.22' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.23": { + "Error": "golangci-lint version 'v1.23' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.24": { + "Error": "golangci-lint version 'v1.24' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.25": { + "Error": "golangci-lint version 'v1.25' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.26": { + "Error": "golangci-lint version 'v1.26' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.27": { + "Error": "golangci-lint version 'v1.27' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.28": { + "TargetVersion": "v1.28.3" + }, + "v1.29": { + "TargetVersion": "v1.29.0" + }, + "v1.3": { + "Error": "golangci-lint version 'v1.3' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.30": { + "TargetVersion": "v1.30.0" + }, + "v1.31": { + "TargetVersion": "v1.31.0" + }, + "v1.32": { + "TargetVersion": "v1.32.2" + }, + "v1.33": { + "TargetVersion": "v1.33.2" + }, + "v1.34": { + "TargetVersion": "v1.34.1" + }, + "v1.35": { + "TargetVersion": "v1.35.2" + }, + "v1.36": { + "TargetVersion": "v1.36.0" + }, + "v1.37": { + "TargetVersion": "v1.37.1" + }, + "v1.38": { + "TargetVersion": "v1.38.0" + }, + "v1.39": { + "TargetVersion": "v1.39.0" + }, + "v1.4": { + "Error": "golangci-lint version 'v1.4' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.40": { + "TargetVersion": "v1.40.1" + }, + "v1.41": { + "TargetVersion": "v1.41.1" + }, + "v1.42": { + "TargetVersion": "v1.42.1" + }, + "v1.43": { + "TargetVersion": "v1.43.0" + }, + "v1.44": { + "TargetVersion": "v1.44.2" + }, + "v1.45": { + "TargetVersion": "v1.45.2" + }, + "v1.46": { + "TargetVersion": "v1.46.2" + }, + "v1.47": { + "TargetVersion": "v1.47.3" + }, + "v1.48": { + "TargetVersion": "v1.48.0" + }, + "v1.49": { + "TargetVersion": "v1.49.0" + }, + "v1.5": { + "Error": "golangci-lint version 'v1.5' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.50": { + "TargetVersion": "v1.50.1" + }, + "v1.51": { + "TargetVersion": "v1.51.2" + }, + "v1.52": { + "TargetVersion": "v1.52.2" + }, + "v1.53": { + "TargetVersion": "v1.53.3" + }, + "v1.54": { + "TargetVersion": "v1.54.2" + }, + "v1.55": { + "TargetVersion": "v1.55.2" + }, + "v1.56": { + "TargetVersion": "v1.56.2" + }, + "v1.57": { + "TargetVersion": "v1.57.2" + }, + "v1.58": { + "TargetVersion": "v1.58.2" + }, + "v1.59": { + "TargetVersion": "v1.59.1" + }, + "v1.6": { + "Error": "golangci-lint version 'v1.6' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.60": { + "TargetVersion": "v1.60.3" + }, + "v1.61": { + "TargetVersion": "v1.61.0" + }, + "v1.62": { + "TargetVersion": "v1.62.2" + }, + "v1.63": { + "TargetVersion": "v1.63.4" + }, + "v1.64": { + "TargetVersion": "v1.64.8" + }, + "v1.7": { + "Error": "golangci-lint version 'v1.7' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.8": { + "Error": "golangci-lint version 'v1.8' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.9": { + "Error": "golangci-lint version 'v1.9' isn't supported: we support only v1.28.3 and later versions" + } + } +} diff --git a/assets/github-action-config.json b/assets/github-action-config.json index bc0b222e6351..32fe14b58fb6 100644 --- a/assets/github-action-config.json +++ b/assets/github-action-config.json @@ -1,209 +1,193 @@ { "MinorVersionToConfig": { "latest": { - "TargetVersion": "v1.55.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.55.0/golangci-lint-1.55.0-linux-amd64.tar.gz" + "TargetVersion": "v1.64.8" }, "v1.10": { - "Error": "golangci-lint version 'v1.10' isn't supported: we support only v1.14.0 and later versions" + "Error": "golangci-lint version 'v1.10' isn't supported: we support only v1.28.3 and later versions" }, "v1.11": { - "Error": "golangci-lint version 'v1.11' isn't supported: we support only v1.14.0 and later versions" + "Error": "golangci-lint version 'v1.11' isn't supported: we support only v1.28.3 and later versions" }, "v1.12": { - "Error": "golangci-lint version 'v1.12' isn't supported: we support only v1.14.0 and later versions" + "Error": "golangci-lint version 'v1.12' isn't supported: we support only v1.28.3 and later versions" }, "v1.13": { - "Error": "golangci-lint version 'v1.13' isn't supported: we support only v1.14.0 and later versions" + "Error": "golangci-lint version 'v1.13' isn't supported: we support only v1.28.3 and later versions" }, "v1.14": { - "TargetVersion": "v1.14.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.14.0/golangci-lint-1.14.0-linux-amd64.tar.gz" + "Error": "golangci-lint version 'v1.14' isn't supported: we support only v1.28.3 and later versions" }, "v1.15": { - "TargetVersion": "v1.15.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.15.0/golangci-lint-1.15.0-linux-amd64.tar.gz" + "Error": "golangci-lint version 'v1.15' isn't supported: we support only v1.28.3 and later versions" }, "v1.16": { - "TargetVersion": "v1.16.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.16.0/golangci-lint-1.16.0-linux-amd64.tar.gz" + "Error": "golangci-lint version 'v1.16' isn't supported: we support only v1.28.3 and later versions" }, "v1.17": { - "TargetVersion": "v1.17.1", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.17.1/golangci-lint-1.17.1-linux-amd64.tar.gz" + "Error": "golangci-lint version 'v1.17' isn't supported: we support only v1.28.3 and later versions" }, "v1.18": { - "TargetVersion": "v1.18.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.18.0/golangci-lint-1.18.0-linux-amd64.tar.gz" + "Error": "golangci-lint version 'v1.18' isn't supported: we support only v1.28.3 and later versions" }, "v1.19": { - "TargetVersion": "v1.19.1", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.19.1/golangci-lint-1.19.1-linux-amd64.tar.gz" + "Error": "golangci-lint version 'v1.19' isn't supported: we support only v1.28.3 and later versions" }, "v1.20": { - "TargetVersion": "v1.20.1", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.20.1/golangci-lint-1.20.1-linux-amd64.tar.gz" + "Error": "golangci-lint version 'v1.20' isn't supported: we support only v1.28.3 and later versions" }, "v1.21": { - "TargetVersion": "v1.21.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.21.0/golangci-lint-1.21.0-linux-amd64.tar.gz" + "Error": "golangci-lint version 'v1.21' isn't supported: we support only v1.28.3 and later versions" }, "v1.22": { - "TargetVersion": "v1.22.2", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.22.2/golangci-lint-1.22.2-linux-amd64.tar.gz" + "Error": "golangci-lint version 'v1.22' isn't supported: we support only v1.28.3 and later versions" }, "v1.23": { - "TargetVersion": "v1.23.8", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.23.8/golangci-lint-1.23.8-linux-amd64.tar.gz" + "Error": "golangci-lint version 'v1.23' isn't supported: we support only v1.28.3 and later versions" }, "v1.24": { - "TargetVersion": "v1.24.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.24.0/golangci-lint-1.24.0-linux-amd64.tar.gz" + "Error": "golangci-lint version 'v1.24' isn't supported: we support only v1.28.3 and later versions" }, "v1.25": { - "TargetVersion": "v1.25.1", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.25.1/golangci-lint-1.25.1-linux-amd64.tar.gz" + "Error": "golangci-lint version 'v1.25' isn't supported: we support only v1.28.3 and later versions" }, "v1.26": { - "TargetVersion": "v1.26.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.26.0/golangci-lint-1.26.0-linux-amd64.tar.gz" + "Error": "golangci-lint version 'v1.26' isn't supported: we support only v1.28.3 and later versions" }, "v1.27": { - "TargetVersion": "v1.27.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.27.0/golangci-lint-1.27.0-linux-amd64.tar.gz" + "Error": "golangci-lint version 'v1.27' isn't supported: we support only v1.28.3 and later versions" }, "v1.28": { - "TargetVersion": "v1.28.3", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.28.3/golangci-lint-1.28.3-linux-amd64.tar.gz" + "TargetVersion": "v1.28.3" }, "v1.29": { - "TargetVersion": "v1.29.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.29.0/golangci-lint-1.29.0-linux-amd64.tar.gz" + "TargetVersion": "v1.29.0" }, "v1.3": { - "Error": "golangci-lint version 'v1.3' isn't supported: we support only v1.14.0 and later versions" + "Error": "golangci-lint version 'v1.3' isn't supported: we support only v1.28.3 and later versions" }, "v1.30": { - "TargetVersion": "v1.30.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.30.0/golangci-lint-1.30.0-linux-amd64.tar.gz" + "TargetVersion": "v1.30.0" }, "v1.31": { - "TargetVersion": "v1.31.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.31.0/golangci-lint-1.31.0-linux-amd64.tar.gz" + "TargetVersion": "v1.31.0" }, "v1.32": { - "TargetVersion": "v1.32.2", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.32.2/golangci-lint-1.32.2-linux-amd64.tar.gz" + "TargetVersion": "v1.32.2" }, "v1.33": { - "TargetVersion": "v1.33.2", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.33.2/golangci-lint-1.33.2-linux-amd64.tar.gz" + "TargetVersion": "v1.33.2" }, "v1.34": { - "TargetVersion": "v1.34.1", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.34.1/golangci-lint-1.34.1-linux-amd64.tar.gz" + "TargetVersion": "v1.34.1" }, "v1.35": { - "TargetVersion": "v1.35.2", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.35.2/golangci-lint-1.35.2-linux-amd64.tar.gz" + "TargetVersion": "v1.35.2" }, "v1.36": { - "TargetVersion": "v1.36.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.36.0/golangci-lint-1.36.0-linux-amd64.tar.gz" + "TargetVersion": "v1.36.0" }, "v1.37": { - "TargetVersion": "v1.37.1", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.37.1/golangci-lint-1.37.1-linux-amd64.tar.gz" + "TargetVersion": "v1.37.1" }, "v1.38": { - "TargetVersion": "v1.38.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.38.0/golangci-lint-1.38.0-linux-amd64.tar.gz" + "TargetVersion": "v1.38.0" }, "v1.39": { - "TargetVersion": "v1.39.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.39.0/golangci-lint-1.39.0-linux-amd64.tar.gz" + "TargetVersion": "v1.39.0" }, "v1.4": { - "Error": "golangci-lint version 'v1.4' isn't supported: we support only v1.14.0 and later versions" + "Error": "golangci-lint version 'v1.4' isn't supported: we support only v1.28.3 and later versions" }, "v1.40": { - "TargetVersion": "v1.40.1", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.40.1/golangci-lint-1.40.1-linux-amd64.tar.gz" + "TargetVersion": "v1.40.1" }, "v1.41": { - "TargetVersion": "v1.41.1", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.41.1/golangci-lint-1.41.1-linux-amd64.tar.gz" + "TargetVersion": "v1.41.1" }, "v1.42": { - "TargetVersion": "v1.42.1", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.42.1/golangci-lint-1.42.1-linux-amd64.tar.gz" + "TargetVersion": "v1.42.1" }, "v1.43": { - "TargetVersion": "v1.43.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.43.0/golangci-lint-1.43.0-linux-amd64.tar.gz" + "TargetVersion": "v1.43.0" }, "v1.44": { - "TargetVersion": "v1.44.2", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.44.2/golangci-lint-1.44.2-linux-amd64.tar.gz" + "TargetVersion": "v1.44.2" }, "v1.45": { - "TargetVersion": "v1.45.2", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.45.2/golangci-lint-1.45.2-linux-amd64.tar.gz" + "TargetVersion": "v1.45.2" }, "v1.46": { - "TargetVersion": "v1.46.2", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.46.2/golangci-lint-1.46.2-linux-amd64.tar.gz" + "TargetVersion": "v1.46.2" }, "v1.47": { - "TargetVersion": "v1.47.3", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.47.3/golangci-lint-1.47.3-linux-amd64.tar.gz" + "TargetVersion": "v1.47.3" }, "v1.48": { - "TargetVersion": "v1.48.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.48.0/golangci-lint-1.48.0-linux-amd64.tar.gz" + "TargetVersion": "v1.48.0" }, "v1.49": { - "TargetVersion": "v1.49.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.49.0/golangci-lint-1.49.0-linux-amd64.tar.gz" + "TargetVersion": "v1.49.0" }, "v1.5": { - "Error": "golangci-lint version 'v1.5' isn't supported: we support only v1.14.0 and later versions" + "Error": "golangci-lint version 'v1.5' isn't supported: we support only v1.28.3 and later versions" }, "v1.50": { - "TargetVersion": "v1.50.1", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.50.1/golangci-lint-1.50.1-linux-amd64.tar.gz" + "TargetVersion": "v1.50.1" }, "v1.51": { - "TargetVersion": "v1.51.2", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.51.2/golangci-lint-1.51.2-linux-amd64.tar.gz" + "TargetVersion": "v1.51.2" }, "v1.52": { - "TargetVersion": "v1.52.2", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.52.2/golangci-lint-1.52.2-linux-amd64.tar.gz" + "TargetVersion": "v1.52.2" }, "v1.53": { - "TargetVersion": "v1.53.3", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.53.3/golangci-lint-1.53.3-linux-amd64.tar.gz" + "TargetVersion": "v1.53.3" }, "v1.54": { - "TargetVersion": "v1.54.2", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.54.2/golangci-lint-1.54.2-linux-amd64.tar.gz" + "TargetVersion": "v1.54.2" }, "v1.55": { - "TargetVersion": "v1.55.0", - "AssetURL": "https://github.com/golangci/golangci-lint/releases/download/v1.55.0/golangci-lint-1.55.0-linux-amd64.tar.gz" + "TargetVersion": "v1.55.2" + }, + "v1.56": { + "TargetVersion": "v1.56.2" + }, + "v1.57": { + "TargetVersion": "v1.57.2" + }, + "v1.58": { + "TargetVersion": "v1.58.2" + }, + "v1.59": { + "TargetVersion": "v1.59.1" }, "v1.6": { - "Error": "golangci-lint version 'v1.6' isn't supported: we support only v1.14.0 and later versions" + "Error": "golangci-lint version 'v1.6' isn't supported: we support only v1.28.3 and later versions" + }, + "v1.60": { + "TargetVersion": "v1.60.3" + }, + "v1.61": { + "TargetVersion": "v1.61.0" + }, + "v1.62": { + "TargetVersion": "v1.62.2" + }, + "v1.63": { + "TargetVersion": "v1.63.4" + }, + "v1.64": { + "TargetVersion": "v1.64.8" }, "v1.7": { - "Error": "golangci-lint version 'v1.7' isn't supported: we support only v1.14.0 and later versions" + "Error": "golangci-lint version 'v1.7' isn't supported: we support only v1.28.3 and later versions" }, "v1.8": { - "Error": "golangci-lint version 'v1.8' isn't supported: we support only v1.14.0 and later versions" + "Error": "golangci-lint version 'v1.8' isn't supported: we support only v1.28.3 and later versions" }, "v1.9": { - "Error": "golangci-lint version 'v1.9' isn't supported: we support only v1.14.0 and later versions" + "Error": "golangci-lint version 'v1.9' isn't supported: we support only v1.28.3 and later versions" } } } diff --git a/assets/goland.svg b/assets/goland.svg new file mode 100644 index 000000000000..2622c97c95aa --- /dev/null +++ b/assets/goland.svg @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/assets/linters-info.json b/assets/linters-info.json new file mode 100644 index 000000000000..5331c5531ca4 --- /dev/null +++ b/assets/linters-info.json @@ -0,0 +1,1430 @@ +[ + { + "name": "asasalint", + "desc": "check for pass []any as any in variadic func(...any)", + "loadMode": 8767, + "inPresets": [ + "bugs" + ], + "originalURL": "https://github.com/alingse/asasalint", + "internal": false, + "isSlow": true, + "since": "v1.47.0" + }, + { + "name": "asciicheck", + "desc": "checks that all code identifiers does not have non-ASCII symbols in the name", + "loadMode": 8199, + "inPresets": [ + "bugs", + "style" + ], + "originalURL": "https://github.com/tdakkota/asciicheck", + "internal": false, + "isSlow": false, + "since": "v1.26.0" + }, + { + "name": "bidichk", + "desc": "Checks for dangerous unicode character sequences", + "loadMode": 8199, + "inPresets": [ + "bugs" + ], + "originalURL": "https://github.com/breml/bidichk", + "internal": false, + "isSlow": false, + "since": "v1.43.0" + }, + { + "name": "bodyclose", + "desc": "checks whether HTTP response body is closed successfully", + "loadMode": 8767, + "inPresets": [ + "performance", + "bugs" + ], + "originalURL": "https://github.com/timakin/bodyclose", + "internal": false, + "isSlow": true, + "since": "v1.18.0" + }, + { + "name": "canonicalheader", + "desc": "canonicalheader checks whether net/http.Header uses canonical header", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/lasiar/canonicalheader", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.58.0" + }, + { + "name": "containedctx", + "desc": "containedctx is a linter that detects struct contained context.Context field", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/sivchari/containedctx", + "internal": false, + "isSlow": true, + "since": "v1.44.0" + }, + { + "name": "contextcheck", + "desc": "check whether the function uses a non-inherited context", + "loadMode": 8767, + "inPresets": [ + "bugs" + ], + "originalURL": "https://github.com/kkHAIKE/contextcheck", + "internal": false, + "isSlow": true, + "since": "v1.43.0" + }, + { + "name": "copyloopvar", + "desc": "a linter detects places where loop variables are copied", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/karamaru-alpha/copyloopvar", + "internal": false, + "canAutoFix": true, + "isSlow": false, + "since": "v1.57.0" + }, + { + "name": "cyclop", + "desc": "checks function and package cyclomatic complexity", + "loadMode": 8199, + "inPresets": [ + "complexity" + ], + "originalURL": "https://github.com/bkielbasa/cyclop", + "internal": false, + "isSlow": false, + "since": "v1.37.0" + }, + { + "name": "decorder", + "desc": "check declaration order and count of types, constants, variables and functions", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://gitlab.com/bosi/decorder", + "internal": false, + "isSlow": false, + "since": "v1.44.0" + }, + { + "name": "depguard", + "desc": "Go linter that checks if package imports are in a list of acceptable packages", + "loadMode": 8199, + "inPresets": [ + "style", + "import", + "module" + ], + "originalURL": "https://github.com/OpenPeeDeeP/depguard", + "internal": false, + "isSlow": false, + "since": "v1.4.0" + }, + { + "name": "dogsled", + "desc": "Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f())", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/alexkohler/dogsled", + "internal": false, + "isSlow": false, + "since": "v1.19.0" + }, + { + "name": "dupl", + "desc": "Detects duplicate fragments of code.", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/mibk/dupl", + "internal": false, + "isSlow": false, + "since": "v1.0.0" + }, + { + "name": "dupword", + "desc": "checks for duplicate words in the source code", + "loadMode": 8199, + "inPresets": [ + "comment" + ], + "originalURL": "https://github.com/Abirdcfly/dupword", + "internal": false, + "canAutoFix": true, + "isSlow": false, + "since": "v1.50.0" + }, + { + "name": "durationcheck", + "desc": "check for two durations multiplied together", + "loadMode": 8767, + "inPresets": [ + "bugs" + ], + "originalURL": "https://github.com/charithe/durationcheck", + "internal": false, + "isSlow": true, + "since": "v1.37.0" + }, + { + "name": "errcheck", + "desc": "errcheck is a program for checking for unchecked errors in Go code. These unchecked errors can be critical bugs in some cases", + "enabledByDefault": true, + "loadMode": 8767, + "inPresets": [ + "bugs", + "error" + ], + "originalURL": "https://github.com/kisielk/errcheck", + "internal": false, + "isSlow": true, + "since": "v1.0.0" + }, + { + "name": "errchkjson", + "desc": "Checks types passed to the json encoding functions. Reports unsupported types and reports occurrences where the check for the returned error can be omitted.", + "loadMode": 8767, + "inPresets": [ + "bugs" + ], + "originalURL": "https://github.com/breml/errchkjson", + "internal": false, + "isSlow": true, + "since": "v1.44.0" + }, + { + "name": "errname", + "desc": "Checks that sentinel errors are prefixed with the `Err` and error types are suffixed with the `Error`.", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/Antonboom/errname", + "internal": false, + "isSlow": true, + "since": "v1.42.0" + }, + { + "name": "errorlint", + "desc": "errorlint is a linter for that can be used to find code that will cause problems with the error wrapping scheme introduced in Go 1.13.", + "loadMode": 8767, + "inPresets": [ + "bugs", + "error" + ], + "originalURL": "https://github.com/polyfloyd/go-errorlint", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.32.0" + }, + { + "name": "exhaustive", + "desc": "check exhaustiveness of enum switch statements", + "loadMode": 8767, + "inPresets": [ + "bugs" + ], + "originalURL": "https://github.com/nishanths/exhaustive", + "internal": false, + "isSlow": true, + "since": " v1.28.0" + }, + { + "name": "exhaustruct", + "desc": "Checks if all structure fields are initialized", + "loadMode": 8767, + "inPresets": [ + "style", + "test" + ], + "originalURL": "https://github.com/GaijinEntertainment/go-exhaustruct", + "internal": false, + "isSlow": true, + "since": "v1.46.0" + }, + { + "name": "exptostd", + "desc": "Detects functions from golang.org/x/exp/ that can be replaced by std functions.", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/ldez/exptostd", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.63.0" + }, + { + "name": "forbidigo", + "desc": "Forbids identifiers", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/ashanbrown/forbidigo", + "internal": false, + "isSlow": true, + "since": "v1.34.0" + }, + { + "name": "forcetypeassert", + "desc": "finds forced type assertions", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/gostaticanalysis/forcetypeassert", + "internal": false, + "isSlow": true, + "since": "v1.38.0" + }, + { + "name": "fatcontext", + "desc": "detects nested contexts in loops and function literals", + "loadMode": 8767, + "inPresets": [ + "performance" + ], + "originalURL": "https://github.com/Crocmagnon/fatcontext", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.58.0" + }, + { + "name": "funlen", + "desc": "Checks for long functions.", + "loadMode": 8199, + "inPresets": [ + "complexity" + ], + "originalURL": "https://github.com/ultraware/funlen", + "internal": false, + "isSlow": false, + "since": "v1.18.0" + }, + { + "name": "gci", + "desc": "Checks if code and import statements are formatted, with additional rules.", + "loadMode": 8199, + "inPresets": [ + "format", + "import" + ], + "originalURL": "https://github.com/daixiang0/gci", + "internal": false, + "canAutoFix": true, + "isSlow": false, + "since": "v1.30.0" + }, + { + "name": "ginkgolinter", + "desc": "enforces standards of using ginkgo and gomega", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/nunnatsa/ginkgolinter", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.51.0" + }, + { + "name": "gocheckcompilerdirectives", + "desc": "Checks that go compiler directive comments (//go:) are valid.", + "loadMode": 8199, + "inPresets": [ + "bugs" + ], + "originalURL": "https://github.com/leighmcculloch/gocheckcompilerdirectives", + "internal": false, + "isSlow": false, + "since": "v1.51.0" + }, + { + "name": "gochecknoglobals", + "desc": "Check that no global variables exist.", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/leighmcculloch/gochecknoglobals", + "internal": false, + "isSlow": true, + "since": "v1.12.0" + }, + { + "name": "gochecknoinits", + "desc": "Checks that no init functions are present in Go code", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "internal": false, + "isSlow": false, + "since": "v1.12.0" + }, + { + "name": "gochecksumtype", + "desc": "Run exhaustiveness checks on Go \"sum types\"", + "loadMode": 8767, + "inPresets": [ + "bugs" + ], + "originalURL": "https://github.com/alecthomas/go-check-sumtype", + "internal": false, + "isSlow": true, + "since": "v1.55.0" + }, + { + "name": "gocognit", + "desc": "Computes and checks the cognitive complexity of functions", + "loadMode": 8199, + "inPresets": [ + "complexity" + ], + "originalURL": "https://github.com/uudashr/gocognit", + "internal": false, + "isSlow": false, + "since": "v1.20.0" + }, + { + "name": "goconst", + "desc": "Finds repeated strings that could be replaced by a constant", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/jgautheron/goconst", + "internal": false, + "isSlow": false, + "since": "v1.0.0" + }, + { + "name": "gocritic", + "desc": "Provides diagnostics that check for bugs, performance and style issues.\nExtensible without recompilation through dynamic rules.\nDynamic rules are written declaratively with AST patterns, filters, report message and optional suggestion.", + "loadMode": 8767, + "inPresets": [ + "style", + "metalinter" + ], + "originalURL": "https://github.com/go-critic/go-critic", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.12.0" + }, + { + "name": "gocyclo", + "desc": "Computes and checks the cyclomatic complexity of functions", + "loadMode": 8199, + "inPresets": [ + "complexity" + ], + "originalURL": "https://github.com/fzipp/gocyclo", + "internal": false, + "isSlow": false, + "since": "v1.0.0" + }, + { + "name": "godot", + "desc": "Check if comments end in a period", + "loadMode": 8199, + "inPresets": [ + "style", + "comment" + ], + "originalURL": "https://github.com/tetafro/godot", + "internal": false, + "canAutoFix": true, + "isSlow": false, + "since": "v1.25.0" + }, + { + "name": "godox", + "desc": "Detects usage of FIXME, TODO and other keywords inside comments", + "loadMode": 8199, + "inPresets": [ + "style", + "comment" + ], + "originalURL": "https://github.com/matoous/godox", + "internal": false, + "isSlow": false, + "since": "v1.19.0" + }, + { + "name": "err113", + "desc": "Go linter to check the errors handling expressions", + "loadMode": 8767, + "inPresets": [ + "style", + "error" + ], + "alternativeNames": [ + "goerr113" + ], + "originalURL": "https://github.com/Djarvur/go-err113", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.26.0" + }, + { + "name": "gofmt", + "desc": "Checks if the code is formatted according to 'gofmt' command.", + "loadMode": 8199, + "inPresets": [ + "format" + ], + "originalURL": "https://pkg.go.dev/cmd/gofmt", + "internal": false, + "canAutoFix": true, + "isSlow": false, + "since": "v1.0.0" + }, + { + "name": "gofumpt", + "desc": "Checks if code and import statements are formatted, with additional rules.", + "loadMode": 8199, + "inPresets": [ + "format" + ], + "originalURL": "https://github.com/mvdan/gofumpt", + "internal": false, + "canAutoFix": true, + "isSlow": false, + "since": "v1.28.0" + }, + { + "name": "goheader", + "desc": "Checks if file header matches to pattern", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/denis-tingaikin/go-header", + "internal": false, + "canAutoFix": true, + "isSlow": false, + "since": "v1.28.0" + }, + { + "name": "goimports", + "desc": "Checks if the code and import statements are formatted according to the 'goimports' command.", + "loadMode": 8199, + "inPresets": [ + "format", + "import" + ], + "originalURL": "https://pkg.go.dev/golang.org/x/tools/cmd/goimports", + "internal": false, + "canAutoFix": true, + "isSlow": false, + "since": "v1.20.0" + }, + { + "name": "mnd", + "desc": "An analyzer to detect magic numbers.", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/tommy-muehle/go-mnd", + "internal": false, + "isSlow": false, + "since": "v1.22.0" + }, + { + "name": "gomoddirectives", + "desc": "Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod.", + "loadMode": 8199, + "inPresets": [ + "style", + "module" + ], + "originalURL": "https://github.com/ldez/gomoddirectives", + "internal": false, + "isSlow": false, + "since": "v1.39.0" + }, + { + "name": "gomodguard", + "desc": "Allow and block list linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations.", + "loadMode": 8199, + "inPresets": [ + "style", + "import", + "module" + ], + "originalURL": "https://github.com/ryancurrah/gomodguard", + "internal": false, + "isSlow": false, + "since": "v1.25.0" + }, + { + "name": "goprintffuncname", + "desc": "Checks that printf-like functions are named with `f` at the end.", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/golangci/go-printf-func-name", + "internal": false, + "isSlow": false, + "since": "v1.23.0" + }, + { + "name": "gosec", + "desc": "Inspects source code for security problems", + "loadMode": 8767, + "inPresets": [ + "bugs" + ], + "alternativeNames": [ + "gas" + ], + "originalURL": "https://github.com/securego/gosec", + "internal": false, + "isSlow": true, + "since": "v1.0.0" + }, + { + "name": "gosimple", + "desc": "Linter for Go source code that specializes in simplifying code", + "enabledByDefault": true, + "loadMode": 8767, + "inPresets": [ + "style" + ], + "alternativeNames": [ + "megacheck" + ], + "originalURL": "https://github.com/dominikh/go-tools/tree/HEAD/simple", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.20.0" + }, + { + "name": "gosmopolitan", + "desc": "Report certain i18n/l10n anti-patterns in your Go codebase", + "loadMode": 8767, + "inPresets": [ + "bugs" + ], + "originalURL": "https://github.com/xen0n/gosmopolitan", + "internal": false, + "isSlow": true, + "since": "v1.53.0" + }, + { + "name": "govet", + "desc": "Vet examines Go source code and reports suspicious constructs. It is roughly the same as 'go vet' and uses its passes.", + "enabledByDefault": true, + "loadMode": 8767, + "inPresets": [ + "bugs", + "metalinter" + ], + "alternativeNames": [ + "vet", + "vetshadow" + ], + "originalURL": "https://pkg.go.dev/cmd/vet", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.0.0" + }, + { + "name": "grouper", + "desc": "Analyze expression groups.", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/leonklingele/grouper", + "internal": false, + "isSlow": false, + "since": "v1.44.0" + }, + { + "name": "iface", + "desc": "Detect the incorrect use of interfaces, helping developers avoid interface pollution.", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/uudashr/iface", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.62.0" + }, + { + "name": "importas", + "desc": "Enforces consistent import aliases", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/julz/importas", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.38.0" + }, + { + "name": "inamedparam", + "desc": "reports interfaces with unnamed method parameters", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/macabu/inamedparam", + "internal": false, + "isSlow": false, + "since": "v1.55.0" + }, + { + "name": "ineffassign", + "desc": "Detects when assignments to existing variables are not used", + "enabledByDefault": true, + "loadMode": 8199, + "inPresets": [ + "unused" + ], + "originalURL": "https://github.com/gordonklaus/ineffassign", + "internal": false, + "isSlow": false, + "since": "v1.0.0" + }, + { + "name": "interfacebloat", + "desc": "A linter that checks the number of methods inside an interface.", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/sashamelentyev/interfacebloat", + "internal": false, + "isSlow": false, + "since": "v1.49.0" + }, + { + "name": "intrange", + "desc": "intrange is a linter to find places where for loops could make use of an integer range.", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/ckaznocha/intrange", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.57.0" + }, + { + "name": "ireturn", + "desc": "Accept Interfaces, Return Concrete Types", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/butuzov/ireturn", + "internal": false, + "isSlow": true, + "since": "v1.43.0" + }, + { + "name": "lll", + "desc": "Reports long lines", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "internal": false, + "isSlow": false, + "since": "v1.8.0" + }, + { + "name": "loggercheck", + "desc": "Checks key value pairs for common logger libraries (kitlog,klog,logr,zap).", + "loadMode": 8767, + "inPresets": [ + "style", + "bugs" + ], + "alternativeNames": [ + "logrlint" + ], + "originalURL": "https://github.com/timonwong/loggercheck", + "internal": false, + "isSlow": true, + "since": "v1.49.0" + }, + { + "name": "maintidx", + "desc": "maintidx measures the maintainability index of each function.", + "loadMode": 8199, + "inPresets": [ + "complexity" + ], + "originalURL": "https://github.com/yagipy/maintidx", + "internal": false, + "isSlow": false, + "since": "v1.44.0" + }, + { + "name": "makezero", + "desc": "Finds slice declarations with non-zero initial length", + "loadMode": 8767, + "inPresets": [ + "style", + "bugs" + ], + "originalURL": "https://github.com/ashanbrown/makezero", + "internal": false, + "isSlow": true, + "since": "v1.34.0" + }, + { + "name": "mirror", + "desc": "reports wrong mirror patterns of bytes/strings usage", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/butuzov/mirror", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.53.0" + }, + { + "name": "misspell", + "desc": "Finds commonly misspelled English words", + "loadMode": 8199, + "inPresets": [ + "style", + "comment" + ], + "originalURL": "https://github.com/client9/misspell", + "internal": false, + "canAutoFix": true, + "isSlow": false, + "since": "v1.8.0" + }, + { + "name": "musttag", + "desc": "enforce field tags in (un)marshaled structs", + "loadMode": 8767, + "inPresets": [ + "style", + "bugs" + ], + "originalURL": "https://github.com/go-simpler/musttag", + "internal": false, + "isSlow": true, + "since": "v1.51.0" + }, + { + "name": "nakedret", + "desc": "Checks that functions with naked returns are not longer than a maximum size (can be zero).", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/alexkohler/nakedret", + "internal": false, + "canAutoFix": true, + "isSlow": false, + "since": "v1.19.0" + }, + { + "name": "nestif", + "desc": "Reports deeply nested if statements", + "loadMode": 8199, + "inPresets": [ + "complexity" + ], + "originalURL": "https://github.com/nakabonne/nestif", + "internal": false, + "isSlow": false, + "since": "v1.25.0" + }, + { + "name": "nilerr", + "desc": "Finds the code that returns nil even if it checks that the error is not nil.", + "loadMode": 8767, + "inPresets": [ + "bugs" + ], + "originalURL": "https://github.com/gostaticanalysis/nilerr", + "internal": false, + "isSlow": true, + "since": "v1.38.0" + }, + { + "name": "nilnesserr", + "desc": "Reports constructs that checks for err != nil, but returns a different nil value error.\nPowered by nilness and nilerr.", + "loadMode": 8767, + "inPresets": [ + "bugs" + ], + "originalURL": "https://github.com/alingse/nilnesserr", + "internal": false, + "isSlow": true, + "since": "v1.63.0" + }, + { + "name": "nilnil", + "desc": "Checks that there is no simultaneous return of `nil` error and an invalid value.", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/Antonboom/nilnil", + "internal": false, + "isSlow": true, + "since": "v1.43.0" + }, + { + "name": "nlreturn", + "desc": "nlreturn checks for a new line before return and branch statements to increase code clarity", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/ssgreg/nlreturn", + "internal": false, + "canAutoFix": true, + "isSlow": false, + "since": "v1.30.0" + }, + { + "name": "noctx", + "desc": "Finds sending http request without context.Context", + "loadMode": 8767, + "inPresets": [ + "performance", + "bugs" + ], + "originalURL": "https://github.com/sonatard/noctx", + "internal": false, + "isSlow": true, + "since": "v1.28.0" + }, + { + "name": "nonamedreturns", + "desc": "Reports all named returns", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/firefart/nonamedreturns", + "internal": false, + "isSlow": true, + "since": "v1.46.0" + }, + { + "name": "nosprintfhostport", + "desc": "Checks for misuse of Sprintf to construct a host with port in a URL.", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/stbenjam/no-sprintf-host-port", + "internal": false, + "isSlow": false, + "since": "v1.46.0" + }, + { + "name": "paralleltest", + "desc": "Detects missing usage of t.Parallel() method in your Go test", + "loadMode": 8767, + "inPresets": [ + "style", + "test" + ], + "originalURL": "https://github.com/kunwardeep/paralleltest", + "internal": false, + "isSlow": true, + "since": "v1.33.0" + }, + { + "name": "perfsprint", + "desc": "Checks that fmt.Sprintf can be replaced with a faster alternative.", + "loadMode": 8767, + "inPresets": [ + "performance" + ], + "originalURL": "https://github.com/catenacyber/perfsprint", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.55.0" + }, + { + "name": "prealloc", + "desc": "Finds slice declarations that could potentially be pre-allocated", + "loadMode": 8199, + "inPresets": [ + "performance" + ], + "originalURL": "https://github.com/alexkohler/prealloc", + "internal": false, + "isSlow": false, + "since": "v1.19.0" + }, + { + "name": "predeclared", + "desc": "find code that shadows one of Go's predeclared identifiers", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/nishanths/predeclared", + "internal": false, + "isSlow": false, + "since": "v1.35.0" + }, + { + "name": "promlinter", + "desc": "Check Prometheus metrics naming via promlint", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/yeya24/promlinter", + "internal": false, + "isSlow": false, + "since": "v1.40.0" + }, + { + "name": "protogetter", + "desc": "Reports direct reads from proto message fields when getters should be used", + "loadMode": 8767, + "inPresets": [ + "bugs" + ], + "originalURL": "https://github.com/ghostiam/protogetter", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.55.0" + }, + { + "name": "reassign", + "desc": "Checks that package variables are not reassigned", + "loadMode": 8767, + "inPresets": [ + "bugs" + ], + "originalURL": "https://github.com/curioswitch/go-reassign", + "internal": false, + "isSlow": true, + "since": "v1.49.0" + }, + { + "name": "recvcheck", + "desc": "checks for receiver type consistency", + "loadMode": 8767, + "inPresets": [ + "bugs" + ], + "originalURL": "https://github.com/raeperd/recvcheck", + "internal": false, + "isSlow": true, + "since": "v1.62.0" + }, + { + "name": "revive", + "desc": "Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint.", + "loadMode": 8199, + "inPresets": [ + "style", + "metalinter" + ], + "originalURL": "https://github.com/mgechev/revive", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.37.0" + }, + { + "name": "rowserrcheck", + "desc": "checks whether Rows.Err of rows is checked successfully", + "loadMode": 8767, + "inPresets": [ + "bugs", + "sql" + ], + "originalURL": "https://github.com/jingyugao/rowserrcheck", + "internal": false, + "isSlow": true, + "since": "v1.23.0" + }, + { + "name": "sloglint", + "desc": "ensure consistent code style when using log/slog", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/go-simpler/sloglint", + "internal": false, + "isSlow": true, + "since": "v1.55.0" + }, + { + "name": "sqlclosecheck", + "desc": "Checks that sql.Rows, sql.Stmt, sqlx.NamedStmt, pgx.Query are closed.", + "loadMode": 8767, + "inPresets": [ + "bugs", + "sql" + ], + "originalURL": "https://github.com/ryanrolds/sqlclosecheck", + "internal": false, + "isSlow": true, + "since": "v1.28.0" + }, + { + "name": "spancheck", + "desc": "Checks for mistakes with OpenTelemetry/Census spans.", + "loadMode": 8767, + "inPresets": [ + "bugs" + ], + "originalURL": "https://github.com/jjti/go-spancheck", + "internal": false, + "isSlow": true, + "since": "v1.56.0" + }, + { + "name": "staticcheck", + "desc": "It's a set of rules from staticcheck. It's not the same thing as the staticcheck binary. The author of staticcheck doesn't support or approve the use of staticcheck as a library inside golangci-lint.", + "enabledByDefault": true, + "loadMode": 8767, + "inPresets": [ + "bugs", + "metalinter" + ], + "alternativeNames": [ + "megacheck" + ], + "originalURL": "https://staticcheck.dev/", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.0.0" + }, + { + "name": "stylecheck", + "desc": "Stylecheck is a replacement for golint", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/dominikh/go-tools/tree/HEAD/stylecheck", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.20.0" + }, + { + "name": "tagalign", + "desc": "check that struct tags are well aligned", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/4meepo/tagalign", + "internal": false, + "canAutoFix": true, + "isSlow": false, + "since": "v1.53.0" + }, + { + "name": "tagliatelle", + "desc": "Checks the struct tags.", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/ldez/tagliatelle", + "internal": false, + "isSlow": true, + "since": "v1.40.0" + }, + { + "name": "tenv", + "desc": "tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17", + "loadMode": 8767, + "inPresets": [ + "test" + ], + "originalURL": "https://github.com/sivchari/tenv", + "internal": false, + "isSlow": true, + "since": "v1.43.0", + "deprecation": { + "since": "v1.64.0", + "message": "Duplicate feature in another linter.", + "replacement": "usetesting" + } + }, + { + "name": "testableexamples", + "desc": "linter checks if examples are testable (have an expected output)", + "loadMode": 8199, + "inPresets": [ + "test" + ], + "originalURL": "https://github.com/maratori/testableexamples", + "internal": false, + "isSlow": false, + "since": "v1.50.0" + }, + { + "name": "testifylint", + "desc": "Checks usage of github.com/stretchr/testify.", + "loadMode": 8767, + "inPresets": [ + "test", + "bugs" + ], + "originalURL": "https://github.com/Antonboom/testifylint", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.55.0" + }, + { + "name": "testpackage", + "desc": "linter that makes you use a separate _test package", + "loadMode": 8199, + "inPresets": [ + "style", + "test" + ], + "originalURL": "https://github.com/maratori/testpackage", + "internal": false, + "isSlow": false, + "since": "v1.25.0" + }, + { + "name": "thelper", + "desc": "thelper detects tests helpers which is not start with t.Helper() method.", + "loadMode": 8767, + "inPresets": [ + "test" + ], + "originalURL": "https://github.com/kulti/thelper", + "internal": false, + "isSlow": true, + "since": "v1.34.0" + }, + { + "name": "tparallel", + "desc": "tparallel detects inappropriate usage of t.Parallel() method in your Go test codes.", + "loadMode": 8767, + "inPresets": [ + "style", + "test" + ], + "originalURL": "https://github.com/moricho/tparallel", + "internal": false, + "isSlow": true, + "since": "v1.32.0" + }, + { + "name": "typecheck", + "desc": "Like the front-end of a Go compiler, parses and type-checks Go code", + "enabledByDefault": true, + "loadMode": 8199, + "internal": true, + "isSlow": false, + "since": "v1.3.0" + }, + { + "name": "unconvert", + "desc": "Remove unnecessary type conversions", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/mdempsky/unconvert", + "internal": false, + "isSlow": true, + "since": "v1.0.0" + }, + { + "name": "unparam", + "desc": "Reports unused function parameters", + "loadMode": 8767, + "inPresets": [ + "unused" + ], + "originalURL": "https://github.com/mvdan/unparam", + "internal": false, + "isSlow": true, + "since": "v1.9.0" + }, + { + "name": "unused", + "desc": "Checks Go code for unused constants, variables, functions and types", + "enabledByDefault": true, + "loadMode": 8767, + "inPresets": [ + "unused" + ], + "alternativeNames": [ + "megacheck" + ], + "originalURL": "https://github.com/dominikh/go-tools/tree/HEAD/unused", + "internal": false, + "isSlow": true, + "doesChangeTypes": true, + "since": "v1.20.0" + }, + { + "name": "usestdlibvars", + "desc": "A linter that detect the possibility to use variables/constants from the Go standard library.", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/sashamelentyev/usestdlibvars", + "internal": false, + "canAutoFix": true, + "isSlow": false, + "since": "v1.48.0" + }, + { + "name": "usetesting", + "desc": "Reports uses of functions with replacement inside the testing package.", + "loadMode": 8767, + "inPresets": [ + "test" + ], + "originalURL": "https://github.com/ldez/usetesting", + "internal": false, + "canAutoFix": true, + "isSlow": true, + "since": "v1.63.0" + }, + { + "name": "varnamelen", + "desc": "checks that the length of a variable's name matches its scope", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/blizzy78/varnamelen", + "internal": false, + "isSlow": true, + "since": "v1.43.0" + }, + { + "name": "wastedassign", + "desc": "Finds wasted assignment statements", + "loadMode": 8767, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/sanposhiho/wastedassign", + "internal": false, + "isSlow": true, + "since": "v1.38.0" + }, + { + "name": "whitespace", + "desc": "Whitespace is a linter that checks for unnecessary newlines at the start and end of functions, if, for, etc.", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/ultraware/whitespace", + "internal": false, + "canAutoFix": true, + "isSlow": false, + "since": "v1.19.0" + }, + { + "name": "wrapcheck", + "desc": "Checks that errors returned from external packages are wrapped", + "loadMode": 8767, + "inPresets": [ + "style", + "error" + ], + "originalURL": "https://github.com/tomarrell/wrapcheck", + "internal": false, + "isSlow": true, + "since": "v1.32.0" + }, + { + "name": "wsl", + "desc": "add or remove empty lines", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/bombsimon/wsl", + "internal": false, + "canAutoFix": true, + "isSlow": false, + "since": "v1.20.0" + }, + { + "name": "zerologlint", + "desc": "Detects the wrong usage of `zerolog` that a user forgets to dispatch with `Send` or `Msg`", + "loadMode": 8767, + "inPresets": [ + "bugs" + ], + "originalURL": "https://github.com/ykadowak/zerologlint", + "internal": false, + "isSlow": true, + "since": "v1.53.0" + }, + { + "name": "nolintlint", + "desc": "Reports ill-formed or insufficient nolint directives", + "loadMode": 8199, + "inPresets": [ + "style" + ], + "originalURL": "https://github.com/golangci/golangci-lint/tree/HEAD/pkg/golinters/nolintlint/internal", + "internal": false, + "canAutoFix": true, + "isSlow": false, + "since": "v1.26.0" + } +] diff --git a/build/Dockerfile b/build/Dockerfile deleted file mode 100644 index 3c86cb6f29fe..000000000000 --- a/build/Dockerfile +++ /dev/null @@ -1,20 +0,0 @@ -# stage 1 building the code -FROM golang:1.21 as builder - -ARG VERSION -ARG SHORT_COMMIT -ARG DATE - -COPY / /golangci -WORKDIR /golangci -RUN CGO_ENABLED=0 go build -trimpath -ldflags "-s -w -X main.version=$VERSION -X main.commit=$SHORT_COMMIT -X main.date=$DATE" -o golangci-lint ./cmd/golangci-lint/main.go - -# stage 2 -FROM golang:1.21 -# related to https://github.com/golangci/golangci-lint/issues/3107 -ENV GOROOT /usr/local/go -# Set all directories as safe -RUN git config --global --add safe.directory '*' -# don't place it into $GOPATH/bin because Drone mounts $GOPATH as volume -COPY --from=builder /golangci/golangci-lint /usr/bin/ -CMD ["golangci-lint"] diff --git a/build/alpine.Dockerfile b/build/alpine.Dockerfile deleted file mode 100644 index 35f2626b9c01..000000000000 --- a/build/alpine.Dockerfile +++ /dev/null @@ -1,29 +0,0 @@ -# stage 1 building the code -FROM golang:1.21-alpine as builder - -ARG VERSION -ARG SHORT_COMMIT -ARG DATE - -COPY / /golangci -WORKDIR /golangci - -# gcc is required to support cgo; -# git and mercurial are needed most times for go get`, etc. -# See https://github.com/docker-library/golang/issues/80 -RUN apk --no-cache add gcc musl-dev git mercurial -RUN CGO_ENABLED=0 go build -trimpath -ldflags "-s -w -X main.version=$VERSION -X main.commit=$SHORT_COMMIT -X main.date=$DATE" -o golangci-lint ./cmd/golangci-lint/main.go - -# stage 2 -FROM golang:1.21-alpine -# related to https://github.com/golangci/golangci-lint/issues/3107 -ENV GOROOT /usr/local/go -# gcc is required to support cgo; -# git and mercurial are needed most times for go get`, etc. -# See https://github.com/docker-library/golang/issues/80 -RUN apk --no-cache add gcc musl-dev git mercurial -# Set all directories as safe -RUN git config --global --add safe.directory '*' -# don't place it into $GOPATH/bin because Drone mounts $GOPATH as volume -COPY --from=builder /golangci/golangci-lint /usr/bin/ -CMD ["golangci-lint"] diff --git a/build/buildx-alpine.Dockerfile b/build/buildx-alpine.Dockerfile new file mode 100644 index 000000000000..72b7ad0797b6 --- /dev/null +++ b/build/buildx-alpine.Dockerfile @@ -0,0 +1,21 @@ +# syntax=docker/dockerfile:1.4 +FROM golang:1.24-alpine + +# related to https://github.com/golangci/golangci-lint/issues/3107 +ENV GOROOT /usr/local/go + +# Allow to download a more recent version of Go. +# https://go.dev/doc/toolchain +# GOTOOLCHAIN=auto is shorthand for GOTOOLCHAIN=local+auto +ENV GOTOOLCHAIN auto + +# gcc is required to support cgo; +# git and mercurial are needed most times for go get`, etc. +# See https://github.com/docker-library/golang/issues/80 +RUN apk --no-cache add gcc musl-dev git mercurial + +# Set all directories as safe +RUN git config --global --add safe.directory '*' + +COPY golangci-lint /usr/bin/ +CMD ["golangci-lint"] diff --git a/build/buildx.Dockerfile b/build/buildx.Dockerfile new file mode 100644 index 000000000000..3b7c277f823a --- /dev/null +++ b/build/buildx.Dockerfile @@ -0,0 +1,16 @@ +# syntax=docker/dockerfile:1.4 +FROM golang:1.24 + +# related to https://github.com/golangci/golangci-lint/issues/3107 +ENV GOROOT /usr/local/go + +# Allow to download a more recent version of Go. +# https://go.dev/doc/toolchain +# GOTOOLCHAIN=auto is shorthand for GOTOOLCHAIN=local+auto +ENV GOTOOLCHAIN auto + +# Set all directories as safe +RUN git config --global --add safe.directory '*' + +COPY golangci-lint /usr/bin/ +CMD ["golangci-lint"] diff --git a/cmd/golangci-lint/main.go b/cmd/golangci-lint/main.go index 9d1daa81df92..bf235bf17fca 100644 --- a/cmd/golangci-lint/main.go +++ b/cmd/golangci-lint/main.go @@ -1,6 +1,7 @@ package main import ( + "cmp" "fmt" "os" "runtime/debug" @@ -13,33 +14,61 @@ var ( goVersion = "unknown" // Populated by goreleaser during build - version = "master" + version = "unknown" commit = "?" date = "" ) func main() { - if buildInfo, available := debug.ReadBuildInfo(); available { - goVersion = buildInfo.GoVersion + info := createBuildInfo() - if date == "" { - version = buildInfo.Main.Version - commit = fmt.Sprintf("(unknown, mod sum: %q)", buildInfo.Main.Sum) - date = "(unknown)" - } + if err := commands.Execute(info); err != nil { + _, _ = fmt.Fprintf(os.Stderr, "Failed executing command with error: %v\n", err) + os.Exit(exitcodes.Failure) } +} +func createBuildInfo() commands.BuildInfo { info := commands.BuildInfo{ - GoVersion: goVersion, - Version: version, Commit: commit, + Version: version, + GoVersion: goVersion, Date: date, } - e := commands.NewExecutor(info) + buildInfo, available := debug.ReadBuildInfo() + if !available { + return info + } - if err := e.Execute(); err != nil { - fmt.Fprintf(os.Stderr, "failed executing command with error %v\n", err) - os.Exit(exitcodes.Failure) + info.GoVersion = buildInfo.GoVersion + + if date != "" { + return info + } + + info.Version = buildInfo.Main.Version + + var revision string + var modified string + for _, setting := range buildInfo.Settings { + // The `vcs.xxx` information is only available with `go build`. + // This information is not available with `go install` or `go run`. + switch setting.Key { + case "vcs.time": + info.Date = setting.Value + case "vcs.revision": + revision = setting.Value + case "vcs.modified": + modified = setting.Value + } } + + revision = cmp.Or(revision, "unknown") + modified = cmp.Or(modified, "?") + info.Date = cmp.Or(info.Date, "(unknown)") + + info.Commit = fmt.Sprintf("(%s, modified: %s, mod sum: %q)", revision, modified, buildInfo.Main.Sum) + + return info } diff --git a/cmd/golangci-lint/plugins.go b/cmd/golangci-lint/plugins.go new file mode 100644 index 000000000000..541ff7624271 --- /dev/null +++ b/cmd/golangci-lint/plugins.go @@ -0,0 +1,3 @@ +package main + +// This file is used to declare module plugins. diff --git a/docs/.gitignore b/docs/.gitignore index f81327511eeb..f14a70ffc3a5 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -20,7 +20,7 @@ coverage # nyc test coverage .nyc_output -# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) .grunt # Bower dependency directory (https://bower.io/) @@ -29,7 +29,7 @@ bower_components # node-waf configuration .lock-wscript -# Compiled binary addons (http://nodejs.org/api/addons.html) +# Compiled binary addons (https://nodejs.org/api/addons.html) build/Release # Dependency directories @@ -67,3 +67,5 @@ yarn-error.log .pnp.js # Yarn Integrity file .yarn-integrity + +/static/jsonschema/ diff --git a/docs/golangci-lint.tape b/docs/golangci-lint.tape new file mode 100644 index 000000000000..4ba51aaf6d4c --- /dev/null +++ b/docs/golangci-lint.tape @@ -0,0 +1,86 @@ +Output docs/static/demo.gif + +# NOTE: it should be run at the root of the repository. +# vhs docs/golangci-lint.tape + +Require golangci-lint + +Set Shell zsh + +Set Theme Dracula +Set FontSize 25 +Set Width 2000 +Set Height 900 + +Set WindowBar Colorful +Set WindowBarSize 50 + +Set Padding 20 + +Set MarginFill "#17afc2" +Set Margin 20 + +Set BorderRadius 30 + +Type "golangci-lint run" Sleep 500ms Enter +Sleep 2s +Sleep 1s + + +# VHS documentation +# https://github.com/charmbracelet/vhs +# +# Output: +# Output .gif Create a GIF output at the given +# Output .mp4 Create an MP4 output at the given +# Output .webm Create a WebM output at the given +# +# Require: +# Require Ensure a program is on the $PATH to proceed +# +# Settings: +# Set FontSize Set the font size of the terminal +# Set FontFamily Set the font family of the terminal +# Set Height Set the height of the terminal +# Set Width Set the width of the terminal +# Set LetterSpacing Set the font letter spacing (tracking) +# Set LineHeight Set the font line height +# Set LoopOffset % Set the starting frame offset for the GIF loop +# Set Theme Set the theme of the terminal +# Set Padding Set the padding of the terminal +# Set Framerate Set the framerate of the recording +# Set PlaybackSpeed Set the playback speed of the recording +# Set MarginFill Set the file or color the margin will be filled with. +# Set Margin Set the size of the margin. Has no effect if MarginFill isn't set. +# Set BorderRadius Set terminal border radius, in pixels. +# Set WindowBar Set window bar type. (one of: Rings, RingsRight, Colorful, ColorfulRight) +# Set WindowBarSize Set window bar size, in pixels. Default is 40. +# Set TypingSpeed