import { CUSTOM_ELEMENTS_SCHEMA, NgModule } from "@angular/core";

Close

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.

import { BrowserModule } from "@angular/platform-browser";

Close

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.

}

Close

Rule: eofline

Ensures the file ends with a newline.

Fix for single-line files is not supported.

Rationale

It is a standard convention to end files with a newline.

Notes

• Has Fix

Config

Not configurable.

Examples

"eofline": true

For more information see this page.

import { GenericTableComponent } from "./generic-table/generic-table.component";

Close

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.

}

Close

Rule: no-trailing-whitespace

Disallows trailing whitespace at the end of a line.

Rationale

Keeps version control diffs clean as it prevents accidental whitespace from being committed.

Notes

• Has Fix

Config

Possible settings are:

• "ignore-template-strings": Allows trailing whitespace in template strings.
• "ignore-comments": Allows trailing whitespace in comments.
• "ignore-jsdoc": Allows trailing whitespace only in JSDoc comments.
• "ignore-blank-lines": Allows trailing whitespace on empty lines.

Examples

"no-trailing-whitespace": true

"no-trailing-whitespace": true,ignore-comments

"no-trailing-whitespace": true,ignore-jsdoc

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "ignore-comments",
      "ignore-jsdoc",
      "ignore-template-strings",
      "ignore-blank-lines"
    ]
  }
}

For more information see this page.

                            a = -1 * Number.parseInt(splits[1]);

Close

Rule: radix

Requires the radix parameter to be specified when calling parseInt.

Rationale

From MDN:

Always specify this parameter to eliminate reader confusion and to guarantee predictable behavior. Different implementations produce different results when a radix is not specified, usually defaulting the value to 10.

Config

Not configurable.

Examples

"radix": true

For more information see this page.

    selector: 'ptooltip',

Close

Rule: component-selector

Component selectors should follow given naming rules.

See more at https://angular.io/guide/styleguide#style-02-07, https://angular.io/guide/styleguide#style-05-02 and https://angular.io/guide/styleguide#style-05-03.

Rationale

• Consistent conventions make it easy to quickly identify and reference assets of different types.
• Makes it easier to promote and share the component in other apps.
• Components are easy to identify in the DOM.
• Keeps the element names consistent with the specification for Custom Elements.
• Components have templates containing HTML and optional Angular template syntax.
• They display content. Developers place components on the page as they would native HTML elements and WebComponents.
• It is easier to recognize that a symbol is a component by looking at the template's HTML.

Notes

• TypeScript Only

Config

Options accept three obligatory items as an array: 1. element or attribute forces components to be used as either elements, attributes, or both (not recommended) 2. A single prefix (string) or array of prefixes (strings) which have to be used in component selectors. 3. kebab-case or camelCase allows you to pick a case.

Examples

"component-selector": true,element,my-prefix,kebab-case

"component-selector": true,element,ng,ngx,kebab-case

"component-selector": true,attribute,myPrefix,camelCase

"component-selector": true,element,attribute,myPrefix,camelCase

Schema

{
  "items": [
    {
      "enum": [
        "attribute",
        "element"
      ]
    },
    {
      "oneOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "string"
        }
      ]
    },
    {
      "enum": [
        "camelCase",
        "kebab-case"
      ]
    }
  ],
  "maxLength": 3,
  "minLength": 3,
  "type": "array"
}

For more information see this page.

            const dataElement: DataElement = data[i];

Close

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.

                            b = -1 * Number.parseInt(splits[1]);

Close

Rule: radix

Requires the radix parameter to be specified when calling parseInt.

Rationale

From MDN:

Always specify this parameter to eliminate reader confusion and to guarantee predictable behavior. Different implementations produce different results when a radix is not specified, usually defaulting the value to 10.

Config

Not configurable.

Examples

"radix": true

For more information see this page.

    public detailsOpen: boolean = false;

Close

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 the typedef 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.

    @Input() columnDisplayAll: boolean = false;

Close

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 the typedef 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.

import { Select2Component } from "./select2/select2.component";

Close

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.

}

