decorder

package module

v0.4.2 Latest Latest Go to latest Published: Apr 21, 2024 License: MIT Imports: 6 Imported by: 7

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitlab.com/bosi/decorder

Links

Open Source Insights

README ¶

Decorder

A declaration order linter for Go. In case of this tool declarations are type, const, var and func.

Rules

This linter applies multiple rules where each can be disabled via cli parameter.

rule	description	cli-options
declaration order	Enforces the order of global declarations (e.g. all global constants are always defined before variables). You can also define a subset of declarations if you don't want to enforce the order of all of them.	* disable all checks: `-disable-dec-order-check` * disable type checks: `-disable-type-dec-order-check` * disable const checks: `-disable-const-dec-order-check` * disable var checks: `-disable-var-dec-order-check` * custom order: `-dec-order var,const,func,type`
declaration number	Enforces that the statements const, var and type are only used once per file. You have to use parenthesis to declare e.g multiple global types inside a file.	disable check: `-disable-dec-num-check`
init func first	Enforces the init func to be the first function in file.	disable check: `-disable-init-func-first-check`

You may find the implementation of the rules inside analyzer.go.

Underscore var declarations can be ignored via -ignore-underscore-vars.

Installation

go install gitlab.com/bosi/decorder/cmd/decorder

You can use the linter via golangci-lint as well: https://golangci-lint.run/usage/linters/#decorder.

Usage

# with default options
decorder ./...

# custom declaration order
decorder -dec-order var,const,func,type ./...

# disable declaration order check
decorder -disable-dec-order-check ./...

# disable check for multiple declarations statements
decorder -disable-dec-num-check ./...

# disable check for multiple declarations (var only) statements
decorder -disable-var-dec-num-check ./...

# disable check that init func is always first function
decorder -disable-init-func-first-check ./...

# ignore underscore variables for all checks
decorder -ignore-underscore-vars ./...

Documentation ¶

Constants ¶

View Source

const (
	Name = "decorder"

	FlagDo    = "dec-order"
	FlagIuv   = "ignore-underscore-vars"
	FlagDdnc  = "disable-dec-num-check"
	FlagDtdnc = "disable-type-dec-num-check"
	FlagDcdnc = "disable-const-dec-num-check"
	FlagDvdnc = "disable-var-dec-num-check"
	FlagDdoc  = "disable-dec-order-check"
	FlagDiffc = "disable-init-func-first-check"
)

Variables ¶

View Source

var (
	Analyzer = &analysis.Analyzer{
		Name: Name,
		Doc:  "check declaration order and count of types, constants, variables and functions",
		Run:  run,
	}
)

Functions ¶

This section is empty.

Types ¶

This section is empty.

Source Files ¶

View all Source files

analyzer.go

Directories ¶

Path	Synopsis
cmd module
decorder

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL