pylint

Documentation

Index

• Variables
• func NewLinter() api.Linter
• type PylintLinter
  • func (l *PylintLinter) LintProject(project api.Project) (api.Report, error)
  • func (l *PylintLinter) Name() string
  • func (l *PylintLinter) Rules() []*api.Rule

Variables

var RuleIsConfigured = api.Rule{
	Slug: "code-quality/pylint/is-configured",
	Name: "Pylint is configured for this project",
	Details: `[Pylint](https://pypi.org/project/pylint/) has a good default configuration,
though there are likely to be rules that you may want to enable, disable or customise for your project.
For example, you may want to configure your indentation width, your maximum line length, or configure which files to ignore while linting.

Additionally, some IDEs have their own default configuration for these linters, which may only enable a subset of Pylint's rules.
For example, VS Code [is known to do this](https://code.visualstudio.com/docs/python/linting#_default-pylint-rules).
However, those IDEs generally _do_ pick up your project's own Pylint configuration.

Having a Pylint configuration in the project also ensures that you, each of your colleages, as well as the CI,
use the same linting configuration.`,
	Weight: 1,
}

var RuleNoIssues = api.Rule{
	Slug: "code-quality/pylint/no-issues",
	Name: "Pylint reports no issues with this project",
	Details: fmt.Sprintf(`[Pylint](https://pypi.org/project/pylint/) is a static analysis tool for finding generic programming errors.
This rule checks whether Pylint returns any errors when running it on all Python files in this project.

The score for this rule is determined as a function of the number of messages Pylint returns and the lines of Python code that your project has.
In the ideal case, Pylint does not recognise any code smells in your project, in which case the score is 100%%.
When there is one Pylint issue for every 20 lines of code, then the score is 50%%.
When there is one Pylint issue for every 10 lines of code, then the score is 0%%.

More specifically, in pseudocode, %s.

Note that the measured amount of lines of code includes any non-hidden Python files in the repository, including those that are ignored by Pylint.`,
		"`score = 100 - 100 * min(1, 10 * number of msgs / lines of code)`"),
	Weight: 1,
}

Functions

func NewLinter

func NewLinter() api.Linter

Types

type PylintLinter

type PylintLinter struct{}

func (*PylintLinter) LintProject

func (l *PylintLinter) LintProject(project api.Project) (api.Report, error)

func (*PylintLinter) Name

func (l *PylintLinter) Name() string

func (*PylintLinter) Rules

func (l *PylintLinter) Rules() []*api.Rule