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

# 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 We use the plugin in [nns-dapp](dfinity/nns-dapp#404) too.
dfinity · Feb 9, 2022 · be3d658 · be3d658
1 parent 1faff43
commit be3d658
Show file tree

Hide file tree

Showing 19 changed files with 5,407 additions and 7,670 deletions.
diff --git a/candid/governance.idl.d.ts b/candid/governance.idl.d.ts
@@ -1,5 +1,5 @@
 import type { IDL } from "@dfinity/candid";
+import { _SERVICE } from "./governanceTypes";
 export const idlFactory: IDL.InterfaceFactory;
 
-import { _SERVICE } from "./governanceTypes";
 export { _SERVICE as GovernanceService };
diff --git a/esbuild.mjs b/esbuild.mjs
@@ -1,16 +1,15 @@
 #!/usr/bin/env node
 
+import esbuild from "esbuild";
 import {
+  existsSync,
+  mkdirSync,
   readdirSync,
   statSync,
   writeFileSync,
-  existsSync,
-  mkdirSync,
 } from "fs";
 import { join } from "path";
 
-import esbuild from "esbuild";
-
 const dist = join(process.cwd(), "dist");
 
 if (!existsSync(dist)) {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -26,8 +26,8 @@
     "@dfinity/agent": "^0.10.2",
     "@dfinity/candid": "^0.10.2",
     "@dfinity/principal": "^0.10.2",
-    "crc-32": "^1.2.0",
     "crc": "^3.8.0",
+    "crc-32": "^1.2.0",
     "google-protobuf": "^3.19.1",
     "js-sha256": "^0.9.0"
   },
@@ -45,6 +45,7 @@
     "jest": "^27.3.1",
     "jest-mock-extended": "^2.0.4",
     "prettier": "^2.5.0",
+    "prettier-plugin-organize-imports": "^2.3.4",
     "text-encoding": "^0.7.0",
     "ts-jest": "^27.0.7",
     "ts-protoc-gen": "^0.15.0",

