@typelib/eslint-plugin v12.5.0

ESLint plugin

Table of contents

• Installation
• Rules
  • class-member-typedef
  • consistent-empty-lines
  • consistent-import
  • disallow-by-regexp
  • disallow-identifier
  • disallow-import
  • empty-lines-around-comment
  • exhaustive-switch
  • no-inferrable-types
  • no-mutable-signature
  • no-unnecessary-readonly
  • no-unnecessary-writable
  • no-unsafe-object-assignment
  • no-unused-import
  • prefer-readonly
  • require-jsdoc
  • sort-class-members
  • template-literal-format
• Shared options

Installation

npm install --save-dev @typelib/eslint-plugin

eslintrc.js

module.exports = {
  plugins: ["@typelib/eslint-plugin"]
};

Rules

class-member-typedef

Requires type definition for class members without initializer.

eslintrc.js

"@typelib/class-member-typedef": "error"

consistent-empty-lines

Requires consistent empty lines.

eslintrc.js

"@typelib/consistent-empty-lines": [
  "error",
  {
    rules: [
      {
        averageLinesGte?: number,
        everyLinesGte?: number,
        selector: string,
        someHasDocComment?: boolean,
        someLinesGte?: number
      },
      ...
    ]
  }
]

Options

consistent-import

Requires consistent import. Auto-imports provided sources.

eslintrc.js

"@typelib/consistent-import": [
  "error",
  {
    sources: [
      {
        altLocalNames?: string[],
        autoImportSource?: string,
        localName?: string,
        sourcePattern: string,
        type: "default" | "wildcard"
      },
      ...
    ]
  }
]

Options

disallow-by-regexp

Disallows code by regular expression.

eslintrc.js

"@typelib/disallow-by-regexp": [
  "error",
  {
    contexts?: Array<"code" | "comment" | "string">,
    rules: [
      {
        contexts?: Array<"code" | "comment" | "string">,
        patterns: string[],
        replacement?: string
      },
      ...
    ]
  }
]

Options

disallow-identifier

Disallows identifiers.

eslintrc.js

"@typelib/disallow-identifier": [
  "error",
  {
    rules: [
      {
        ids: string[],
        replacement?: string
      },
      ...
    ]
  }
]

Options

disallow-import

Disallows import.

eslintrc.js

"@typelib/disallow-import": [
  "error",
  {
    rules: [
      {
        allow?: string[],
        disallow?: string[]
      },
      ...
    ]
  }
]

Options

empty-lines-around-comment

Requires consistent empty lines around comments.

eslintrc.js

"@typelib/empty-lines-around-comment": "error"

exhaustive-switch

Requires exhaustive switch (replaces "@typescript-eslint/switch-exhaustiveness-check" rule, correctly treats typeof operator).

eslintrc.js

"@typelib/exhaustive-switch": "error"

no-inferrable-types

Forbids inferrable types (complements "@typescript-eslint/no-inferrable-types" rule).

eslintrc.js

"@typelib/no-inferrable-types": "error"

no-mutable-signature

Forbids mutable signatures.

eslintrc.js

"@typelib/no-mutable-signature": [
  "error",
  {
    ignoreClasses?: boolean,
    ignoreIdentifiers?: string[],
    ignoreNumberSignature?: boolean,
    ignoreStringSignature?: boolean,
    ignoreTypes?: string[]
  }
]

Options

no-unnecessary-readonly

Forbids unnecessary Readonly|DeepReadonly wrapper.

eslintrc.js

"@typelib/no-unnecessary-readonly": [
  "error",
  {
    ignoreClasses?: boolean,
    ignoreTypes?: string[]
  }
]

Options

no-unnecessary-writable

Forbids unnecessary Writable|DeepWritable wrapper.

eslintrc.js

"@typelib/no-unnecessary-writable": [
  "error",
  {
    ignoreClasses?: boolean,
    ignoreTypes?: string[]
  }
]

Options

no-unsafe-object-assignment

Forbids:

• Readonly-to-mutable assignments.
• Optional assignments.

eslintrc.js

"@typelib/no-unsafe-object-assignment": "error"

no-unused-import

Removes unused import.

eslintrc.js

"@typelib/no-unused-import": "error"

prefer-readonly

Enforces the use of readonly properties.

eslintrc.js

"@typelib/prefer-readonly": [
  "error",
  {
    excludeSelectors?: string[],
    ignoreClasses?: boolean,
    ignoreIdentifiers?: string[],
    ignoreTypes?: string[],
    includeSelectors?: string[],
    noDefaultSelectors?: boolean
  }
]

Options

require-jsdoc

Requires JSDoc comments.

eslintrc.js

"@typelib/require-jsdoc": [
  "error",
  {
    excludeSelectors?: string[],
    includeSelectors?: string[],
    interfaceOptions?: Array<"callSignatures" | "constructSignatures" | "interface">,
    noDefaultSelectors?: string[],
    propertyOptions?: Array<"function" | "nonFunction">
  }
]

Options

sort-class-members

Sorts class member.

eslintrc.js

"@typelib/sort-class-members": [
  "error",
  {
    sortingOrder: string[]
  }
]

Options

template-literal-format

Checks template literal format.

eslintrc.js

"@typelib/template-literal-format": "error"

Shared options

eslintrc.js

"@typelib/<rule-id>": [
  "error",
  {
    filesToLint?: string[],
    filesToSkip?: string[],
    <sub-options-key>: [
      {
        filesToLint?: string[],
        filesToSkip?: string[],
        subOptionsId?: string
      },
      ...
    ]
  }
]

Options

Configuration comment

/* typelib/\<rule-id\> disable \<\>[\<sub-options-id\>] */