Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(js): add lint rules for import order: eslint-plugin-simple-import-sort #6028

Closed
wants to merge 2 commits into from
Closed

chore(js): add lint rules for import order: eslint-plugin-simple-import-sort #6028

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8725e88
refactor(js): add import order linting
IanLondon Jun 29, 2020
10098ec
explicit side-effect import for failing mocks
IanLondon Jun 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions app/src/calibration/epic/__tests__/fetchCalibrationStatusEpic.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// @flow
import '../../../robot-api/__utils__/epic-test-mocks'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't say I'm a fan of this. "Import the mock before you import the code under test" is my preferred way to do this, which is how things were ordered before

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what you mean, isn't this importing the mocks before any other imports?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is, but we only need it because this plugin arbitrarily put them out of order in the first place. The "after" here seems arbitrary and (as noted in my other comment) not what the plugin is supposed to do

// before re-ordering
// import mocks
import { setupEpicTestMocks, runEpicTest } from '../../../robot-api/__utils__'
// import other stuff
import * as Fixtures from '../../__fixtures__'
import * as Actions from '../../actions'
// import code under test
import { calibrationEpic } from '..'
// after re-ordering
// import mocks but only for their `jest.mock` side effects
import '../../../robot-api/__utils__/epic-test-mocks'
// import code under test
import { calibrationEpic } from '..'
// import mocks and other stuff
import * as Fixtures from '../../__fixtures__'
import { runEpicTest, setupEpicTestMocks } from '../../../robot-api/__utils__'
import * as Actions from '../../actions'


import { calibrationEpic } from '..'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to the documentation of the plugin:

Since “.” sorts before “/”, relative imports of files higher up in the directory structure come before closer ones – "../../utils" comes before "../utils". Perhaps surprisingly though, ".." would come before "../../utils" (since shorter substrings sort before longer strings). For that reason there’s one addition to the alphabetical rule: "." and ".." are treated as "./" and "../".

This seems to be the exact opposite of what has happened in this file, which is confusing to me

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

confuses me too!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

me three

import * as Fixtures from '../../__fixtures__'
import { runEpicTest, setupEpicTestMocks } from '../../../robot-api/__utils__'
Expand Down
2 changes: 2 additions & 0 deletions app/src/networking/epic/__tests__/disconnectEpic.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// @flow
import '../../../robot-api/__utils__/epic-test-mocks'

import { networkingEpic } from '..'
import * as Fixtures from '../../__fixtures__'
import { runEpicTest, setupEpicTestMocks } from '../../../robot-api/__utils__'
Expand Down
2 changes: 2 additions & 0 deletions app/src/networking/epic/__tests__/fetchEapOptionsEpic.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// @flow
import '../../../robot-api/__utils__/epic-test-mocks'

import { networkingEpic } from '..'
import * as Fixtures from '../../__fixtures__'
import { runEpicTest, setupEpicTestMocks } from '../../../robot-api/__utils__'
Expand Down
2 changes: 2 additions & 0 deletions app/src/networking/epic/__tests__/fetchWifiKeysEpic.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// @flow
import '../../../robot-api/__utils__/epic-test-mocks'

import { networkingEpic } from '..'
import * as Fixtures from '../../__fixtures__'
import { runEpicTest, setupEpicTestMocks } from '../../../robot-api/__utils__'
Expand Down
2 changes: 2 additions & 0 deletions app/src/networking/epic/__tests__/postWifiKeysEpic.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// @flow
import '../../../robot-api/__utils__/epic-test-mocks'

import { networkingEpic } from '..'
import * as Fixtures from '../../__fixtures__'
import { runEpicTest, setupEpicTestMocks } from '../../../robot-api/__utils__'
Expand Down
2 changes: 2 additions & 0 deletions app/src/networking/epic/__tests__/statusEpic.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// @flow
import '../../../robot-api/__utils__/epic-test-mocks'

import { networkingEpic } from '..'
import * as Fixtures from '../../__fixtures__'
import { runEpicTest, setupEpicTestMocks } from '../../../robot-api/__utils__'
Expand Down
2 changes: 2 additions & 0 deletions app/src/networking/epic/__tests__/wifiConfigureEpic.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// @flow
import '../../../robot-api/__utils__/epic-test-mocks'

import { networkingEpic } from '..'
import * as Fixtures from '../../__fixtures__'
import * as Discovery from '../../../discovery'
Expand Down
2 changes: 2 additions & 0 deletions app/src/networking/epic/__tests__/wifiListEpic.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// @flow
import '../../../robot-api/__utils__/epic-test-mocks'

import { networkingEpic } from '..'
import * as Fixtures from '../../__fixtures__'
import { runEpicTest, setupEpicTestMocks } from '../../../robot-api/__utils__'
Expand Down
2 changes: 2 additions & 0 deletions app/src/sessions/epic/__tests__/createSessionEpic.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// @flow
import '../../../robot-api/__utils__/epic-test-mocks'

import { sessionsEpic } from '..'
import * as Fixtures from '../../__fixtures__'
import { runEpicTest, setupEpicTestMocks } from '../../../robot-api/__utils__'
Expand Down
2 changes: 2 additions & 0 deletions app/src/sessions/epic/__tests__/deleteSessionEpic.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// @flow
import '../../../robot-api/__utils__/epic-test-mocks'

import { sessionsEpic } from '..'
import * as Fixtures from '../../__fixtures__'
import { runEpicTest, setupEpicTestMocks } from '../../../robot-api/__utils__'
Expand Down
2 changes: 2 additions & 0 deletions app/src/sessions/epic/__tests__/ensureSessionEpic.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// @flow
import '../../../robot-api/__utils__/epic-test-mocks'

import { sessionsEpic } from '..'
import * as Fixtures from '../../__fixtures__'
import { runEpicTest, setupEpicTestMocks } from '../../../robot-api/__utils__'
Expand Down
2 changes: 2 additions & 0 deletions app/src/sessions/epic/__tests__/fetchAllSessionsEpic.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// @flow
import '../../../robot-api/__utils__/epic-test-mocks'

import { sessionsEpic } from '..'
import * as Fixtures from '../../__fixtures__'
import { mockRobot } from '../../../robot-api/__fixtures__'
Expand Down
2 changes: 2 additions & 0 deletions app/src/sessions/epic/__tests__/fetchAllSessionsOnConnectEpic.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// @flow
import '../../../robot-api/__utils__/epic-test-mocks'

import { TestScheduler } from 'rxjs/testing'

import * as DiscoverySelectors from '../../../discovery/selectors'
Expand Down
2 changes: 2 additions & 0 deletions app/src/sessions/epic/__tests__/fetchSessionEpic.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// @flow
import '../../../robot-api/__utils__/epic-test-mocks'

import { sessionsEpic } from '..'
import * as Fixtures from '../../__fixtures__'
import { mockRobot } from '../../../robot-api/__fixtures__'
Expand Down
2 changes: 2 additions & 0 deletions app/src/sessions/epic/createSessionCommandEpic.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// @flow
import '../../robot-api/__utils__/epic-test-mocks'

import { ofType } from 'redux-observable'
import { of } from 'rxjs'
import { map, switchMap } from 'rxjs/operators'
Expand Down