Similar blocks of code found in 2 locations. Consider refactoring. Open
it('doesn\'t decorate if test function returns false', () => {
assert(spyWithFunctionReturningFalse.callCount === 0);
assert(new ClassSpiedWithFunctionReturningFalse().status === undefined);
});
- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 46.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication
's documentation for more information about tuning the mass threshold in your .codeclimate.yml
.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Similar blocks of code found in 2 locations. Consider refactoring. Open
it('doesn\'t decorate if test is falsy', () => {
assert(spyWithFalse.callCount === 0);
assert(new ClazzSpiedWithFalse().status === undefined);
});
- Read upRead up
Duplicated Code
Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:
Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).
Tuning
This issue has a mass of 46.
We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.
The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.
If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.
See codeclimate-duplication
's documentation for more information about tuning the mass threshold in your .codeclimate.yml
.
Refactorings
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Missing trailing comma Open
)
- Read upRead up
- Exclude checks
Rule: trailing-comma
Requires or disallows trailing commas in array and object literals, destructuring assignments, function typings, named imports and exports and function parameters.
Notes
- Has Fix
Config
One argument which is an object with the keys multiline
and singleline
.
Both can be set to a string ("always"
or "never"
) or an object.
The object can contain any of the following keys: "arrays"
, "objects"
, "functions"
,
"imports"
, "exports"
, and "typeLiterals"
; each key can have one of the following
values: "always"
, "never"
, and "ignore"
. Any missing keys will default to "ignore"
.
-
"multiline"
checks multi-line object literals. -
"singleline"
checks single-line object literals.
An array is considered "multiline" if its closing bracket is on a line after the last array element. The same general logic is followed for object literals, function typings, named import statements and function parameters.
To align this rule with the ECMAScript specification that is implemented in modern JavaScript VMs,
there is a third option esSpecCompliant
. Set this option to true
to disallow trailing comma on
object and array rest and rest parameters.
Examples
"trailing-comma": true,[object Object]
"trailing-comma": true,[object Object]
Schema
{
"type": "object",
"properties": {
"multiline": {
"anyOf": [
{
"type": "string",
"enum": [
"always",
"never"
]
},
{
"type": "object",
"properties": {
"arrays": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"exports": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"functions": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"imports": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"objects": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"typeLiterals": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
}
}
}
]
},
"singleline": {
"anyOf": [
{
"type": "string",
"enum": [
"always",
"never"
]
},
{
"type": "object",
"properties": {
"arrays": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"exports": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"functions": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"imports": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"objects": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"typeLiterals": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
}
}
}
]
},
"esSpecCompliant": {
"type": "boolean"
}
},
"additionalProperties": false
}
For more information see this page.
Missing trailing comma Open
deepSpy
- Read upRead up
- Exclude checks
Rule: trailing-comma
Requires or disallows trailing commas in array and object literals, destructuring assignments, function typings, named imports and exports and function parameters.
Notes
- Has Fix
Config
One argument which is an object with the keys multiline
and singleline
.
Both can be set to a string ("always"
or "never"
) or an object.
The object can contain any of the following keys: "arrays"
, "objects"
, "functions"
,
"imports"
, "exports"
, and "typeLiterals"
; each key can have one of the following
values: "always"
, "never"
, and "ignore"
. Any missing keys will default to "ignore"
.
-
"multiline"
checks multi-line object literals. -
"singleline"
checks single-line object literals.
An array is considered "multiline" if its closing bracket is on a line after the last array element. The same general logic is followed for object literals, function typings, named import statements and function parameters.
To align this rule with the ECMAScript specification that is implemented in modern JavaScript VMs,
there is a third option esSpecCompliant
. Set this option to true
to disallow trailing comma on
object and array rest and rest parameters.
Examples
"trailing-comma": true,[object Object]
"trailing-comma": true,[object Object]
Schema
{
"type": "object",
"properties": {
"multiline": {
"anyOf": [
{
"type": "string",
"enum": [
"always",
"never"
]
},
{
"type": "object",
"properties": {
"arrays": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"exports": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"functions": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"imports": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"objects": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"typeLiterals": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
}
}
}
]
},
"singleline": {
"anyOf": [
{
"type": "string",
"enum": [
"always",
"never"
]
},
{
"type": "object",
"properties": {
"arrays": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"exports": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"functions": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"imports": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"objects": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"typeLiterals": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
}
}
}
]
},
"esSpecCompliant": {
"type": "boolean"
}
},
"additionalProperties": false
}
For more information see this page.
expected variable-declaration: 'deepDecorator' to have a typedef Open
let deepDecorator = createClassDecorator('status', 'yes');
- Read upRead up
- Exclude checks
Rule: typedef
Requires type definitions to exist.
Notes
- TypeScript Only
Config
Several arguments may be optionally provided:
-
"call-signature"
checks return type of functions. -
"arrow-call-signature"
checks return type of arrow functions. -
"parameter"
checks type specifier of function parameters for non-arrow functions. -
"arrow-parameter"
checks type specifier of function parameters for arrow functions. -
"property-declaration"
checks return types of interface properties. -
"variable-declaration"
checks non-binding variable declarations. -
"variable-declaration-ignore-function"
ignore variable declarations for non-arrow and arrow functions. -
"member-variable-declaration"
checks member variable declarations. -
"object-destructuring"
checks object destructuring declarations. -
"array-destructuring"
checks array destructuring declarations.
Examples
"typedef": true,call-signature,parameter,member-variable-declaration
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"call-signature",
"arrow-call-signature",
"parameter",
"arrow-parameter",
"property-declaration",
"variable-declaration",
"variable-declaration-ignore-function",
"member-variable-declaration",
"object-destructuring",
"array-destructuring"
]
},
"minLength": 0,
"maxLength": 10
}
For more information see this page.
expected variable-declaration: 'spyWithTrue' to have a typedef Open
let spyWithTrue = sinon.spy(statusDecorator);
- Read upRead up
- Exclude checks
Rule: typedef
Requires type definitions to exist.
Notes
- TypeScript Only
Config
Several arguments may be optionally provided:
-
"call-signature"
checks return type of functions. -
"arrow-call-signature"
checks return type of arrow functions. -
"parameter"
checks type specifier of function parameters for non-arrow functions. -
"arrow-parameter"
checks type specifier of function parameters for arrow functions. -
"property-declaration"
checks return types of interface properties. -
"variable-declaration"
checks non-binding variable declarations. -
"variable-declaration-ignore-function"
ignore variable declarations for non-arrow and arrow functions. -
"member-variable-declaration"
checks member variable declarations. -
"object-destructuring"
checks object destructuring declarations. -
"array-destructuring"
checks array destructuring declarations.
Examples
"typedef": true,call-signature,parameter,member-variable-declaration
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"call-signature",
"arrow-call-signature",
"parameter",
"arrow-parameter",
"property-declaration",
"variable-declaration",
"variable-declaration-ignore-function",
"member-variable-declaration",
"object-destructuring",
"array-destructuring"
]
},
"minLength": 0,
"maxLength": 10
}
For more information see this page.
Missing trailing comma Open
)
- Read upRead up
- Exclude checks
Rule: trailing-comma
Requires or disallows trailing commas in array and object literals, destructuring assignments, function typings, named imports and exports and function parameters.
Notes
- Has Fix
Config
One argument which is an object with the keys multiline
and singleline
.
Both can be set to a string ("always"
or "never"
) or an object.
The object can contain any of the following keys: "arrays"
, "objects"
, "functions"
,
"imports"
, "exports"
, and "typeLiterals"
; each key can have one of the following
values: "always"
, "never"
, and "ignore"
. Any missing keys will default to "ignore"
.
-
"multiline"
checks multi-line object literals. -
"singleline"
checks single-line object literals.
An array is considered "multiline" if its closing bracket is on a line after the last array element. The same general logic is followed for object literals, function typings, named import statements and function parameters.
To align this rule with the ECMAScript specification that is implemented in modern JavaScript VMs,
there is a third option esSpecCompliant
. Set this option to true
to disallow trailing comma on
object and array rest and rest parameters.
Examples
"trailing-comma": true,[object Object]
"trailing-comma": true,[object Object]
Schema
{
"type": "object",
"properties": {
"multiline": {
"anyOf": [
{
"type": "string",
"enum": [
"always",
"never"
]
},
{
"type": "object",
"properties": {
"arrays": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"exports": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"functions": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"imports": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"objects": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"typeLiterals": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
}
}
}
]
},
"singleline": {
"anyOf": [
{
"type": "string",
"enum": [
"always",
"never"
]
},
{
"type": "object",
"properties": {
"arrays": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"exports": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"functions": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"imports": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"objects": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"typeLiterals": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
}
}
}
]
},
"esSpecCompliant": {
"type": "boolean"
}
},
"additionalProperties": false
}
For more information see this page.
Missing trailing comma Open
)
- Read upRead up
- Exclude checks
Rule: trailing-comma
Requires or disallows trailing commas in array and object literals, destructuring assignments, function typings, named imports and exports and function parameters.
Notes
- Has Fix
Config
One argument which is an object with the keys multiline
and singleline
.
Both can be set to a string ("always"
or "never"
) or an object.
The object can contain any of the following keys: "arrays"
, "objects"
, "functions"
,
"imports"
, "exports"
, and "typeLiterals"
; each key can have one of the following
values: "always"
, "never"
, and "ignore"
. Any missing keys will default to "ignore"
.
-
"multiline"
checks multi-line object literals. -
"singleline"
checks single-line object literals.
An array is considered "multiline" if its closing bracket is on a line after the last array element. The same general logic is followed for object literals, function typings, named import statements and function parameters.
To align this rule with the ECMAScript specification that is implemented in modern JavaScript VMs,
there is a third option esSpecCompliant
. Set this option to true
to disallow trailing comma on
object and array rest and rest parameters.
Examples
"trailing-comma": true,[object Object]
"trailing-comma": true,[object Object]
Schema
{
"type": "object",
"properties": {
"multiline": {
"anyOf": [
{
"type": "string",
"enum": [
"always",
"never"
]
},
{
"type": "object",
"properties": {
"arrays": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"exports": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"functions": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"imports": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"objects": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"typeLiterals": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
}
}
}
]
},
"singleline": {
"anyOf": [
{
"type": "string",
"enum": [
"always",
"never"
]
},
{
"type": "object",
"properties": {
"arrays": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"exports": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"functions": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"imports": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"objects": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
},
"typeLiterals": {
"type": "string",
"enum": [
"always",
"never",
"ignore"
]
}
}
}
]
},
"esSpecCompliant": {
"type": "boolean"
}
},
"additionalProperties": false
}
For more information see this page.
expected variable-declaration: 'deepSpy' to have a typedef Open
let deepSpy = sinon.spy(deepDecorator);
- Read upRead up
- Exclude checks
Rule: typedef
Requires type definitions to exist.
Notes
- TypeScript Only
Config
Several arguments may be optionally provided:
-
"call-signature"
checks return type of functions. -
"arrow-call-signature"
checks return type of arrow functions. -
"parameter"
checks type specifier of function parameters for non-arrow functions. -
"arrow-parameter"
checks type specifier of function parameters for arrow functions. -
"property-declaration"
checks return types of interface properties. -
"variable-declaration"
checks non-binding variable declarations. -
"variable-declaration-ignore-function"
ignore variable declarations for non-arrow and arrow functions. -
"member-variable-declaration"
checks member variable declarations. -
"object-destructuring"
checks object destructuring declarations. -
"array-destructuring"
checks array destructuring declarations.
Examples
"typedef": true,call-signature,parameter,member-variable-declaration
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"call-signature",
"arrow-call-signature",
"parameter",
"arrow-parameter",
"property-declaration",
"variable-declaration",
"variable-declaration-ignore-function",
"member-variable-declaration",
"object-destructuring",
"array-destructuring"
]
},
"minLength": 0,
"maxLength": 10
}
For more information see this page.
expected variable-declaration: 'spyWithFalse' to have a typedef Open
let spyWithFalse = sinon.spy(statusDecorator);
- Read upRead up
- Exclude checks
Rule: typedef
Requires type definitions to exist.
Notes
- TypeScript Only
Config
Several arguments may be optionally provided:
-
"call-signature"
checks return type of functions. -
"arrow-call-signature"
checks return type of arrow functions. -
"parameter"
checks type specifier of function parameters for non-arrow functions. -
"arrow-parameter"
checks type specifier of function parameters for arrow functions. -
"property-declaration"
checks return types of interface properties. -
"variable-declaration"
checks non-binding variable declarations. -
"variable-declaration-ignore-function"
ignore variable declarations for non-arrow and arrow functions. -
"member-variable-declaration"
checks member variable declarations. -
"object-destructuring"
checks object destructuring declarations. -
"array-destructuring"
checks array destructuring declarations.
Examples
"typedef": true,call-signature,parameter,member-variable-declaration
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"call-signature",
"arrow-call-signature",
"parameter",
"arrow-parameter",
"property-declaration",
"variable-declaration",
"variable-declaration-ignore-function",
"member-variable-declaration",
"object-destructuring",
"array-destructuring"
]
},
"minLength": 0,
"maxLength": 10
}
For more information see this page.
expected variable-declaration: 'spyWithFunctionReturningTrue' to have a typedef Open
let spyWithFunctionReturningTrue = sinon.spy(statusDecorator2);
- Read upRead up
- Exclude checks
Rule: typedef
Requires type definitions to exist.
Notes
- TypeScript Only
Config
Several arguments may be optionally provided:
-
"call-signature"
checks return type of functions. -
"arrow-call-signature"
checks return type of arrow functions. -
"parameter"
checks type specifier of function parameters for non-arrow functions. -
"arrow-parameter"
checks type specifier of function parameters for arrow functions. -
"property-declaration"
checks return types of interface properties. -
"variable-declaration"
checks non-binding variable declarations. -
"variable-declaration-ignore-function"
ignore variable declarations for non-arrow and arrow functions. -
"member-variable-declaration"
checks member variable declarations. -
"object-destructuring"
checks object destructuring declarations. -
"array-destructuring"
checks array destructuring declarations.
Examples
"typedef": true,call-signature,parameter,member-variable-declaration
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"call-signature",
"arrow-call-signature",
"parameter",
"arrow-parameter",
"property-declaration",
"variable-declaration",
"variable-declaration-ignore-function",
"member-variable-declaration",
"object-destructuring",
"array-destructuring"
]
},
"minLength": 0,
"maxLength": 10
}
For more information see this page.
The class property 'status' must be marked either 'private', 'public', or 'protected' Open
status: string;
- Read upRead up
- Exclude checks
Rule: member-access
Requires explicit visibility declarations for class members.
Rationale
Explicit visibility declarations can make code more readable and accessible for those new to TS.
Other languages such as C# default to private
, unlike TypeScript's default of public
.
Members lacking a visibility declaration may be an indication of an accidental leak of class internals.
Notes
- TypeScript Only
- Has Fix
Config
These arguments may be optionally provided:
-
"no-public"
forbids public accessibility to be specified, because this is the default. -
"check-accessor"
enforces explicit visibility on get/set accessors -
"check-constructor"
enforces explicit visibility on constructors -
"check-parameter-property"
enforces explicit visibility on parameter properties
Examples
"member-access": true
"member-access": true,no-public
"member-access": true,check-accessor
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"no-public",
"check-accessor",
"check-constructor",
"check-parameter-property"
]
},
"minLength": 0,
"maxLength": 4
}
For more information see this page.
expected variable-declaration: 'statusDecorator' to have a typedef Open
let statusDecorator = createClassDecorator('status', 'status 1');
- Read upRead up
- Exclude checks
Rule: typedef
Requires type definitions to exist.
Notes
- TypeScript Only
Config
Several arguments may be optionally provided:
-
"call-signature"
checks return type of functions. -
"arrow-call-signature"
checks return type of arrow functions. -
"parameter"
checks type specifier of function parameters for non-arrow functions. -
"arrow-parameter"
checks type specifier of function parameters for arrow functions. -
"property-declaration"
checks return types of interface properties. -
"variable-declaration"
checks non-binding variable declarations. -
"variable-declaration-ignore-function"
ignore variable declarations for non-arrow and arrow functions. -
"member-variable-declaration"
checks member variable declarations. -
"object-destructuring"
checks object destructuring declarations. -
"array-destructuring"
checks array destructuring declarations.
Examples
"typedef": true,call-signature,parameter,member-variable-declaration
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"call-signature",
"arrow-call-signature",
"parameter",
"arrow-parameter",
"property-declaration",
"variable-declaration",
"variable-declaration-ignore-function",
"member-variable-declaration",
"object-destructuring",
"array-destructuring"
]
},
"minLength": 0,
"maxLength": 10
}
For more information see this page.
expected arrow-parameter: 'clazz' to have a typedef Open
return clazz => {
- Read upRead up
- Exclude checks
Rule: typedef
Requires type definitions to exist.
Notes
- TypeScript Only
Config
Several arguments may be optionally provided:
-
"call-signature"
checks return type of functions. -
"arrow-call-signature"
checks return type of arrow functions. -
"parameter"
checks type specifier of function parameters for non-arrow functions. -
"arrow-parameter"
checks type specifier of function parameters for arrow functions. -
"property-declaration"
checks return types of interface properties. -
"variable-declaration"
checks non-binding variable declarations. -
"variable-declaration-ignore-function"
ignore variable declarations for non-arrow and arrow functions. -
"member-variable-declaration"
checks member variable declarations. -
"object-destructuring"
checks object destructuring declarations. -
"array-destructuring"
checks array destructuring declarations.
Examples
"typedef": true,call-signature,parameter,member-variable-declaration
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"call-signature",
"arrow-call-signature",
"parameter",
"arrow-parameter",
"property-declaration",
"variable-declaration",
"variable-declaration-ignore-function",
"member-variable-declaration",
"object-destructuring",
"array-destructuring"
]
},
"minLength": 0,
"maxLength": 10
}
For more information see this page.
expected variable-declaration: 'statusDecorator2' to have a typedef Open
let statusDecorator2 = createClassDecorator('status', 'status 2');
- Read upRead up
- Exclude checks
Rule: typedef
Requires type definitions to exist.
Notes
- TypeScript Only
Config
Several arguments may be optionally provided:
-
"call-signature"
checks return type of functions. -
"arrow-call-signature"
checks return type of arrow functions. -
"parameter"
checks type specifier of function parameters for non-arrow functions. -
"arrow-parameter"
checks type specifier of function parameters for arrow functions. -
"property-declaration"
checks return types of interface properties. -
"variable-declaration"
checks non-binding variable declarations. -
"variable-declaration-ignore-function"
ignore variable declarations for non-arrow and arrow functions. -
"member-variable-declaration"
checks member variable declarations. -
"object-destructuring"
checks object destructuring declarations. -
"array-destructuring"
checks array destructuring declarations.
Examples
"typedef": true,call-signature,parameter,member-variable-declaration
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"call-signature",
"arrow-call-signature",
"parameter",
"arrow-parameter",
"property-declaration",
"variable-declaration",
"variable-declaration-ignore-function",
"member-variable-declaration",
"object-destructuring",
"array-destructuring"
]
},
"minLength": 0,
"maxLength": 10
}
For more information see this page.
expected variable-declaration: 'spyWithFunctionReturningFalse' to have a typedef Open
let spyWithFunctionReturningFalse = sinon.spy(statusDecorator2);
- Read upRead up
- Exclude checks
Rule: typedef
Requires type definitions to exist.
Notes
- TypeScript Only
Config
Several arguments may be optionally provided:
-
"call-signature"
checks return type of functions. -
"arrow-call-signature"
checks return type of arrow functions. -
"parameter"
checks type specifier of function parameters for non-arrow functions. -
"arrow-parameter"
checks type specifier of function parameters for arrow functions. -
"property-declaration"
checks return types of interface properties. -
"variable-declaration"
checks non-binding variable declarations. -
"variable-declaration-ignore-function"
ignore variable declarations for non-arrow and arrow functions. -
"member-variable-declaration"
checks member variable declarations. -
"object-destructuring"
checks object destructuring declarations. -
"array-destructuring"
checks array destructuring declarations.
Examples
"typedef": true,call-signature,parameter,member-variable-declaration
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"call-signature",
"arrow-call-signature",
"parameter",
"arrow-parameter",
"property-declaration",
"variable-declaration",
"variable-declaration-ignore-function",
"member-variable-declaration",
"object-destructuring",
"array-destructuring"
]
},
"minLength": 0,
"maxLength": 10
}
For more information see this page.
The class property 'status' must be marked either 'private', 'public', or 'protected' Open
status: string;
- Read upRead up
- Exclude checks
Rule: member-access
Requires explicit visibility declarations for class members.
Rationale
Explicit visibility declarations can make code more readable and accessible for those new to TS.
Other languages such as C# default to private
, unlike TypeScript's default of public
.
Members lacking a visibility declaration may be an indication of an accidental leak of class internals.
Notes
- TypeScript Only
- Has Fix
Config
These arguments may be optionally provided:
-
"no-public"
forbids public accessibility to be specified, because this is the default. -
"check-accessor"
enforces explicit visibility on get/set accessors -
"check-constructor"
enforces explicit visibility on constructors -
"check-parameter-property"
enforces explicit visibility on parameter properties
Examples
"member-access": true
"member-access": true,no-public
"member-access": true,check-accessor
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"no-public",
"check-accessor",
"check-constructor",
"check-parameter-property"
]
},
"minLength": 0,
"maxLength": 4
}
For more information see this page.
The class property 'status' must be marked either 'private', 'public', or 'protected' Open
status: string;
- Read upRead up
- Exclude checks
Rule: member-access
Requires explicit visibility declarations for class members.
Rationale
Explicit visibility declarations can make code more readable and accessible for those new to TS.
Other languages such as C# default to private
, unlike TypeScript's default of public
.
Members lacking a visibility declaration may be an indication of an accidental leak of class internals.
Notes
- TypeScript Only
- Has Fix
Config
These arguments may be optionally provided:
-
"no-public"
forbids public accessibility to be specified, because this is the default. -
"check-accessor"
enforces explicit visibility on get/set accessors -
"check-constructor"
enforces explicit visibility on constructors -
"check-parameter-property"
enforces explicit visibility on parameter properties
Examples
"member-access": true
"member-access": true,no-public
"member-access": true,check-accessor
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"no-public",
"check-accessor",
"check-constructor",
"check-parameter-property"
]
},
"minLength": 0,
"maxLength": 4
}
For more information see this page.
The class property 'status' must be marked either 'private', 'public', or 'protected' Open
status: string;
- Read upRead up
- Exclude checks
Rule: member-access
Requires explicit visibility declarations for class members.
Rationale
Explicit visibility declarations can make code more readable and accessible for those new to TS.
Other languages such as C# default to private
, unlike TypeScript's default of public
.
Members lacking a visibility declaration may be an indication of an accidental leak of class internals.
Notes
- TypeScript Only
- Has Fix
Config
These arguments may be optionally provided:
-
"no-public"
forbids public accessibility to be specified, because this is the default. -
"check-accessor"
enforces explicit visibility on get/set accessors -
"check-constructor"
enforces explicit visibility on constructors -
"check-parameter-property"
enforces explicit visibility on parameter properties
Examples
"member-access": true
"member-access": true,no-public
"member-access": true,check-accessor
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"no-public",
"check-accessor",
"check-constructor",
"check-parameter-property"
]
},
"minLength": 0,
"maxLength": 4
}
For more information see this page.
The class property 'status' must be marked either 'private', 'public', or 'protected' Open
status: string;
- Read upRead up
- Exclude checks
Rule: member-access
Requires explicit visibility declarations for class members.
Rationale
Explicit visibility declarations can make code more readable and accessible for those new to TS.
Other languages such as C# default to private
, unlike TypeScript's default of public
.
Members lacking a visibility declaration may be an indication of an accidental leak of class internals.
Notes
- TypeScript Only
- Has Fix
Config
These arguments may be optionally provided:
-
"no-public"
forbids public accessibility to be specified, because this is the default. -
"check-accessor"
enforces explicit visibility on get/set accessors -
"check-constructor"
enforces explicit visibility on constructors -
"check-parameter-property"
enforces explicit visibility on parameter properties
Examples
"member-access": true
"member-access": true,no-public
"member-access": true,check-accessor
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"no-public",
"check-accessor",
"check-constructor",
"check-parameter-property"
]
},
"minLength": 0,
"maxLength": 4
}
For more information see this page.