diff --git a/scripts/rmdir.mjs b/scripts/rmdir.mjs
@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-import { rmSync, existsSync } from "fs";
+import { existsSync, rmSync } from "fs";
 import { join } from "path";
 
 const rmDir = () => {

diff --git a/src/account_identifier.spec.ts b/src/account_identifier.spec.ts
@@ -1,5 +1,5 @@
 import { Principal } from "@dfinity/principal";
-import { expect, describe, it } from "@jest/globals";
+import { describe, expect, it } from "@jest/globals";
 import { AccountIdentifier } from ".";
 import { SubAccount } from "./account_identifier";
 

diff --git a/src/account_identifier.ts b/src/account_identifier.ts
@@ -1,6 +1,6 @@
-import { AccountIdentifier as AccountIdentifierPb } from "../proto/ledger_pb";
-import { sha224 } from "js-sha256";
 import { Principal } from "@dfinity/principal";
+import { sha224 } from "js-sha256";
+import { AccountIdentifier as AccountIdentifierPb } from "../proto/ledger_pb";
 import {
   asciiStringToByteArray,
   calculateCrc32,

diff --git a/src/canisters/governance/payloads.ts b/src/canisters/governance/payloads.ts
@@ -1,4 +1,3 @@
-import { Option } from "../../types/option";
 import { IDL, JsonObject } from "@dfinity/candid";
 import { Buffer } from "buffer";
 import {
@@ -19,6 +18,7 @@ import {
   UpdateSubnetReplicaVersionPayload,
   UpdateUnassignedNodesConfigPayload,
 } from "../../../candid/payloads.idl";
+import { Option } from "../../types/option";
 
 export const getNnsFunctionName = (nnsFunction: number): string => {
   switch (nnsFunction) {

diff --git a/src/canisters/governance/request.converters.ts b/src/canisters/governance/request.converters.ts
@@ -1,55 +1,45 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import { Principal } from "@dfinity/principal";
 import {
-  accountIdentifierToBytes,
-  arrayBufferToArrayOfNumber,
-} from "../../utils/converter.utils";
+  AccountIdentifier as RawAccountIdentifier,
+  Action as RawAction,
+  Amount,
+  By as RawBy,
+  Change as RawChange,
+  Command as RawCommand,
+  Followees as RawFollowees,
+  ListProposalInfo,
+  ManageNeuron as RawManageNeuron,
+  NeuronId as RawNeuronId,
+  NeuronIdOrSubaccount as RawNeuronIdOrSubaccount,
+  NodeProvider as RawNodeProvider,
+  Operation as RawOperation,
+  RewardMode as RawRewardMode,
+} from "../../../candid/governanceTypes.d";
 import { AccountIdentifier, E8s, NeuronId } from "../../types/common";
 import {
   Action,
-  AddHotKeyRequest,
   By,
   Change,
   ClaimNeuronRequest,
   ClaimOrRefreshNeuronRequest,
   Command,
-  DisburseRequest,
   DisburseToNeuronRequest,
-  FollowRequest,
-  IncreaseDissolveDelayRequest,
   ListProposalsRequest,
   MakeProposalRequest,
   ManageNeuron,
-  MergeMaturityRequest,
   NeuronIdOrSubaccount,
   NodeProvider,
   Operation,
   ProposalId,
-  RegisterVoteRequest,
-  RemoveHotKeyRequest,
   RewardMode,
-  SpawnRequest,
   SplitRequest,
-  StartDissolvingRequest,
-  StopDissolvingRequest,
   UnsupportedValueError,
 } from "../../types/governance_converters";
 import {
-  AccountIdentifier as RawAccountIdentifier,
-  Action as RawAction,
-  Amount,
-  By as RawBy,
-  Change as RawChange,
-  Command as RawCommand,
-  Followees as RawFollowees,
-  ListProposalInfo,
-  ManageNeuron as RawManageNeuron,
-  NeuronId as RawNeuronId,
-  NeuronIdOrSubaccount as RawNeuronIdOrSubaccount,
-  NodeProvider as RawNodeProvider,
-  Operation as RawOperation,
-  RewardMode as RawRewardMode,
-} from "../../../candid/governanceTypes.d";
+  accountIdentifierToBytes,
+  arrayBufferToArrayOfNumber,
+} from "../../utils/converter.utils";
 // Protobuf is not supported yet.
 // import { AccountIdentifier as PbAccountIdentifier } from "../../proto/ledger_pb";
 // import { ManageNeuron as PbManageNeuron } from "../../proto/governance_pb";

diff --git a/src/canisters/governance/response.converters.ts b/src/canisters/governance/response.converters.ts
@@ -4,11 +4,31 @@
 
 import { Principal } from "@dfinity/principal";
 import {
-  accountIdentifierFromBytes,
-  arrayOfNumberToArrayBuffer,
-  arrayOfNumberToUint8Array,
-  principalToAccountIdentifier,
-} from "../../utils/converter.utils";
+  AccountIdentifier as RawAccountIdentifier,
+  Action as RawAction,
+  Amount as RawAmount,
+  Ballot as RawBallot,
+  BallotInfo as RawBallotInfo,
+  By as RawBy,
+  Change as RawChange,
+  Command as RawCommand,
+  DissolveState as RawDissolveState,
+  Followees as RawFollowees,
+  KnownNeuron as RawKnownNeuron,
+  ListNeuronsResponse as RawListNeuronsResponse,
+  ListProposalInfoResponse as RawListProposalInfoResponse,
+  ManageNeuronResponse as RawManageNeuronResponse,
+  Neuron as RawNeuron,
+  NeuronId as RawNeuronId,
+  NeuronIdOrSubaccount as RawNeuronIdOrSubaccount,
+  NeuronInfo as RawNeuronInfo,
+  NodeProvider as RawNodeProvider,
+  Operation as RawOperation,
+  Proposal as RawProposal,
+  ProposalInfo as RawProposalInfo,
+  RewardMode as RawRewardMode,
+  Tally as RawTally,
+} from "../../../candid/governanceTypes.d";
 import { GOVERNANCE_CANISTER_ID } from "../../constants/canister_ids";
 import { AccountIdentifier, E8s, NeuronId } from "../../types/common";
 import {
@@ -18,14 +38,12 @@ import {
   By,
   Change,
   Command,
-  DisburseResponse,
   DisburseToNeuronResponse,
   DissolveState,
   Followees,
   KnownNeuron,
   ListProposalsResponse,
   MakeProposalResponse,
-  MergeMaturityResponse,
   Neuron,
   NeuronIdOrSubaccount,
   NeuronInfo,
@@ -34,37 +52,16 @@ import {
   Proposal,
   ProposalInfo,
   RewardMode,
-  SpawnResponse,
   Tally,
   UnsupportedValueError,
 } from "../../types/governance_converters";
-import {
-  AccountIdentifier as RawAccountIdentifier,
-  Action as RawAction,
-  Amount as RawAmount,
-  Ballot as RawBallot,
-  BallotInfo as RawBallotInfo,
-  By as RawBy,
-  Change as RawChange,
-  Command as RawCommand,
-  DissolveState as RawDissolveState,
-  Followees as RawFollowees,
-  KnownNeuron as RawKnownNeuron,
-  ListNeuronsResponse as RawListNeuronsResponse,
-  ListProposalInfoResponse as RawListProposalInfoResponse,
-  ManageNeuronResponse as RawManageNeuronResponse,
-  Neuron as RawNeuron,
-  NeuronId as RawNeuronId,
-  NeuronIdOrSubaccount as RawNeuronIdOrSubaccount,
-  NeuronInfo as RawNeuronInfo,
-  NodeProvider as RawNodeProvider,
-  Operation as RawOperation,
-  Proposal as RawProposal,
-  ProposalInfo as RawProposalInfo,
-  RewardMode as RawRewardMode,
-  Tally as RawTally,
-} from "../../../candid/governanceTypes.d";
 import { Option } from "../../types/option";
+import {
+  accountIdentifierFromBytes,
+  arrayOfNumberToArrayBuffer,
+  arrayOfNumberToUint8Array,
+  principalToAccountIdentifier,
+} from "../../utils/converter.utils";
 // Protobuf is not supported yet:
 // import { ManageNeuronResponse as PbManageNeuronResponse } from "../../proto/governance_pb";
 import { convertNnsFunctionPayload, getNnsFunctionName } from "./payloads";

diff --git a/src/governance.spec.ts b/src/governance.spec.ts
@@ -1,7 +1,7 @@
 import { mock } from "jest-mock-extended";
+import { GovernanceService } from "../candid/governance.idl";
 import { ListKnownNeuronsResponse } from "../candid/governanceTypes";
 import { GovernanceCanister } from "./governance";
-import { GovernanceService } from "../candid/governance.idl";
 
 describe("GovernanceCanister.listKnownNeurons", () => {
   it("populates all KnownNeuron fields correctly", async () => {

diff --git a/src/governance.ts b/src/governance.ts
@@ -1,16 +1,16 @@
 import { Actor } from "@dfinity/agent";
-import { GovernanceService, idlFactory } from "../candid/governance.idl";
 import { idlFactory as certifiedIdlFactory } from "../candid/governance.certified.idl";
+import { GovernanceService, idlFactory } from "../candid/governance.idl";
 import { RequestConverters } from "./canisters/governance/request.converters";
 import { ResponseConverters } from "./canisters/governance/response.converters";
+import { MAINNET_GOVERNANCE_CANISTER_ID } from "./constants/canister_ids";
+import { GovernanceCanisterOptions } from "./types/governance";
 import {
   KnownNeuron,
   ListProposalsRequest,
   ListProposalsResponse,
 } from "./types/governance_converters";
-import { MAINNET_GOVERNANCE_CANISTER_ID } from "./constants/canister_ids";
 import { defaultAgent } from "./utils/agent.utils";
-import { GovernanceCanisterOptions } from "./types/governance";
 
 export class GovernanceCanister {
   private constructor(

diff --git a/src/icp.spec.ts b/src/icp.spec.ts
@@ -1,4 +1,4 @@
-import { expect, describe, it } from "@jest/globals";
+import { describe, expect, it } from "@jest/globals";
 import { ICP } from ".";
 import { FromICPStringError } from "./types/icp";
 

diff --git a/src/index.ts b/src/index.ts
@@ -1,7 +1,7 @@
-export { GovernanceCanister } from "./governance";
-export { LedgerCanister } from "./ledger";
 export { AccountIdentifier, SubAccount } from "./account_identifier";
+export { GovernanceCanister } from "./governance";
 export { ICP } from "./icp";
+export { LedgerCanister } from "./ledger";
 export * from "./types/governance";
 export * from "./types/governance_converters";
 export * from "./types/icp";

diff --git a/src/ledger.ts b/src/ledger.ts
@@ -9,10 +9,9 @@ import {
   SendRequest,
 } from "../proto/ledger_pb";
 import { AccountIdentifier } from "./account_identifier";
-import { ICP } from "./icp";
-import { queryCall, updateCall } from "./utils/proto.utils";
 import { MAINNET_LEDGER_CANISTER_ID } from "./constants/canister_ids";
-import { defaultAgent } from "./utils/agent.utils";
+import { ICP } from "./icp";
+import { BlockHeight } from "./types/common";
 import {
   Fetcher,
   InsufficientFunds,
@@ -23,7 +22,8 @@ import {
   TxDuplicate,
   TxTooOld,
 } from "./types/ledger";
-import { BlockHeight } from "./types/common";
+import { defaultAgent } from "./utils/agent.utils";
+import { queryCall, updateCall } from "./utils/proto.utils";
 
 export class LedgerCanister {
   private constructor(

diff --git a/src/types/governance_converters.ts b/src/types/governance_converters.ts
@@ -1,13 +1,13 @@
 import { DerEncodedPublicKey } from "@dfinity/agent";
-import { Option } from "./option";
+import { Principal } from "@dfinity/principal";
 import {
   AccountIdentifier,
   CanisterIdString,
   E8s,
   NeuronId,
   PrincipalString,
 } from "./common";
-import { Principal } from "@dfinity/principal";
+import { Option } from "./option";
 
 export type Action =
   | { RegisterKnownNeuron: KnownNeuron }

diff --git a/src/types/ledger.ts b/src/types/ledger.ts
@@ -1,6 +1,6 @@
-import { ICP } from "../icp";
 import { Agent } from "@dfinity/agent";
 import { Principal } from "@dfinity/principal";
+import { ICP } from "../icp";
 
 export type BlockHeight = bigint;
 

diff --git a/src/utils/converter.utils.ts b/src/utils/converter.utils.ts
@@ -1,9 +1,9 @@
 import { Principal } from "@dfinity/principal";
-import { sha224 } from "js-sha256";
 import { Buffer } from "buffer";
 /* eslint-disable @typescript-eslint/ban-ts-comment */
 // @ts-ignore (no type definitions for crc are available)
 import crc from "crc";
+import { sha224 } from "js-sha256";
 /* eslint-enable @typescript-eslint/ban-ts-comment */
 import { SUB_ACCOUNT_BYTE_LENGTH } from "../constants/constants";
 import { AccountIdentifier, SubAccount } from "../types/common";

diff --git a/src/utils/proto.utils.ts b/src/utils/proto.utils.ts
@@ -1,6 +1,5 @@
-import { Agent } from "@dfinity/agent";
+import { Agent, polling } from "@dfinity/agent";
 import { Principal } from "@dfinity/principal";
-import { polling } from "@dfinity/agent";
 
 /**
  * Submits an update call to the IC.