build: organize imports in ts and spec files with prettier (#404)

# Motivation To ease the review of PR and to improve our DX, automatically organize and sort the `import` # Changes - add [prettier-plugin-organize-imports](https://github.com/simonhaenisch/prettier-plugin-organize-imports) # Note - the plugin does not organize imports in `.svelte` [yet](simonhaenisch/prettier-plugin-organize-imports#39) but will do so in all other files (all `.ts` and `.spec.ts` files)
dfinity · Feb 7, 2022 · ddd1999 · ddd1999
1 parent 5ab91aa
commit ddd1999
Show file tree

Hide file tree

Showing 22 changed files with 54 additions and 37 deletions.
diff --git a/frontend/svelte/package-lock.json b/frontend/svelte/package-lock.json
diff --git a/frontend/svelte/package.json b/frontend/svelte/package.json
@@ -30,6 +30,7 @@
     "postcss": "^8.4.5",
     "postcss-load-config": "^3.1.1",
     "prettier": "^2.5.0",
+    "prettier-plugin-organize-imports": "^2.3.4",
     "prettier-plugin-svelte": "^2.5.0",
     "rollup": "^2.3.4",
     "rollup-plugin-css-only": "^3.1.0",

diff --git a/frontend/svelte/rollup.config.js b/frontend/svelte/rollup.config.js
@@ -1,14 +1,14 @@
-import svelte from "rollup-plugin-svelte";
 import commonjs from "@rollup/plugin-commonjs";
+import inject from "@rollup/plugin-inject";
+import json from "@rollup/plugin-json";
 import resolve from "@rollup/plugin-node-resolve";
-import livereload from "rollup-plugin-livereload";
-import { terser } from "rollup-plugin-terser";
-import sveltePreprocess from "svelte-preprocess";
 import replace from "@rollup/plugin-replace";
 import typescript from "@rollup/plugin-typescript";
 import css from "rollup-plugin-css-only";
-import inject from "@rollup/plugin-inject";
-import json from "@rollup/plugin-json";
+import livereload from "rollup-plugin-livereload";
+import svelte from "rollup-plugin-svelte";
+import { terser } from "rollup-plugin-terser";
+import sveltePreprocess from "svelte-preprocess";
 
 const production = !process.env.ROLLUP_WATCH;
 

diff --git a/frontend/svelte/scripts/i18n.types.mjs b/frontend/svelte/scripts/i18n.types.mjs
@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
-import en from "../src/lib/i18n/en.json";
-import prettier from "prettier";
 import { writeFileSync } from "fs";
+import prettier from "prettier";
+import en from "../src/lib/i18n/en.json";
 
 /**
  * Generate the TypeScript interfaces from the english translation file.

diff --git a/frontend/svelte/src/lib/stores/auth.store.ts b/frontend/svelte/src/lib/stores/auth.store.ts
@@ -1,6 +1,6 @@
-import { writable } from "svelte/store";
 import { AuthClient } from "@dfinity/auth-client";
 import type { Principal } from "@dfinity/principal";
+import { writable } from "svelte/store";
 
 export interface AuthStore {
   principal: Principal | undefined | null;

diff --git a/frontend/svelte/src/lib/stores/i18n.ts b/frontend/svelte/src/lib/stores/i18n.ts
@@ -1,5 +1,4 @@
 import { readable } from "svelte/store";
-
 import en from "../i18n/en.json";
 
 export const i18n = readable<I18n>({

diff --git a/frontend/svelte/src/lib/utils/accounts.utils.ts b/frontend/svelte/src/lib/utils/accounts.utils.ts
@@ -1,5 +1,5 @@
-import type { Principal } from "@dfinity/principal";
 import { AccountIdentifier, ICP, LedgerCanister } from "@dfinity/nns";
+import type { Principal } from "@dfinity/principal";
 import type { AccountsStore } from "../stores/accounts.store";
 
 export const loadAccounts = async ({

diff --git a/frontend/svelte/src/tests/App.spec.ts b/frontend/svelte/src/tests/App.spec.ts
@@ -2,16 +2,16 @@
  * @jest-environment jsdom
  */
 
+import type { Principal } from "@dfinity/principal";
+import { render, waitFor } from "@testing-library/svelte";
+import App from "../App.svelte";
+import { accountsStore } from "../lib/stores/accounts.store";
 import { AuthStore, authStore } from "../lib/stores/auth.store";
 import {
   authStoreMock,
   mockPrincipal,
   mutableMockAuthStoreSubscribe,
 } from "./mocks/auth.store.mock";
-import { accountsStore } from "../lib/stores/accounts.store";
-import { render, waitFor } from "@testing-library/svelte";
-import App from "../App.svelte";
-import type { Principal } from "@dfinity/principal";
 
 describe("App", () => {
   let accountsStoreMock;

diff --git a/frontend/svelte/src/tests/lib/components/accounts/AccountCard.spec.ts b/frontend/svelte/src/tests/lib/components/accounts/AccountCard.spec.ts
@@ -2,11 +2,11 @@
  * @jest-environment jsdom
  */
 
-import type { Account } from "../../../../lib/types/account";
-import { mockMainAccount } from "../../../mocks/accounts.store.mock";
 import { render } from "@testing-library/svelte";
 import AccountCard from "../../../../lib/components/accounts/AccountCard.svelte";
+import type { Account } from "../../../../lib/types/account";
 import { formatICP } from "../../../../lib/utils/icp.utils";
+import { mockMainAccount } from "../../../mocks/accounts.store.mock";
 
 describe("AccountCard", () => {
   const props: { account: Account } = { account: mockMainAccount };

diff --git a/frontend/svelte/src/tests/lib/components/common/Guard.spec.ts b/frontend/svelte/src/tests/lib/components/common/Guard.spec.ts
@@ -2,9 +2,9 @@
  * @jest-environment jsdom
  */
 
-import { authStore } from "../../../../lib/stores/auth.store";
 import { render } from "@testing-library/svelte";
 import Guard from "../../../../lib/components/common/Guard.svelte";
+import { authStore } from "../../../../lib/stores/auth.store";
 
 describe("Guard", () => {
   it("should render a spinner while loading", () => {

diff --git a/frontend/svelte/src/tests/lib/components/ic/ICP.spec.ts b/frontend/svelte/src/tests/lib/components/ic/ICP.spec.ts
@@ -2,11 +2,11 @@
  * @jest-environment jsdom
  */
 
-import { mockMainAccount } from "../../../mocks/accounts.store.mock";
 import type { ICP as ICPModel } from "@dfinity/nns";
 import { render } from "@testing-library/svelte";
-import { formatICP } from "../../../../lib/utils/icp.utils";
 import ICP from "../../../../lib/components/ic/ICP.svelte";
+import { formatICP } from "../../../../lib/utils/icp.utils";
+import { mockMainAccount } from "../../../mocks/accounts.store.mock";
 
 describe("ICP", () => {
   const props: { icp: ICPModel } = { icp: mockMainAccount.balance };

diff --git a/frontend/svelte/src/tests/lib/components/ui/Toast.spec.ts b/frontend/svelte/src/tests/lib/components/ui/Toast.spec.ts
@@ -2,8 +2,8 @@
  * @jest-environment jsdom
  */
 
-import Toast from "../../../../lib/components/ui/Toast.svelte";
 import { render } from "@testing-library/svelte";
+import Toast from "../../../../lib/components/ui/Toast.svelte";
 import type { ToastMsg } from "../../../../lib/stores/toasts.store";
 
 describe("Toast", () => {

diff --git a/frontend/svelte/src/tests/lib/modals/VotingFilterModal.spec.ts b/frontend/svelte/src/tests/lib/modals/VotingFilterModal.spec.ts
@@ -2,9 +2,9 @@
  * @jest-environment jsdom
  */
 
-import { Topics, VotingFilterModalProps } from "../../../lib/types/voting";
 import { fireEvent, render } from "@testing-library/svelte";
 import VotingFilterModal from "../../../lib/modals/VotingFilterModal.svelte";
+import { Topics, VotingFilterModalProps } from "../../../lib/types/voting";
 
 const en = require("../../../lib/i18n/en.json");
 

diff --git a/frontend/svelte/src/tests/lib/stores/auth.store.spec.ts b/frontend/svelte/src/tests/lib/stores/auth.store.spec.ts
@@ -1,7 +1,7 @@
-import { AuthClient } from "@dfinity/auth-client";
 import type { Identity } from "@dfinity/agent";
-import { mockPrincipal } from "../../mocks/auth.store.mock";
+import { AuthClient } from "@dfinity/auth-client";
 import { authStore } from "../../../lib/stores/auth.store";
+import { mockPrincipal } from "../../mocks/auth.store.mock";
 
 class MockAuthClient extends AuthClient {
   constructor() {

diff --git a/frontend/svelte/src/tests/lib/utils/accounts.utils.spec.ts b/frontend/svelte/src/tests/lib/utils/accounts.utils.spec.ts
@@ -1,5 +1,5 @@
-import { AccountIdentifier, LedgerCanister } from "@dfinity/nns";
 import type { ICP } from "@dfinity/nns";
+import { AccountIdentifier, LedgerCanister } from "@dfinity/nns";
 import { loadAccounts } from "../../../lib/utils/accounts.utils";
 import { mockPrincipal } from "../../mocks/auth.store.mock";
 

diff --git a/frontend/svelte/src/tests/lib/utils/auth.utils.spec.ts b/frontend/svelte/src/tests/lib/utils/auth.utils.spec.ts
@@ -1,6 +1,6 @@
+import type { Principal } from "@dfinity/principal";
 import { isSignedIn } from "../../../lib/utils/auth.utils";
 import { mockPrincipal } from "../../mocks/auth.store.mock";
-import type { Principal } from "@dfinity/principal";
 
 describe("auth-utils", () => {
   it("should not be signed in", () => {

diff --git a/frontend/svelte/src/tests/lib/utils/route.utils.spec.ts b/frontend/svelte/src/tests/lib/utils/route.utils.spec.ts
@@ -2,14 +2,14 @@
  * @jest-environment jsdom
  */
 
+import * as routeUtils from "../../../lib/utils/route.utils";
 import {
   baseHref,
   pushHistory,
   replaceHistory,
   routeContext,
   routePath,
 } from "../../../lib/utils/route.utils";
-import * as routeUtils from "../../../lib/utils/route.utils";
 
 describe("route-utils", () => {
   describe("base href", () => {

diff --git a/frontend/svelte/src/tests/mocks/accounts.store.mock.ts b/frontend/svelte/src/tests/mocks/accounts.store.mock.ts
@@ -1,7 +1,7 @@
+import { ICP } from "@dfinity/nns";
 import type { Subscriber } from "svelte/store";
 import type { AccountsStore } from "../../lib/stores/accounts.store";
 import type { Account } from "../../lib/types/account";
-import { ICP } from "@dfinity/nns";
 
 export const mockMainAccount: Account = {
   identifier:

diff --git a/frontend/svelte/src/tests/mocks/auth.store.mock.ts b/frontend/svelte/src/tests/mocks/auth.store.mock.ts
@@ -1,6 +1,6 @@
+import { Principal } from "@dfinity/principal";
 import type { Subscriber } from "svelte/store";
 import type { AuthStore } from "../../lib/stores/auth.store";
-import { Principal } from "@dfinity/principal";
 
 export const mockPrincipal = Principal.fromText(
   "xlmdg-vkosz-ceopx-7wtgu-g3xmd-koiyc-awqaq-7modz-zf6r6-364rh-oqe"

diff --git a/frontend/svelte/src/tests/routes/Accounts.spec.ts b/frontend/svelte/src/tests/routes/Accounts.spec.ts
@@ -2,16 +2,16 @@
  * @jest-environment jsdom
  */
 
+import { render } from "@testing-library/svelte";
+import { accountsStore } from "../../lib/stores/accounts.store";
 import { authStore } from "../../lib/stores/auth.store";
-import { mockAuthStoreSubscribe } from "../mocks/auth.store.mock";
+import { formatICP } from "../../lib/utils/icp.utils";
+import Accounts from "../../routes/Accounts.svelte";
 import {
   mockAccountsStoreSubscribe,
   mockMainAccount,
 } from "../mocks/accounts.store.mock";
-import { accountsStore } from "../../lib/stores/accounts.store";
-import { render } from "@testing-library/svelte";
-import Accounts from "../../routes/Accounts.svelte";
-import { formatICP } from "../../lib/utils/icp.utils";
+import { mockAuthStoreSubscribe } from "../mocks/auth.store.mock";
 
 describe("Accounts", () => {
   let authStoreMock, accountsStoreMock;

diff --git a/frontend/svelte/src/tests/routes/Neurons.spec.ts b/frontend/svelte/src/tests/routes/Neurons.spec.ts
@@ -3,8 +3,8 @@
  */
 
 import { render } from "@testing-library/svelte";
-import Neurons from "../../routes/Neurons.svelte";
 import { authStore } from "../../lib/stores/auth.store";
+import Neurons from "../../routes/Neurons.svelte";
 import {
   mockAuthStoreSubscribe,
   mockPrincipal,

diff --git a/frontend/svelte/src/tests/routes/Proposals.spec.ts b/frontend/svelte/src/tests/routes/Proposals.spec.ts
@@ -4,9 +4,8 @@
 
 import { render } from "@testing-library/svelte";
 import { authStore } from "../../lib/stores/auth.store";
-import { mockAuthStoreSubscribe } from "../mocks/auth.store.mock";
 import Proposals from "../../routes/Proposals.svelte";
-import { Topics } from "../../lib/types/voting";
+import { mockAuthStoreSubscribe } from "../mocks/auth.store.mock";
 
 describe("Proposals", () => {
   let authStoreMock;