.jscsrc
JSCS configuration file
| Type | object |
|---|---|
| File match |
.jscsrc
jscsrc.json
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/jscsrc/latest.json |
| Source | https://www.schemastore.org/jscsrc.json |
Validate with Lintel
npx @lintel/lintel checkProperties
Path to load additional rules
Requires that a function expression be named. Named functions provide more information in the error stack trace than anonymous functions. This option does not help if you use Arrow functions (ES6) which are always anonymous.
Disallows arrow functions.
Requires the first alphabetical character of a comment to be lowercase.
Disallows commas as last token on a line in lists.
Disallows curly braces after statements.
Disallows identifiers that start or end in _. Some popular identifiers are automatically listed as exceptions: proto (javascript), _ (underscore.js), __filename (node.js global), _dirname (node.js global), super (node.js, used by util.inherits).
Disallows empty blocks (except for catch blocks).
Disallows function declarations.
Disallows identical destructuring names for the key and value in favor of using shorthand destructuring.
Disallows a specified set of identifier names.
Disallows implicit type conversion.
Disallows one or more keywords in comments.
Disallows placing the specified keywords on a new line.
Requires lines to not contain both spaces and tabs consecutively, or spaces after tabs only for alignment if "smart
Disallows the test, consequent and alternate to be on separate lines when using the ternary operator.
Disallows multiple blank lines in a row.
Disallows strings that span multiple lines without using concatenation.
Disallows multiple indentation characters (tabs or spaces) between identifiers, keywords, and any other token.
Disallows multiple var declaration (except for-loop).
Disallows unassigned functions to be named inline.
Disallows nested ternaries.
Disallows newline before opening curly brace of all block statements.
Disallow use of certain node types (from Esprima/ESTree). Value equals an array of parser node types to be disallowed.
Disallows the not, not equals, and strict not equals operators in conditionals.
Disallows placing object keys on new line.
Requires putting certain operators on the next line rather than on the current line before a line break.
Disallow a newline after blocks.
Disallow a blank line after 'use strict'; statements.
Disallows newline before module.exports.
Disallow an empty line above the specified keywords.
Disallows newline before line comments.
Disallows blocks from beginning or ending with 2 newlines.
Disallows newlines adjacent to curly braces in all object literals.
Disallows parentheses around arrow function expressions that contain a single parameter.
Disallows quoted keys in object if possible.
Disallows lines from ending in a semicolon.
Require arrow functions to use a block statement (explicit return).
Requires sticking binary operators to the right.
Disallows spaces after commas.
Disallows space after the specified keywords. A value of true will require spaces after all possible keywords.
Requires that a line comment (//) not be followed by a space.
Disallows space after object keys.
Requires sticking unary operators to the right.
Requires sticking binary operators to the left.
Disallows space before block statements (for loops, control structures).
Disallows spaces before commas.
Disallows space before keyword.
Disallows space before object values.
Requires sticking unary operators to the left.
Disallows spaces before semicolons.
Ensure there are no spaces after argument separators in call expressions.
Disallows space before () or {} in anonymous function expressions.
Disallows space before () in call expressions.
Disallows space before and/or after ? or : in conditional expressions.
Disallow spaces in between for statement.
Disallows space before () or {} in function expressions (both named and anonymous) and function declarations.
Disallows space before () or {} in function declarations.
Disallows space before () or {} in function expressions (both named and anonymous).
Disallow space before or after * in generator functions.
Disallows space before () or {} in named function expressions
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.
Disallows space after opening square bracket and before closing. Reports on all on brackets, even on property accessors. Use disallowSpacesInsideArrayBrackets to exclude property accessors.
Disallows space after opening object curly brace and before closing.
Disallows space after opening round bracket and before closing.
Disallows space after opening and before closing grouping parentheses.
Disallows spaces before and after curly brace inside template string placeholders.
Disallows an extra comma following the final element of an array or object literal.
Requires all lines to end on a non-whitespace character.
Disallows unused params in function expression and function declaration.
Disallows declaring variables with var.
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.
Disables style checking for specified paths.
Validate jsdoc comments.
18 nested properties
Checks whether tag names are valid.
Checks whether all parameters are documented.
Checks whether param names in jsdoc and in function declaration are equal.
Checks whether params in jsdoc contains type.
Reports redundant params in jsdoc.
Checks for differences between the jsdoc and actual return types if both exist.
Report statements for functions without a return, which are described with an @return tag.
Checks whether @returns in jsdoc contains type.
Reports invalid types for bunch of tags.
Reports redundant access declarations.
Checks whether access declaration is set for _underscored function names. Ignores a bunch of popular identifiers: __filename, _dirname, proto, defineGetter, super, __constructor, etc.
Checks whether jsdoc block exists.
Checks whether a jsdoc param description has a hyphen before it (checks for -).
Checks whether a jsdoc comment description has a padding (trailing) newline separator between it and additional @tags.
Checks whether a jsdoc comment description has no padding (trailing) newline separator between it and additional @tags.
Checks whether a jsdoc comment description is a complete sentence. A complete sentence is defined as starting with an upper case letter and ending with a period.
Checks whether a jsdoc param description exists.
Checks whether a jsdoc return description exists.
Requires all lines to be at most the number of characters specified.
Requires the file to be at most the number of lines specified.
Extends defined rules with preset rules.
Enforces indentation of parameters in multiline functions.
Requires proper alignment in object literals.
Requires that a function expression be anonymous.
Requires that variable assignment from array values are * destructured.
Requires that arrow functions are used instead of anonymous function expressions in callbacks.
Requires blocks to begin and end with a newline.
Requires identifiers to be camelCased or UPPERCASE_WITH_UNDERSCORES.
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.
Requires capitalized constructors to to use the new keyword.
Requires constructors to be capitalized (except for "this")
Requires commas as last token on a line in lists.
Requires curly braces after statements. A value of true will require curly braces for all the necessary keywords: if, else, for, while do, try, catch, case, and default.
Require a $ before variable names that are jquery assignments.
Requires member expressions to use dot notation when possible.
Requires early return in a function.
Requires declaring objects via ES6 enhanced object literals.
Requires function declarations by disallowing assignment of functions expressions to variables. Function expressions are allowed in all other contexts, including when passed as function arguments or immediately invoked. Assignment of function expressions to object members is also permitted, since these can't be declared.
Requires imports to be alphabetized (A-Z).
Requires placing the specified keywords on a new line.
Requires placing line feed after assigning a variable.
Requires placing line feed at file end.
Requires function names to match member and property names. It doesn't affect anonymous functions nor functions assigned to members or properties named with a reserved word. Assigning to module.exports is also ignored, unless includeModuleExports: true is configured.
Requires the test, consequent and alternate to be on separate lines when using the ternary operator.
Requires multiple var declaration.
Require unassigned functions to be named inline.
Requires newline before opening curly brace of all block statements. If true, always requires newline before curly brace of block statements. Array specifies block-type keywords after which newlines are required before curly brace.
Requires use of binary, hexadecimal, and octal literals instead of parseInt.
Requires variable declarations from objects via destructuring.
Requires placing object keys on new line.
Requires operators to appear before line breaks and not after.
Requires an extra blank newline after var declarations, as long as it is not the last expression in the current block.
Requires newline after blocks.
Requires a blank line after 'use strict'; statements.
Requires newline before module.exports.
Requires an empty line above the specified keywords unless the keyword is the first expression in a block. If true, specifies that the spacedKeywords found in the utils module require an empty line above it. Array values indicate keywords that require an empty line above it.
Requires newline before line comments.
Requires blocks to begin and end with 2 newlines.
Requires newline inside curly braces of all objects.
Requires parentheses around arrow function expressions with a single parameter.
Requires parentheses around immediately invoked function expressions.
Requires quoted keys in objects.
Requires semicolon after: var declaration, expression statement, return, throw, break, continue, do-while.
Require arrow functions to use an expression body when returning a single statement (no block statement, implicit return).
Disallows sticking binary operators to the right.
Requires space after comma.
Requires space after the specified keywords. A value of true will disallow spaces after all possible keywords.
Requires that a line comment (//) be followed by a space.
Requires space after object keys.
Disallows sticking unary operators to the right.
Disallows sticking binary operators to the left.
Requires space before block statements (for loops, control structures).
Requires a space before a comma.
Requires a space before a keyword.
Requires space after object keys.
Disallows sticking unary operators to the left.
Ensure there are spaces after argument separators in call expressions.
Requires space before () or {} in function expressions (both named and anonymous).
Requires space before () in call expressions.
Requires space before and/or after ? or : in conditional expressions.
Requires spaces in between for statement.
Requires space before () or {} in function expressions (both named and anonymous) and function declarations.
Requires space before () or {} in function declarations.
Requires space before () or {} in function expressions (both named and anonymous).
Requires space before and after * in generator functions.
Requires space before () or {} in named function expressions.
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.
Requires space after opening square bracket and before closing. Reports on all on brackets, even on property accessors. Use requireSpacesInsideArrayBrackets to exclude property accessors.
Requires space after opening object curly brace and before closing.
Requires space after opening round bracket and before closing.
Requires space after opening and before closing grouping parentheses.
Disallows using .apply in favor of the spread operator.
Requires the use of template strings instead of string concatenation.
Requires an extra comma following the final element of an array or object literal.
Requires var declaration to be on the top of an enclosing scope.
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.
Option to check var that = this expressions.
Validates proper alignment of function parameters.
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
Validates indentation for switch statements and block statements.
Option to check line break characters.
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.
Validates the order in object keys.
Enable validation of separators between function parameters. Will ignore newlines.
Requires all quote marks to be either the supplied value, or consistent if true.
Definitions
Validate jsdoc comments.
Checks whether tag names are valid.
Checks whether all parameters are documented.
Checks whether param names in jsdoc and in function declaration are equal.
Checks whether params in jsdoc contains type.
Reports redundant params in jsdoc.
Checks for differences between the jsdoc and actual return types if both exist.
Report statements for functions without a return, which are described with an @return tag.
Checks whether @returns in jsdoc contains type.
Reports invalid types for bunch of tags.
Reports redundant access declarations.
Checks whether access declaration is set for _underscored function names. Ignores a bunch of popular identifiers: __filename, _dirname, proto, defineGetter, super, __constructor, etc.
Checks whether jsdoc block exists.
Checks whether a jsdoc param description has a hyphen before it (checks for -).
Checks whether a jsdoc comment description has a padding (trailing) newline separator between it and additional @tags.
Checks whether a jsdoc comment description has no padding (trailing) newline separator between it and additional @tags.
Checks whether a jsdoc comment description is a complete sentence. A complete sentence is defined as starting with an upper case letter and ending with a period.
Checks whether a jsdoc param description exists.
Checks whether a jsdoc return description exists.
Removes the rule.