Skip to content

Add descriptions and examples to each lint rule #159

@bartlomieju

Description

@bartlomieju

All lint rules should be updated to contains some kind of method that returns description as well as some examples of valid and invalid. This feature will be used to generate documentation.

  • adjacent-overload-signatures
  • ban-ts-comment
  • ban-types
  • ban-untagged-ignore
  • ban-untagged-todo
  • constructor-super
  • default-param-last
  • eqeqeq
  • explicit-function-return-type
  • explicit-module-boundary-types
  • for-direction
  • getter-return
  • no-array-constructor
  • no-async-promise-executor
  • no-await-in-loop
  • no-case-declarations
  • no-class-assign
  • no-compare-neg-zero
  • no-cond-assign
  • no-const-assign
  • no-constant-condition
  • no-control-regex
  • no-debugger
  • no-delete-var
  • no-dupe-args
  • no-dupe-class-members
  • no-dupe-else-if
  • no-dupe-keys
  • no-duplicate-case
  • no-empty
  • no-empty-character-class
  • no-empty-interface
  • no-empty-pattern
  • no-eval
  • no-ex-assign
  • no-explicit-any
  • no-extra-boolean-cast
  • no-extra-non-null-assertion
  • no-extra-semi
  • no-fallthrough
  • no-func-assign
  • no-global-assign
  • no-import-assign
  • no-inferrable-types
  • no-inner-declarations
  • no-invalid-regexp
  • no-irregular-whitespace
  • no-misused-new
  • no-mixed-spaces-and-tabs
  • no-namespace
  • no-new-symbol
  • no-non-null-asserted-optional-chain
  • no-non-null-assertion
  • no-obj-calls
  • no-octal
  • no-prototype-builtins
  • no-redeclare
  • no-regex-spaces
  • no-self-assign
  • no-setter-return
  • no-shadow-restricted-names
  • no-sparse-arrays
  • no-this-alias
  • no-this-before-super
  • no-throw-literal
  • no-undef
  • no-unreachable
  • no-unsafe-finally
  • no-unsafe-negation
  • no-unused-labels
  • no-unused-vars
  • no-var
  • no-with
  • prefer-as-const
  • prefer-const
  • prefer-namespace-keyword
  • require-yield
  • single-var-declarator
  • triple-slash-reference
  • use-isnan
  • valid-typeof

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions