schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
jscsrc.json
requireSpaceBeforePostfixUnaryOperators
Disallows sticking unary operators to the left.
{"type": ["array", "boolean", "null"], "oneOf": [{}]}
jscsrc.json
requireSpaceBetweenArguments
Ensure there are spaces after argument separators in call expressions.
{"type": ["boolean", "null"], "oneOf": [{"type": "boolean"}, {}]}
jscsrc.json
requireSpacesInAnonymousFunctionExpression
Requires space before `()` or `{}` in function expressions (both named and anonymous).
{"type": ["null", "object"], "oneOf": [{"type": "object", "properties": {"beforeOpeningRoundBrace": {"type": ["boolean", "null"]}, "beforeOpeningCurlyBrace": {"type": ["boolean", "null"]}, "allExcept": {"type": ["boolean", "null", "array"], "oneOf": [{"type": "boolean"}, {}, {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["shorthand"]}]}, "uniqueItems": true}]}}}]}
jscsrc.json
requireSpacesInAnonymousFunctionExpression
An object with the following properties (one of "beforeOpeningRoundBrace" and "beforeOpeningCurlyBrace" must be provided):
{"type": "object", "properties": {"beforeOpeningRoundBrace": {"type": ["boolean", "null"]}, "beforeOpeningCurlyBrace": {"type": ["boolean", "null"]}, "allExcept": {"type": ["boolean", "null", "array"], "oneOf": [{"type": "boolean"}, {}, {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["shorthand"]}]}, "uniqueItems": true}]}}}
jscsrc.json
allExcept
A boolean or an array of quoted exceptions.
{"type": ["boolean", "null", "array"], "oneOf": [{"type": "boolean"}, {}, {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["shorthand"]}]}, "uniqueItems": true}]}
jscsrc.json
allExcept
If true, enable all configuration exceptions.
{"type": "boolean"}
jscsrc.json
allExcept
Array of quoted keywords to exempt.
{"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["shorthand"]}]}, "uniqueItems": true}
jscsrc.json
items
If "shorthand" is provided, spaces will not be required for ES6 method definitions.
{"enum": ["shorthand"]}
jscsrc.json
requireSpacesInCallExpression
Requires space before `()` in call expressions.
{"type": ["boolean", "null"], "oneOf": [{"type": "boolean"}, {}]}
jscsrc.json
requireSpacesInConditionalExpression
Requires space before and/or after `?` or `:` in conditional expressions.
{"type": ["boolean", "null", "object"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"afterTest": {"type": "boolean"}, "beforeConsequent": {"type": "boolean"}, "afterConsequent": {"type": "boolean"}, "beforeAlternate": {"type": "boolean"}}}]}
jscsrc.json
requireSpacesInConditionalExpression
If true, set all properties to true.
{"type": "boolean"}
jscsrc.json
requireSpacesInForStatement
Requires spaces in between `for` statement.
{"type": ["boolean", "null"], "oneOf": [{"type": "boolean"}, {}]}
jscsrc.json
requireSpacesInFunction
Requires space before `()` or `{}` in function expressions (both named and anonymous) and function declarations.
{"type": ["null", "object"], "oneOf": [{}]}
jscsrc.json
requireSpacesInFunctionDeclaration
Requires space before `()` or `{}` in function declarations.
{"type": ["null", "object"], "oneOf": [{}]}
jscsrc.json
requireSpacesInFunctionExpression
Requires space before `()` or `{}` in function expressions (both named and anonymous).
{"type": ["null", "object"], "oneOf": [{}]}
jscsrc.json
requireSpacesInGenerator
Requires space before and after `*` in generator functions.
{"type": ["null", "object"], "oneOf": [{}, {"type": "object", "properties": {"beforeStar": {"type": "boolean"}, "afterStar": {"type": "boolean"}}}]}
jscsrc.json
requireSpacesInGenerator
An object where at least one of its properties must be present and it must be set to true.
{"type": "object", "properties": {"beforeStar": {"type": "boolean"}, "afterStar": {"type": "boolean"}}}
jscsrc.json
beforeStar
If true, validates that there is a space before `*`.
{"type": "boolean"}
jscsrc.json
afterStar
If true, validates that there is a space after `*`.
{"type": "boolean"}
jscsrc.json
requireSpacesInNamedFunctionExpression
Requires space before `()` or `{}` in named function expressions.
{"type": ["null", "object"], "oneOf": [{}]}
jscsrc.json
requireSpacesInsideArrayBrackets
Requires space after opening array square bracket and before closing. Reports only on arrays, not on property accessors. Use requireSpacesInsideBrackets to report on all brackets.
{"type": ["null", "object", "string"], "oneOf": [{}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["{", "}", "[", "]"]}]}, "uniqueItems": true}}}, {"type": "string", "oneOf": [{"enum": ["all"]}, {"enum": ["allButNested"]}]}]}
jscsrc.json
requireSpacesInsideArrayBrackets
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 that can occur after an opening square bracket or before a closing square bracket without a space.
{"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["{", "}", "[", "]"]}]}, "uniqueItems": true}
jscsrc.json
requireSpacesInsideArrayBrackets
Strict mode.
{"enum": ["all"]}
jscsrc.json
requireSpacesInsideArrayBrackets
Deprecated in favor of the object "allExcept": ["[", "]"] format.
{"enum": ["allButNested"]}
jscsrc.json
requireSpacesInsideBrackets
Requires space after opening square bracket and before closing. Reports on all on brackets, even on property accessors. Use requireSpacesInsideArrayBrackets 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
requireSpacesInsideBrackets
For default behavior (strict mode).
{"type": "boolean"}
jscsrc.json
requireSpacesInsideBrackets
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 that can occur after an opening square bracket or before a closing square bracket without a space.
{"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["{", "}", "[", "]"]}]}, "uniqueItems": true}
jscsrc.json
requireSpacesInsideObjectBrackets
Requires space after opening object curly brace and before closing.
{"type": ["null", "object", "string"], "oneOf": [{}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["(", ")", "{", "}", "[", "]"]}]}, "uniqueItems": true}}}, {"type": "string", "oneOf": [{"enum": ["all"]}, {"enum": ["allButNested"]}]}]}
jscsrc.json
requireSpacesInsideObjectBrackets
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 that can occur after an opening object brace or before a closing object brace without a space.
{"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["(", ")", "{", "}", "[", "]"]}]}, "uniqueItems": true}
jscsrc.json
requireSpacesInsideObjectBrackets
Strict mode.
{"enum": ["all"]}
jscsrc.json
requireSpacesInsideObjectBrackets
Deprecated in favor of the object "allExcept": ["}"] format.
{"enum": ["allButNested"]}
jscsrc.json
requireSpacesInsideParentheses
Requires space after opening round bracket and before closing.
{"type": ["null", "object", "string"], "oneOf": [{}, {"type": "object", "properties": {"all": {"type": "boolean"}, "ignoreParenthesizedExpression": {"type": "boolean"}, "except": {"type": "array", "minItems": 0, "items": {"type": "string", "anyOf": [{"enum": ["(", ")", "{", "}", "[", "]"]}, {"type": "string", "maxLength": 1}]}, "uniqueItems": true}}}, {"type": "string", "oneOf": [{"enum": ["all"]}, {"enum": ["allButNested"]}]}]}
jscsrc.json
requireSpacesInsideParentheses
An object that contains an "except" key equal to an array of exception tokens, in addition to other attributes.
{"type": "object", "properties": {"all": {"type": "boolean"}, "ignoreParenthesizedExpression": {"type": "boolean"}, "except": {"type": "array", "minItems": 0, "items": {"type": "string", "anyOf": [{"enum": ["(", ")", "{", "}", "[", "]"]}, {"type": "string", "maxLength": 1}]}, "uniqueItems": true}}}
jscsrc.json
except
Array of quoted tokens that can occur after an opening bracket or before a closing bracket without a space.
{"type": "array", "minItems": 0, "items": {"type": "string", "anyOf": [{"enum": ["(", ")", "{", "}", "[", "]"]}, {"type": "string", "maxLength": 1}]}, "uniqueItems": true}
jscsrc.json
requireSpacesInsideParentheses
Strict mode.
{"enum": ["all"]}
jscsrc.json
requireSpacesInsideParentheses
Deprecated in favor of the object "except": ["(", ")"] format. Ignores nested brackets in a row.
{"enum": ["allButNested"]}
jscsrc.json
requireSpacesInsideParenthesizedExpression
Requires 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
requireSpacesInsideParenthesizedExpression
If true, always require spaces inside grouping parentheses.
{"type": "boolean"}
jscsrc.json
requireSpacesInsideParenthesizedExpression
An object that contains an "allExcept" key equal to an array of exception values.
{"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["{", "}", "function"]}]}, "uniqueItems": true}}}
jscsrc.json
allExcept
Array of quoted keywords to exempt.
{"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["{", "}", "function"]}]}, "uniqueItems": true}
jscsrc.json
items
Ignore parenthesized objects and functions.
{"enum": ["{", "}", "function"]}
jscsrc.json
requireSpread
Disallows using `.apply` in favor of the spread operator.
{"type": ["boolean", "null"], "oneOf": [{"type": "boolean"}, {}]}
jscsrc.json
requireSpread
If true, specifies that apply `.apply` is disallowed.
{"type": "boolean"}
jscsrc.json
requireTemplateStrings
Requires the use of template strings instead of string concatenation.
{"type": ["boolean", "null", "object"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["stringConcatenation"]}]}, "uniqueItems": true}}}]}
jscsrc.json
requireTemplateStrings
An object that contains an "allExcept" key equal to an array of exception values.
{"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["stringConcatenation"]}]}, "uniqueItems": true}}}
jscsrc.json
allExcept
Array of quoted keywords to exempt.
{"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["stringConcatenation"]}]}, "uniqueItems": true}
jscsrc.json
items
Ignores strings concatenated with other strings.
{"enum": ["stringConcatenation"]}
jscsrc.json
requireTrailingComma
Requires an extra comma following the final element of an array or object literal.
{"type": ["boolean", "null", "object"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"ignoreSingleValue": {"type": "boolean"}, "ignoreSingleLine": {"type": "boolean"}}}]}
jscsrc.json
requireTrailingComma
If true, validates all arrays and objects.
{"type": "boolean"}
jscsrc.json
ignoreSingleValue
If true, allows single property objects and single element arrays to not require a trailing comma.
{"type": "boolean"}
jscsrc.json
ignoreSingleLine
If true, allows objects and arrays on a single line to not require a trailing comma.
{"type": "boolean"}
jscsrc.json
requireVarDeclFirst
Requires `var` declaration to be on the top of an enclosing scope.
{"type": ["boolean", "null"], "oneOf": [{"type": "boolean"}, {}]}
jscsrc.json
requireVarDeclFirst
If true, specifies that `var` declarations must occur the top of a function scope.
{"type": "boolean"}
jscsrc.json
requireYodaConditions
Requires the variable to be the right hand operator when doing a boolean comparison. An array of quoted operators can be supplied to indicate which operators requires yoda conditions.
{"type": ["array", "boolean", "null"], "oneOf": [{}, {"type": "boolean"}, {}]}
jscsrc.json
requireYodaConditions
If true, specifies that yoda conditions are required for most possible comparison operators.
{"type": "boolean"}
jscsrc.json
safeContextKeyword
Option to check `var that = this` expressions.
{"type": ["array", "null", "string"], "oneOf": [{"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string", "minLength": 1}]}, "uniqueItems": true}, {}, {"type": "string", "minLength": 1}]}
jscsrc.json
safeContextKeyword
Array of quoted keywords that can be assigned to `this` context.
{"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string", "minLength": 1}]}, "uniqueItems": true}
jscsrc.json
safeContextKeyword
Represents the keyword that can be assigned to `this` context.
{"type": "string", "minLength": 1}
jscsrc.json
validateAlignedFunctionParameters
Validates proper alignment of function parameters.
{"type": ["boolean", "null", "object"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"lineBreakAfterOpeningBrace": {"type": "boolean"}, "lineBreakBeforeClosingBrace": {"type": "boolean"}}}]}
jscsrc.json
validateAlignedFunctionParameters
If true, this is the same as validating the rule using `{lineBreakAfterOpeningBrace: true, lineBreakBeforeClosingBrace: true}`.
{"type": "boolean"}
jscsrc.json
lineBreakAfterOpeningBrace
If true, specifies that the first function parameter must not be on the same line as the opening parenthesis `(` of the function parameters list.
{"type": "boolean"}
jscsrc.json
lineBreakBeforeClosingBrace
If true, specifies that the last function parameter must not be on the same line as the closing parenthesis `)` of the function parameters list.
{"type": "boolean"}
jscsrc.json
validateCommentPosition
This rule is for validating the positioning of line comments. Block comments are ignored. Comments that start with the following keywords are also ignored: `eslint`, `jshint`, `jslint`, `istanbul`, `global`, `exported`, `jscs`, `falls through` eg. // jshint strict: true
{"type": ["null", "object"], "oneOf": [{}, {"type": "object", "properties": {"position": {"type": "string", "enum": ["above", "beside"]}, "allExcept": {"type": "array", "minItems": 0, "items": {"type": "string"}, "uniqueItems": true}}}]}
jscsrc.json
allExcept
Array of quoted exceptions (comments that start with these values will be excepted).
{"type": "array", "minItems": 0, "items": {"type": "string"}, "uniqueItems": true}
jscsrc.json
validateIndentation
Validates indentation for switch statements and block statements.
{"type": ["integer", "null", "object", "string"], "oneOf": [{"type": "integer", "minimum": 0}, {}, {"type": "object", "properties": {"value": {"type": ["integer", "string"], "oneOf": [{"type": "integer", "minimum": 0}, {"type": "string"}]}, "includeEmptyLines": {"type": "boolean", "default": false}, "allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["comments"]}, {"enum": ["emptyLines"]}]}, "uniqueItems": true}}, "required": ["value"]}]}
jscsrc.json
validateIndentation
A positive number of spaces.
{"type": "integer", "minimum": 0}
jscsrc.json
includeEmptyLines
Deprecated. Require empty lines to be indented.
{"type": "boolean", "default": false}
jscsrc.json
allExcept
Array of quoted exceptions.
{"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["comments"]}, {"enum": ["emptyLines"]}]}, "uniqueItems": true}
jscsrc.json
items
Ignores comments.
{"enum": ["comments"]}
jscsrc.json
items
Ignores empty lines, included by default.
{"enum": ["emptyLines"]}
jscsrc.json
validateLineBreaks
Option to check line break characters.
{"type": ["null", "object", "string"], "oneOf": [{}, {"type": "object", "properties": {"character": {"type": "string", "enum": ["CR", "LF", "CRLF"]}, "reportOncePerFile": {"type": "boolean"}}}, {"type": "string", "enum": ["CR", "LF", "CRLF"]}]}
jscsrc.json
reportOncePerFile
If true, specifies that validation for the file should stop running upon encountering the first rule violation and return the details of that violation in the report.
{"type": "boolean"}
jscsrc.json
validateLineBreaks
Setting this is the same as validating the rule using `{character: String, reportOncePerFile: false}`.
{"type": "string", "enum": ["CR", "LF", "CRLF"]}
jscsrc.json
validateNewlineAfterArrayElements
Requires each element in array on a single line when array length is more than passed maximum number or array fills more than one line.
{"type": ["boolean", "integer", "null", "object"], "oneOf": [{"type": "boolean"}, {"type": "integer", "minimum": 0}, {}, {"type": "object", "properties": {"maximum": {"type": "integer", "minimum": 0}, "ignoreBrackets": {"type": "boolean"}}}]}
jscsrc.json
validateNewlineAfterArrayElements
If true, this is the same as validating the rule using `{maximum: Infinity, ignoreBrackets: false}`.
{"type": "boolean"}
jscsrc.json
validateNewlineAfterArrayElements
Setting this is the same as validating the rule using `{maximum: Integer, ignoreBrackets: false}`.
{"type": "integer", "minimum": 0}
jscsrc.json
ignoreBrackets
If true, specifies that the `[` and `]` brackets can be placed on the same line as the array elements.
{"type": "boolean"}
jscsrc.json
validateOrderInObjectKeys
Validates the order in object keys.
{"type": ["boolean", "null", "string"], "oneOf": [{"type": "boolean"}, {}, {"type": "string", "oneOf": [{"enum": ["asc"]}, {"enum": ["asc-insensitive"]}, {"enum": ["asc-natural"]}, {"enum": ["desc"]}, {"enum": ["desc-insensitive"]}, {"enum": ["desc-natural"]}]}]}
jscsrc.json
validateOrderInObjectKeys
If true, alias to `asc`.
{"type": "boolean"}
jscsrc.json
validateOrderInObjectKeys
Requires sorting in ascending order.
{"enum": ["asc"]}
jscsrc.json
validateOrderInObjectKeys
Requires sorting in ascending order (case-insensitive).
{"enum": ["asc-insensitive"]}
jscsrc.json
validateOrderInObjectKeys
Requires sorting in ascending natural order.
{"enum": ["asc-natural"]}
jscsrc.json
validateOrderInObjectKeys
Requires sorting in descending order.
{"enum": ["desc"]}
jscsrc.json
validateOrderInObjectKeys
Requires sorting in descending order (case-insensitive).
{"enum": ["desc-insensitive"]}
jscsrc.json
validateOrderInObjectKeys
Requires sorting in descending natural order.
{"enum": ["desc-natural"]}
jscsrc.json
validateParameterSeparator
Enable validation of separators between function parameters. Will ignore newlines.
{"type": ["null", "string"], "oneOf": [{}, {"type": "string", "oneOf": [{"enum": [","]}, {"enum": [", "]}, {"enum": [" ,"]}, {"enum": [" , "]}]}]}
jscsrc.json
validateParameterSeparator
Function parameters are immediately followed by a comma.
{"enum": [","]}
jscsrc.json
validateParameterSeparator
Function parameters are immediately followed by a comma and then a space.
{"enum": [", "]}
jscsrc.json
validateParameterSeparator
Function parameters are immediately followed by a space and then a comma.
{"enum": [" ,"]}
jscsrc.json
validateParameterSeparator
Function parameters are immediately followed by a space, a comma, and then a space.
{"enum": [" , "]}
jscsrc.json
validateQuoteMarks
Requires all quote marks to be either the supplied value, or consistent if `true`.
{"type": ["boolean", "null", "object", "string"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"escape": {"type": "boolean"}, "mark": {"type": "string", "oneOf": [{"enum": [""]}, {"enum": [""]}]}, "ignoreJSX": {"type": "boolean"}}, "required": ["value"]}, {"type": "string", "oneOf": [{"enum": ["\""]}, {"enum": ["'"]}]}]}
jscsrc.json
validateQuoteMarks
If true, all strings require the quote mark first encountered in the source code.
{"type": "boolean"}
jscsrc.json
escape
Allow the "other" quote mark to be used, but only to avoid having to escape.
{"type": "boolean"}
jscsrc.json
mark
The same effect as the non-object values.
{"type": "string", "oneOf": [{"enum": [""]}, {"enum": [""]}]}
jscsrc.json
mark
All strings require double quotes.
{"enum": [""]}
jscsrc.json
mark
All strings require single quotes.
{"enum": [""]}
jscsrc.json
ignoreJSX
Ignore JSX nodes.
{"type": "boolean"}