eslint-plugin-typescript-sort-keys

    2.0.0 • Public • Published

    Tests

    eslint-plugin-typescript-sort-keys

    Sort interface and string enum keys

    Inspired by and sourced from eslint/sort-keys

    Installation

    You'll first need to install

    yarn add -D eslint typescript @typescript-eslint/parser

    Next, install eslint-plugin-typescript-sort-keys:

    yarn add -D eslint-plugin-typescript-sort-keys

    Note: If you installed ESLint globally then you must also install eslint-plugin-typescript-sort-keys globally.

    Usage

    Specify the parser for typescript files in your .eslintrc configuration file:

    {
      "parser": "@typescript-eslint/parser"
    }

    Add typescript-sort-keys to the plugins section. You can omit the eslint-plugin- prefix:

    {
      "plugins": ["typescript-sort-keys"]
    }

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

    {
      "rules": {
        "typescript-sort-keys/interface": "error",
        "typescript-sort-keys/string-enum": "error"
      }
    }

    Or enable all rules with defaults

    {
      "extends": ["plugin:typescript-sort-keys/recommended"]
    }

    Supported Rules

    Key: ✔️ = recommended, 🔧 = fixable

    Name Description ✔️ 🔧
    typescript-sort-keys/interface require interface keys to be sorted ✔️ 🔧
    typescript-sort-keys/string-enum require string enum members to be sorted ✔️ 🔧

    Install

    npm i eslint-plugin-typescript-sort-keys

    DownloadsWeekly Downloads

    49,852

    Version

    2.0.0

    License

    ISC

    Unpacked Size

    42.2 kB

    Total Files

    6

    Last publish

    Collaborators

    • infctr