Rule: variable-name
Checks variable names for various errors.
Config
Five arguments may be optionally provided:
"check-format"
: allows only camelCased or UPPER_CASED variable names"allow-leading-underscore"
allows underscores at the beginning (only has an effect if “check-format” specified)"allow-trailing-underscore"
allows underscores at the end. (only has an effect if “check-format” specified)"allow-pascal-case
allows PascalCase in addtion to camelCase.
"ban-keywords"
: disallows the use of certain TypeScript keywords (any
,Number
,number
,String
,string
,Boolean
,boolean
,undefined
) as variable or parameter names.
Examples
"variable-name": [true, "ban-keywords", "check-format", "allow-leading-underscore"]
Schema
{ "type": "array", "items": { "type": "string", "enum": [ "check-format", "allow-leading-underscore", "allow-trailing-underscore", "allow-pascal-case", "ban-keywords" ] }, "minLength": 0, "maxLength": 5 }