Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Readability rules

RuleWhat it catches
blank-line-before-control-flowAn if/for/while crowded against the statement above
blank-line-before-returnA return buried against the code above it
group-separationA long run of statements with no blank lines between groups
excessive-indentationLines indented past the readable limit
deep-nestingControl flow nested past the configured depth
long-parameter-listAn argument list that should be split across lines
overlong-lineA line wider than the readable limit
oversized-unitA function too long to hold in your head
oversized-fileA file too large to navigate
mixed-indentationA file that indents with both tabs and spaces
comment-required-on-complex-unitA complex function with no explanation
comment-explains-whyCredit for a comment that explains reasoning
comment-narrates-codeA comment that restates what the code already says
excessive-commentsMore commentary than the code can carry
thin-documentationA doc block that lists structure without explaining purpose