feat: add --ignore-func-signatures flag to prevent wrapping function signatures#32
Open
danrneal wants to merge 1 commit intogolangci:mainfrom
Open
feat: add --ignore-func-signatures flag to prevent wrapping function signatures#32danrneal wants to merge 1 commit intogolangci:mainfrom
--ignore-func-signatures flag to prevent wrapping function signatures#32danrneal wants to merge 1 commit intogolangci:mainfrom
Conversation
a4738ba to
ec32158
Compare
This adds a boolean flag, `--ignore-func-signatures`, which allows users to bypass shortening logic for function declarations and types. This enables keeping function signatures with many parameters on a single line, adhering more closely to standard library idioms where signatures often exceed global line length limits.
ec32158 to
6a2ee9e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses Discussion #31
Description
This PR introduces a new boolean flag,
--ignore-func-signatures, which allows users to bypass the line-shortening logic specifically for function declarations and function types.By default,
golinesapplies the--max-lenlimit uniformly across all AST nodes, which can force function signatures with multiple parameters to wrap across several lines. The Go standard library frequently keeps function signatures on a single line even when they exceed typical column limits (e.g., inimage/draw).This flag gives users the option to strictly format the bodies of their functions and structs to a specific length while maintaining idiomatic, single-line function signatures, eliminating the need to rely on
//golines:ignorecomments above every long signature.Changes Made
--ignore-func-signaturesboolean flag (default:false) to the CLI.shorten.Config.formatDecl(*dst.FuncDecl) andformatExpr(*dst.FuncType) inshorten/format.goto conditionally bypass formatting the parameter list if the flag is enabled.shorten/testdata/ignore_func_signaturesto verify the behavior.README.mdwith documentation for the new flag.