schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
jscsrc.json
allExcept
Array of quoted keywords to exempt.
{"type": "array", "minItems": 0, "items": {"type": "string"}, "uniqueItems": true}
jscsrc.json
disallowEmptyBlocks
Disallows empty blocks (except for catch blocks).
{"type": ["boolean", "null", "object"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"enum": ["comments"]}, "uniqueItems": true}}}]}
jscsrc.json
disallowEmptyBlocks
For default behavior (strict mode, no empty blocks allowed).
{"type": "boolean"}
jscsrc.json
disallowEmptyBlocks
An object that contains an "allExcept" key equal to an array of quoted exceptions.
{"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"enum": ["comments"]}, "uniqueItems": true}}}
jscsrc.json
allExcept
Array of quoted keywords to exempt. Blocks containing only comments would not be considered empty.
{"type": "array", "minItems": 0, "items": {"enum": ["comments"]}, "uniqueItems": true}
jscsrc.json
disallowFunctionDeclarations
Disallows function declarations.
{"type": ["boolean", "null"]}
jscsrc.json
disallowIdenticalDestructuringNames
Disallows identical destructuring names for the key and value in favor of using shorthand destructuring.
{"type": ["boolean", "null"]}
jscsrc.json
disallowIdentifierNames
Disallows a specified set of identifier names.
{"type": ["array", "null"], "oneOf": [{"type": "array", "minItems": 0, "items": {"type": "string"}, "uniqueItems": true}, {}]}
jscsrc.json
disallowIdentifierNames
An array of strings, which should be disallowed as identifier names.
{"type": "array", "minItems": 0, "items": {"type": "string"}, "uniqueItems": true}
jscsrc.json
disallowImplicitTypeConversion
Disallows implicit type conversion.
{"type": ["array", "null"], "items": {"enum": ["numeric", "boolean", "binary", "string"]}, "uniqueItems": true}
jscsrc.json
disallowKeywordsInComments
Disallows one or more keywords in comments.
{"type": ["array", "boolean", "null", "string"], "oneOf": [{"type": "array", "minItems": 0, "items": {"type": "string"}, "uniqueItems": true}, {"type": "boolean"}, {}, {"type": "string"}]}
jscsrc.json
disallowKeywordsInComments
An array of strings, which should be disallowed keywords in comments.
{"type": "array", "minItems": 0, "items": {"type": "string"}, "uniqueItems": true}
jscsrc.json
disallowKeywordsInComments
If true, "TODO" and "FIXME" will be disallowed in comments.
{"type": "boolean"}
jscsrc.json
disallowKeywordsInComments
A valid Regular Expression.
{"type": "string"}
jscsrc.json
disallowKeywordsOnNewLine
Disallows placing the specified keywords on a new line.
{"type": ["array", "null"], "oneOf": [{}]}
jscsrc.json
disallowKeywords
Disallows usage of the specified keywords.
{"type": ["array", "null"], "oneOf": [{}]}
jscsrc.json
disallowMixedSpacesAndTabs
Requires lines to not contain both spaces and tabs consecutively, or spaces after tabs only for alignment if "smart
{"type": ["boolean", "null", "string"], "enum": [true, false, null, "smart"]}
jscsrc.json
disallowMultiLineTernary
Disallows the test, consequent and alternate to be on separate lines when using the ternary operator.
{"type": ["boolean", "null"]}
jscsrc.json
disallowMultipleLineBreaks
Disallows multiple blank lines in a row.
{"type": ["boolean", "null"]}
jscsrc.json
disallowMultipleLineStrings
Disallows strings that span multiple lines without using concatenation.
{"type": ["boolean", "null"]}
jscsrc.json
disallowMultipleSpaces
Disallows multiple indentation characters (tabs or spaces) between identifiers, keywords, and any other token.
{"type": ["boolean", "null", "object"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"allowEOLComments": {"type": ["boolean", "null"]}}}]}
jscsrc.json
disallowMultipleSpaces
An object that contains a "allowEOLComments" key equal to a boolean.
{"type": "object", "properties": {"allowEOLComments": {"type": ["boolean", "null"]}}}
jscsrc.json
disallowMultipleVarDecl
Disallows multiple `var` declaration (except for-loop).
{"type": ["boolean", "null", "object"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"strict": {"type": ["boolean", "null"]}, "allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["require"]}, {"enum": ["undefined"]}]}, "uniqueItems": true}}}]}
jscsrc.json
disallowMultipleVarDecl
An object that contains a "allowEOLComments" key equal to a boolean.
{"type": "object", "properties": {"strict": {"type": ["boolean", "null"]}, "allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["require"]}, {"enum": ["undefined"]}]}, "uniqueItems": true}}}
jscsrc.json
allExcept
Array of quoted keywords to exempt.
{"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["require"]}, {"enum": ["undefined"]}]}, "uniqueItems": true}
jscsrc.json
items
Allows declarations where all variables are importing external modules with require.
{"enum": ["require"]}
jscsrc.json
items
Allows declarations where all variables are not defined.
{"enum": ["undefined"]}
jscsrc.json
disallowNamedUnassignedFunctions
Disallows unassigned functions to be named inline.
{"type": ["boolean", "null"]}
jscsrc.json
disallowNestedTernaries
Disallows nested ternaries.
{"type": ["boolean", "null", "object"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"maxLevel": {"type": "integer", "minimum": 1}}}]}
jscsrc.json
disallowNestedTernaries
An object that contains a "maxLevel" property equal to an integer indicating the maximum levels of nesting to be allowed.
{"type": "object", "properties": {"maxLevel": {"type": "integer", "minimum": 1}}}
jscsrc.json
maxLevel
The maximum levels of ternary nesting to be allowed.
{"type": "integer", "minimum": 1}
jscsrc.json
disallowNewlineBeforeBlockStatements
Disallows newline before opening curly brace of all block statements.
{"type": ["array", "boolean", "null", "object"], "oneOf": [{}, {"type": "boolean"}, {}, {"type": "object", "properties": {"value": {"type": ["array", "boolean"]}, "allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}, {"enum": ["multiline"]}]}, "uniqueItems": true}}}]}
jscsrc.json
disallowNewlineBeforeBlockStatements
A value of true will always disallow newline before curly brace of block statements.
{"type": "boolean"}
jscsrc.json
disallowNewlineBeforeBlockStatements
An object that contains a "value" key equal to a boolean or an array, and / or an "allExcept" key equal to an array of quoted exceptions.
{"type": "object", "properties": {"value": {"type": ["array", "boolean"]}, "allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}, {"enum": ["multiline"]}]}, "uniqueItems": true}}}
jscsrc.json
allExcept
Array of quoted keywords to exempt. If `multiline` is specified, when the conditions span on multiple lines, require a new line before the curly brace.
{"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}, {"enum": ["multiline"]}]}, "uniqueItems": true}
jscsrc.json
disallowNodeTypes
Disallow use of certain node types (from Esprima/ESTree). Value equals an array of parser node types to be disallowed.
{"type": ["array", "null"], "oneOf": [{}]}
jscsrc.json
disallowNotOperatorsInConditionals
Disallows the not, not equals, and strict not equals operators in conditionals.
{"type": ["boolean", "null"]}
jscsrc.json
disallowObjectKeysOnNewLine
Disallows placing object keys on new line.
{"type": ["boolean", "null"]}
jscsrc.json
disallowOperatorBeforeLineBreak
Requires putting certain operators on the next line rather than on the current line before a line break.
{"type": ["array", "boolean", "null"], "oneOf": [{}]}
jscsrc.json
disallowPaddingNewLinesAfterBlocks
Disallow a newline after blocks.
{"type": ["boolean", "null"]}
jscsrc.json
disallowPaddingNewLinesAfterUseStrict
Disallow a blank line after 'use strict'; statements.
{"type": ["boolean", "null"]}
jscsrc.json
disallowPaddingNewLinesBeforeExport
Disallows newline before module.exports.
{"type": ["boolean", "null"]}
jscsrc.json
disallowPaddingNewlinesBeforeKeywords
Disallow an empty line above the specified keywords.
{"type": ["array", "boolean", "null"], "oneOf": [{}]}
jscsrc.json
disallowPaddingNewLinesBeforeLineComments
Disallows newline before line comments.
{"type": ["boolean", "null"], "oneOf": [{"type": "boolean"}, {}]}
jscsrc.json
disallowPaddingNewlinesInBlocks
Disallows blocks from beginning or ending with 2 newlines.
{"type": ["boolean", "null", "object"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"close": {"type": "boolean"}, "open": {"type": "boolean"}, "allExcept": {"type": "array", "minItems": 0, "items": {"enum": ["conditionals", "functions"]}, "uniqueItems": true}}}]}
jscsrc.json
disallowPaddingNewlinesInBlocks
A value of true validates all non-empty blocks.
{"type": "boolean"}
jscsrc.json
disallowPaddingNewlinesInBlocks
An object that contains a "open" key equal to a boolean, an "close" key equal to a boolean, and / or an "allExcept" key equal to an array of quoted exceptions.
{"type": "object", "properties": {"close": {"type": "boolean"}, "open": {"type": "boolean"}, "allExcept": {"type": "array", "minItems": 0, "items": {"enum": ["conditionals", "functions"]}, "uniqueItems": true}}}
jscsrc.json
close
A value of true validates that there is a newline before the closing brace in a block. A value of false ignores the newline validation before the closing brace in a block.
{"type": "boolean"}
jscsrc.json
open
A value of true validates that there is a newline after the opening brace in a block. A value of false ignores the newline validation after the opening brace in a block.
{"type": "boolean"}
jscsrc.json
allExcept
Array of quoted keywords to exempt. If `conditionals` is specified, conditionals (if, else if, else) blocks are ignored. If `functions` is specified, function blocks are ignored.
{"type": "array", "minItems": 0, "items": {"enum": ["conditionals", "functions"]}, "uniqueItems": true}
jscsrc.json
disallowPaddingNewLinesInObjects
Disallows newlines adjacent to curly braces in all object literals.
{"type": ["boolean", "null"]}
jscsrc.json
disallowParenthesesAroundArrowParam
Disallows parentheses around arrow function expressions that contain a single parameter.
{"type": ["boolean", "null"]}
jscsrc.json
disallowQuotedKeysInObjects
Disallows quoted keys in object if possible.
{"type": ["boolean", "null", "object", "string"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}, {"enum": ["reserved"]}]}, "uniqueItems": true}}}, {"type": "string", "oneOf": [{"enum": ["allButReserved"]}]}]}
jscsrc.json
disallowQuotedKeysInObjects
Set to true for strict mode.
{"type": "boolean"}
jscsrc.json
disallowQuotedKeysInObjects
An object that contains an "allExcept" key equal to an array of exception values.
{"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}, {"enum": ["reserved"]}]}, "uniqueItems": true}}}
jscsrc.json
allExcept
Array of quoted keywords to exempt.
{"type": "array", "minItems": 0, "items": {"anyOf": [{"type": "string"}, {"enum": ["reserved"]}]}, "uniqueItems": true}
jscsrc.json
items
Allows ES3+ reserved words to remain quoted which is helpful when using this option with JSHint's es3 flag.
{"enum": ["reserved"]}
jscsrc.json
disallowQuotedKeysInObjects
Deprecated in favor of the object "allExcept": ["reserved"] rule format.
{"type": "string", "oneOf": [{"enum": ["allButReserved"]}]}
jscsrc.json
disallowSemicolons
Disallows lines from ending in a semicolon.
{"type": ["boolean", "null"]}
jscsrc.json
disallowShorthandArrowFunctions
Require arrow functions to use a block statement (explicit return).
{"type": ["boolean", "null"]}
jscsrc.json
disallowSpaceAfterBinaryOperators
Requires sticking binary operators to the right.
{"type": ["array", "boolean", "null"], "oneOf": [{}]}
jscsrc.json
disallowSpaceAfterComma
Disallows spaces after commas.
{"type": ["boolean", "null", "object"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["sparseArrays"]}]}, "uniqueItems": true}}}]}
jscsrc.json
disallowSpaceAfterComma
A value of true will disallow any spaces after any comma.
{"type": "boolean"}
jscsrc.json
disallowSpaceAfterComma
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": ["sparseArrays"]}]}, "uniqueItems": true}}}
jscsrc.json
allExcept
Array of quoted keywords to exempt.
{"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["sparseArrays"]}]}, "uniqueItems": true}
jscsrc.json
items
Allow spaces in place of absent values in sparse arrays.
{"enum": ["sparseArrays"]}
jscsrc.json
disallowSpaceAfterKeywords
Disallows space after the specified keywords. A value of true will require spaces after all possible keywords.
{"type": ["array", "boolean", "null"], "oneOf": [{}]}
jscsrc.json
disallowSpaceAfterLineComment
Requires that a line comment (//) not be followed by a space.
{"type": ["boolean", "null"]}
jscsrc.json
disallowSpaceAfterObjectKeys
Disallows space after object keys.
{"type": ["boolean", "null", "object", "string"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["singleline"]}, {"enum": ["multiline"]}, {"enum": ["aligned"]}, {"enum": ["method"]}]}, "uniqueItems": true}}}, {"type": "string", "oneOf": [{"enum": ["ignoreSingleLine"]}, {"enum": ["ignoreMultiLine"]}]}]}
jscsrc.json
disallowSpaceAfterObjectKeys
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": ["singleline"]}, {"enum": ["multiline"]}, {"enum": ["aligned"]}, {"enum": ["method"]}]}, "uniqueItems": true}}}
jscsrc.json
allExcept
Array of quoted keywords to exempt.
{"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["singleline"]}, {"enum": ["multiline"]}, {"enum": ["aligned"]}, {"enum": ["method"]}]}, "uniqueItems": true}
jscsrc.json
items
Ignores objects if the object only takes up a single line.
{"enum": ["singleline"]}
jscsrc.json
items
Ignores objects if the object takes up multiple lines.
{"enum": ["multiline"]}
jscsrc.json
items
Ignores aligned object properties.
{"enum": ["aligned"]}
jscsrc.json
items
Ignores method declarations.
{"enum": ["method"]}
jscsrc.json
disallowSpaceAfterObjectKeys
Deprecated in favor of the object "allExcept": [] rule format.
{"type": "string", "oneOf": [{"enum": ["ignoreSingleLine"]}, {"enum": ["ignoreMultiLine"]}]}
jscsrc.json
disallowSpaceAfterObjectKeys
Ignores objects if the object only takes up a single line.
{"enum": ["ignoreSingleLine"]}
jscsrc.json
disallowSpaceAfterObjectKeys
Ignores objects if the object takes up multiple lines.
{"enum": ["ignoreMultiLine"]}
jscsrc.json
disallowSpaceAfterPrefixUnaryOperators
Requires sticking unary operators to the right.
{"type": ["array", "boolean", "null"], "oneOf": [{}]}
jscsrc.json
disallowSpaceBeforeBinaryOperators
Requires sticking binary operators to the left.
{"type": ["array", "boolean", "null"], "oneOf": [{}]}
jscsrc.json
disallowSpaceBeforeBlockStatements
Disallows space before block statements (for loops, control structures).
{"type": ["boolean", "null"]}
jscsrc.json
disallowSpaceBeforeComma
Disallows spaces before commas.
{"type": ["boolean", "null", "object", "string"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["sparseArrays"]}]}, "uniqueItems": true}}}, {"type": "string", "oneOf": [{"enum": ["exceptExports"]}]}]}
jscsrc.json
disallowSpaceBeforeComma
A value of true will disallow any spaces before any comma.
{"type": "boolean"}
jscsrc.json
disallowSpaceBeforeComma
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": ["sparseArrays"]}]}, "uniqueItems": true}}}
jscsrc.json
allExcept
Array of quoted keywords to exempt.
{"type": "array", "minItems": 0, "items": {"type": "string", "oneOf": [{"enum": ["sparseArrays"]}]}, "uniqueItems": true}
jscsrc.json
items
Allow spaces in place of absent values in sparse arrays.
{"enum": ["sparseArrays"]}
jscsrc.json
disallowSpaceBeforeComma
Deprecated in favor of the object "allExcept": ["exports"] rule format.
{"type": "string", "oneOf": [{"enum": ["exceptExports"]}]}
jscsrc.json
disallowSpaceBeforeComma
Skip expression functions.
{"enum": ["exceptExports"]}
jscsrc.json
disallowSpaceBeforeKeywords
Disallows space before keyword.
{"type": ["array", "boolean", "null"], "oneOf": [{}]}
jscsrc.json
disallowSpaceBeforeObjectValues
Disallows space before object values.
{"type": ["boolean", "null"]}
jscsrc.json
disallowSpaceBeforePostfixUnaryOperators
Requires sticking unary operators to the left.
{"type": ["array", "boolean", "null"], "oneOf": [{}]}
jscsrc.json
disallowSpaceBeforeSemicolon
Disallows spaces before semicolons.
{"type": ["boolean", "null", "object"], "oneOf": [{"type": "boolean"}, {}, {"type": "object", "properties": {"allExcept": {"type": "array", "minItems": 0, "items": {"type": "string", "anyOf": [{"enum": ["("]}, {"type": "string", "maxLength": 1}]}, "uniqueItems": true}}}]}
jscsrc.json
disallowSpaceBeforeSemicolon
A value of true will disallow any spaces before any semicolon.
{"type": "boolean"}
jscsrc.json
disallowSpaceBeforeSemicolon
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", "anyOf": [{"enum": ["("]}, {"type": "string", "maxLength": 1}]}, "uniqueItems": true}}}
jscsrc.json
allExcept
Array of quoted tokens to exempt (allows whitespace before semicolon if preceded by the specified token).
{"type": "array", "minItems": 0, "items": {"type": "string", "anyOf": [{"enum": ["("]}, {"type": "string", "maxLength": 1}]}, "uniqueItems": true}
jscsrc.json
disallowSpaceBetweenArguments
Ensure there are no spaces after argument separators in call expressions.
{"type": ["boolean", "null"]}
jscsrc.json
disallowSpacesInAnonymousFunctionExpression
Disallows space before () or {} in anonymous function expressions.
{"type": ["null", "object"], "oneOf": [{}]}
jscsrc.json
disallowSpacesInCallExpression
Disallows space before () in call expressions.
{"type": ["boolean", "null"]}
jscsrc.json
disallowSpacesInConditionalExpression
Disallows space before and/or after ? or : in conditional expressions.
{"type": ["boolean", "null", "object"], "anyOf": [{"type": "boolean"}, {}, {"properties": {"afterConsequent": {"type": "boolean"}, "afterTest": {"type": "boolean"}, "beforeAlternate": {"type": "boolean"}, "beforeConsequent": {"type": "boolean"}}}]}
jscsrc.json
disallowSpacesInConditionalExpression
A value of true will set all properties [afterTest, beforeConsequent, afterConsequent, beforeAlternate] to true.
{"type": "boolean"}