fensu rule

fensu rule prints the complete metadata for one rule: its family, severity, whether it is on by default, its source, and its full message and remediation. Use it to understand a code you saw in fensu check output, or to read what a rule claims before you enable or disable it.

fensu rule CODE [--color MODE]

Usage

fensu rule FFS131

FFS131 no-complex-comprehensions
Family: shape
Severity: error
Kind: core
Enabled by default: yes
Source: core
Message: nested or multi-generator comprehensions hide control flow and data shapes
Remediation: Extract a named helper when the transformation has a coherent purpose. For one-off
             local logic, use simple statements with named intermediate values instead of nested
             comprehension control flow.

The lookup is case-insensitive, so fensu rule ffs131 works too.

Fields

Field	Meaning
Header	The code and slug.
Family	The rule’s family.
Severity	`error` or `warning`.
Kind	`core` for shipped rules, `custom` for your own.
Enabled by default	Whether the rule runs without being named explicitly.
Source	`core`, or the file or module a custom rule was loaded from.
Message	The one-sentence statement of the violated contract.
Remediation	The normal correction, or `None provided.` if the rule sets none.

Severity is catalogue metadata declared by the rule. Configuring a rule in warn assigns it to the project’s advisory tier without changing that metadata. Use fensu check --warn to see the effective tier in a run.

Custom and configured rules

fensu rule reads the whole catalogue for the current repository, so it resolves custom rules once they are configured, and it can inspect rules that are ignored or off by default. A custom rule shows its source path:

fensu rule XAC001

XAC001 no-acme-global
Family: custom
Severity: error
Kind: custom
Enabled by default: yes
Source: scripts/fensu_policy/rules/boundaries.py
Message: ACME_GLOBAL hides ownership
Remediation: Move the value to the module that owns and produces it.

Options

Option	Values	Default	Purpose
`--color`	`auto`, `always`, `never`	`auto`	ANSI color behavior. Respects `NO_COLOR`.

Exit codes

Code	Meaning
`0`	The rule was found and printed.
`2`	The code is not a known rule.

An unknown code reports:

Unknown rule code: NOPE

Getting Started

Concepts

CLI Reference

API Reference

Usage

Fields

Custom and configured rules

Options

Exit codes

​Usage

​Fields

​Custom and configured rules

​Options

​Exit codes

Usage

Fields

Custom and configured rules

Options

Exit codes