eslint-plugin-sort-annotation

Lint rule to autofix unsorted object's keys or array


Keywords
eslint, eslintplugin, eslint-plugin, import, relative, modules, autofix, eslint-rules
License
MIT
Install
npm install eslint-plugin-sort-annotation@1.0.7

Documentation

eslint-plugin-sort-annotation

NPM version Build Status

An ESLint plugin for sorting interface properties, object keys and array values if code has annotation. Rules support auto fix and Typescript also.

sort-annotation/sort sort-annotation/sort-keys
sort sort-keys

Installation

You’ll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-sort-annotation:

npm i eslint-plugin-sort-annotation --save-dev

Usage

Here’s a suggested ESLint configuration that:

{
  "parserOptions": { ... }, // Nothing changed
  "plugins": [..., "sort-annotation"], // Add 'sort-annotation' next to old plugins
  "rules": {
    ...
    // Add below rules next to old rules 
    'sort-annotation/sort-keys': 'error',
    'sort-annotation/sort': 'error',
  }
}

Supported Rules

  • sort-keys : Sort interface properties or object keys if has @sort-keys annotation

  • sort : Sort array values if has @sort annotation

License

BSD License