Close

Rule: eofline

Ensures the file ends with a newline.

Fix for single-line files is not supported.

Rationale

It is a standard convention to end files with a newline.

Notes

• Has Fix

Config

Not configurable.

Examples

"eofline": true

For more information see this page.

    selector: 'pcard',

Close

Rule: component-selector

Component selectors should follow given naming rules.

See more at https://angular.io/guide/styleguide#style-02-07, https://angular.io/guide/styleguide#style-05-02 and https://angular.io/guide/styleguide#style-05-03.

Rationale

• Consistent conventions make it easy to quickly identify and reference assets of different types.
• Makes it easier to promote and share the component in other apps.
• Components are easy to identify in the DOM.
• Keeps the element names consistent with the specification for Custom Elements.
• Components have templates containing HTML and optional Angular template syntax.
• They display content. Developers place components on the page as they would native HTML elements and WebComponents.
• It is easier to recognize that a symbol is a component by looking at the template's HTML.

Notes

• TypeScript Only

Config

Options accept three obligatory items as an array: 1. element or attribute forces components to be used as either elements, attributes, or both (not recommended) 2. A single prefix (string) or array of prefixes (strings) which have to be used in component selectors. 3. kebab-case or camelCase allows you to pick a case.

Examples

"component-selector": true,element,my-prefix,kebab-case

"component-selector": true,element,ng,ngx,kebab-case

"component-selector": true,attribute,myPrefix,camelCase

"component-selector": true,element,attribute,myPrefix,camelCase

Schema

{
  "items": [
    {
      "enum": [
        "attribute",
        "element"
      ]
    },
    {
      "oneOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "string"
        }
      ]
    },
    {
      "enum": [
        "camelCase",
        "kebab-case"
      ]
    }
  ],
  "maxLength": 3,
  "minLength": 3,
  "type": "array"
}

For more information see this page.

                            a = -1 * Number.parseInt(splits[2]);

Close

Rule: radix

Requires the radix parameter to be specified when calling parseInt.

Rationale

From MDN:

Always specify this parameter to eliminate reader confusion and to guarantee predictable behavior. Different implementations produce different results when a radix is not specified, usually defaulting the value to 10.

Config

Not configurable.

Examples

"radix": true

