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.

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

Using Biome.js instead of ESLint and Prettier #347

Merged
merged 8 commits into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
12 changes: 0 additions & 12 deletions .vscode/extensions.json

This file was deleted.

2 changes: 2 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"aseed",
"astar",
"ausd",
"biomejs",
"bncs",
"composablenodes",
"crustnetwork",
Expand Down Expand Up @@ -37,6 +38,7 @@
"litentry",
"mangata",
"metadatas",
"mkdocs",
"mnemonic",
"moonbase",
"moonchain",
Expand Down
47 changes: 47 additions & 0 deletions biome.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
"formatter": {
"indentStyle": "space"
},
"organizeImports": {
"enabled": true
},
"linter": {
"enabled": true,
"rules": {
"recommended": true,
"complexity": {
"noForEach": "off"
}
}
},
"files": {
"ignore": [
".turbo",
".vscode/extensions.json",
"build",
"dist",
"node_modules",
"out",
"target",
"mkdocs/site"
]
},
"javascript": {
"formatter": {
"quoteStyle": "single"
}
},
"overrides": [
{
"include": ["*.test.ts"],
"linter": {
"rules": {
"suspicious": {
"noExplicitAny": "off"
}
}
}
}
]
}
1 change: 0 additions & 1 deletion cspell.config.cjs
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
// eslint-disable-next-line @typescript-eslint/no-var-requires
const vscodeConfig = require('./.vscode/settings.json');

module.exports = {
Expand Down
2 changes: 1 addition & 1 deletion examples/mrl-simple/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
} from '@moonbeam-network/xcm-config';
import { Keyring } from '@polkadot/api';
import { cryptoWaitReady } from '@polkadot/util-crypto';
import { Address, createWalletClient, http } from 'viem';
import { http, type Address, createWalletClient } from 'viem';
import { privateKeyToAccount } from 'viem/accounts';

// disable unnecessary warning logs
Expand Down
6 changes: 2 additions & 4 deletions examples/sdk-simple/index.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
/* eslint-disable import/no-extraneous-dependencies */
import { dot, moonbeam, polkadot } from '@moonbeam-network/xcm-config';
import { Sdk, TransferData } from '@moonbeam-network/xcm-sdk';
import { Sdk, type TransferData } from '@moonbeam-network/xcm-sdk';
import { Keyring } from '@polkadot/api';
import { cryptoWaitReady } from '@polkadot/util-crypto';
import { setTimeout } from 'node:timers/promises';
import { Address, createWalletClient, http } from 'viem';
import { http, type Address, createWalletClient } from 'viem';
import { privateKeyToAccount } from 'viem/accounts';

