Skip to content

docs+build: introduce ast-grep to encode some of the style guide elements not captured by the linter #10393

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Roasbeef wants to merge 2 commits into
base: master
Choose a base branch
from
+287 −1
Open

docs+build: introduce ast-grep to encode some of the style guide elements not captured by the linter #10393

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bcee3b4
build: add ast-grep style enforcement rules
Roasbeef Nov 26, 2025
f484ab0
build: add make targets for ast-grep linting
Roasbeef Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,23 @@ lint-config-check:
$(GOTOOL) $(GOLINT_PKG) config verify -v

#? lint: Run static code analysis
lint: check-go-version lint-config-check lint-source
lint: check-go-version lint-config-check lint-source

# Globs to exclude generated files from ast-grep.
AST_GREP_EXCLUDE := --globs '!**/*.pb.go' --globs '!**/*.pb.gw.go' --globs '!**/*.pb.json.go' --globs '!**/sqlc/*.go'

# Optional directory/package filter for ast-grep (e.g., make ast-lint pkg=lnwallet).
AST_GREP_PATH := $(if $(pkg),$(pkg),.)

#? ast-lint: Run ast-grep style checks. Use pkg=<dir> to focus on a specific directory.
ast-lint:
Copy link
Member

@yyforyongyu yyforyongyu Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like it giving false positives, or should we update our guidelines to be more specific?

warning[func-def-dangling-return-paren]: Function return types should not start with open paren on its own line
     ┌─ lnwallet/channel_test.go:1625:1
     │  
1625 │ ╭ func TestHTLCSigNumber(t *testing.T) {
     · │
1775 │ │ }
     │ ╰─^
     │  
     = Per docs/development_guidelines.md: Return type wrapping should continue
       on the same line, not start a new line with open paren.
       
       WRONG:
         func bar(a, b, c) (
         d, error,
         ) {
       
       RIGHT:
         func baz(a, b, c) (d,
         error) {

@$(call print, "Running ast-grep style checks.")
sg scan $(AST_GREP_EXCLUDE) $(AST_GREP_PATH)

#? ast-grep-fix: Auto-fix ast-grep style issues. Use pkg=<dir> to focus on a specific directory.
ast-grep-fix:
Copy link
Member

@yyforyongyu yyforyongyu Nov 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tried make ast-grep-fix pkg=lnwallet but it didn't fix.

@$(call print, "Auto-fixing ast-grep style issues.")
sg scan --update-all $(AST_GREP_EXCLUDE) $(AST_GREP_PATH)

#? protolint: Lint proto files using protolint
protolint:
Expand Down
Loading