Merge pull request #7777 from onflow/peter/improve-lint

[CI] Add new make lint targets

Author: peterargue

.github/workflows/ci.yml

@@ -321,6 +321,8 @@ jobs:
           username: ${{ vars.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
         if: ${{ (github.event_name == 'merge_group' || (github.event.pull_request && (github.event.pull_request.author_association == 'MEMBER' || github.event.pull_request.author_association == 'COLLABORATOR'))) }}
+        # this docker auth is exclusively for higher rate limits. continue unauthenticated if it fails
+        continue-on-error: true
 
 
       - name: Docker build

.golangci.yml

@@ -3,10 +3,22 @@ run:
 
 linters-settings:
   goimports:
+    # enforced by linter
     # put imports beginning with prefix after 3rd-party packages;
     # it's a comma-separated list of prefixes
     local-prefixes: github.com/onflow/flow-go/
 
+  # used to generate canonical import ordering
+  # not enforced by linter
+  gci:
+    sections:
+      - standard                           # 1. standard library
+      - default                            # 2. external packages
+      - prefix(github.com/onflow/)         # 3. org packages
+      - prefix(github.com/onflow/flow-go/) # 4. project packages
+    skip-generated: true
+    custom-order: true
+
   gosec:
     # To select a subset of rules to run.
     # Available rules: https://github.com/securego/gosec#available-rules

AGENTS.md

@@ -51,13 +51,21 @@ This file provides guidance to AI Agents when working with code in this reposito
 
 ### Code Quality and Generation
 - `make lint` - Run linter (includes tidy and custom checks)
-- `make lint -e LINT_PATH=./path/to/lint/...` - Run linter for a specific module
+- `make fix-new` - Run linter for files changed since master
 - `make fix-lint` - Automatically fix linting issues
+- `make fix-lint-new` - Automatically fix linting issues for files changed since master
+- `make fix-imports` - Automatically fix imports
+- `make fix-imports-new` - Automatically fix imports for files changed since master
+- `make vet` - Run go vet
+- `make vet-new` - Run go vet for files changed since master
 - `make generate` - Run all code generators (proto, mocks, fvm wrappers)
 - `make generate-mocks` - Generate mocks for unit tests
 - `make generate-proto` - Generate protobuf stubs
 - `make tidy` - Run go mod tidy
 
+`lint`, `vet`, `fix-lint`, and `fix-imports` support passing `LINT_PATH`, which sets the path used by golangci-lint
+- `make lint -e LINT_PATH=./path/to/lint/...` - Run linter for a specific module
+
 ### Dependency Management
 - `make install-tools` - Install all required development tools
 - `make install-mock-generators` - Install mock generation tools

Makefile

@@ -170,15 +170,39 @@ tools/custom-gcl: tools/structwrite .custom-gcl.yml
 	golangci-lint custom
 
 .PHONY: lint
-lint: tidy tools/custom-gcl
+lint: tools/custom-gcl
 	# revive -config revive.toml -exclude storage/ledger/trie ./...
 	./tools/custom-gcl run -v $(or $(LINT_PATH),./...)
 
+.PHONY: lint-new
+lint-new: tools/custom-gcl
+	./tools/custom-gcl run -v --new-from-rev=master
+
 .PHONY: fix-lint
-fix-lint:
+fix-lint: tools/custom-gcl
 	# revive -config revive.toml -exclude storage/ledger/trie ./...
 	./tools/custom-gcl run -v --fix $(or $(LINT_PATH),./...)
 
+.PHONY: fix-lint-new
+fix-lint-new: tools/custom-gcl
+	./tools/custom-gcl run -v --fix --new-from-rev=master
+
+.PHONY: fix-imports
+fix-imports: tools/custom-gcl
+	./tools/custom-gcl run --enable-only=gci --fix $(or $(LINT_PATH),./...)
+
+.PHONY: fix-imports-new
+fix-imports-new: tools/custom-gcl
+	./tools/custom-gcl run --enable-only=gci --fix --new-from-rev=master
+
+.PHONY: vet
+vet: tools/custom-gcl
+	./tools/custom-gcl run --enable-only=govet $(or $(LINT_PATH),./...)
+
+.PHONY: vet-new
+vet-new: tools/custom-gcl
+	./tools/custom-gcl run --enable-only=govet --new-from-rev=master
+
 # Runs unit tests with different list of packages as passed by CI so they run in parallel
 .PHONY: ci
 ci: install-tools test