{{define "rule.html"}} {{template "head" .}} {{template "topbar" .}}
{{.Rule.ID}}

AUR report card · Rule reference

{{.Rule.Name}}

{{if .Rule.FixLevel.Fixable}}

{{template "fixpill" .Rule.FixLevel}}

{{end}}

{{doc .Rule.Doc}}

{{if .Rule.FixLevel.Fixable}}

Auto-fix

Run pkglint {{.Rule.FixLevel.Flag}} to rewrite this in place{{if not .Rule.FixLevel.Safe}} — the rewrite is mechanical but changes what the build does, so read the result{{end}}. Add --diff to see the change without writing it.

{{end}}
Example
Flagged
{{.Rule.Bad}}
Preferred
{{.Rule.Good}}
Suppress

If a package trips this rule on purpose and you have reviewed it, put the directive on the offending line or the line above it:

# pkglint: ignore={{.Rule.ID}}

It covers only that line pair, in that file. Passing --ignore {{.Rule.ID}} turns the rule off for a whole run instead.

{{end}}