// Moonbeam Signer ===========================================================
Expand Down
7 changes: 4 additions & 3 deletions lefthook.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
pre-commit:
parallel: true
commands:
eslint:
glob: '*.{ts,js,}'
run: pnpm eslint --fix {staged_files} && git update-index --again
biome:
glob: "*.{js,ts,cjs,mjs,d.cts,d.mts,jsx,tsx,json,jsonc}"
run: pnpm biome check --write --no-errors-on-unmatched --files-ignore-unknown=true --colors=off {staged_files}
stage_fixed: true
spell:
run: pnpm run spell
20 changes: 4 additions & 16 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,15 @@
"url": "git+https://github.com/moonbeam-foundation/xcm-sdk.git"
},
"type": "module",
"workspaces": [
"packages/*",
"examples/*"
],
"workspaces": ["packages/*", "examples/*", "scripts/*"],
"packageManager": "[email protected]",
"scripts": {
"preinstall": "npx only-allow pnpm",
"build": "turbo run build",
"dev": "turbo run dev",
"link": "turbo run link",
"lint": "turbo run lint",
"lint:fix": "turbo run lint:fix",
"lint": "pnpm biome check .",
"lint:fix": "pnpm biome check --write .",
"typecheck": "turbo run typecheck",
"spell": "cspell --quiet -c cspell.config.cjs 'packages/**/src/**'",
"test": "turbo run test",
Expand All @@ -49,23 +46,14 @@
"@wormhole-foundation/sdk-evm": "^0.8.2"
},
"devDependencies": {
"@biomejs/biome": "^1.8.3",
"@changesets/changelog-github": "^0.5.0",
"@changesets/cli": "^2.27.7",
"@slack/webhook": "^7.0.3",
"@types/big.js": "^6.2.2",
"@typescript-eslint/eslint-plugin": "^7.18.0",
"@typescript-eslint/parser": "^7.18.0",
"bun": "^1.1.25",
"cspell": "^8.13.1",
"dotenv": "^16.4.5",
"eslint": "^8.57.0",
"eslint-config-airbnb-base": "^15.0.0",
"eslint-config-airbnb-typescript": "^18.0.0",
"eslint-config-prettier": "^9.1.0",
"eslint-import-resolver-typescript": "^3.6.1",
"eslint-plugin-import": "^2.29.1",
"eslint-plugin-jest": "^28.8.0",
"eslint-plugin-prettier": "^5.2.1",
"glob": "^11.0.0",
"lefthook": "^1.7.11",
"prettier": "^3.3.3",
Expand Down
7 changes: 3 additions & 4 deletions packages/builder/fixtures/builderParamsMock.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
// eslint-disable-next-line import/no-extraneous-dependencies
import { vi } from 'vitest';
import {
Asset,
AssetAmount,
Expand All @@ -10,13 +7,15 @@ import {
EvmParachain,
Parachain,
} from '@moonbeam-network/xcm-types';
import { MrlBuilderParams, BuilderPrams } from '../src';
import { vi } from 'vitest';
import type { BuilderPrams, MrlBuilderParams } from '../src';

export const apiMock = {
tx: {
polkadotXcm: { send: vi.fn(() => 'polkadotXcm.send => RESULT') },
xTokens: { transfer: vi.fn(() => 'xTokens.transfer => RESULT') },
},
// biome-ignore lint/suspicious/noExplicitAny: <explanation>
} as any;

export const test = new Asset({ key: 'usdt', originSymbol: 'USDT' });
Expand Down
12 changes: 2 additions & 10 deletions packages/builder/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@
"scripts": {
"build": "tsup",
"dev": "pnpm run build -- --watch",
"lint": "eslint ./src --ext .js,.ts",
"lint:fix": "pnpm run lint -- --fix",
"typecheck": "tsc --noEmit",
"test": "vitest --run",
"test:watch": "vitest",
Expand All @@ -18,20 +16,14 @@
"type": "git",
"url": "git+https://github.com/moonbeam-foundation/xcm-sdk.git"
},
"keywords": [
"moonbeam",
"moonriver",
"xcm"
],
"keywords": ["moonbeam", "moonriver", "xcm"],
"author": "moonbeam-foundation",
"license": "MIT",
"bugs": {
"url": "https://github.com/moonbeam-foundation/xcm-sdk/issues"
},
"homepage": "https://moonbeam-foundation.github.io/xcm-sdk/latest",
"files": [
"build"
],
"files": ["build"],
"type": "module",
"exports": "./build/index.mjs",
"types": "./build/index.d.ts",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type { ChainAssetId } from '@moonbeam-network/xcm-types';
import type { SubstrateQueryConfig } from '../types/substrate/SubstrateQueryConfig';
import type { ConfigBuilder } from '../builder.interfaces';
import type { SubstrateQueryConfig } from '../types/substrate/SubstrateQueryConfig';

export type AssetMinConfigBuilder = ConfigBuilder<
SubstrateQueryConfig,
Expand Down
1 change: 0 additions & 1 deletion packages/builder/src/asset-min/AssetMinBuilder.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
// eslint-disable-next-line import/no-extraneous-dependencies
import { describe, expect, it } from 'vitest';

import { TypeRegistry, U128 } from '@polkadot/types';
Expand Down
12 changes: 5 additions & 7 deletions packages/builder/src/asset-min/AssetMinBuilder.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
/* eslint-disable @typescript-eslint/no-use-before-define */

import { Option } from '@polkadot/types';
import { PalletAssetsAssetDetails } from '@polkadot/types/lookup';
import type { Option } from '@polkadot/types';
import type { PalletAssetsAssetDetails } from '@polkadot/types/lookup';
import { SubstrateQueryConfig } from '../types/substrate/SubstrateQueryConfig';
import { AssetMinConfigBuilder } from './AssetMinBuilder.interfaces';
import type { AssetMinConfigBuilder } from './AssetMinBuilder.interfaces';

export function AssetMinBuilder() {
return {
Expand All @@ -21,7 +19,7 @@ function assetRegistry() {
module: pallet,
func: 'assetMetadatas',
args: [asset],
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// biome-ignore lint/suspicious/noExplicitAny: not sure how to fix this
transform: async (response: Option<any>): Promise<bigint> =>
response.unwrapOrDefault().minimalBalance.toBigInt(),
}),
Expand All @@ -32,7 +30,7 @@ function assetRegistry() {
module: pallet,
func: 'currencyMetadatas',
args: [asset],
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// biome-ignore lint/suspicious/noExplicitAny: not sure how to fix this
transform: async (response: Option<any>): Promise<bigint> =>
response.unwrapOrDefault().minimalBalance.toBigInt(),
}),
Expand Down
4 changes: 2 additions & 2 deletions packages/builder/src/balance/BalanceBuilder.interfaces.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import type { Struct, u128 } from '@polkadot/types';
import type { ChainAsset } from '@moonbeam-network/xcm-types';
import type { Struct, u128 } from '@polkadot/types';
import type { ConfigBuilder } from '../builder.interfaces';
import type { ContractConfig } from '../contract';
import type { SubstrateQueryConfig } from '../types/substrate/SubstrateQueryConfig';
import type { ConfigBuilder } from '../builder.interfaces';

export type BalanceConfigBuilder = ConfigBuilder<
ContractConfig | SubstrateQueryConfig,
Expand Down
1 change: 0 additions & 1 deletion packages/builder/src/balance/BalanceBuilder.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
// eslint-disable-next-line import/no-extraneous-dependencies
import { describe, expect, it } from 'vitest';

import { TypeRegistry, U128 } from '@polkadot/types';
Expand Down
12 changes: 5 additions & 7 deletions packages/builder/src/balance/BalanceBuilder.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
/* eslint-disable @typescript-eslint/no-use-before-define */

import { Option } from '@polkadot/types';
import {
import type { Option } from '@polkadot/types';
import type {
FrameSystemAccountInfo,
PalletAssetsAssetAccount,
PalletBalancesAccountData,
} from '@polkadot/types/lookup';
import { evmToAddress } from '@polkadot/util-crypto';
import { ContractConfig } from '../contract';
import { SubstrateQueryConfig } from '../types/substrate/SubstrateQueryConfig';
import {
import type {
BalanceConfigBuilder,
EquilibriumSystemBalanceData,
PalletBalancesAccountDataOld,
Expand Down Expand Up @@ -103,9 +101,9 @@ function system() {
balances = res;
}

// eslint-disable-next-line @typescript-eslint/no-explicit-any
// biome-ignore lint/suspicious/noExplicitAny: not sure how to fix this
if (Array.isArray((res as any)?.v0?.balance)) {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
// biome-ignore lint/suspicious/noExplicitAny: not sure how to fix this
balances = (res as any).v0.balance;
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { ContractConfig } from '../types/ContractConfig';
import type { ConfigBuilder } from '../builder.interfaces';
import type { ContractConfig } from '../types/ContractConfig';

export type ContractConfigBuilder = ConfigBuilder<ContractConfig>;
5 changes: 2 additions & 3 deletions packages/builder/src/contract/contracts/Xtokens/Xtokens.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
/* eslint-disable @typescript-eslint/no-use-before-define */
import { AnyParachain, EvmParachain } from '@moonbeam-network/xcm-types';
import { type AnyParachain, EvmParachain } from '@moonbeam-network/xcm-types';
import { formatAssetIdToERC20 } from '@moonbeam-network/xcm-utils';
import { u8aToHex } from '@polkadot/util';
import { decodeAddress, evmToAddress } from '@polkadot/util-crypto';
import { ContractConfigBuilder } from '../../ContractBuilder.interfaces';
import { ContractConfig } from '../../../types/ContractConfig';
import type { ContractConfigBuilder } from '../../ContractBuilder.interfaces';
import { XTOKENS_ABI } from './XtokensABI';

const U_64_MAX = 18446744073709551615n;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { ExtrinsicConfig } from '../types/substrate/ExtrinsicConfig';
import type { ConfigBuilder } from '../builder.interfaces';
import type { ExtrinsicConfig } from '../types/substrate/ExtrinsicConfig';

export type ExtrinsicConfigBuilder = ConfigBuilder<ExtrinsicConfig>;

Expand Down
2 changes: 0 additions & 2 deletions packages/builder/src/extrinsic/ExtrinsicBuilder.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
/* eslint-disable @typescript-eslint/no-use-before-define */

import { eqBalances } from './pallets/eqBalances';
import { polkadotXcm } from './pallets/polkadotXcm';
import { xTokens } from './pallets/xTokens';
Expand Down
4 changes: 2 additions & 2 deletions packages/builder/src/extrinsic/ExtrinsicBuilder.utils.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import { SubmittableExtrinsicFunction } from '@polkadot/api/types';
import type { SubmittableExtrinsicFunction } from '@polkadot/api/types';
import { getTypeDef } from '@polkadot/types';
import { u8aToHex } from '@polkadot/util';
import { decodeAddress } from '@polkadot/util-crypto';
import { XcmVersion } from './ExtrinsicBuilder.interfaces';

export function getExtrinsicArgumentVersion(
func?: SubmittableExtrinsicFunction<'promise'>,
index: number = 0,
index = 0,
): XcmVersion {
if (!func) return XcmVersion.v1;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
// eslint-disable-next-line import/no-extraneous-dependencies
import { describe, expect, it } from 'vitest';

import {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { ExtrinsicConfigBuilder } from '../../ExtrinsicBuilder.interfaces';
import { getExtrinsicAccount } from '../../ExtrinsicBuilder.utils';
import { ExtrinsicConfig } from '../../../types/substrate/ExtrinsicConfig';
import type { ExtrinsicConfigBuilder } from '../../ExtrinsicBuilder.interfaces';
import { getExtrinsicAccount } from '../../ExtrinsicBuilder.utils';

export enum EqBalancesFee {
SovereignAccWillPay = 'SovereignAccWillPay',
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
// eslint-disable-next-line import/no-extraneous-dependencies
import { describe, expect, it } from 'vitest';

import {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { ExtrinsicConfigBuilder } from '../../ExtrinsicBuilder.interfaces';
import { ExtrinsicConfig } from '../../../types/substrate/ExtrinsicConfig';
import type { ExtrinsicConfigBuilder } from '../../ExtrinsicBuilder.interfaces';
import {
getPolkadotXcmExtrinsicArgs,
shouldFeeAssetPrecedeAsset,
Expand Down
Loading