jfmengels / eslint-plugin-import-order Goto Github PK

View Code? Open in Web Editor NEW

42.0 7.0 2.0 34 KB

ESLint plugin to enforce the order of import/require statements.

License: MIT License

JavaScript 100.00%

eslint-plugin-import-order's Introduction

eslint-plugin-import-order

ESLint plugin to enforce the order of import/require statements.

Deprecation notice

This plugin is no longer maintained, as its sole feature has been integrated and improved upon in eslint-plugin-import, which does even more cool stuff. The corresponding rule is available under the name order.

Install

$ npm install --save-dev eslint eslint-plugin-import-order

Usage

Configure it in package.json.

{
	"name": "my-awesome-project",
	"eslintConfig": {
		"env": {
			"es6": true
		},
		"parserOptions": {
			"ecmaVersion": 6,
			"sourceType": "module"
		},
		"plugins": [
			"import-order"
		],
		"rules": {
			"import-order/import-order": 2
		}
	}
}

Rules

import-order - Enforce a convention in module import order.

Recommended configuration

This plugin exports a recommended configuration that enforces good practices.

To enable this configuration use the extends property in your package.json.

{
	"name": "my-awesome-project",
	"eslintConfig": {
		"extends": "plugin:import-order/recommended",
		"plugins": [
			"import-order"
		]
	}
}

See ESLint documentation for more information about extending configuration files.

Note: This configuration will also enable the correct parser options and environment.

eslint-plugin-import-order's People

Contributors

Stargazers

Watchers

Forkers

duncanbeevers

eslint-plugin-import-order's Issues

Condense output

With the following:

var AvaError = require('./ava-error');
var debug = require('debug')('ava:watcher');
var diff = require('arr-diff');
var flatten = require('arr-flatten');
var union = require('array-union');
var uniq = require('array-uniq');
var defaultIgnore = require('ignore-by-default').directories();
var multimatch = require('multimatch');
var keypress = require('keypress');
var nodePath = require('path');
var slash = require('slash');

(source)

I currently get a lot of violations:

   4:13  error  `debug` import should occur before import of `./ava-error`              import-order/import-order
   5:12  error  `arr-diff` import should occur before import of `./ava-error`           import-order/import-order
   6:15  error  `arr-flatten` import should occur before import of `./ava-error`        import-order/import-order
   7:13  error  `array-union` import should occur before import of `./ava-error`        import-order/import-order
   8:12  error  `array-uniq` import should occur before import of `./ava-error`         import-order/import-order
   9:21  error  `ignore-by-default` import should occur before import of `./ava-error`  import-order/import-order
  10:18  error  `multimatch` import should occur before import of `./ava-error`         import-order/import-order
  11:16  error  `keypress` import should occur before import of `./ava-error`           import-order/import-order
  12:16  error  `path` import should occur before import of `./ava-error`               import-order/import-order
  13:13  error  `slash` import should occur before import of `./ava-error`              import-order/import-order

Here it should instead report that ./ava-error should be below slash.

Autofix

Would be so nice if this plugin supported autofixing.

Ignore imports without a variable

require('loud-rejection');

import 'loud-rejection';

These usually mutate some state and should allowed to be placed anywhere.

Publish new patch to npm for the latest REAME.md

The README that currently is available at npm is out of date with the master on this repository.

Most notably the rule is incorrect leading to the user getting the following error:

  1:1  error  Definition for rule 'import-order' was not found  import-order

Publishing a new version will avoid this confusion.

Documentation formatting.

It's a little off on mobile: https://www.dropbox.com/s/xvkkp7r32cfi56a/Screenshot_20160325-112210.png?dl=0

I recommend moving the code comments up to their own line.

Sort `import` and `require` independently

I sometimes have to use both import and require as require is less strict. Like achieving lazy requiring or requiring without a cache (for testing). I think they should be sorted independently as import should be at the top, which makes it hard to mix them.

Example: https://github.com/sindresorhus/atom-editorconfig/blob/0a32ee50684aa390d787ee5099cb11c31c94eedd/index.js#L4

Use options object for the config

Just in case you want to add more options in the future:

"import-order/import-order": [2, ["index", "sibling", "parent", "external", "builtin"]]

To:

"import-order/import-order": [2, {"order": ["index", "sibling", "parent", "external", "builtin"]}]

Enforce `import` at the top

According to the ES2015 spec the import keyword should always be at the top. Would be useful to have a rule to enforce this for early warning in the editor and for Babel, which doesn't seem to enforce it.