Prettier Import Sort Plugin (MystenLabs#13957)

## Description We currently use `import/order` to sort imports. I hate this for a couple reasons: - This feels like formatting, which is what prettier is for. ESLint is for catching functional or code issues, not formatting. - I don't run ESLint auto-fixing automatically, and IMO folks generally shouldn't need to because it really shouldn't be catching much that's super auto-fixable, because only formatting is easily auto-fixable without supervision. - I want to move to a world where we don't have anything yell at you locally for prettier because ideally you just set that up and don't think about it, and it can fail in CI, but ESLint / TS will yell at you in your editor, keeping your signal to noise ratio high, which is good. - I just personally hate import sorting and this will at least make me think about it less. ## Test Plan How did you test the new or updated feature? --- If your changes are not user-facing and not a breaking change, you can skip the following section. Otherwise, please indicate what changed, and then add to the Release Notes section as highlighted during the release process. ### Type of Change (Check all that apply) - [ ] protocol change - [ ] user-visible impact - [ ] breaking change for a client SDKs - [ ] breaking change for FNs (FN binary must upgrade) - [ ] breaking change for validators or node operators (must upgrade binaries) - [ ] breaking change for on-chain data layout - [ ] necessitate either a data wipe or data migration ### Release notes
kakudo · Sep 25, 2023 · 05eed92 · 05eed92
1 parent e5235d2
commit 05eed92
Show file tree

Hide file tree

Showing 665 changed files with 2,301 additions and 2,195 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -85,26 +85,6 @@ module.exports = {
 		{
 			files: ['apps/explorer/**/*'],
 			rules: {
-				'import/order': [
-					'warn',
-					{
-						groups: [['builtin', 'external'], ['internal', 'parent', 'sibling', 'index'], 'type'],
-						pathGroups: [
-							{
-								pattern: '{.,..}/**/*.css',
-								group: 'type',
-								position: 'after',
-							},
-							{
-								pattern: '~/**',
-								group: 'internal',
-							},
-						],
-						'newlines-between': 'always',
-						alphabetize: { order: 'asc' },
-						warnOnUnassignedImports: true,
-					},
-				],
 				'import/no-duplicates': ['error'],
 				'import/no-anonymous-default-export': 'off',
 				'@typescript-eslint/consistent-type-imports': [
@@ -220,30 +200,6 @@ module.exports = {
 			files: ['apps/wallet/**/*'],
 			rules: {
 				'react/display-name': 'off',
-				'import/order': [
-					'warn',
-					{
-						groups: [['builtin', 'external'], ['internal', 'parent', 'sibling', 'index'], 'type'],
-						pathGroups: [
-							{
-								pattern: '{.,..,_*,*}/**/*.?(s)css',
-								group: 'type',
-								position: 'after',
-							},
-							{
-								pattern: '_*',
-								group: 'internal',
-							},
-							{
-								pattern: '_*/**',
-								group: 'internal',
-							},
-						],
-						pathGroupsExcludedImportTypes: ['builtin', 'object', 'type'],
-						alphabetize: { order: 'asc' },
-						warnOnUnassignedImports: true,
-					},
-				],
 				'import/no-duplicates': ['error'],
 				'@typescript-eslint/consistent-type-imports': [
 					'error',

diff --git a/apps/core/src/hooks/__tests__/useFormatCoin.test.ts b/apps/core/src/hooks/__tests__/useFormatCoin.test.ts
@@ -2,9 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import BigNumber from 'bignumber.js';
-import { describe, it, expect } from 'vitest';
+import { describe, expect, it } from 'vitest';
 
-import { formatBalance, CoinFormat } from '../useFormatCoin';
+import { CoinFormat, formatBalance } from '../useFormatCoin';
 
 const SUI_DECIMALS = 9;
 

diff --git a/apps/core/src/hooks/nameService.ts b/apps/core/src/hooks/nameService.ts
@@ -1,9 +1,9 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { useQuery } from '@tanstack/react-query';
-import { useSuiClient } from '@mysten/dapp-kit';
 import { useFeatureIsOn } from '@growthbook/growthbook-react';
+import { useSuiClient } from '@mysten/dapp-kit';
+import { useQuery } from '@tanstack/react-query';
 
 const SUI_NS_FEATURE_FLAG = 'suins';
 

diff --git a/apps/core/src/hooks/useCookieConsentBanner.ts b/apps/core/src/hooks/useCookieConsentBanner.ts
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { useEffect } from 'react';
+
 import { PersistableStorage } from '../utils/persistableStorage';
 import { useProductAnalyticsConfig } from './useProductAnalyticsConfig';
 

diff --git a/apps/core/src/hooks/useFormatCoin.ts b/apps/core/src/hooks/useFormatCoin.ts
@@ -1,13 +1,14 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
+import { useSuiClient } from '@mysten/dapp-kit';
 import { CoinMetadata } from '@mysten/sui.js/client';
 import { SUI_TYPE_ARG } from '@mysten/sui.js/utils';
 import { useQuery, type UseQueryResult } from '@tanstack/react-query';
 import BigNumber from 'bignumber.js';
 import { useMemo } from 'react';
+
 import { formatAmount } from '../utils/formatAmount';
-import { useSuiClient } from '@mysten/dapp-kit';
 
 type FormattedCoin = [
 	formattedBalance: string,

diff --git a/apps/core/src/hooks/useGetCoins.ts b/apps/core/src/hooks/useGetCoins.ts
@@ -3,7 +3,7 @@
 
 import { useSuiClient } from '@mysten/dapp-kit';
 import { PaginatedCoins } from '@mysten/sui.js/client';
-import { UseInfiniteQueryResult, useInfiniteQuery } from '@tanstack/react-query';
+import { useInfiniteQuery, UseInfiniteQueryResult } from '@tanstack/react-query';
 
 const MAX_COINS_PER_REQUEST = 10;
 

diff --git a/apps/core/src/hooks/useGetDynamicFields.ts b/apps/core/src/hooks/useGetDynamicFields.ts
@@ -1,9 +1,9 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { useInfiniteQuery } from '@tanstack/react-query';
-import { normalizeSuiAddress } from '@mysten/sui.js/utils';
 import { useSuiClient } from '@mysten/dapp-kit';
+import { normalizeSuiAddress } from '@mysten/sui.js/utils';
+import { useInfiniteQuery } from '@tanstack/react-query';
 
 const MAX_PAGE_SIZE = 10;
 

diff --git a/apps/core/src/hooks/useGetKioskContents.ts b/apps/core/src/hooks/useGetKioskContents.ts
@@ -1,11 +1,12 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
+import { useSuiClient } from '@mysten/dapp-kit';
 import { KIOSK_ITEM, KioskClient, KioskItem, KioskOwnerCap, Network } from '@mysten/kiosk';
-import { useQuery } from '@tanstack/react-query';
-import { ORIGINBYTE_KIOSK_OWNER_TOKEN, getKioskIdFromOwnerCap } from '../utils/kiosk';
 import { SuiClient } from '@mysten/sui.js/src/client';
-import { useSuiClient } from '@mysten/dapp-kit';
+import { useQuery } from '@tanstack/react-query';
+
+import { getKioskIdFromOwnerCap, ORIGINBYTE_KIOSK_OWNER_TOKEN } from '../utils/kiosk';
 
 export enum KioskTypes {
 	SUI = 'sui',

diff --git a/apps/core/src/hooks/useGetTransferAmount.ts b/apps/core/src/hooks/useGetTransferAmount.ts
@@ -1,8 +1,9 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
-import { SUI_TYPE_ARG } from '@mysten/sui.js/utils';
 import { SuiTransactionBlockResponse } from '@mysten/sui.js/client';
+import { SUI_TYPE_ARG } from '@mysten/sui.js/utils';
 import { useMemo } from 'react';
+
 import { getTotalGasUsed } from '../utils/transaction';
 
 export function useGetTransferAmount(txnData: SuiTransactionBlockResponse) {

diff --git a/apps/core/src/hooks/useGetValidatorsApy.ts b/apps/core/src/hooks/useGetValidatorsApy.ts
@@ -1,10 +1,10 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
+import { useLatestSuiSystemState, useSuiClient } from '@mysten/dapp-kit';
 import { useQuery } from '@tanstack/react-query';
 
 import { roundFloat } from '../utils/roundFloat';
-import { useSuiClient, useLatestSuiSystemState } from '@mysten/dapp-kit';
 
 // recentEpochRewards is list of the last 30 epoch rewards for a specific validator
 // APY_e = (1 + epoch_rewards / stake)^365-1

diff --git a/apps/core/src/hooks/useGetValidatorsEvents.ts b/apps/core/src/hooks/useGetValidatorsEvents.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 import { useSuiClient } from '@mysten/dapp-kit';
-import { type EventId, SuiEvent } from '@mysten/sui.js/client';
+import { SuiEvent, type EventId } from '@mysten/sui.js/client';
 import { useQuery } from '@tanstack/react-query';
 
 type GetValidatorsEvent = {

diff --git a/apps/core/src/hooks/useMultiGetObjects.ts b/apps/core/src/hooks/useMultiGetObjects.ts
@@ -1,10 +1,11 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
+import { useSuiClient } from '@mysten/dapp-kit';
+import { SuiObjectDataOptions } from '@mysten/sui.js/src/client';
 import { useQuery } from '@tanstack/react-query';
+
 import { chunkArray } from '../utils/chunkArray';
-import { SuiObjectDataOptions } from '@mysten/sui.js/src/client';
-import { useSuiClient } from '@mysten/dapp-kit';
 
 export function useMultiGetObjects(
 	ids: string[],

diff --git a/apps/core/src/hooks/useOnScreen.ts b/apps/core/src/hooks/useOnScreen.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { useState, useEffect, MutableRefObject } from 'react';
+import { MutableRefObject, useEffect, useState } from 'react';
 
 export const useOnScreen = (elementRef: MutableRefObject<Element | null>) => {
 	const [isIntersecting, setIsIntersecting] = useState(false);

diff --git a/apps/core/src/hooks/useSuiCoinData.ts b/apps/core/src/hooks/useSuiCoinData.ts
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { useQuery } from '@tanstack/react-query';
+
 import { useAppsBackend } from './useAppsBackend';
 
 // TODO: We should consider using tRPC or something for apps-backend

diff --git a/apps/core/src/hooks/useTransactionSummary.ts b/apps/core/src/hooks/useTransactionSummary.ts
@@ -7,14 +7,14 @@ import {
 import { useMemo } from 'react';
 
 import { getBalanceChangeSummary } from '../utils/transaction/getBalanceChangeSummary';
+import { getGasSummary } from '../utils/transaction/getGasSummary';
+import { getLabel } from '../utils/transaction/getLabel';
 import {
-	SuiObjectChangeWithDisplay,
 	getObjectChangeSummary,
+	SuiObjectChangeWithDisplay,
 } from '../utils/transaction/getObjectChangeSummary';
-import { getLabel } from '../utils/transaction/getLabel';
-import { getGasSummary } from '../utils/transaction/getGasSummary';
-import { useMultiGetObjects } from './useMultiGetObjects';
 import { getObjectDisplayLookup } from '../utils/transaction/getObjectDisplayLookup';
+import { useMultiGetObjects } from './useMultiGetObjects';
 
 export function useTransactionSummary({
 	transaction,

diff --git a/apps/core/src/hooks/useZodForm.ts b/apps/core/src/hooks/useZodForm.ts
@@ -3,9 +3,8 @@
 
 import { zodResolver } from '@hookform/resolvers/zod';
 import { useForm } from 'react-hook-form';
-
 import type { UseFormProps } from 'react-hook-form';
-import type { ZodSchema, TypeOf } from 'zod';
+import type { TypeOf, ZodSchema } from 'zod';
 
 interface UseZodFormProps<T extends ZodSchema<any>> extends UseFormProps<TypeOf<T>> {
 	schema: T;

diff --git a/apps/core/src/utils/getRefGasPrice.ts b/apps/core/src/utils/getRefGasPrice.ts
@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { SuiValidatorSummary } from '@mysten/sui.js/client';
+
 import { calculateStakeShare } from './calculateStakeShare';
 
 const REF_THRESHOLD = 66.67;

diff --git a/apps/core/src/utils/kiosk.ts b/apps/core/src/utils/kiosk.ts
@@ -1,8 +1,8 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { SuiObjectData, SuiObjectResponse } from '@mysten/sui.js/client';
 import { KIOSK_OWNER_CAP } from '@mysten/kiosk';
+import { SuiObjectData, SuiObjectResponse } from '@mysten/sui.js/client';
 
 export const ORIGINBYTE_KIOSK_MODULE =
 	'0x95a441d389b07437d00dd07e0b6f05f513d7659b13fd7c5d3923c7d9d847199b::ob_kiosk';

diff --git a/apps/core/src/utils/transaction/getBalanceChangeSummary.ts b/apps/core/src/utils/transaction/getBalanceChangeSummary.ts
@@ -1,8 +1,8 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 import {
-	type ObjectOwner,
 	type DryRunTransactionBlockResponse,
+	type ObjectOwner,
 	type SuiTransactionBlockResponse,
 } from '@mysten/sui.js/client';
 import { normalizeSuiObjectId, parseStructTag } from '@mysten/sui.js/utils';

diff --git a/apps/core/src/utils/transaction/getGasSummary.ts b/apps/core/src/utils/transaction/getGasSummary.ts
@@ -3,8 +3,8 @@
 import {
 	DryRunTransactionBlockResponse,
 	GasCostSummary,
-	SuiTransactionBlockResponse,
 	SuiGasData,
+	SuiTransactionBlockResponse,
 	TransactionEffects,
 } from '@mysten/sui.js/client';
 

diff --git a/apps/core/src/utils/transaction/getObjectChangeSummary.ts b/apps/core/src/utils/transaction/getObjectChangeSummary.ts
@@ -1,15 +1,16 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 import {
-	SuiObjectChangeTransferred,
+	DisplayFieldsResponse,
+	SuiObjectChange,
 	SuiObjectChangeCreated,
+	SuiObjectChangeDeleted,
 	SuiObjectChangeMutated,
 	SuiObjectChangePublished,
-	SuiObjectChange,
-	DisplayFieldsResponse,
-	SuiObjectChangeDeleted,
+	SuiObjectChangeTransferred,
 	SuiObjectChangeWrapped,
 } from '@mysten/sui.js/client';
+
 import { groupByOwner } from './groupByOwner';
 import { SuiObjectChangeTypes } from './types';
 

diff --git a/apps/core/src/utils/transaction/getObjectDisplayLookup.ts b/apps/core/src/utils/transaction/getObjectDisplayLookup.ts
@@ -1,6 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 import { DisplayFieldsResponse, SuiObjectResponse } from '@mysten/sui.js/client';
+
 import { hasDisplayData } from '../hasDisplayData';
 
 export function getObjectDisplayLookup(objects: SuiObjectResponse[] = []) {

diff --git a/apps/core/tailwind.config.ts b/apps/core/tailwind.config.ts
@@ -2,8 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { type Config } from 'tailwindcss';
-import { fontFamily } from 'tailwindcss/defaultTheme';
 import colors from 'tailwindcss/colors';
+import { fontFamily } from 'tailwindcss/defaultTheme';
 
 /** The minimum line height that text should use to avoid clipping and overflow scrolling */
 const MIN_LINE_HEIGHT = '1.13';

diff --git a/apps/core/vite.config.ts b/apps/core/vite.config.ts
@@ -1,8 +1,8 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { defineConfig } from 'vite';
 import { vanillaExtractPlugin } from '@vanilla-extract/vite-plugin';
+import { defineConfig } from 'vite';
 
 process.env.VITE_VERCEL_ENV = process.env.VERCEL_ENV || 'development';
 

diff --git a/apps/explorer/tests/utils/localnet.ts b/apps/explorer/tests/utils/localnet.ts
@@ -1,13 +1,12 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-// eslint-disable-next-line import/order
+import 'tsconfig-paths/register';
+
 import { SuiClient, getFullnodeUrl } from '@mysten/sui.js/client';
 import { type Keypair } from '@mysten/sui.js/cryptography';
 import { Ed25519Keypair } from '@mysten/sui.js/keypairs/ed25519';
 import { TransactionBlock } from '@mysten/sui.js/transactions';
-import 'tsconfig-paths/register';
-// eslint-disable-next-line import/order
 
 const addressToKeypair = new Map<string, Keypair>();
 

diff --git a/apps/ui/src/Button.stories.tsx b/apps/ui/src/Button.stories.tsx
@@ -1,10 +1,10 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
+import { CheckFill16, Search16 } from '@mysten/icons';
 import type { Meta, StoryObj } from '@storybook/react';
 
 import { Button } from './Button';
-import { CheckFill16, Search16 } from '@mysten/icons';
 
 const meta = {
 	component: Button,

diff --git a/apps/ui/src/Button.tsx b/apps/ui/src/Button.tsx
@@ -1,11 +1,11 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
+import { Slot } from '@radix-ui/react-slot';
 import { cva, type VariantProps } from 'class-variance-authority';
 import { ButtonHTMLAttributes, forwardRef, type ReactNode } from 'react';
 
 import { LoadingIndicator } from './LoadingIndicator';
-import { Slot } from '@radix-ui/react-slot';
 
 const buttonStyles = cva(['inline-flex flex-nowrap items-center justify-center gap-2 relative'], {
 	variants: {

diff --git a/apps/ui/src/Combobox.tsx b/apps/ui/src/Combobox.tsx
@@ -3,20 +3,20 @@
 
 import { Command } from 'cmdk';
 import {
-	type ComponentProps,
-	type ReactNode,
-	type RefObject,
 	createContext,
 	useCallback,
 	useContext,
 	useEffect,
 	useRef,
 	useState,
+	type ComponentProps,
+	type ReactNode,
+	type RefObject,
 } from 'react';
 
-import { Text } from './Text';
-import { LoadingIndicator } from './LoadingIndicator';
 import { useOnClickOutside } from './hooks/useOnClickOutside';
+import { LoadingIndicator } from './LoadingIndicator';
+import { Text } from './Text';
 
 export type ComboboxItem = {
 	value: string;

diff --git a/apps/ui/src/IconButton.stories.tsx b/apps/ui/src/IconButton.stories.tsx
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { X12 } from '@mysten/icons';
-import { type StoryObj, type Meta } from '@storybook/react';
+import { type Meta, type StoryObj } from '@storybook/react';
 
 import { IconButton } from './IconButton';