eslint-plugin-readable

Make your JavaScript more readable.

Links

• CHANGE LOG
• Homepage

Rules

Notes:

1. Option name "-" means the rule's option may be a direct value instead of an object.
2. Default value "-" means that this option has no default value.

readable/const-name

Require const name to be UPPER_CASE.

Option Type	Name	Default Value	Desc
Array	except	-	const names to be ignored

readable/function-lines

Require number of lines in a function to be no more than max.

Option Type	Name	Default Value	Desc
number	-	40	max lines each function
number	max	40	max lines each function
boolean	skipBlankLines	true	whether to skip blank lines
boolean	skipComments	true	whether to skip comments

readable/function-name

Require function name to be camelCase.

Option Type	Name	Default Value	Desc
Array	except	-	function names to be ignored

readable/loop-counter

Require counter variable used in for-statement to be single lowercase character.

readable/loop-nesting

Require depth of loop nesting to be LE a fixed number.

Option Type	Name	Default Value	Desc
number	-	4	max depth of loops
number	max	4	max depth of loops

readable/param-number

Require number of function params to be LE a fixed number.

Option Type	Name	Default Value	Desc
number	-	4	max length of parameters
number	max	4	max length of parameters

readable/property-name

Require property name to be camelCase.

Option Type	Name	Default Value	Desc
Array	except	-	property names to be ignored

readable/space-in-brackets

Require matching spaces inside brackets couple.

readable/space-in-parens

Require matching spaces inside parenthese couple.

readable/var-name

Require property name to be camelCase.

Option Type	Name	Default Value	Desc
Array	except	-	variable names to be ignored