schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
jscsrc.json
disallowSpacesInConditionalExpression
An object that contains keys of type boolean.
{"properties": {"afterConsequent": {"type": "boolean"}, "afterTest": {"type": "boolean"}, "beforeAlternate": {"type": "boolean"}, "beforeConsequent": {"type": "boolean"}}}
jscsrc.json
disallowSpacesInForStatement
Disallow spaces in between for statement.
{"type": ["boolean", "null"]}
jscsrc.json
disallowSpacesInFunction
Disallows space before `()` or `{}` in function expressions (both named and anonymous) and function declarations.
{"type": ["null", "object"], "oneOf": [{}]}
jscsrc.json
disallowSpacesInFunctionDeclaration
Disallows space before () or {} in function declarations.
{"type": ["null", "object"], "oneOf": [{}]}
jscsrc.json
disallowSpacesInFunctionExpression
Disallows space before `()` or `{}` in function expressions (both named and anonymous).
{"type": ["null", "object"], "oneOf": [{}]}
jscsrc.json
disallowSpacesInGenerator
Disallow space before or after * in generator functions.
{"type": ["null", "object"], "oneOf": [{}, {"type": "object", "properties": {"beforeStar": {"type": "boolean"}, "afterStar": {"type": "boolean"}}}]}
jscsrc.json
disallowSpacesInGenerator
At least one of the object properties must be present and it must be set to true.
{"type": "object", "properties": {"beforeStar": {"type": "boolean"}, "afterStar": {"type": "boolean"}}}
jscsrc.json
beforeStar
A value of true disallows space before *.
{"type": "boolean"}
jscsrc.json
afterStar
A value of true disallows space after *.
{"type": "boolean"}
jscsrc.json
disallowSpacesInNamedFunctionExpression
Disallows space before () or {} in named function expressions
{"type": ["null", "object"], "oneOf": [{}]}
jscsrc.json
disallowSpacesInsideArrayBrackets
Disallows space after opening array square bracket and before closing. Reports only on arrays, not on property accessors. Use disallowSpacesInsideBrackets to report on all brackets.
{"type": ["boolean", "null", "object", "string"], "oneOf": [{"type": ["boolean", "string"], "enum": [true, false, "all"]}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["(", ")", "{", "}", "[", "]"]}]}, "uniqueItems": true}}}, {"type": "string", "oneOf": [{"enum": ["nested"]}]}]}
jscsrc.json
disallowSpacesInsideArrayBrackets
Use "all" or true for strict mode.
{"type": ["boolean", "string"], "enum": [true, false, "all"]}
jscsrc.json
disallowSpacesInsideArrayBrackets
An object that contains an "allExcept" key equal to an array of exception tokens.
{"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["(", ")", "{", "}", "[", "]"]}]}, "uniqueItems": true}}}
jscsrc.json
allExcept
Array of quoted tokens to exempt. Tokens should consist of an opener with a matching closer () {} [] etc.
{"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["(", ")", "{", "}", "[", "]"]}]}, "uniqueItems": true}
jscsrc.json
items
Tokens should consist of an opener with a matching closer () {} [] etc.
{"enum": ["(", ")", "{", "}", "[", "]"]}
jscsrc.json
disallowSpacesInsideArrayBrackets
Deprecated in favor of the object "allExcept": [] rule format.
{"type": "string", "oneOf": [{"enum": ["nested"]}]}
jscsrc.json
disallowSpacesInsideBrackets
Disallows space after opening square bracket and before closing. Reports on all on brackets, even on property accessors. Use disallowSpacesInsideArrayBrackets to exclude property accessors.
{"type": ["boolean", "null", "object"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["(", ")", "{", "}", "[", "]"]}]}, "uniqueItems": true}}}]}
jscsrc.json
disallowSpacesInsideBrackets
Use true for strict mode.
{"type": "boolean"}
jscsrc.json
disallowSpacesInsideBrackets
An object that contains an "allExcept" key equal to an array of exception tokens.
{"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["(", ")", "{", "}", "[", "]"]}]}, "uniqueItems": true}}}
jscsrc.json
allExcept
Array of quoted tokens to exempt. Tokens should consist of an opener with a matching closer () {} [] etc.
{"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["(", ")", "{", "}", "[", "]"]}]}, "uniqueItems": true}
jscsrc.json
items
Tokens should consist of an opener with a matching closer () {} [] etc.
{"enum": ["(", ")", "{", "}", "[", "]"]}
jscsrc.json
disallowSpacesInsideObjectBrackets
Disallows space after opening object curly brace and before closing.
{"type": ["boolean", "null", "object", "string"], "oneOf": [{"type": ["boolean", "string"], "enum": [true, false, "all"]}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": [")", "}", "]"]}]}, "uniqueItems": true}}}, {"type": "string", "oneOf": [{"enum": ["nested"]}]}]}
jscsrc.json
disallowSpacesInsideObjectBrackets
Use "all" or true for strict mode.
{"type": ["boolean", "string"], "enum": [true, false, "all"]}
jscsrc.json
disallowSpacesInsideObjectBrackets
An object that contains an "allExcept" key equal to an array of exception tokens.
{"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": [")", "}", "]"]}]}, "uniqueItems": true}}}
jscsrc.json
allExcept
Array of quoted tokens to exempt. Applies only to closer tokens: e.g. ) } ]. If a (closer) token is specified, the rule ignores contiguous (closer) tokens.
{"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": [")", "}", "]"]}]}, "uniqueItems": true}
jscsrc.json
items
Tokens should consist of an closer: ) } ] etc.
{"enum": [")", "}", "]"]}
jscsrc.json
disallowSpacesInsideObjectBrackets
Deprecated in favor of the object "allExcept": [] rule format.
{"type": "string", "oneOf": [{"enum": ["nested"]}]}
jscsrc.json
disallowSpacesInsideParentheses
Disallows space after opening round bracket and before closing.
{"type": ["boolean", "null", "string", "object"], "oneOf": [{"type": ["boolean", "string"], "enum": [true, false, "all"]}, {}, {"type": "object", "properties": {"only": {"type": "array", "minItems": 0, "items": {"type": "string", "anyOf": [{"enum": ["(", ")", "{", "}", "[", "]", "function"]}, {"type": "string", "minLength": 1}]}, "uniqueItems": true}}}]}
jscsrc.json
disallowSpacesInsideParentheses
An object that contains an "only" key equal to an array of values which indicate where to apply this rule.
{"type": "object", "properties": {"only": {"type": "array", "minItems": 0, "items": {"type": "string", "anyOf": [{"enum": ["(", ")", "{", "}", "[", "]", "function"]}, {"type": "string", "minLength": 1}]}, "uniqueItems": true}}}
jscsrc.json
only
Array of quoted values to target.
{"type": "array", "minItems": 0, "items": {"type": "string", "anyOf": [{"enum": ["(", ")", "{", "}", "[", "]", "function"]}, {"type": "string", "minLength": 1}]}, "uniqueItems": true}
jscsrc.json
disallowSpacesInsideParenthesizedExpression
Disallows space after opening and before closing grouping parentheses.
{"type": ["boolean", "null", "object"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["(", ")", "{", "}", "[", "]", "function"]}]}, "uniqueItems": true}}}]}
jscsrc.json
disallowSpacesInsideParenthesizedExpression
If true, always disallow spaces inside grouping parentheses.
{"type": "boolean"}
jscsrc.json
disallowSpacesInsideParenthesizedExpression
An object that contains an "allExcept" key equal to an array of quoted exceptions.
{"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["(", ")", "{", "}", "[", "]", "function"]}]}, "uniqueItems": true}}}
jscsrc.json
allExcept
Array of quoted tokens or items to exempt. Tokens should consist of an opener with a matching closer () {} [] or `function`.
{"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["(", ")", "{", "}", "[", "]", "function"]}]}, "uniqueItems": true}
jscsrc.json
items
Tokens should consist of an opener with a matching closer () {} [] etc. or `function`.
{"enum": ["(", ")", "{", "}", "[", "]", "function"]}
jscsrc.json
disallowSpacesInsideTemplateStringPlaceholders
Disallows spaces before and after curly brace inside template string placeholders.
{"type": ["boolean", "null"], "oneOf": [{"type": "boolean"}, {}]}
jscsrc.json
disallowTabs
Disallows tabs everywhere.
{"type": ["boolean", "null"], "oneOf": [{"type": "boolean"}, {}]}
jscsrc.json
disallowTrailingComma
Disallows an extra comma following the final element of an array or object literal.
{"type": ["boolean", "null"], "oneOf": [{"type": "boolean"}, {}]}
jscsrc.json
disallowTrailingWhitespace
Requires all lines to end on a non-whitespace character.
{"type": ["boolean", "null", "string"], "oneOf": [{"type": ["boolean", "string"], "enum": [true, false, "ignoreEmptyLines"]}, {}]}
jscsrc.json
disallowTrailingWhitespace
Use "ignoreEmptyLines" to allow whitespace on empty lines (default is false).
{"type": ["boolean", "string"], "enum": [true, false, "ignoreEmptyLines"]}
jscsrc.json
disallowUnusedParams
Disallows unused params in function expression and function declaration.
{"type": ["boolean", "null"], "oneOf": [{"type": "boolean"}, {}]}
jscsrc.json
disallowVar
Disallows declaring variables with var.
{"oneOf": [{"type": "boolean"}, {}]}
jscsrc.json
disallowYodaConditions
Requires the variable to be the left hand operator when doing a boolean comparison. Array of quoted operators or true to disallow yoda conditions for most possible comparison operators.
{"type": ["array", "boolean", "null"], "oneOf": [{}]}
jscsrc.json
excludeFiles
Disables style checking for specified paths.
{"type": "array", "items": {"type": "string"}, "uniqueItems": true}
jscsrc.json
maximumLineLength
Requires all lines to be at most the number of characters specified.
{"type": ["integer", "null", "object"], "oneOf": [{"type": "integer", "minimum": 1}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"enum": ["comments"]}, {"enum": ["functionSignature"]}, {"enum": ["regex"]}, {"enum": ["require"]}, {"enum": ["urlComments"]}]}, "uniqueItems": true}, "tabSize": {"type": "integer", "minimum": 1}, "value": {"type": "integer", "minimum": 1}}, "required": ["value"]}]}
jscsrc.json
maximumLineLength
Lines should be at most the number of characters specified.
{"type": "integer", "minimum": 1}
jscsrc.json
maximumLineLength
An object that contains an "allExcept" key equal to an array an array of conditions that will exempt a line, in addition to other attributes.
{"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"enum": ["comments"]}, {"enum": ["functionSignature"]}, {"enum": ["regex"]}, {"enum": ["require"]}, {"enum": ["urlComments"]}]}, "uniqueItems": true}, "tabSize": {"type": "integer", "minimum": 1}, "value": {"type": "integer", "minimum": 1}}, "required": ["value"]}
jscsrc.json
allExcept
Array of conditions that will exempt a line.
{"type": "array", "minItems": 0, "items": {"anyOf": [{"enum": ["comments"]}, {"enum": ["functionSignature"]}, {"enum": ["regex"]}, {"enum": ["require"]}, {"enum": ["urlComments"]}]}, "uniqueItems": true}
jscsrc.json
items
Allows comments to break the rule.
{"enum": ["comments"]}
jscsrc.json
items
Allows function definitions to break the rule.
{"enum": ["functionSignature"]}
jscsrc.json
items
Allows regular expression literals to break the rule.
{"enum": ["regex"]}
jscsrc.json
items
Allows require expressions to break the rule.
{"enum": ["require"]}
jscsrc.json
items
Allows comments with long urls to break the rule.
{"enum": ["urlComments"]}
jscsrc.json
tabSize
Considered the tab character as number of specified spaces.
{"type": "integer", "minimum": 1}
jscsrc.json
value
Lines should be at most the number of characters specified.
{"type": "integer", "minimum": 1}
jscsrc.json
maximumNumberOfLines
Requires the file to be at most the number of lines specified.
{"type": ["integer", "null", "object"], "oneOf": [{"type": "integer", "minimum": 1}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"enum": ["comments"]}]}, "uniqueItems": true}, "value": {"type": "integer", "minimum": 1}}, "required": ["value"]}]}
jscsrc.json
maximumNumberOfLines
File should be at most the number of lines specified.
{"type": "integer", "minimum": 1}
jscsrc.json
maximumNumberOfLines
An object that contains an "allExcept" key equal to an array an array of conditions that will exempt a line, in addition to other attributes.
{"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"enum": ["comments"]}]}, "uniqueItems": true}, "value": {"type": "integer", "minimum": 1}}, "required": ["value"]}
jscsrc.json
allExcept
Array of conditions that will exempt a line.
{"type": "array", "minItems": 0, "items": {"anyOf": [{"enum": ["comments"]}]}, "uniqueItems": true}
jscsrc.json
items
Allows comments to break the rule.
{"enum": ["comments"]}
jscsrc.json
value
Lines should be at most the number of characters specified.
{"type": "integer", "minimum": 1}
jscsrc.json
preset
Extends defined rules with preset rules.
{"type": "string", "enum": ["airbnb", "crockford", "google", "grunt", "idiomatic", "jquery", "mdcs", "node-style-guide", "wikimedia", "wordpress", "yandex"]}
jscsrc.json
requireAlignedMultilineParams
Enforces indentation of parameters in multiline functions.
{"type": ["boolean", "integer", "null", "string"], "oneOf": [{"type": "boolean"}, {"type": "integer"}, {}, {"type": "string", "enum": ["firstParam"]}]}
jscsrc.json
requireAlignedMultilineParams
If true, require parameters to align with the body of the function.
{"type": "boolean"}
jscsrc.json
requireAlignedMultilineParams
The number of columns the parameters should be indented past the function body.
{"type": "integer"}
jscsrc.json
requireAlignedMultilineParams
Use `firstParam` to require parameters on a new line to be aligned with the first parameter(s) on the previous line.
{"type": "string", "enum": ["firstParam"]}
jscsrc.json
requireAlignedObjectValues
Requires proper alignment in object literals.
{"type": ["null", "string"], "oneOf": [{}, {"type": "string", "oneOf": [{"enum": ["all"]}, {"enum": ["ignoreFunction"]}, {"enum": ["ignoreLineBreak"]}]}]}
jscsrc.json
requireAlignedObjectValues
Use for strict mode.
{"enum": ["all"]}
jscsrc.json
requireAlignedObjectValues
Ignores objects if one of the property values is a function expression.
{"enum": ["ignoreFunction"]}
jscsrc.json
requireAlignedObjectValues
Ignores objects if there are line breaks between properties.
{"enum": ["ignoreLineBreak"]}
jscsrc.json
requireAnonymousFunctions
Requires that a function expression be anonymous.
{"type": ["boolean", "null", "object"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"enum": ["declarations"]}]}, "uniqueItems": true}}}]}
jscsrc.json
requireAnonymousFunctions
An object that contains an "allExcept" key equal to an array of quoted exceptions.
{"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"enum": ["declarations"]}]}, "uniqueItems": true}}}
jscsrc.json
allExcept
Array of quoted keywords to exempt.
{"type": "array", "minItems": 0, "items": {"anyOf": [{"enum": ["declarations"]}]}, "uniqueItems": true}
jscsrc.json
items
Ignores function declarations.
{"enum": ["declarations"]}
jscsrc.json
requireArrayDestructuring
Requires that variable assignment from array values are * destructured.
{"type": ["boolean", "null"], "oneOf": [{"type": "boolean"}, {}]}
jscsrc.json
requireArrowFunctions
Requires that arrow functions are used instead of anonymous function expressions in callbacks.
{"type": ["boolean", "null"], "oneOf": [{"type": "boolean"}, {}]}
jscsrc.json
requireBlocksOnNewline
Requires blocks to begin and end with a newline.
{"type": ["boolean", "integer", "null", "object"], "oneOf": [{"type": "boolean"}, {"type": "integer"}, {}, {"type": "object", "properties": {"includeComments": {"type": "boolean"}, "minLines": {"type": "integer"}}}]}
jscsrc.json
requireBlocksOnNewline
If true, validates all non-empty blocks.
{"type": "boolean"}
jscsrc.json
requireBlocksOnNewline
Specifies a minimum number of lines containing elements in the block before validating.
{"type": "integer"}
jscsrc.json
includeComments
If true, includes comments as part of the validation.
{"type": "boolean"}
jscsrc.json
minLines
Specifies a minimum number of lines containing elements in the block before validating.
{"type": "integer"}
jscsrc.json
requireCamelCaseOrUpperCaseIdentifiers
Requires identifiers to be camelCased or UPPERCASE_WITH_UNDERSCORES.
{"type": ["boolean", "null", "object", "string"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}, "allowedPrefixes": {"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}, "allowedSuffixes": {"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}, "ignoreProperties": {"type": "boolean"}, "strict": {"type": "boolean"}}}, {"type": "string", "oneOf": [{"enum": ["ignoreProperties"]}]}]}
jscsrc.json
requireCamelCaseOrUpperCaseIdentifiers
An object that contains an "allExcept" key equal to an array of exception values, in addition to other attributes.
{"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}, "allowedPrefixes": {"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}, "allowedSuffixes": {"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}, "ignoreProperties": {"type": "boolean"}, "strict": {"type": "boolean"}}}
jscsrc.json
allExcept
Array of String, RegExp, or ESTree RegExpLiteral values permitted as exceptions.
{"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}
jscsrc.json
allowedPrefixes
Array of String, RegExp, or ESTree RegExpLiteral values permitted as prefixes.
{"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}
jscsrc.json
allowedSuffixes
Array of String, RegExp, or ESTree RegExpLiteral values permitted as suffixes.
{"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}
jscsrc.json
ignoreProperties
If true, allows an exception for object property names.
{"type": "boolean"}
jscsrc.json
strict
If true, forces the first character to not be capitalized.
{"type": "boolean"}
jscsrc.json
requireCamelCaseOrUpperCaseIdentifiers
Deprecated in favor of the object "ignoreProperties" rule format.
{"type": "string", "oneOf": [{"enum": ["ignoreProperties"]}]}
jscsrc.json
requireCapitalizedComments
Requires the first alphabetical character of a comment to be uppercase, unless it is part of a multi-line textblock. This rule automatically ignores jscs, jshint, eslint, and istanbul specific comments.
{"type": ["boolean", "null", "object"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}, "inlined": {"type": "boolean"}}}]}
jscsrc.json
requireCapitalizedComments
An object that contains an "allExcept" key equal to an array of quoted exceptions, in addition to other attributes.
{"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}, "inlined": {"type": "boolean"}}}
jscsrc.json
allExcept
Array of quoted keywords to exempt.
{"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}
jscsrc.json
inlined
If true, ignore comments in the middle of the code line.
{"type": "boolean"}
jscsrc.json
requireCapitalizedConstructorsNew
Requires capitalized constructors to to use the new keyword.
{"type": ["boolean", "null", "object"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}}}]}
jscsrc.json
requireCapitalizedConstructorsNew
An object that contains an "allExcept" key equal to an array of quoted exceptions.
{"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}}}
jscsrc.json
allExcept
Array of quoted keywords to exempt.
{"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}
jscsrc.json
requireCapitalizedConstructors
Requires constructors to be capitalized (except for "this")
{"type": ["boolean", "null", "object"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}}}]}
jscsrc.json
requireCapitalizedConstructors
An object that contains an "allExcept" key equal to an array of quoted exceptions.
{"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}}}
jscsrc.json
allExcept
Array of quoted keywords to exempt.
{"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}]}, "uniqueItems": true}
jscsrc.json
requireCommaBeforeLineBreak
Requires commas as last token on a line in lists.
{"type": ["boolean", "null"], "oneOf": [{"type": "boolean"}, {}]}