Eslint: autosort imports by path (#2603)

I was talking to mwiencek yesterday about wanting to sort imports by path (most plugins sort by import name) and I eventually found https://github.com/lydell/eslint-plugin-simple-import-sort/ which seems to do the trick fairly well. I added a custom sorting config so that we still sort same-folder imports last. It's based on one of their default examples, removing things that we don't seem to need. import/order is superseded by this (and could conflict depending on the configuration chosen) so I'm removing it.
metabrainz · Sep 14, 2022 · 30aff7b · 30aff7b
1 parent 3317389
commit 30aff7b
Show file tree

Hide file tree

Showing 339 changed files with 715 additions and 686 deletions.
diff --git a/.eslintrc.yaml b/.eslintrc.yaml
@@ -8,6 +8,7 @@ plugins:
   - flowtype
   - fb-flow
   - react-hooks
+  - simple-import-sort
 
 env:
   browser: true
@@ -214,7 +215,7 @@ rules:
   require-yield: error
   rest-spread-spacing: [warn, never]
   # sort-imports does not support Flow 'type' imports, so we use the
-  # import/order rule from eslint-plugin-import instead.
+  # imports rule from simple-import-sort instead.
   sort-imports: off
   template-curly-spacing: [warn, never]
 
@@ -230,7 +231,6 @@ rules:
   import/no-duplicates: warn
   import/no-dynamic-require: error
   import/no-unresolved: error
-  import/order: [warn, {newlines-between: always}]
 
   #######################
   # eslint-plugin-react #
@@ -357,3 +357,23 @@ rules:
 
   react-hooks/exhaustive-deps: error
   react-hooks/rules-of-hooks: error
+
+  ####################################
+  # eslint-plugin-simple-import-sort #
+  ####################################
+
+  simple-import-sort/imports: [warn, {groups: [
+      # Node.js builtins. You could also generate this regex if you use a `.js` config.
+      # For example: `^(${require("module").builtinModules.join("|")})(/|$)`
+      ["^(assert|buffer|child_process|cluster|console|constants|crypto|dgram|dns|domain|events|fs|http|https|module|net|os|path|punycode|querystring|readline|repl|stream|string_decoder|sys|timers|tls|tty|url|util|vm|zlib|freelist|v8|process|async_hooks|http2|perf_hooks)(/.*|$)"],
+      # Packages.
+      ["^@?\\w"],
+      # Side effect imports.
+      ["^\\u0000"],
+      # Parent imports. Put `..` last.
+      ["^\\.\\.(?!/?$)", "^\\.\\./?$"],
+      # Other relative imports. Put same-folder imports and `.` last.
+      ["^\\./(?=.*/)(?!/?$)", "^\\.(?!/?$)", "^\\./?$"],
+    ],
+  }]
+  simple-import-sort/exports: warn
diff --git a/package.json b/package.json
@@ -32,6 +32,7 @@
     "core-js": "3.6.5",
     "deep-freeze-strict": "1.1.1",
     "detect-node": "2.0.3",
+    "eslint-plugin-simple-import-sort": "^7.0.0",
     "fast-diff": "1.2.0",
     "filesize": "2.0.4",
     "generic-diff": "1.0.1",

diff --git a/root/account/EditProfile.js b/root/account/EditProfile.js
@@ -14,10 +14,10 @@ import UserAccountLayout, {
 } from '../components/UserAccountLayout.js';
 import {CatalystContext} from '../context.mjs';
 import * as manifest from '../static/manifest.mjs';
-import EditProfileForm
-  from '../static/scripts/account/components/EditProfileForm.js';
 import type {EditProfileFormPropsT}
   from '../static/scripts/account/components/EditProfileForm.js';
+import EditProfileForm
+  from '../static/scripts/account/components/EditProfileForm.js';
 
 const EditProfile = (
   props: EditProfileFormPropsT,

diff --git a/root/account/LostPassword.js b/root/account/LostPassword.js
@@ -13,9 +13,9 @@ import Layout from '../layout/index.js';
 import FormCsrfToken
   from '../static/scripts/edit/components/FormCsrfToken.js';
 import FormRow from '../static/scripts/edit/components/FormRow.js';
-import FormRowText from '../static/scripts/edit/components/FormRowText.js';
 import FormRowEmailLong
   from '../static/scripts/edit/components/FormRowEmailLong.js';
+import FormRowText from '../static/scripts/edit/components/FormRowText.js';
 import FormSubmit from '../static/scripts/edit/components/FormSubmit.js';
 
 type LostPasswordFormT = FormT<{

diff --git a/root/account/LostPasswordSent.js b/root/account/LostPasswordSent.js
@@ -9,8 +9,8 @@
 
 import * as React from 'react';
 
-import {CONTACT_URL} from '../constants.js';
 import StatusPage from '../components/StatusPage.js';
+import {CONTACT_URL} from '../constants.js';
 
 const LostPasswordSent = (): React.Element<typeof StatusPage> => (
   <StatusPage title={hyphenateTitle(l('Lost Password'), l('Email Sent!'))}>

diff --git a/root/account/LostUsernameSent.js b/root/account/LostUsernameSent.js
@@ -9,8 +9,8 @@
 
 import * as React from 'react';
 
-import {CONTACT_URL} from '../constants.js';
 import StatusPage from '../components/StatusPage.js';
+import {CONTACT_URL} from '../constants.js';
 
 const LostUsernameSent = (): React.Element<typeof StatusPage> => (
   <StatusPage title={hyphenateTitle(l('Lost Username'), l('Email Sent!'))}>

diff --git a/root/account/Preferences.js b/root/account/Preferences.js
@@ -13,11 +13,11 @@ import UserAccountLayout, {
   sanitizedAccountLayoutUser,
 } from '../components/UserAccountLayout.js';
 import {CatalystContext} from '../context.mjs';
-import PreferencesForm
-  from '../static/scripts/account/components/PreferencesForm.js';
+import * as manifest from '../static/manifest.mjs';
 import type {PreferencesFormPropsT}
   from '../static/scripts/account/components/PreferencesForm.js';
-import * as manifest from '../static/manifest.mjs';
+import PreferencesForm
+  from '../static/scripts/account/components/PreferencesForm.js';
 
 const Preferences = (
   props: PreferencesFormPropsT,

diff --git a/root/account/applications/Edit.js b/root/account/applications/Edit.js
@@ -10,10 +10,10 @@
 import * as React from 'react';
 
 import Layout from '../../layout/index.js';
-import ApplicationForm
-  from '../../static/scripts/account/components/ApplicationForm.js';
 import type {ApplicationFormT}
   from '../../static/scripts/account/components/ApplicationForm.js';
+import ApplicationForm
+  from '../../static/scripts/account/components/ApplicationForm.js';
 
 type Props = {
   +form: ApplicationFormT,

diff --git a/root/account/applications/Index.js b/root/account/applications/Index.js
@@ -9,10 +9,10 @@
 
 import * as React from 'react';
 
+import PaginatedResults from '../../components/PaginatedResults.js';
 import {ACCESS_SCOPE_PERMISSIONS} from '../../constants.js';
-import {compare} from '../../static/scripts/common/i18n.js';
 import Layout from '../../layout/index.js';
-import PaginatedResults from '../../components/PaginatedResults.js';
+import {compare} from '../../static/scripts/common/i18n.js';
 import {commaOnlyListText}
   from '../../static/scripts/common/i18n/commaOnlyList.js';
 import loopParity from '../../utility/loopParity.js';

diff --git a/root/account/applications/Register.js b/root/account/applications/Register.js
@@ -11,10 +11,10 @@ import * as React from 'react';
 
 import Layout from '../../layout/index.js';
 import * as manifest from '../../static/manifest.mjs';
-import ApplicationForm
-  from '../../static/scripts/account/components/ApplicationForm.js';
 import type {ApplicationFormT}
   from '../../static/scripts/account/components/ApplicationForm.js';
+import ApplicationForm
+  from '../../static/scripts/account/components/ApplicationForm.js';
 
 type Props = {
   +form: ApplicationFormT,

diff --git a/root/admin/EditBanner.js b/root/admin/EditBanner.js
@@ -9,12 +9,12 @@
 
 import * as React from 'react';
 
+import Layout from '../layout/index.js';
 import FormCsrfToken
   from '../static/scripts/edit/components/FormCsrfToken.js';
 import FormRowTextArea
   from '../static/scripts/edit/components/FormRowTextArea.js';
 import FormSubmit from '../static/scripts/edit/components/FormSubmit.js';
-import Layout from '../layout/index.js';
 
 type Props = {
   +form: ReadOnlyFormT<{

diff --git a/root/admin/EmailSearch.js b/root/admin/EmailSearch.js
@@ -9,10 +9,10 @@
 
 import * as React from 'react';
 
-import FormRowText from '../static/scripts/edit/components/FormRowText.js';
-import FormSubmit from '../static/scripts/edit/components/FormSubmit.js';
 import Layout from '../layout/index.js';
 import expand2react from '../static/scripts/common/i18n/expand2react.js';
+import FormRowText from '../static/scripts/edit/components/FormRowText.js';
+import FormSubmit from '../static/scripts/edit/components/FormSubmit.js';
 
 import UserList from './components/UserList.js';
 

diff --git a/root/admin/LockedUsernameSearch.js b/root/admin/LockedUsernameSearch.js
@@ -10,12 +10,12 @@
 import * as React from 'react';
 
 import Layout from '../layout/index.js';
+import expand2react from '../static/scripts/common/i18n/expand2react.js';
+import bracketed from '../static/scripts/common/utility/bracketed.js';
 import FormRowCheckbox
   from '../static/scripts/edit/components/FormRowCheckbox.js';
 import FormRowText from '../static/scripts/edit/components/FormRowText.js';
 import FormSubmit from '../static/scripts/edit/components/FormSubmit.js';
-import expand2react from '../static/scripts/common/i18n/expand2react.js';
-import bracketed from '../static/scripts/common/utility/bracketed.js';
 
 type Props = {
   +form: FormT<{

diff --git a/root/admin/LockedUsernameUnlock.js b/root/admin/LockedUsernameUnlock.js
@@ -10,10 +10,10 @@
 import * as React from 'react';
 
 import Layout from '../layout/index.js';
+import expand2text from '../static/scripts/common/i18n/expand2text.js';
 import FormCsrfToken
   from '../static/scripts/edit/components/FormCsrfToken.js';
 import FormSubmit from '../static/scripts/edit/components/FormSubmit.js';
-import expand2text from '../static/scripts/common/i18n/expand2text.js';
 
 type Props = {
   +form: SecureConfirmFormT,

diff --git a/root/admin/PrivilegeSearch.js b/root/admin/PrivilegeSearch.js
@@ -10,10 +10,10 @@
 import * as React from 'react';
 
 import PaginatedResults from '../components/PaginatedResults.js';
+import Layout from '../layout/index.js';
 import FormRowCheckbox
   from '../static/scripts/edit/components/FormRowCheckbox.js';
 import FormSubmit from '../static/scripts/edit/components/FormSubmit.js';
-import Layout from '../layout/index.js';
 
 import UserList from './components/UserList.js';
 

diff --git a/root/admin/wikidoc/WikiDocIndex.js b/root/admin/wikidoc/WikiDocIndex.js
@@ -10,9 +10,9 @@
 import * as React from 'react';
 import type {CellRenderProps} from 'react-table';
 
-import Layout from '../../layout/index.js';
 import Table from '../../components/Table.js';
 import {SanitizedCatalystContext} from '../../context.mjs';
+import Layout from '../../layout/index.js';
 import bracketed from '../../static/scripts/common/utility/bracketed.js';
 import {isWikiTranscluder}
   from '../../static/scripts/common/utility/privileges.js';

diff --git a/root/annotation/AnnotationComparison.js b/root/annotation/AnnotationComparison.js
@@ -13,7 +13,7 @@ import ENTITIES from '../../entities.mjs';
 import {SanitizedCatalystContext} from '../context.mjs';
 import EditorLink from '../static/scripts/common/components/EditorLink.js';
 import DiffSide from '../static/scripts/edit/components/edit/DiffSide.js';
-import {INSERT, DELETE} from '../static/scripts/edit/utility/editDiff.js';
+import {DELETE, INSERT} from '../static/scripts/edit/utility/editDiff.js';
 import chooseLayoutComponent from '../utility/chooseLayoutComponent.js';
 import formatUserDate from '../utility/formatUserDate.js';
 

diff --git a/root/annotation/AnnotationHistory.js b/root/annotation/AnnotationHistory.js
@@ -12,9 +12,9 @@ import * as React from 'react';
 import ENTITIES from '../../entities.mjs';
 import PaginatedResults from '../components/PaginatedResults.js';
 import * as manifest from '../static/manifest.mjs';
-import FormSubmit from '../static/scripts/edit/components/FormSubmit.js';
 import AnnotationHistoryTable
   from '../static/scripts/annotation/AnnotationHistoryTable.js';
+import FormSubmit from '../static/scripts/edit/components/FormSubmit.js';
 import chooseLayoutComponent from '../utility/chooseLayoutComponent.js';
 
 type AnnotationHistoryProps = {

diff --git a/root/annotation/EditAnnotation.js b/root/annotation/EditAnnotation.js
@@ -9,12 +9,12 @@
 
 import * as React from 'react';
 
-import FormRowText from '../static/scripts/edit/components/FormRowText.js';
-import FormRowTextArea
-  from '../static/scripts/edit/components/FormRowTextArea.js';
 import EnterEdit from '../static/scripts/edit/components/EnterEdit.js';
 import EnterEditNote
   from '../static/scripts/edit/components/EnterEditNote.js';
+import FormRowText from '../static/scripts/edit/components/FormRowText.js';
+import FormRowTextArea
+  from '../static/scripts/edit/components/FormRowTextArea.js';
 import chooseLayoutComponent from '../utility/chooseLayoutComponent.js';
 
 type EditAnnotationFormT = FormT<{

diff --git a/root/area/AreaHeader.js b/root/area/AreaHeader.js
@@ -9,11 +9,11 @@
 
 import * as React from 'react';
 
+import EntityHeader from '../components/EntityHeader.js';
 import AreaContainmentLink
   from '../static/scripts/common/components/AreaContainmentLink.js';
 import localizeTypeNameForEntity
   from '../static/scripts/common/i18n/localizeTypeNameForEntity.js';
-import EntityHeader from '../components/EntityHeader.js';
 
 type Props = {
   +area: AreaT,

diff --git a/root/area/AreaIndex.js b/root/area/AreaIndex.js
@@ -9,12 +9,12 @@
 
 import * as React from 'react';
 
+import * as manifest from '../static/manifest.mjs';
 import Annotation from '../static/scripts/common/components/Annotation.js';
 import Relationships
   from '../static/scripts/common/components/Relationships.js';
 import WikipediaExtract
   from '../static/scripts/common/components/WikipediaExtract.js';
-import * as manifest from '../static/manifest.mjs';
 
 import AreaLayout from './AreaLayout.js';
 

diff --git a/root/area/AreaLayout.js b/root/area/AreaLayout.js
@@ -9,8 +9,8 @@
 
 import * as React from 'react';
 
-import Layout from '../layout/index.js';
 import AreaSidebar from '../layout/components/sidebar/AreaSidebar.js';
+import Layout from '../layout/index.js';
 import localizeAreaName
   from '../static/scripts/common/i18n/localizeAreaName.js';
 

diff --git a/root/area/AreaMerge.js b/root/area/AreaMerge.js
@@ -9,14 +9,14 @@
 
 import * as React from 'react';
 
-import sortByEntityName
-  from '../static/scripts/common/utility/sortByEntityName.js';
-import FieldErrors from '../static/scripts/edit/components/FieldErrors.js';
 import AreaList from '../components/list/AreaList.js';
 import Layout from '../layout/index.js';
+import sortByEntityName
+  from '../static/scripts/common/utility/sortByEntityName.js';
 import EnterEdit from '../static/scripts/edit/components/EnterEdit.js';
 import EnterEditNote
   from '../static/scripts/edit/components/EnterEditNote.js';
+import FieldErrors from '../static/scripts/edit/components/FieldErrors.js';
 
 type Props = {
   +form: MergeFormT,

diff --git a/root/artist/ArtistIndex.js b/root/artist/ArtistIndex.js
@@ -9,6 +9,12 @@
 
 import * as React from 'react';
 
+import RecordingList from '../components/list/RecordingList.js';
+import ReleaseGroupList from '../components/list/ReleaseGroupList.js';
+import PaginatedResults from '../components/PaginatedResults.js';
+import RelatedEntitiesDisplay from '../components/RelatedEntitiesDisplay.js';
+import {SanitizedCatalystContext} from '../context.mjs';
+import * as manifest from '../static/manifest.mjs';
 import Annotation from '../static/scripts/common/components/Annotation.js';
 import DescriptiveLink
   from '../static/scripts/common/components/DescriptiveLink.js';
@@ -20,14 +26,8 @@ import WikipediaExtract
 import commaOnlyList, {commaOnlyListText}
   from '../static/scripts/common/i18n/commaOnlyList.js';
 import {bracketedText} from '../static/scripts/common/utility/bracketed.js';
-import FormSubmit from '../static/scripts/edit/components/FormSubmit.js';
-import RecordingList from '../components/list/RecordingList.js';
-import ReleaseGroupList from '../components/list/ReleaseGroupList.js';
-import PaginatedResults from '../components/PaginatedResults.js';
-import RelatedEntitiesDisplay from '../components/RelatedEntitiesDisplay.js';
-import {SanitizedCatalystContext} from '../context.mjs';
-import * as manifest from '../static/manifest.mjs';
 import entityHref from '../static/scripts/common/utility/entityHref.js';
+import FormSubmit from '../static/scripts/edit/components/FormSubmit.js';
 import {returnToCurrentPage} from '../utility/returnUri.js';
 
 import ArtistLayout from './ArtistLayout.js';

diff --git a/root/artist/ArtistLayout.js b/root/artist/ArtistLayout.js
@@ -9,8 +9,8 @@
 
 import * as React from 'react';
 
-import Layout from '../layout/index.js';
 import ArtistSidebar from '../layout/components/sidebar/ArtistSidebar.js';
+import Layout from '../layout/index.js';
 
 import ArtistHeader from './ArtistHeader.js';
 

diff --git a/root/artist/ArtistMerge.js b/root/artist/ArtistMerge.js
@@ -13,12 +13,12 @@ import ArtistList from '../components/list/ArtistList.js';
 import Layout from '../layout/index.js';
 import sortByEntityName
   from '../static/scripts/common/utility/sortByEntityName.js';
-import FieldErrors from '../static/scripts/edit/components/FieldErrors.js';
-import FormRowCheckbox
-  from '../static/scripts/edit/components/FormRowCheckbox.js';
 import EnterEdit from '../static/scripts/edit/components/EnterEdit.js';
 import EnterEditNote
   from '../static/scripts/edit/components/EnterEditNote.js';
+import FieldErrors from '../static/scripts/edit/components/FieldErrors.js';
+import FormRowCheckbox
+  from '../static/scripts/edit/components/FormRowCheckbox.js';
 
 type Props = {
   +form: MergeFormT,

diff --git a/root/artist/ArtistRecordings.js b/root/artist/ArtistRecordings.js
@@ -9,14 +9,14 @@
 
 import * as React from 'react';
 
-import FormSubmit from '../static/scripts/edit/components/FormSubmit.js';
 import RecordingList from '../components/list/RecordingList.js';
 import PaginatedResults from '../components/PaginatedResults.js';
 import {SanitizedCatalystContext} from '../context.mjs';
 import Filter from '../static/scripts/common/components/Filter.js';
 import {type FilterFormT}
   from '../static/scripts/common/components/FilterForm.js';
 import bracketed from '../static/scripts/common/utility/bracketed.js';
+import FormSubmit from '../static/scripts/edit/components/FormSubmit.js';
 import {returnToCurrentPage} from '../utility/returnUri.js';
 
 import ArtistLayout from './ArtistLayout.js';