Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

eslint-plugin-sort-requires-by-path

oaltman11.8kMIT1.0.2

ESLint rule to enforce sorting of variable declarations in a group of require('path') calls by 'path' string

commonjs, eslint, eslint-plugin, eslint-plugin-sort, eslintplugin, require, sort-requires, sorting

readme

eslint-plugin-sort-requires-by-path

ESLint rule to enforce sorting of variable declarations in a group of require("path") calls based on "path" string.

Installation

You'll first need to install ESLint:

$ npm install eslint --save-dev

Next, install eslint-plugin-sort-requires-by-path:

$ npm install eslint-plugin-sort-requires-by-path --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-sort-requires-by-path globally.

Usage

Add sort-requires-by-path to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": [
    "sort-requires-by-path"
  ]
}

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

{
  "rules": {
    "sort-requires-by-path/sort-requires-by-path": 2
  }
}

License

MIT