root 3bf41bf355 update 1 year ago
..
.github 3bf41bf355 update 1 year ago
lib 3bf41bf355 update 1 year ago
test 3bf41bf355 update 1 year ago
.eslintrc.js 3bf41bf355 update 1 year ago
.prettierrc.js 3bf41bf355 update 1 year ago
README.md 3bf41bf355 update 1 year ago
package.json 3bf41bf355 update 1 year ago

README.md

eslint-plugin-sort-exports

Sort export declarations in modules, similarly to sort-imports

Installation

First install ESLint

yarn add -d eslint

Then install eslint-plugin-sort-exports

yarn add --dev eslint-plugin-sort-exports

Note: If you installed ESLint globally, you must also install eslint-plugin-sort-exports globally.

Usage

Add sort-exports to the plugins section of your .eslintrc and configure the rule under the rules section.

{
    "plugins": ["sort-exports"],
    "rules": {
        "sort-exports/sort-exports": ["error", {"sortDir": "asc"}]
    }
}

Supported rules

sort-exports

Configuration

{
    "sort-exports/sort-exports": [
        "error",
        { sortDir: "asc", ignoreCase: true, sortExportKindFirst: "type" }
    ]
}

Options can be any of the following properties:

  • sortDir: Can be either asc (default) or desc signifying ascending or descending sort order, respectively.
  • ignoreCase: If true, sorting is case-insensitive.
  • sortExportKindFirst: Can be type, value, or none. Determines whether export or export type are sorted first, if not none.
  • disableAutofixer: If there's a bug in the autofixer and you want to disable it but leave other rules alone, you can set this to true.