Showing 220 of 225 total issues
" should be ' Open
directories = ["."];
- Read upRead up
- Exclude checks
Rule: quotemark
Enforces quote character for string literals.
Notes
- Has Fix
Config
Five arguments may be optionally provided:
-
"single"
enforces single quotes. -
"double"
enforces double quotes. -
"backtick"
enforces backticks. -
"jsx-single"
enforces single quotes for JSX attributes. -
"jsx-double"
enforces double quotes for JSX attributes. -
"avoid-template"
forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if"avoid-escape"
is enabled and both single and double quotes are present in the string (the latter option takes precedence). -
"avoid-escape"
allows you to use the "other" quotemark in cases where escaping would normally be required. For example,[true, "double", "avoid-escape"]
would not report a failure on the string literal'Hello "World"'
.
Examples
"quotemark": true,single,avoid-escape,avoid-template
"quotemark": true,single,jsx-double
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"single",
"double",
"backtick",
"jsx-single",
"jsx-double",
"avoid-escape",
"avoid-template"
]
},
"minLength": 0,
"maxLength": 5
}
For more information see this page.
This overload and the one on line 47 can be combined into one signature with an optional parameter. Open
maximumDepth: number,
- Read upRead up
- Exclude checks
Rule: unified-signatures
Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.
Notes
- TypeScript Only
Config
Not configurable.
Examples
"unified-signatures": true
For more information see this page.
This overload and the one on line 93 can be combined into one signature with an optional parameter. Open
startDirectory: string,
- Read upRead up
- Exclude checks
Rule: unified-signatures
Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.
Notes
- TypeScript Only
Config
Not configurable.
Examples
"unified-signatures": true
For more information see this page.
This overload and the one on line 120 can be combined into one signature with an optional parameter. Open
maximumDepth: number,
- Read upRead up
- Exclude checks
Rule: unified-signatures
Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.
Notes
- TypeScript Only
Config
Not configurable.
Examples
"unified-signatures": true
For more information see this page.
This overload and the one on line 268 can be combined into one signature with an optional parameter. Open
export function upwardDirectories(startPath: string): AsyncIterable<string>;
- Read upRead up
- Exclude checks
Rule: unified-signatures
Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.
Notes
- TypeScript Only
Config
Not configurable.
Examples
"unified-signatures": true
For more information see this page.
Array type using 'Array<t>' is forbidden. Use 'T[]' instead.</t> Open
): [Iterable<string>, Array<FilterSync<string>>] => {
- Read upRead up
- Exclude checks
Rule: array-type
Requires using either 'T[]' or 'Array<t>' for arrays.</t>
Notes
- TypeScript Only
- Has Fix
Config
One of the following arguments must be provided:
-
"array"
enforces use ofT[]
for all types T. -
"generic"
enforces use ofArray<T>
for all types T. -
"array-simple"
enforces use ofT[]
ifT
is a simple type (primitive or type reference).
Examples
"array-type": true,array
"array-type": true,generic
"array-type": true,array-simple
Schema
{
"type": "string",
"enum": [
"array",
"generic",
"array-simple"
]
}
For more information see this page.
Shadowed name: 'realpath' Open
const realpath = await realpathNative(file);
- Read upRead up
- Exclude checks
Rule: no-shadowed-variable
Disallows shadowing variable declarations.
Rationale
When a variable in a local scope and a variable in the containing scope have the same name, shadowing occurs. Shadowing makes it impossible to access the variable in the containing scope and obscures to what value an identifier actually refers. Compare the following snippets:
const a = 'no shadow';
function print() {
console.log(a);
}
print(); // logs 'no shadow'.
const a = 'no shadow';
function print() {
const a = 'shadow'; // TSLint will complain here.
console.log(a);
}
print(); // logs 'shadow'.
ESLint has an equivalent rule. For more background information, refer to this MDN closure doc.
Config
You can optionally pass an object to disable checking for certain kinds of declarations.
Possible keys are "class"
, "enum"
, "function"
, "import"
, "interface"
, "namespace"
, "typeAlias"
and "typeParameter"
. You can also pass "underscore
" to ignore variable names that begin with _
.
Just set the value to false
for the check you want to disable.
All checks default to true
, i.e. are enabled by default.
Note that you cannot disable variables and parameters.
The option "temporalDeadZone"
defaults to true
which shows errors when shadowing block scoped declarations in their
temporal dead zone. When set to false
parameters, classes, enums and variables declared
with let
or const
are not considered shadowed if the shadowing occurs within their
temporal dead zone.
The following example shows how the "temporalDeadZone"
option changes the linting result:
function fn(value) {
if (value) {
const tmp = value; // no error on this line if "temporalDeadZone" is false
return tmp;
}
let tmp = undefined;
if (!value) {
const tmp = value; // this line always contains an error
return tmp;
}
}
Examples
"no-shadowed-variable": true
"no-shadowed-variable": true,[object Object]
Schema
{
"type": "object",
"properties": {
"class": {
"type": "boolean"
},
"enum": {
"type": "boolean"
},
"function": {
"type": "boolean"
},
"import": {
"type": "boolean"
},
"interface": {
"type": "boolean"
},
"namespace": {
"type": "boolean"
},
"typeAlias": {
"type": "boolean"
},
"typeParameter": {
"type": "boolean"
},
"temporalDeadZone": {
"type": "boolean"
},
"underscore": {
"type": "boolean"
}
}
}
For more information see this page.
This overload and the one on line 18 can be combined into one signature with an optional parameter. Open
maximumDepth: number,
- Read upRead up
- Exclude checks
Rule: unified-signatures
Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.
Notes
- TypeScript Only
Config
Not configurable.
Examples
"unified-signatures": true
For more information see this page.
This overload and the one on line 278 can be combined into one signature with an optional parameter. Open
endPath: string,
- Read upRead up
- Exclude checks
Rule: unified-signatures
Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.
Notes
- TypeScript Only
Config
Not configurable.
Examples
"unified-signatures": true
For more information see this page.
Array type using 'Array<t>' is forbidden. Use 'T[]' instead.</t> Open
const pendingFiles: Array<Iterable<string>> = [readdirSync(start)];
- Read upRead up
- Exclude checks
Rule: array-type
Requires using either 'T[]' or 'Array<t>' for arrays.</t>
Notes
- TypeScript Only
- Has Fix
Config
One of the following arguments must be provided:
-
"array"
enforces use ofT[]
for all types T. -
"generic"
enforces use ofArray<T>
for all types T. -
"array-simple"
enforces use ofT[]
ifT
is a simple type (primitive or type reference).
Examples
"array-type": true,array
"array-type": true,generic
"array-type": true,array-simple
Schema
{
"type": "string",
"enum": [
"array",
"generic",
"array-simple"
]
}
For more information see this page.
Shadowed name: 'realpath' Open
const realpath = await realpathNative(file);
- Read upRead up
- Exclude checks
Rule: no-shadowed-variable
Disallows shadowing variable declarations.
Rationale
When a variable in a local scope and a variable in the containing scope have the same name, shadowing occurs. Shadowing makes it impossible to access the variable in the containing scope and obscures to what value an identifier actually refers. Compare the following snippets:
const a = 'no shadow';
function print() {
console.log(a);
}
print(); // logs 'no shadow'.
const a = 'no shadow';
function print() {
const a = 'shadow'; // TSLint will complain here.
console.log(a);
}
print(); // logs 'shadow'.
ESLint has an equivalent rule. For more background information, refer to this MDN closure doc.
Config
You can optionally pass an object to disable checking for certain kinds of declarations.
Possible keys are "class"
, "enum"
, "function"
, "import"
, "interface"
, "namespace"
, "typeAlias"
and "typeParameter"
. You can also pass "underscore
" to ignore variable names that begin with _
.
Just set the value to false
for the check you want to disable.
All checks default to true
, i.e. are enabled by default.
Note that you cannot disable variables and parameters.
The option "temporalDeadZone"
defaults to true
which shows errors when shadowing block scoped declarations in their
temporal dead zone. When set to false
parameters, classes, enums and variables declared
with let
or const
are not considered shadowed if the shadowing occurs within their
temporal dead zone.
The following example shows how the "temporalDeadZone"
option changes the linting result:
function fn(value) {
if (value) {
const tmp = value; // no error on this line if "temporalDeadZone" is false
return tmp;
}
let tmp = undefined;
if (!value) {
const tmp = value; // this line always contains an error
return tmp;
}
}
Examples
"no-shadowed-variable": true
"no-shadowed-variable": true,[object Object]
Schema
{
"type": "object",
"properties": {
"class": {
"type": "boolean"
},
"enum": {
"type": "boolean"
},
"function": {
"type": "boolean"
},
"import": {
"type": "boolean"
},
"interface": {
"type": "boolean"
},
"namespace": {
"type": "boolean"
},
"typeAlias": {
"type": "boolean"
},
"typeParameter": {
"type": "boolean"
},
"temporalDeadZone": {
"type": "boolean"
},
"underscore": {
"type": "boolean"
}
}
}
For more information see this page.
This overload and the one on line 399 can be combined into one signature with an optional parameter. Open
export function upwardFiles(maximumHeight: number): AsyncIterable<string>;
- Read upRead up
- Exclude checks
Rule: unified-signatures
Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.
Notes
- TypeScript Only
Config
Not configurable.
Examples
"unified-signatures": true
For more information see this page.
This overload and the one on line 487 can be combined into one signature with an optional parameter. Open
export function upwardFilesSync(startPath: string): Iterable<string>;
- Read upRead up
- Exclude checks
Rule: unified-signatures
Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.
Notes
- TypeScript Only
Config
Not configurable.
Examples
"unified-signatures": true
For more information see this page.
This overload and the one on line 510 can be combined into one signature with an optional parameter. Open
maximumHeight: number,
- Read upRead up
- Exclude checks
Rule: unified-signatures
Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.
Notes
- TypeScript Only
Config
Not configurable.
Examples
"unified-signatures": true
For more information see this page.
Array type using 'Array<t>' is forbidden. Use 'T[]' instead.</t> Open
const pendingFiles: Array<AsyncIterable<string>> = [readdir(start)];
- Read upRead up
- Exclude checks
Rule: array-type
Requires using either 'T[]' or 'Array<t>' for arrays.</t>
Notes
- TypeScript Only
- Has Fix
Config
One of the following arguments must be provided:
-
"array"
enforces use ofT[]
for all types T. -
"generic"
enforces use ofArray<T>
for all types T. -
"array-simple"
enforces use ofT[]
ifT
is a simple type (primitive or type reference).
Examples
"array-type": true,array
"array-type": true,generic
"array-type": true,array-simple
Schema
{
"type": "string",
"enum": [
"array",
"generic",
"array-simple"
]
}
For more information see this page.
This overload and the one on line 312 can be combined into one signature with an optional parameter. Open
export function downwardFilesSync(maximumDepth: number): Iterable<string>;
- Read upRead up
- Exclude checks
Rule: unified-signatures
Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.
Notes
- TypeScript Only
Config
Not configurable.
Examples
"unified-signatures": true
For more information see this page.
This overload and the one on line 312 can be combined into one signature with an optional parameter. Open
export function downwardFilesSync(startDirectory: string): Iterable<string>;
- Read upRead up
- Exclude checks
Rule: unified-signatures
Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.
Notes
- TypeScript Only
Config
Not configurable.
Examples
"unified-signatures": true
For more information see this page.
This overload and the one on line 439 can be combined into one signature taking number | string
. Open
endDirectory: string,
- Read upRead up
- Exclude checks
Rule: unified-signatures
Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.
Notes
- TypeScript Only
Config
Not configurable.
Examples
"unified-signatures": true
For more information see this page.
Array type using 'Array<t>' is forbidden. Use 'T[]' instead.</t> Open
filters: Array<Filter<T> | FilterSync<T>>,
- Read upRead up
- Exclude checks
Rule: array-type
Requires using either 'T[]' or 'Array<t>' for arrays.</t>
Notes
- TypeScript Only
- Has Fix
Config
One of the following arguments must be provided:
-
"array"
enforces use ofT[]
for all types T. -
"generic"
enforces use ofArray<T>
for all types T. -
"array-simple"
enforces use ofT[]
ifT
is a simple type (primitive or type reference).
Examples
"array-type": true,array
"array-type": true,generic
"array-type": true,array-simple
Schema
{
"type": "string",
"enum": [
"array",
"generic",
"array-simple"
]
}
For more information see this page.
Shadowed name: 'filter' Open
for (const filter of filters) {
- Read upRead up
- Exclude checks
Rule: no-shadowed-variable
Disallows shadowing variable declarations.
Rationale
When a variable in a local scope and a variable in the containing scope have the same name, shadowing occurs. Shadowing makes it impossible to access the variable in the containing scope and obscures to what value an identifier actually refers. Compare the following snippets:
const a = 'no shadow';
function print() {
console.log(a);
}
print(); // logs 'no shadow'.
const a = 'no shadow';
function print() {
const a = 'shadow'; // TSLint will complain here.
console.log(a);
}
print(); // logs 'shadow'.
ESLint has an equivalent rule. For more background information, refer to this MDN closure doc.
Config
You can optionally pass an object to disable checking for certain kinds of declarations.
Possible keys are "class"
, "enum"
, "function"
, "import"
, "interface"
, "namespace"
, "typeAlias"
and "typeParameter"
. You can also pass "underscore
" to ignore variable names that begin with _
.
Just set the value to false
for the check you want to disable.
All checks default to true
, i.e. are enabled by default.
Note that you cannot disable variables and parameters.
The option "temporalDeadZone"
defaults to true
which shows errors when shadowing block scoped declarations in their
temporal dead zone. When set to false
parameters, classes, enums and variables declared
with let
or const
are not considered shadowed if the shadowing occurs within their
temporal dead zone.
The following example shows how the "temporalDeadZone"
option changes the linting result:
function fn(value) {
if (value) {
const tmp = value; // no error on this line if "temporalDeadZone" is false
return tmp;
}
let tmp = undefined;
if (!value) {
const tmp = value; // this line always contains an error
return tmp;
}
}
Examples
"no-shadowed-variable": true
"no-shadowed-variable": true,[object Object]
Schema
{
"type": "object",
"properties": {
"class": {
"type": "boolean"
},
"enum": {
"type": "boolean"
},
"function": {
"type": "boolean"
},
"import": {
"type": "boolean"
},
"interface": {
"type": "boolean"
},
"namespace": {
"type": "boolean"
},
"typeAlias": {
"type": "boolean"
},
"typeParameter": {
"type": "boolean"
},
"temporalDeadZone": {
"type": "boolean"
},
"underscore": {
"type": "boolean"
}
}
}
For more information see this page.