Use 'eslint-plugin-simple-import-sort' to sort imports (#3446)

Author: IvanGoncharov

.eslintrc.yml

@@ -9,6 +9,7 @@ plugins:
   - internal-rules
   - node
   - import
+  - simple-import-sort
 settings:
   node:
     tryExtensions: ['.js', '.json', '.node', '.ts', '.d.ts']
@@ -140,6 +141,38 @@ rules:
   import/group-exports: off
   import/dynamic-import-chunkname: off
 
+  ##############################################################################
+  # `eslint-plugin-simple-import-sort` rule list based on `v2.25.x`
+  # https://github.com/lydell/eslint-plugin-simple-import-sort
+  ##############################################################################
+  simple-import-sort/imports:
+    - error
+    - groups:
+        # Packages.
+        # Things that start with a letter (or digit or underscore), or `@` followed by a letter.
+        - ["^@?\\w"]
+
+        # General utilities
+        - ["^(\\./|(\\.\\./)+)__testUtils__/"]
+        - ["^(\\./|(\\.\\./)+)jsutils/"]
+
+        # Top-level directories
+        - ["^(\\./|(\\.\\./)+)error/"]
+        - ["^(\\./|(\\.\\./)+)language/"]
+        - ["^(\\./|(\\.\\./)+)type/"]
+        - ["^(\\./|(\\.\\./)+)validation/"]
+        - ["^(\\./|(\\.\\./)+)execution/"]
+        - ["^(\\./|(\\.\\./)+)utilities/"]
+
+        # Relative imports.
+        # Anything that starts with a dot.
+        - ["^(\\.\\./){4,}"]
+        - ["^(\\.\\./){3}"]
+        - ["^(\\.\\./){2}"]
+        - ["^(\\.\\./){1}"]
+        - ["^\\./"]
+  simple-import-sort/exports: off # TODO
+
   ##############################################################################
   # ESLint builtin rules list based on `v8.5.x`
   ##############################################################################

package-lock.json

@@ -67,6 +67,7 @@
     "eslint-plugin-import": "2.25.3",
     "eslint-plugin-internal-rules": "file:./resources/eslint-internal-rules",
     "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-simple-import-sort": "7.0.0",
     "eslint-plugin-tsdoc": "0.2.14",
     "mocha": "9.1.3",
     "prettier": "2.5.1",

package.json

@@ -1,7 +1,7 @@
 import { expect } from 'chai';
 
-import { mapValue } from '../jsutils/mapValue';
 import { isObjectLike } from '../jsutils/isObjectLike';
+import { mapValue } from '../jsutils/mapValue';
 
 /**
  * Deeply transforms an arbitrary value to a JSON-safe value by calling toJSON

src/__testUtils__/expectJSON.ts

@@ -1,14 +1,14 @@
-import { GraphQLSchema } from '../type/schema';
-import { GraphQLString } from '../type/scalars';
 import {
-  GraphQLList,
-  GraphQLNonNull,
   GraphQLEnumType,
   GraphQLInterfaceType,
+  GraphQLList,
+  GraphQLNonNull,
   GraphQLObjectType,
 } from '../type/definition';
+import { GraphQLString } from '../type/scalars';
+import { GraphQLSchema } from '../type/schema';
 
-import { getFriends, getHero, getHuman, getDroid } from './starWarsData';
+import { getDroid, getFriends, getHero, getHuman } from './starWarsData';
 
 /**
  * This is designed to be an end-to-end test, demonstrating

src/__tests__/starWarsSchema.ts

@@ -2,10 +2,10 @@ import { isObjectLike } from '../jsutils/isObjectLike';
 import type { Maybe } from '../jsutils/Maybe';
 
 import type { ASTNode, Location } from '../language/ast';
-import type { Source } from '../language/source';
 import type { SourceLocation } from '../language/location';
 import { getLocation } from '../language/location';
 import { printLocation, printSourceLocation } from '../language/printLocation';
+import type { Source } from '../language/source';
 
 /**
  * Custom extensions

src/error/GraphQLError.ts

@@ -9,7 +9,7 @@ import { Kind } from '../../language/kinds';
 import { parse } from '../../language/parser';
 import { Source } from '../../language/source';
 
-import { GraphQLError, printError, formatError } from '../GraphQLError';
+import { formatError, GraphQLError, printError } from '../GraphQLError';
 
 const source = new Source(dedent`
   {

src/error/__tests__/GraphQLError-test.ts

@@ -5,19 +5,19 @@ import { expectJSON } from '../../__testUtils__/expectJSON';
 
 import { parse } from '../../language/parser';
 
-import { GraphQLSchema } from '../../type/schema';
-import { GraphQLString, GraphQLBoolean } from '../../type/scalars';
 import {
   assertInterfaceType,
+  GraphQLInterfaceType,
   GraphQLList,
   GraphQLObjectType,
-  GraphQLInterfaceType,
   GraphQLUnionType,
 } from '../../type/definition';
+import { GraphQLBoolean, GraphQLString } from '../../type/scalars';
+import { GraphQLSchema } from '../../type/schema';
 
 import { buildSchema } from '../../utilities/buildASTSchema';
 
-import { executeSync, execute } from '../execute';
+import { execute, executeSync } from '../execute';
 
 async function executeQuery(args: {
   schema: GraphQLSchema;

src/execution/__tests__/abstract-test.ts

@@ -3,9 +3,9 @@ import { describe, it } from 'mocha';
 
 import { parse } from '../../language/parser';
 
-import { GraphQLSchema } from '../../type/schema';
-import { GraphQLString } from '../../type/scalars';
 import { GraphQLObjectType } from '../../type/definition';
+import { GraphQLString } from '../../type/scalars';
+import { GraphQLSchema } from '../../type/schema';
 
 import { executeSync } from '../execute';
 

src/execution/__tests__/directives-test.ts

@@ -9,16 +9,16 @@ import { invariant } from '../../jsutils/invariant';
 import { Kind } from '../../language/kinds';
 import { parse } from '../../language/parser';
 
-import { GraphQLSchema } from '../../type/schema';
-import { GraphQLInt, GraphQLBoolean, GraphQLString } from '../../type/scalars';
 import {
+  GraphQLInterfaceType,
   GraphQLList,
   GraphQLNonNull,
-  GraphQLScalarType,
-  GraphQLInterfaceType,
   GraphQLObjectType,
+  GraphQLScalarType,
   GraphQLUnionType,
 } from '../../type/definition';
+import { GraphQLBoolean, GraphQLInt, GraphQLString } from '../../type/scalars';
+import { GraphQLSchema } from '../../type/schema';
 
 import { execute, executeSync } from '../execute';
 

src/execution/__tests__/executor-test.ts

@@ -2,14 +2,13 @@ import { expect } from 'chai';
 import { describe, it } from 'mocha';
 
 import { expectJSON } from '../../__testUtils__/expectJSON';
-
 import { resolveOnNextTick } from '../../__testUtils__/resolveOnNextTick';
 
 import { parse } from '../../language/parser';
 
+import { GraphQLObjectType } from '../../type/definition';
 import { GraphQLInt } from '../../type/scalars';
 import { GraphQLSchema } from '../../type/schema';
-import { GraphQLObjectType } from '../../type/definition';
 
 import { execute, executeSync } from '../execute';
 

src/execution/__tests__/mutations-test.ts

@@ -5,9 +5,9 @@ import { expectJSON } from '../../__testUtils__/expectJSON';
 
 import { parse } from '../../language/parser';
 
-import { GraphQLSchema } from '../../type/schema';
-import { GraphQLString } from '../../type/scalars';
 import { GraphQLNonNull, GraphQLObjectType } from '../../type/definition';
+import { GraphQLString } from '../../type/scalars';
+import { GraphQLSchema } from '../../type/schema';
 
 import { buildSchema } from '../../utilities/buildASTSchema';
 

src/execution/__tests__/nonnull-test.ts

@@ -4,9 +4,9 @@ import { describe, it } from 'mocha';
 import { parse } from '../../language/parser';
 
 import type { GraphQLFieldConfig } from '../../type/definition';
-import { GraphQLSchema } from '../../type/schema';
-import { GraphQLInt, GraphQLString } from '../../type/scalars';
 import { GraphQLObjectType } from '../../type/definition';
+import { GraphQLInt, GraphQLString } from '../../type/scalars';
+import { GraphQLSchema } from '../../type/schema';
 
 import { executeSync } from '../execute';
 

src/execution/__tests__/resolve-test.ts

@@ -3,18 +3,18 @@ import { describe, it } from 'mocha';
 
 import { parse } from '../../language/parser';
 
-import { GraphQLSchema } from '../../type/schema';
 import {
   GraphQLList,
   GraphQLNonNull,
   GraphQLObjectType,
 } from '../../type/definition';
 import {
+  GraphQLBoolean,
   GraphQLID,
   GraphQLInt,
   GraphQLString,
-  GraphQLBoolean,
 } from '../../type/scalars';
+import { GraphQLSchema } from '../../type/schema';
 
 import { executeSync } from '../execute';
 

src/execution/__tests__/schema-test.ts

@@ -9,9 +9,9 @@ import { isAsyncIterable } from '../../jsutils/isAsyncIterable';
 
 import { parse } from '../../language/parser';
 
-import { GraphQLSchema } from '../../type/schema';
 import { GraphQLList, GraphQLObjectType } from '../../type/definition';
-import { GraphQLInt, GraphQLString, GraphQLBoolean } from '../../type/scalars';
+import { GraphQLBoolean, GraphQLInt, GraphQLString } from '../../type/scalars';
+import { GraphQLSchema } from '../../type/schema';
 
 import { createSourceEventStream, subscribe } from '../subscribe';
 

src/execution/__tests__/subscribe-test.ts

@@ -5,11 +5,11 @@ import { expectJSON } from '../../__testUtils__/expectJSON';
 
 import { parse } from '../../language/parser';
 
-import { validate } from '../../validation/validate';
-
-import { GraphQLSchema } from '../../type/schema';
-import { GraphQLString } from '../../type/scalars';
 import { GraphQLObjectType } from '../../type/definition';
+import { GraphQLString } from '../../type/scalars';
+import { GraphQLSchema } from '../../type/schema';
+
+import { validate } from '../../validation/validate';
 
 import { graphqlSync } from '../../graphql';
 

src/execution/__tests__/sync-test.ts

@@ -3,14 +3,14 @@ import { describe, it } from 'mocha';
 
 import { parse } from '../../language/parser';
 
-import { GraphQLSchema } from '../../type/schema';
-import { GraphQLString, GraphQLBoolean } from '../../type/scalars';
 import {
+  GraphQLInterfaceType,
   GraphQLList,
-  GraphQLUnionType,
   GraphQLObjectType,
-  GraphQLInterfaceType,
+  GraphQLUnionType,
 } from '../../type/definition';
+import { GraphQLBoolean, GraphQLString } from '../../type/scalars';
+import { GraphQLSchema } from '../../type/schema';
 
 import { executeSync } from '../execute';
 

src/execution/__tests__/union-interface-test.ts

@@ -10,19 +10,19 @@ import { Kind } from '../../language/kinds';
 import { parse } from '../../language/parser';
 
 import type {
-  GraphQLFieldConfig,
   GraphQLArgumentConfig,
+  GraphQLFieldConfig,
 } from '../../type/definition';
-import { GraphQLSchema } from '../../type/schema';
-import { GraphQLString } from '../../type/scalars';
 import {
+  GraphQLEnumType,
+  GraphQLInputObjectType,
   GraphQLList,
   GraphQLNonNull,
-  GraphQLScalarType,
   GraphQLObjectType,
-  GraphQLInputObjectType,
-  GraphQLEnumType,
+  GraphQLScalarType,
 } from '../../type/definition';
+import { GraphQLString } from '../../type/scalars';
+import { GraphQLSchema } from '../../type/schema';
 
 import { executeSync } from '../execute';
 import { getVariableValues } from '../values';

src/execution/__tests__/variables-test.ts

@@ -1,21 +1,21 @@
 import type { ObjMap } from '../jsutils/ObjMap';
 
 import type {
-  SelectionSetNode,
   FieldNode,
+  FragmentDefinitionNode,
   FragmentSpreadNode,
   InlineFragmentNode,
-  FragmentDefinitionNode,
+  SelectionSetNode,
 } from '../language/ast';
 import { Kind } from '../language/kinds';
 
-import type { GraphQLSchema } from '../type/schema';
 import type { GraphQLObjectType } from '../type/definition';
+import { isAbstractType } from '../type/definition';
 import {
   GraphQLIncludeDirective,
   GraphQLSkipDirective,
 } from '../type/directives';
-import { isAbstractType } from '../type/definition';
+import type { GraphQLSchema } from '../type/schema';
 
 import { typeFromAST } from '../utilities/typeFromAST';