revive

Documentation

Mon, 01 Jan 0001 00:00:00 +0000

Rules

Mon, 01 Jan 0001 00:00:00 +0000

This is the complete list of the linting rules provided by revive, with their behavior, configuration options, and examples.

Configuration options format

By convention, configuration options are documented using the kebab-case format (e.g., max-lit-count, allow-strs, skip-comments). For backward compatibility, camelCase (e.g., maxLitCount, allowStrs, skipComments) and lowercase (e.g., maxlitcount, allowstrs, skipcomments) formats are still supported but are deprecated.

add-constant

Go version: 1.0.

Description: Suggests using constant for magic numbers and string literals.

Developing a Custom Rule

Mon, 01 Jan 0001 00:00:00 +0000

Each rule needs to implement the lint.Rule interface:

type Rule interface {
 Name() string
 Apply(*File, Arguments) []Failure
}

The Arguments type is an alias of the type []interface{}. The arguments of the rule are passed from the configuration file.

Example

Let us develop a rule called ArgumentsLimitRule which sets a restriction on the number of arguments that a function may accept. As we explained above, our rule needs to implement the Rule interface:

Developing a Custom Formatter

Mon, 01 Jan 0001 00:00:00 +0000

Each formatter needs to implement the following interface:

type Formatter interface {
 Format(<-chan Failure, RulesConfig) (string, error)
 Name() string
}

The Format method accepts a channel of Failure instances and the configuration of the enabled rules. The Name() method should return a string different from the names of the already existing rules. This string is used when specifying the formatter when invoking the revive CLI tool.

Example

Let us implement a sample formatter which outputs the rule failures to plain text.

API

Mon, 01 Jan 0001 00:00:00 +0000

revive

Documentation

Rules

Configuration options format link

add-constant link

Developing a Custom Rule

Example link

Developing a Custom Formatter

Example link

API

Configuration options format

add-constant

Example

Example