From 104cbb1c178567095135908140d8c7386e1dd3ee Mon Sep 17 00:00:00 2001 From: Christian Muehlhaeuser Date: Wed, 18 May 2022 02:04:53 +0200 Subject: [PATCH] fix: make linter happy --- .github/workflows/lint-soft.yml | 23 ++++++++++++++++ .github/workflows/lint.yml | 15 ++++++----- .golangci-soft.yml | 47 +++++++++++++++++++++++++++++++++ .golangci.yml | 18 ++++++++----- gists.go | 4 +-- main.go | 2 +- repos.go | 22 +++++++-------- rss.go | 1 + sponsors.go | 8 +++--- stars.go | 4 +-- types.go | 32 +++++++++++++--------- users.go | 4 +-- 12 files changed, 132 insertions(+), 48 deletions(-) create mode 100644 .github/workflows/lint-soft.yml create mode 100644 .golangci-soft.yml diff --git a/.github/workflows/lint-soft.yml b/.github/workflows/lint-soft.yml new file mode 100644 index 0000000..d5fd7f9 --- /dev/null +++ b/.github/workflows/lint-soft.yml @@ -0,0 +1,23 @@ +name: lint-soft +on: + push: + pull_request: + +permissions: + contents: read + # Optional: allow read access to pull request. Use with `only-new-issues` option. + pull-requests: read + +jobs: + golangci: + name: lint-soft + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: golangci-lint + uses: golangci/golangci-lint-action@v3 + with: + # Optional: golangci-lint command line arguments. + args: --config .golangci-soft.yml --issues-exit-code=0 + # Optional: show only new issues if it's a pull request. The default value is `false`. + only-new-issues: true diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index da69d9b..8851983 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -3,20 +3,21 @@ on: push: pull_request: +permissions: + contents: read + # Optional: allow read access to pull request. Use with `only-new-issues` option. + pull-requests: read + jobs: golangci: name: lint runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: golangci-lint - uses: golangci/golangci-lint-action@v2 + uses: golangci/golangci-lint-action@v3 with: - # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version. - version: v1.30 # Optional: golangci-lint command line arguments. - args: --issues-exit-code=0 - # Optional: working directory, useful for monorepos - # working-directory: somedir + #args: # Optional: show only new issues if it's a pull request. The default value is `false`. only-new-issues: true diff --git a/.golangci-soft.yml b/.golangci-soft.yml new file mode 100644 index 0000000..ef456e0 --- /dev/null +++ b/.golangci-soft.yml @@ -0,0 +1,47 @@ +run: + tests: false + +issues: + include: + - EXC0001 + - EXC0005 + - EXC0011 + - EXC0012 + - EXC0013 + + max-issues-per-linter: 0 + max-same-issues: 0 + +linters: + enable: + # - dupl + - exhaustive + # - exhaustivestruct + - goconst + - godot + - godox + - gomnd + - gomoddirectives + - goprintffuncname + - ifshort + # - lll + - misspell + - nakedret + - nestif + - noctx + - nolintlint + - prealloc + - wrapcheck + + # disable default linters, they are already enabled in .golangci.yml + disable: + - deadcode + - errcheck + - gosimple + - govet + - ineffassign + - staticcheck + - structcheck + - typecheck + - unused + - varcheck diff --git a/.golangci.yml b/.golangci.yml index 0a17bad..a5a91d0 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -2,24 +2,28 @@ run: tests: false issues: + include: + - EXC0001 + - EXC0005 + - EXC0011 + - EXC0012 + - EXC0013 + max-issues-per-linter: 0 max-same-issues: 0 linters: enable: - bodyclose - - dupl - exportloopref - - goconst - - godot - - godox - goimports - - goprintffuncname - gosec - - misspell - - prealloc + - nilerr + - predeclared + - revive - rowserrcheck - sqlclosecheck + - tparallel - unconvert - unparam - whitespace diff --git a/gists.go b/gists.go index a903772..337bac8 100644 --- a/gists.go +++ b/gists.go @@ -13,7 +13,7 @@ var gistsQuery struct { TotalCount githubv4.Int Edges []struct { Cursor githubv4.String - Node QLGist + Node qlGist } } `graphql:"gists(first: $count, orderBy: {field: CREATED_AT, direction: DESC})"` } `graphql:"user(login:$username)"` @@ -34,7 +34,7 @@ func gists(count int) []Gist { // fmt.Printf("%+v\n", query) for _, v := range gistsQuery.User.Gists.Edges { - gists = append(gists, GistFromQL(v.Node)) + gists = append(gists, gistFromQL(v.Node)) } // fmt.Printf("Found %d gists!\n", len(gists)) diff --git a/main.go b/main.go index 636056e..0c4cc06 100644 --- a/main.go +++ b/main.go @@ -93,7 +93,7 @@ func main() { fmt.Println("Can't create:", err) os.Exit(1) } - defer f.Close() + defer f.Close() //nolint: errcheck w = f } diff --git a/repos.go b/repos.go index 8f21623..87cc0f3 100644 --- a/repos.go +++ b/repos.go @@ -21,7 +21,7 @@ var recentContributionsQuery struct { } } } `graphql:"contributions(first: 1)"` - Repository QLRepository + Repository qlRepository } `graphql:"commitContributionsByRepository(maxRepositories: 100)"` } } `graphql:"user(login:$username)"` @@ -34,7 +34,7 @@ var recentPullRequestsQuery struct { TotalCount githubv4.Int Edges []struct { Cursor githubv4.String - Node QLPullRequest + Node qlPullRequest } } `graphql:"pullRequests(first: $count, orderBy: {field: CREATED_AT, direction: DESC})"` } `graphql:"user(login:$username)"` @@ -47,7 +47,7 @@ var recentReposQuery struct { TotalCount githubv4.Int Edges []struct { Cursor githubv4.String - Node QLRepository + Node qlRepository } } `graphql:"repositories(first: $count, privacy: PUBLIC, isFork: false, ownerAffiliations: OWNER, orderBy: {field: CREATED_AT, direction: DESC})"` } `graphql:"user(login:$username)"` @@ -61,8 +61,8 @@ var recentReleasesQuery struct { Edges []struct { Cursor githubv4.String Node struct { - QLRepository - Releases QLRelease `graphql:"releases(first: 10, orderBy: {field: CREATED_AT, direction: DESC})"` + qlRepository + Releases qlRelease `graphql:"releases(first: 10, orderBy: {field: CREATED_AT, direction: DESC})"` } } } `graphql:"repositoriesContributedTo(first: 100, after:$after includeUserRepositories: true, contributionTypes: COMMIT, privacy: PUBLIC)"` @@ -91,7 +91,7 @@ func recentContributions(count int) []Contribution { } c := Contribution{ - Repo: RepoFromQL(v.Repository), + Repo: repoFromQL(v.Repository), OccurredAt: v.Contributions.Edges[0].Node.OccurredAt.Time, } @@ -131,7 +131,7 @@ func recentPullRequests(count int) []PullRequest { continue } - pullRequests = append(pullRequests, PullRequestFromQL(v.Node)) + pullRequests = append(pullRequests, pullRequestFromQL(v.Node)) if len(pullRequests) == count { break } @@ -160,7 +160,7 @@ func recentRepos(count int) []Repo { continue } - repos = append(repos, RepoFromQL(v.Node)) + repos = append(repos, repoFromQL(v.Node)) if len(repos) == count { break } @@ -192,7 +192,7 @@ func recentReleases(count int) []Repo { } for _, v := range recentReleasesQuery.User.RepositoriesContributedTo.Edges { - r := RepoFromQL(v.Node.QLRepository) + r := repoFromQL(v.Node.qlRepository) for _, rel := range v.Node.Releases.Nodes { if rel.IsPrerelease || rel.IsDraft { @@ -202,7 +202,7 @@ func recentReleases(count int) []Repo { v.Node.Releases.Nodes[0].PublishedAt.Time.IsZero() { continue } - r.LastRelease = ReleaseFromQL(v.Node.Releases) + r.LastRelease = releaseFromQL(v.Node.Releases) break } @@ -210,7 +210,7 @@ func recentReleases(count int) []Repo { repos = append(repos, r) } - after = &v.Cursor + after = githubv4.NewString(v.Cursor) } } diff --git a/rss.go b/rss.go index ae44f99..0fa8cf1 100644 --- a/rss.go +++ b/rss.go @@ -6,6 +6,7 @@ import ( "github.com/mmcdole/gofeed" ) +// RSSEntry represents a single RSS entry. type RSSEntry struct { Title string URL string diff --git a/sponsors.go b/sponsors.go index 0e77012..f6f2bbd 100644 --- a/sponsors.go +++ b/sponsors.go @@ -17,8 +17,8 @@ var sponsorsQuery struct { CreatedAt githubv4.DateTime SponsorEntity struct { Typename githubv4.String `graphql:"__typename"` - User QLUser `graphql:"... on User"` - Organization QLUser `graphql:"... on Organization"` + User qlUser `graphql:"... on User"` + Organization qlUser `graphql:"... on Organization"` } } } @@ -45,12 +45,12 @@ func sponsors(count int) []Sponsor { switch v.Node.SponsorEntity.Typename { case "User": sponsors = append(sponsors, Sponsor{ - User: UserFromQL(v.Node.SponsorEntity.User), + User: userFromQL(v.Node.SponsorEntity.User), CreatedAt: v.Node.CreatedAt.Time, }) case "Organization": sponsors = append(sponsors, Sponsor{ - User: UserFromQL(v.Node.SponsorEntity.Organization), + User: userFromQL(v.Node.SponsorEntity.Organization), CreatedAt: v.Node.CreatedAt.Time, }) } diff --git a/stars.go b/stars.go index 6f5521d..977a2b1 100644 --- a/stars.go +++ b/stars.go @@ -14,7 +14,7 @@ var recentStarsQuery struct { Edges []struct { Cursor githubv4.String StarredAt githubv4.DateTime - Node QLRepository + Node qlRepository } } `graphql:"starredRepositories(first: $count, orderBy: {field: STARRED_AT, direction: DESC})"` } `graphql:"user(login:$username)"` @@ -34,7 +34,7 @@ func recentStars(count int) []Star { for _, v := range recentStarsQuery.User.Stars.Edges { starredRepos = append(starredRepos, Star{ StarredAt: v.StarredAt.Time, - Repo: RepoFromQL(v.Node), + Repo: repoFromQL(v.Node), }) } diff --git a/types.go b/types.go index 286fd18..afc2519 100644 --- a/types.go +++ b/types.go @@ -6,11 +6,13 @@ import ( "github.com/shurcooL/githubv4" ) +// Contribution represents a contribution to a repo. type Contribution struct { OccurredAt time.Time Repo Repo } +// Gist represents a gist. type Gist struct { Name string Description string @@ -18,11 +20,13 @@ type Gist struct { CreatedAt time.Time } +// Star represents a star/favorite event. type Star struct { StarredAt time.Time Repo Repo } +// PullRequest represents a pull request. type PullRequest struct { Title string URL string @@ -31,6 +35,7 @@ type PullRequest struct { Repo Repo } +// Release represents a release. type Release struct { Name string TagName string @@ -38,6 +43,7 @@ type Release struct { URL string } +// Repo represents a git repo. type Repo struct { Name string URL string @@ -46,11 +52,13 @@ type Repo struct { LastRelease Release } +// Sponsor represents a sponsor. type Sponsor struct { User User CreatedAt time.Time } +// User represents a SCM user. type User struct { Login string Name string @@ -58,22 +66,22 @@ type User struct { URL string } -type QLGist struct { +type qlGist struct { Name githubv4.String Description githubv4.String URL githubv4.String CreatedAt githubv4.DateTime } -type QLPullRequest struct { +type qlPullRequest struct { URL githubv4.String Title githubv4.String State githubv4.PullRequestState CreatedAt githubv4.DateTime - Repository QLRepository + Repository qlRepository } -type QLRelease struct { +type qlRelease struct { Nodes []struct { Name githubv4.String TagName githubv4.String @@ -84,7 +92,7 @@ type QLRelease struct { } } -type QLRepository struct { +type qlRepository struct { NameWithOwner githubv4.String URL githubv4.String Description githubv4.String @@ -94,14 +102,14 @@ type QLRepository struct { } } -type QLUser struct { +type qlUser struct { Login githubv4.String Name githubv4.String AvatarURL githubv4.String URL githubv4.String } -func GistFromQL(gist QLGist) Gist { +func gistFromQL(gist qlGist) Gist { return Gist{ Name: string(gist.Name), Description: string(gist.Description), @@ -110,17 +118,17 @@ func GistFromQL(gist QLGist) Gist { } } -func PullRequestFromQL(pullRequest QLPullRequest) PullRequest { +func pullRequestFromQL(pullRequest qlPullRequest) PullRequest { return PullRequest{ Title: string(pullRequest.Title), URL: string(pullRequest.URL), State: string(pullRequest.State), CreatedAt: pullRequest.CreatedAt.Time, - Repo: RepoFromQL(pullRequest.Repository), + Repo: repoFromQL(pullRequest.Repository), } } -func ReleaseFromQL(release QLRelease) Release { +func releaseFromQL(release qlRelease) Release { return Release{ Name: string(release.Nodes[0].Name), TagName: string(release.Nodes[0].TagName), @@ -129,7 +137,7 @@ func ReleaseFromQL(release QLRelease) Release { } } -func RepoFromQL(repo QLRepository) Repo { +func repoFromQL(repo qlRepository) Repo { return Repo{ Name: string(repo.NameWithOwner), URL: string(repo.URL), @@ -138,7 +146,7 @@ func RepoFromQL(repo QLRepository) Repo { } } -func UserFromQL(user QLUser) User { +func userFromQL(user qlUser) User { return User{ Login: string(user.Login), Name: string(user.Name), diff --git a/users.go b/users.go index 0899f5f..88ad0d2 100644 --- a/users.go +++ b/users.go @@ -19,7 +19,7 @@ var recentFollowersQuery struct { TotalCount githubv4.Int Edges []struct { Cursor githubv4.String - Node QLUser + Node qlUser } } `graphql:"followers(first: $count)"` } `graphql:"user(login:$username)"` @@ -49,7 +49,7 @@ func recentFollowers(count int) []User { // fmt.Printf("%+v\n", query) for _, v := range recentFollowersQuery.User.Followers.Edges { - users = append(users, UserFromQL(v.Node)) + users = append(users, userFromQL(v.Node)) } // fmt.Printf("Found %d recent followers!\n", len(users))