For more information see this page.

    static getHtml(converter: Showdown.Converter, citation: Map<string, Citation>, markdown: string): string {
        if (isNullOrUndefined(markdown)) return null;
        return ConfigurationService.converter.makeHtml(markdown.toString()).replace(/(?:\[@)([^\]]*)(?:\])/g, (match, dec) => {
            if (citation.has(dec)) {
                return '<a class="cite-link" href="#' + dec + '">[' + citation.get(dec).index + ']</a>';

Close

Rule: member-ordering

Enforces member ordering.

Rationale

A consistent ordering for class members can make classes easier to read, navigate, and edit.

A common opposite practice to member-ordering is to keep related groups of classes together. Instead of creating classes with multiple separate groups, consider splitting class responsibilities apart across multiple single-responsibility classes.

Notes

• Has Fix

Config

One argument, which is an object, must be provided. It should contain an order property. The order property should have a value of one of the following strings:

• fields-first
• instance-sandwich
• statics-first

fields-first puts, in order of precedence: * fields before constructors before methods * static members before instance members * public members before protected members before private members instance-sandwich puts, in order of precedence: * fields before constructors before methods * static fields before instance fields, but static methods after instance methods * public members before protected members before private members statics-first puts, in order of precedence: * static members before instance members * public members before protected members before private members * fields before methods * instance fields before constructors before instance methods * fields before constructors before methods * public members before protected members before private members Note that these presets, despite looking similar, can have subtly different behavior due to the order in which these rules are specified. A fully expanded ordering can be found in the PRESETS constant in https://github.com/palantir/tslint/blob/master/src/rules/memberOrderingRule.ts. (You may need to check the version of the file corresponding to your version of tslint.)

Alternatively, the value for order may be an array consisting of the following strings:

• public-static-field
• protected-static-field
• private-static-field
• public-static-method
• private-static-method
• protected-static-method
• public-instance-field
• protected-instance-field
• private-instance-field
• public-constructor
• protected-constructor
• private-constructor
• public-instance-method
• protected-instance-method
• private-instance-method
• public-static-accessor
• protected-static-accessor
• private-static-accessor
• public-instance-accessor
• protected-instance-accessor
• private-instance-accessor

You can also omit the access modifier to refer to "public-", "protected-", and "private-" all at once; for example, "static-field".

You can also make your own categories by using an object instead of a string:

{
    "name": "static non-private",
    "kinds": [
        "public-static-field",
        "protected-static-field",
        "public-static-method",
        "protected-static-method"
    ]
}

The 'alphabetize' option will enforce that members within the same category should be alphabetically sorted by name. Computed property names are sorted before others but not sorted amongst each other. Additionally getters will be sorted before setters (after alphabetization).

Examples

"member-ordering": true,[object Object]

"member-ordering": true,[object Object]

"member-ordering": true,[object Object]

Schema

{
  "type": "object",
  "properties": {
    "alphabetize": {
      "type": "boolean"
    },
    "order": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "fields-first",
            "instance-sandwich",
            "statics-first"
          ]
        },
        {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "public-static-field",
              "protected-static-field",
              "private-static-field",
              "public-static-method",
              "private-static-method",
              "protected-static-method",
              "public-instance-field",
              "protected-instance-field",
              "private-instance-field",
              "public-constructor",
              "protected-constructor",
              "private-constructor",
              "public-instance-method",
              "protected-instance-method",
              "private-instance-method",
              "public-static-accessor",
              "protected-static-accessor",
              "private-static-accessor",
              "public-instance-accessor",
              "protected-instance-accessor",
              "private-instance-accessor"
            ]
          },
          "maxLength": 13
        }
      ]
    }
  },
  "additionalProperties": false
}

For more information see this page.

import { PolymerModule } from "./../polymer/polymer.module";

Close

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.

import { FootnoteComponent } from "./footnote/footnote.component";

Close

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.

                            a = Number.parseInt(splits[0]);

Close

Rule: radix

Requires the radix parameter to be specified when calling parseInt.

Rationale

From MDN:

Always specify this parameter to eliminate reader confusion and to guarantee predictable behavior. Different implementations produce different results when a radix is not specified, usually defaulting the value to 10.

Config

Not configurable.

Examples

"radix": true

For more information see this page.

    selector: 'comparison',

Close

Rule: component-selector

Component selectors should follow given naming rules.

See more at https://angular.io/guide/styleguide#style-02-07, https://angular.io/guide/styleguide#style-05-02 and https://angular.io/guide/styleguide#style-05-03.

Rationale

• Consistent conventions make it easy to quickly identify and reference assets of different types.
• Makes it easier to promote and share the component in other apps.
• Components are easy to identify in the DOM.
• Keeps the element names consistent with the specification for Custom Elements.
• Components have templates containing HTML and optional Angular template syntax.
• They display content. Developers place components on the page as they would native HTML elements and WebComponents.
• It is easier to recognize that a symbol is a component by looking at the template's HTML.

Notes

• TypeScript Only

Config

Options accept three obligatory items as an array: 1. element or attribute forces components to be used as either elements, attributes, or both (not recommended) 2. A single prefix (string) or array of prefixes (strings) which have to be used in component selectors. 3. kebab-case or camelCase allows you to pick a case.

Examples

"component-selector": true,element,my-prefix,kebab-case

"component-selector": true,element,ng,ngx,kebab-case

"component-selector": true,attribute,myPrefix,camelCase

"component-selector": true,element,attribute,myPrefix,camelCase

Schema

{
  "items": [
    {
      "enum": [
        "attribute",
        "element"
      ]
    },
    {
      "oneOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "string"
        }
      ]
    },
    {
      "enum": [
        "camelCase",
        "kebab-case"
      ]
    }
  ],
  "maxLength": 3,
  "minLength": 3,
  "type": "array"
}

For more information see this page.