Skip to content

A plugin for enforcing some Javascript best practices when using Typescript as "typed" Javascript. This plugin can also be used together with Javascript to prevent the usage of Class extends.

License

Notifications You must be signed in to change notification settings

BonnierNews/eslint-plugin-typescript-rules

Repository files navigation

Eslint plugin typescript rules

Tests

A plugin for enforcing some Javascript best practices when using Typescript as "typed" Javascript. This plugin can also be used together with Javascript to prevent the usage of Class extends.

Usage

Install eslint and the plugin npm i eslint @bonniernews/eslint-plugin-typescript-rules --save-dev

Add typescript-rules to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["typescript-rules"]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "typescript-rules/disallow-class-extends": "error",
    "typescript-rules/disallow-abstract-class": "error",
    "typescript-rules/disallow-non-es-compatible": "error"
  }
}

Recommended

This plugin exports a recommended configuration that includes all the rules enabled.

To enable this configuration use the extends property in your .eslintrc config file:

{
  "extends": [
    "eslint:recommended",
    "plugin:typescript-rules/recommended"
  ]
}

Rules

Name                       Description
disallow-abstract-class Prevent usage of abstract classes.
disallow-class-extends Prevent extending classes. Unless it's an Error class.
disallow-non-es-compatible Prevent usage of non EcmaScript compatible functionality when using Typescript, such as decorators, enums, private methods and properties.

License

Released under the MIT license.

About

A plugin for enforcing some Javascript best practices when using Typescript as "typed" Javascript. This plugin can also be used together with Javascript to prevent the usage of Class extends.

Resources

License

Stars

Watchers

Forks