File stop.component.ts
has 262 lines of code (exceeds 250 allowed). Consider refactoring. Open
import { Component, ChangeDetectorRef } from '@angular/core';
import { NavController, NavParams, LoadingController, AlertController } from 'ionic-angular';
import { Storage } from '@ionic/storage';
import { StopDeparture } from '../../models/stop-departure.model';
Function sort
has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring. Open
sort (directions): any {
this.departuresByTime = [];
this.departuresByDirection = [];
// Avail returns an array of RouteDirections. We must deal
// with the Departures for each Direction.
- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
Function ionViewWillEnter
has 39 lines of code (exceeds 25 allowed). Consider refactoring. Open
ionViewWillEnter() {
this.getAlerts();
this.favoriteStopSvc.contains(this.stopId, (liked) => {
this.liked = liked;
});
Function sort
has 32 lines of code (exceeds 25 allowed). Consider refactoring. Open
sort (directions): any {
this.departuresByTime = [];
this.departuresByDirection = [];
// Avail returns an array of RouteDirections. We must deal
// with the Departures for each Direction.
Function getDepartures
has 26 lines of code (exceeds 25 allowed). Consider refactoring. Open
getDepartures(refresher?: any): void {
this.stopDepartureSvc.getStopDeparture(this.stopId)
.then(directions => {
this.sort(directions[0]);
let routeIds = _.uniq(_.map(directions[0].RouteDirections, 'RouteId'));
Avoid deeply nested control flow statements. Open
if (!_.includes(this.alerts, alert)) {
this.alerts.push(alert);
}
Named imports must be alphabetized. Open
import { Component, ChangeDetectorRef } from '@angular/core';
- Read upRead up
- Exclude checks
Rule: ordered-imports
Requires that import statements be alphabetized and grouped.
Enforce a consistent ordering for ES6 imports: - Named imports must be alphabetized (i.e. "import {A, B, C} from "foo";") - The exact ordering can be controlled by the named-imports-order option. - "longName as name" imports are ordered by "longName". - Import sources must be alphabetized within groups, i.e.: import * as foo from "a"; import * as bar from "b"; - Groups of imports are delineated by blank lines. You can use this rule to group imports however you like, e.g. by first- vs. third-party or thematically or you can define groups based upon patterns in import path names.
Notes
- Has Fix
Config
You may set the "import-sources-order"
option to control the ordering of source
imports (the "foo"
in import {A, B, C} from "foo"
).
Possible values for "import-sources-order"
are:
-
"case-insensitive'
: Correct order is"Bar"
,"baz"
,"Foo"
. (This is the default.) -
"case-insensitive-legacy'
: Correct order is"Bar"
,"baz"
,"Foo"
. -
"lowercase-first"
: Correct order is"baz"
,"Bar"
,"Foo"
. -
"lowercase-last"
: Correct order is"Bar"
,"Foo"
,"baz"
. -
"any"
: Allow any order.
You may set the "grouped-imports"
option to control the grouping of source
imports (the "foo"
in import {A, B, C} from "foo"
). The grouping used
is controlled by the "groups"
option.
Possible values for "grouped-imports"
are:
-
false
: Do not enforce grouping. (This is the default.) -
true
: Group source imports using default grouping or groups setting.
The value of "groups"
is a list of group rules of the form:
[{
"name": "optional rule name",
"match": "regex string",
"order": 10
}, {
"name": "pkga imports",
"match": "^@pkga",
"order": 20
}]
there is also a simplified form where you only pass a list of patterns and the order is given by the position in the list
["^@pkga", "^\.\."]
The first rule in the list to match a given import is the group that is used.
If no rule in matched then the import will be put in an unmatched
group
at the end of all groups. The groups must be ordered based upon the sequential
value of the order
value. (ie. order 0 is first)
If no "groups"
options is set, a default grouping is used of third-party,
parent directories and the current directory. ("bar"
, "../baz"
, "./foo"
.)
You may set the "named-imports-order"
option to control the ordering of named
imports (the {A, B, C}
in import {A, B, C} from "foo"
).
Possible values for "named-imports-order"
are:
-
"case-insensitive'
: Correct order is{A, b, C}
. (This is the default.) -
"case-insensitive-legacy'
: Correct order is"Bar"
,"baz"
,"Foo"
. -
"lowercase-first"
: Correct order is{b, A, C}
. -
"lowercase-last"
: Correct order is{A, C, b}
. -
"any"
: Allow any order.
You may set the "module-source-path"
option to control the ordering of imports based full path
or just the module name
Possible values for "module-source-path"
are:
-
"full'
: Correct order is"./a/Foo"
,"./b/baz"
,"./c/Bar"
. (This is the default.) -
"basename"
: Correct order is"./c/Bar"
,"./b/baz"
,"./a/Foo"
.
Examples
"ordered-imports": true
"ordered-imports": true,[object Object]
Schema
{
"type": "object",
"properties": {
"grouped-imports": {
"type": "boolean"
},
"groups": {
"type": "list",
"listType": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"match": {
"type": "string"
},
"order": {
"type": "number"
}
},
"required": [
"match",
"order"
]
}
]
}
},
"import-sources-order": {
"type": "string",
"enum": [
"case-insensitive",
"case-insensitive-legacy",
"lowercase-first",
"lowercase-last",
"any"
]
},
"named-imports-order": {
"type": "string",
"enum": [
"case-insensitive",
"case-insensitive-legacy",
"lowercase-first",
"lowercase-last",
"any"
]
},
"module-source-path": {
"type": "string",
"enum": [
"full",
"basename"
]
}
},
"additionalProperties": false
}
For more information see this page.
asterisks in jsdoc must be aligned Open
*/
- Read upRead up
- Exclude checks
Rule: jsdoc-format
Enforces basic format rules for JSDoc comments.
The following rules are enforced for JSDoc comments (comments starting with /**
):
- each line contains an asterisk and asterisks must be aligned
- each asterisk must be followed by either a space or a newline (except for the first and the last)
- the only characters before the asterisk on each line must be whitespace characters
- one line comments must start with
/**
and end with*/
- multiline comments don't allow text after
/**
in the first line (with option"check-multiline-start"
)
Rationale
Helps maintain a consistent, readable style for JSDoc comments.
Config
You can optionally specify the option "check-multiline-start"
to enforce the first line of a
multiline JSDoc comment to be empty.
Examples
"jsdoc-format": true
"jsdoc-format": true,check-multiline-start
Schema
{
"type": "array",
"minItems": 0,
"maxItems": 1,
"items": {
"type": "string",
"enum": [
"check-multiline-start"
]
}
}
For more information see this page.
Identifier 'routePromises' is never reassigned; use 'const' instead of 'let'. Open
let routePromises = this.routeSvc.getEachRoute(routeIds);
- Read upRead up
- Exclude checks
Rule: prefer-const
Requires that variable declarations use const
instead of let
and var
if possible.
If a variable is only assigned to once when it is declared, it should be declared using 'const'
Notes
- Has Fix
Config
An optional object containing the property "destructuring" with two possible values:
- "any" (default) - If any variable in destructuring can be const, this rule warns for those variables.
- "all" - Only warns if all variables in destructuring can be const.
Examples
"prefer-const": true
"prefer-const": true,[object Object]
Schema
{
"type": "object",
"properties": {
"destructuring": {
"type": "string",
"enum": [
"all",
"any"
]
}
}
}
For more information see this page.
Identifier 'routeIds' is never reassigned; use 'const' instead of 'let'. Open
let routeIds = _.uniq(_.map(directions[0].RouteDirections, 'RouteId'));
- Read upRead up
- Exclude checks
Rule: prefer-const
Requires that variable declarations use const
instead of let
and var
if possible.
If a variable is only assigned to once when it is declared, it should be declared using 'const'
Notes
- Has Fix
Config
An optional object containing the property "destructuring" with two possible values:
- "any" (default) - If any variable in destructuring can be const, this rule warns for those variables.
- "all" - Only warns if all variables in destructuring can be const.
Examples
"prefer-const": true
"prefer-const": true,[object Object]
Schema
{
"type": "object",
"properties": {
"destructuring": {
"type": "string",
"enum": [
"all",
"any"
]
}
}
}
For more information see this page.
Identifier 'route' is never reassigned; use 'const' instead of 'let'. Open
for (let route of directions[0].RouteDirections) {
- Read upRead up
- Exclude checks
Rule: prefer-const
Requires that variable declarations use const
instead of let
and var
if possible.
If a variable is only assigned to once when it is declared, it should be declared using 'const'
Notes
- Has Fix
Config
An optional object containing the property "destructuring" with two possible values:
- "any" (default) - If any variable in destructuring can be const, this rule warns for those variables.
- "all" - Only warns if all variables in destructuring can be const.
Examples
"prefer-const": true
"prefer-const": true,[object Object]
Schema
{
"type": "object",
"properties": {
"destructuring": {
"type": "string",
"enum": [
"all",
"any"
]
}
}
}
For more information see this page.
Identifier 'departureSort' is never reassigned; use 'const' instead of 'let'. Open
let departureSort: string = this.depSortSvc.validate(storedSort);
- Read upRead up
- Exclude checks
Rule: prefer-const
Requires that variable declarations use const
instead of let
and var
if possible.
If a variable is only assigned to once when it is declared, it should be declared using 'const'
Notes
- Has Fix
Config
An optional object containing the property "destructuring" with two possible values:
- "any" (default) - If any variable in destructuring can be const, this rule warns for those variables.
- "all" - Only warns if all variables in destructuring can be const.
Examples
"prefer-const": true
"prefer-const": true,[object Object]
Schema
{
"type": "object",
"properties": {
"destructuring": {
"type": "string",
"enum": [
"all",
"any"
]
}
}
}
For more information see this page.
Identifier 'lightweightDirection' is never reassigned; use 'const' instead of 'let'. Open
let lightweightDirection = {
- Read upRead up
- Exclude checks
Rule: prefer-const
Requires that variable declarations use const
instead of let
and var
if possible.
If a variable is only assigned to once when it is declared, it should be declared using 'const'
Notes
- Has Fix
Config
An optional object containing the property "destructuring" with two possible values:
- "any" (default) - If any variable in destructuring can be const, this rule warns for those variables.
- "all" - Only warns if all variables in destructuring can be const.
Examples
"prefer-const": true
"prefer-const": true,[object Object]
Schema
{
"type": "object",
"properties": {
"destructuring": {
"type": "string",
"enum": [
"all",
"any"
]
}
}
}
For more information see this page.
Type boolean trivially inferred from a boolean literal, remove type annotation Open
isInternetExplorer: boolean = false;
- Read upRead up
- Exclude checks
Rule: no-inferrable-types
Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean.
Rationale
Explicit types where they can be easily inferred by the compiler make code more verbose.
Notes
- TypeScript Only
- Has Fix
Config
Two arguments may be optionally provided:
-
ignore-params
allows specifying an inferrable type annotation for function params. This can be useful when combining with thetypedef
rule. -
ignore-properties
allows specifying an inferrable type annotation for class properties.
Examples
"no-inferrable-types": true
"no-inferrable-types": true,ignore-params
"no-inferrable-types": true,ignore-params,ignore-properties
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"ignore-params",
"ignore-properties"
]
},
"minLength": 0,
"maxLength": 2
}
For more information see this page.
Identifier 'route' is never reassigned; use 'const' instead of 'let'. Open
let route = this.routeList[departure.RouteId];
- Read upRead up
- Exclude checks
Rule: prefer-const
Requires that variable declarations use const
instead of let
and var
if possible.
If a variable is only assigned to once when it is declared, it should be declared using 'const'
Notes
- Has Fix
Config
An optional object containing the property "destructuring" with two possible values:
- "any" (default) - If any variable in destructuring can be const, this rule warns for those variables.
- "all" - Only warns if all variables in destructuring can be const.
Examples
"prefer-const": true
"prefer-const": true,[object Object]
Schema
{
"type": "object",
"properties": {
"destructuring": {
"type": "string",
"enum": [
"all",
"any"
]
}
}
}
For more information see this page.
Identifier 'direction' is never reassigned; use 'const' instead of 'let'. Open
for (let direction of directions.RouteDirections) {
- Read upRead up
- Exclude checks
Rule: prefer-const
Requires that variable declarations use const
instead of let
and var
if possible.
If a variable is only assigned to once when it is declared, it should be declared using 'const'
Notes
- Has Fix
Config
An optional object containing the property "destructuring" with two possible values:
- "any" (default) - If any variable in destructuring can be const, this rule warns for those variables.
- "all" - Only warns if all variables in destructuring can be const.
Examples
"prefer-const": true
"prefer-const": true,[object Object]
Schema
{
"type": "object",
"properties": {
"destructuring": {
"type": "string",
"enum": [
"all",
"any"
]
}
}
}
For more information see this page.
Identifier 'times' is never reassigned; use 'const' instead of 'var'. Open
var times = this.calculateTimes(departure);
- Read upRead up
- Exclude checks
Rule: prefer-const
Requires that variable declarations use const
instead of let
and var
if possible.
If a variable is only assigned to once when it is declared, it should be declared using 'const'
Notes
- Has Fix
Config
An optional object containing the property "destructuring" with two possible values:
- "any" (default) - If any variable in destructuring can be const, this rule warns for those variables.
- "all" - Only warns if all variables in destructuring can be const.
Examples
"prefer-const": true
"prefer-const": true,[object Object]
Schema
{
"type": "object",
"properties": {
"destructuring": {
"type": "string",
"enum": [
"all",
"any"
]
}
}
}
For more information see this page.
asterisks in jsdoc must be aligned Open
* Given all the RouteDirections and their upcoming departures
- Read upRead up
- Exclude checks
Rule: jsdoc-format
Enforces basic format rules for JSDoc comments.
The following rules are enforced for JSDoc comments (comments starting with /**
):
- each line contains an asterisk and asterisks must be aligned
- each asterisk must be followed by either a space or a newline (except for the first and the last)
- the only characters before the asterisk on each line must be whitespace characters
- one line comments must start with
/**
and end with*/
- multiline comments don't allow text after
/**
in the first line (with option"check-multiline-start"
)
Rationale
Helps maintain a consistent, readable style for JSDoc comments.
Config
You can optionally specify the option "check-multiline-start"
to enforce the first line of a
multiline JSDoc comment to be empty.
Examples
"jsdoc-format": true
"jsdoc-format": true,check-multiline-start
Schema
{
"type": "array",
"minItems": 0,
"maxItems": 1,
"items": {
"type": "string",
"enum": [
"check-multiline-start"
]
}
}
For more information see this page.
Use a conditional expression instead of assigning to 'this.shownRoute' in multiple places. Open
if (this.isRouteDropdownShown(routeDirection)) {
- Read upRead up
- Exclude checks
Rule: prefer-conditional-expression
Recommends to use a conditional expression instead of assigning to the same thing in each branch of an if statement.
Rationale
This reduces duplication and can eliminate an unnecessary variable declaration.
Config
If check-else-if
is specified, the rule also checks nested if-else-if statements.
Examples
"prefer-conditional-expression": true
"prefer-conditional-expression": true,check-else-if
Schema
{
"type": "string",
"enum": [
"check-else-if"
]
}
For more information see this page.
asterisks in jsdoc must be aligned Open
* It sorts departures in two ways:
- Read upRead up
- Exclude checks
Rule: jsdoc-format
Enforces basic format rules for JSDoc comments.
The following rules are enforced for JSDoc comments (comments starting with /**
):
- each line contains an asterisk and asterisks must be aligned
- each asterisk must be followed by either a space or a newline (except for the first and the last)
- the only characters before the asterisk on each line must be whitespace characters
- one line comments must start with
/**
and end with*/
- multiline comments don't allow text after
/**
in the first line (with option"check-multiline-start"
)
Rationale
Helps maintain a consistent, readable style for JSDoc comments.
Config
You can optionally specify the option "check-multiline-start"
to enforce the first line of a
multiline JSDoc comment to be empty.
Examples
"jsdoc-format": true
"jsdoc-format": true,check-multiline-start
Schema
{
"type": "array",
"minItems": 0,
"maxItems": 1,
"items": {
"type": "string",
"enum": [
"check-multiline-start"
]
}
}
For more information see this page.
asterisks in jsdoc must be aligned Open
* all departures so they can be clearly and simply displayed in the UI.
- Read upRead up
- Exclude checks
Rule: jsdoc-format
Enforces basic format rules for JSDoc comments.
The following rules are enforced for JSDoc comments (comments starting with /**
):
- each line contains an asterisk and asterisks must be aligned
- each asterisk must be followed by either a space or a newline (except for the first and the last)
- the only characters before the asterisk on each line must be whitespace characters
- one line comments must start with
/**
and end with*/
- multiline comments don't allow text after
/**
in the first line (with option"check-multiline-start"
)
Rationale
Helps maintain a consistent, readable style for JSDoc comments.
Config
You can optionally specify the option "check-multiline-start"
to enforce the first line of a
multiline JSDoc comment to be empty.
Examples
"jsdoc-format": true
"jsdoc-format": true,check-multiline-start
Schema
{
"type": "array",
"minItems": 0,
"maxItems": 1,
"items": {
"type": "string",
"enum": [
"check-multiline-start"
]
}
}
For more information see this page.
Identifier 'departure' is never reassigned; use 'const' instead of 'let'. Open
for (let departure of direction.Departures) {
- Read upRead up
- Exclude checks
Rule: prefer-const
Requires that variable declarations use const
instead of let
and var
if possible.
If a variable is only assigned to once when it is declared, it should be declared using 'const'
Notes
- Has Fix
Config
An optional object containing the property "destructuring" with two possible values:
- "any" (default) - If any variable in destructuring can be const, this rule warns for those variables.
- "all" - Only warns if all variables in destructuring can be const.
Examples
"prefer-const": true
"prefer-const": true,[object Object]
Schema
{
"type": "object",
"properties": {
"destructuring": {
"type": "string",
"enum": [
"all",
"any"
]
}
}
}
For more information see this page.
asterisks in jsdoc must be aligned Open
* 2) By Time
- Read upRead up
- Exclude checks
Rule: jsdoc-format
Enforces basic format rules for JSDoc comments.
The following rules are enforced for JSDoc comments (comments starting with /**
):
- each line contains an asterisk and asterisks must be aligned
- each asterisk must be followed by either a space or a newline (except for the first and the last)
- the only characters before the asterisk on each line must be whitespace characters
- one line comments must start with
/**
and end with*/
- multiline comments don't allow text after
/**
in the first line (with option"check-multiline-start"
)
Rationale
Helps maintain a consistent, readable style for JSDoc comments.
Config
You can optionally specify the option "check-multiline-start"
to enforce the first line of a
multiline JSDoc comment to be empty.
Examples
"jsdoc-format": true
"jsdoc-format": true,check-multiline-start
Schema
{
"type": "array",
"minItems": 0,
"maxItems": 1,
"items": {
"type": "string",
"enum": [
"check-multiline-start"
]
}
}
For more information see this page.
Identifier 'promise' is never reassigned; use 'const' instead of 'let'. Open
for (let promise of routePromises) {
- Read upRead up
- Exclude checks
Rule: prefer-const
Requires that variable declarations use const
instead of let
and var
if possible.
If a variable is only assigned to once when it is declared, it should be declared using 'const'
Notes
- Has Fix
Config
An optional object containing the property "destructuring" with two possible values:
- "any" (default) - If any variable in destructuring can be const, this rule warns for those variables.
- "all" - Only warns if all variables in destructuring can be const.
Examples
"prefer-const": true
"prefer-const": true,[object Object]
Schema
{
"type": "object",
"properties": {
"destructuring": {
"type": "string",
"enum": [
"all",
"any"
]
}
}
}
For more information see this page.
asterisks in jsdoc must be aligned Open
* 1) By Route Direction
- Read upRead up
- Exclude checks
Rule: jsdoc-format
Enforces basic format rules for JSDoc comments.
The following rules are enforced for JSDoc comments (comments starting with /**
):
- each line contains an asterisk and asterisks must be aligned
- each asterisk must be followed by either a space or a newline (except for the first and the last)
- the only characters before the asterisk on each line must be whitespace characters
- one line comments must start with
/**
and end with*/
- multiline comments don't allow text after
/**
in the first line (with option"check-multiline-start"
)
Rationale
Helps maintain a consistent, readable style for JSDoc comments.
Config
You can optionally specify the option "check-multiline-start"
to enforce the first line of a
multiline JSDoc comment to be empty.
Examples
"jsdoc-format": true
"jsdoc-format": true,check-multiline-start
Schema
{
"type": "array",
"minItems": 0,
"maxItems": 1,
"items": {
"type": "string",
"enum": [
"check-multiline-start"
]
}
}
For more information see this page.
Identifier 'alert' is never reassigned; use 'const' instead of 'let'. Open
for (let alert of alerts) {
- Read upRead up
- Exclude checks
Rule: prefer-const
Requires that variable declarations use const
instead of let
and var
if possible.
If a variable is only assigned to once when it is declared, it should be declared using 'const'
Notes
- Has Fix
Config
An optional object containing the property "destructuring" with two possible values:
- "any" (default) - If any variable in destructuring can be const, this rule warns for those variables.
- "all" - Only warns if all variables in destructuring can be const.
Examples
"prefer-const": true
"prefer-const": true,[object Object]
Schema
{
"type": "object",
"properties": {
"destructuring": {
"type": "string",
"enum": [
"all",
"any"
]
}
}
}
For more information see this page.
Identifier 'autoRefreshValidity' is never reassigned; use 'const' instead of 'let'. Open
let autoRefreshValidity: [boolean, number] = this.refreshSvc
- Read upRead up
- Exclude checks
Rule: prefer-const
Requires that variable declarations use const
instead of let
and var
if possible.
If a variable is only assigned to once when it is declared, it should be declared using 'const'
Notes
- Has Fix
Config
An optional object containing the property "destructuring" with two possible values:
- "any" (default) - If any variable in destructuring can be const, this rule warns for those variables.
- "all" - Only warns if all variables in destructuring can be const.
Examples
"prefer-const": true
"prefer-const": true,[object Object]
Schema
{
"type": "object",
"properties": {
"destructuring": {
"type": "string",
"enum": [
"all",
"any"
]
}
}
}
For more information see this page.
Forbidden 'var' keyword, use 'let' or 'const' instead Open
var futureDepartures = [];
- Read upRead up
- Exclude checks
Rule: no-var-keyword
Disallows usage of the var
keyword.
Use let
or const
instead.
Rationale
Declaring variables using var
has several edge case behaviors that make var
unsuitable for modern code.
Variables declared by var
have their parent function block as their scope, ignoring other control flow statements.
var
s have declaration "hoisting" (similar to function
s) and can appear to be used before declaration.
Variables declared by const
and let
instead have as their scope the block in which they are defined,
and are not allowed to used before declaration or be re-declared with another const
or let
.
Notes
- Has Fix
Config
Not configurable.
Examples
"no-var-keyword": true
For more information see this page.
Forbidden 'var' keyword, use 'let' or 'const' instead Open
var times = this.calculateTimes(departure);
- Read upRead up
- Exclude checks
Rule: no-var-keyword
Disallows usage of the var
keyword.
Use let
or const
instead.
Rationale
Declaring variables using var
has several edge case behaviors that make var
unsuitable for modern code.
Variables declared by var
have their parent function block as their scope, ignoring other control flow statements.
var
s have declaration "hoisting" (similar to function
s) and can appear to be used before declaration.
Variables declared by const
and let
instead have as their scope the block in which they are defined,
and are not allowed to used before declaration or be re-declared with another const
or let
.
Notes
- Has Fix
Config
Not configurable.
Examples
"no-var-keyword": true
For more information see this page.
Identifier 'futureDepartures' is never reassigned; use 'const' instead of 'var'. Open
var futureDepartures = [];
- Read upRead up
- Exclude checks
Rule: prefer-const
Requires that variable declarations use const
instead of let
and var
if possible.
If a variable is only assigned to once when it is declared, it should be declared using 'const'
Notes
- Has Fix
Config
An optional object containing the property "destructuring" with two possible values:
- "any" (default) - If any variable in destructuring can be const, this rule warns for those variables.
- "all" - Only warns if all variables in destructuring can be const.
Examples
"prefer-const": true
"prefer-const": true,[object Object]
Schema
{
"type": "object",
"properties": {
"destructuring": {
"type": "string",
"enum": [
"all",
"any"
]
}
}
}
For more information see this page.
Named imports must be alphabetized. Open
import { NavController, NavParams, LoadingController, AlertController } from 'ionic-angular';
- Read upRead up
- Exclude checks
Rule: ordered-imports
Requires that import statements be alphabetized and grouped.
Enforce a consistent ordering for ES6 imports: - Named imports must be alphabetized (i.e. "import {A, B, C} from "foo";") - The exact ordering can be controlled by the named-imports-order option. - "longName as name" imports are ordered by "longName". - Import sources must be alphabetized within groups, i.e.: import * as foo from "a"; import * as bar from "b"; - Groups of imports are delineated by blank lines. You can use this rule to group imports however you like, e.g. by first- vs. third-party or thematically or you can define groups based upon patterns in import path names.
Notes
- Has Fix
Config
You may set the "import-sources-order"
option to control the ordering of source
imports (the "foo"
in import {A, B, C} from "foo"
).
Possible values for "import-sources-order"
are:
-
"case-insensitive'
: Correct order is"Bar"
,"baz"
,"Foo"
. (This is the default.) -
"case-insensitive-legacy'
: Correct order is"Bar"
,"baz"
,"Foo"
. -
"lowercase-first"
: Correct order is"baz"
,"Bar"
,"Foo"
. -
"lowercase-last"
: Correct order is"Bar"
,"Foo"
,"baz"
. -
"any"
: Allow any order.
You may set the "grouped-imports"
option to control the grouping of source
imports (the "foo"
in import {A, B, C} from "foo"
). The grouping used
is controlled by the "groups"
option.
Possible values for "grouped-imports"
are:
-
false
: Do not enforce grouping. (This is the default.) -
true
: Group source imports using default grouping or groups setting.
The value of "groups"
is a list of group rules of the form:
[{
"name": "optional rule name",
"match": "regex string",
"order": 10
}, {
"name": "pkga imports",
"match": "^@pkga",
"order": 20
}]
there is also a simplified form where you only pass a list of patterns and the order is given by the position in the list
["^@pkga", "^\.\."]
The first rule in the list to match a given import is the group that is used.
If no rule in matched then the import will be put in an unmatched
group
at the end of all groups. The groups must be ordered based upon the sequential
value of the order
value. (ie. order 0 is first)
If no "groups"
options is set, a default grouping is used of third-party,
parent directories and the current directory. ("bar"
, "../baz"
, "./foo"
.)
You may set the "named-imports-order"
option to control the ordering of named
imports (the {A, B, C}
in import {A, B, C} from "foo"
).
Possible values for "named-imports-order"
are:
-
"case-insensitive'
: Correct order is{A, b, C}
. (This is the default.) -
"case-insensitive-legacy'
: Correct order is"Bar"
,"baz"
,"Foo"
. -
"lowercase-first"
: Correct order is{b, A, C}
. -
"lowercase-last"
: Correct order is{A, C, b}
. -
"any"
: Allow any order.
You may set the "module-source-path"
option to control the ordering of imports based full path
or just the module name
Possible values for "module-source-path"
are:
-
"full'
: Correct order is"./a/Foo"
,"./b/baz"
,"./c/Bar"
. (This is the default.) -
"basename"
: Correct order is"./c/Bar"
,"./b/baz"
,"./a/Foo"
.
Examples
"ordered-imports": true
"ordered-imports": true,[object Object]
Schema
{
"type": "object",
"properties": {
"grouped-imports": {
"type": "boolean"
},
"groups": {
"type": "list",
"listType": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"match": {
"type": "string"
},
"order": {
"type": "number"
}
},
"required": [
"match",
"order"
]
}
]
}
},
"import-sources-order": {
"type": "string",
"enum": [
"case-insensitive",
"case-insensitive-legacy",
"lowercase-first",
"lowercase-last",
"any"
]
},
"named-imports-order": {
"type": "string",
"enum": [
"case-insensitive",
"case-insensitive-legacy",
"lowercase-first",
"lowercase-last",
"any"
]
},
"module-source-path": {
"type": "string",
"enum": [
"full",
"basename"
]
}
},
"additionalProperties": false
}
For more information see this page.
asterisks in jsdoc must be aligned Open
* at this stop, this function organizes and manipulates
- Read upRead up
- Exclude checks
Rule: jsdoc-format
Enforces basic format rules for JSDoc comments.
The following rules are enforced for JSDoc comments (comments starting with /**
):
- each line contains an asterisk and asterisks must be aligned
- each asterisk must be followed by either a space or a newline (except for the first and the last)
- the only characters before the asterisk on each line must be whitespace characters
- one line comments must start with
/**
and end with*/
- multiline comments don't allow text after
/**
in the first line (with option"check-multiline-start"
)
Rationale
Helps maintain a consistent, readable style for JSDoc comments.
Config
You can optionally specify the option "check-multiline-start"
to enforce the first line of a
multiline JSDoc comment to be empty.
Examples
"jsdoc-format": true
"jsdoc-format": true,check-multiline-start
Schema
{
"type": "array",
"minItems": 0,
"maxItems": 1,
"items": {
"type": "string",
"enum": [
"check-multiline-start"
]
}
}
For more information see this page.