[SDK] Feature: Adds tsdoc parsing and other eslint rules

package.json

@@ -70,8 +70,6 @@
       "ws@>=8.0.0 <8.17.1": "8.17.1",
       "ws@>=7.0.0 <7.5.10": "7.5.10",
       "ws@>=6.0.0 <6.2.3": "6.2.3",
-      "eslint": "8.57.0",
-      "@typescript-eslint/typescript-estree": "^7.14.1",
       "axios@<1.7.4": "^1.7.4",
       "send@<0.19.0": "^0.19.0",
       "elliptic@<6.5.7": "^6.5.7",

packages/thirdweb/.eslintrc.cjs

@@ -0,0 +1,54 @@
+module.exports = {
+  rules: {
+    "no-restricted-syntax": [
+      "warn",
+      {
+        selector: "CallExpression[callee.name='useEffect']",
+        message:
+          'Are you *sure* you need to use "useEffect" here? If you loading any async function prefer using "useQuery".',
+      },
+      {
+        selector: "CallExpression[callee.name='createContext']",
+        message:
+          'Are you *sure* you need to use a "Context"? In almost all cases you should prefer passing props directly.',
+      },
+      {
+        selector: "CallExpression[callee.name='defineChain']",
+        message: "Use getCachedChain instead for all internal usage",
+      },
+    ],
+    "no-unused-vars": [
+      "warn",
+      {
+        argsIgnorePattern: "^_",
+        varsIgnorePattern: "^_",
+        caughtErrorsIgnorePattern: "^_",
+        destructuredArrayIgnorePattern: "^_",
+        ignoreRestSiblings: true,
+        args: "none", // Ignore variables used in type definitions
+      },
+    ],
+    "tsdoc/syntax": "warn",
+  },
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint", "eslint-plugin-tsdoc"],
+  parserOptions: {
+    ecmaVersion: 2019,
+    ecmaFeatures: {
+      impliedStrict: true,
+      jsx: true,
+    },
+    warnOnUnsupportedTypeScriptVersion: false,
+  },
+  overrides: [
+    // THIS NEEDS TO GO LAST!
+    {
+      files: ["*.ts", "*.js", "*.tsx", "*.jsx"],
+      extends: ["biome"],
+    },
+  ],
+  env: {
+    browser: true,
+    node: true,
+  },
+};

packages/thirdweb/src/wallets/wallet-connect/receiver/receiver.test.ts

@@ -27,7 +27,7 @@ const URI_MOCK =
 
 const DEFAULT_METADATA = getDefaultAppMetadata();
 
-const listeners: Record<string, (event?: unknown) => Promise<void>> = {};
+const listeners: Record<string, (_event?: unknown) => Promise<void>> = {};
 
 const signClientMock = {
   on: vi.fn((event, listener) => {

packages/thirdweb/src/wallets/wallet-connect/types.ts

@@ -160,7 +160,7 @@ export type WCConnectOptions = {
        * })
        * ```
        */
-      onDisplayUri?: (uri: string) => void;
+      onDisplayUri?: (_uri: string) => void;
     }
   >;
 };

packages/thirdweb/src/wallets/wallet-types.ts

@@ -134,7 +134,7 @@ export type WalletAutoConnectionOption<T extends WalletId> =
  * @example
  * ```ts
  * type X = WalletCreationOptions<'io.metamask'>
- * ````
+ * ```
  */
 export type WalletCreationOptions<T extends WalletId> = T extends "smart"
   ? SmartWalletOptions

packages/thirdweb/tsdoc.json

@@ -1,118 +1,122 @@
 {
-  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
-  "tagDefinitions": [
-    {
-      "tagName": "@contract",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@wallet",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@extension",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@rpc",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@transaction",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@connectWallet",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@theme",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@locale",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@component",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@walletConfig",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@walletConnection",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@walletUtils",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@buyCrypto",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@storage",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@auth",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@utils",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@chain",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@modules",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@social",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@client",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@nft",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@account",
-      "syntaxKind": "block"
-    }
-  ],
-  "supportForTags": {
-    "@contract": true,
-    "@wallet": true,
-    "@extension": true,
-    "@rpc": true,
-    "@transaction": true,
-    "@connectWallet": true,
-    "@theme": true,
-    "@locale": true,
-    "@component": true,
-    "@walletConfig": true,
-    "@walletConnection": true,
-    "@walletUtils": true,
-    "@buyCrypto": true,
-    "@storage": true,
-    "@auth": true,
-    "@utils": true,
-    "@chain": true,
-    "@modules": true,
-    "@social": true,
-    "@client": true,
-    "@nft": true,
-    "@account": true,
-    "@beta": true
-  }
+	"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+	"tagDefinitions": [
+		{
+			"tagName": "@example",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@contract",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@wallet",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@extension",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@rpc",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@transaction",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@connectWallet",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@theme",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@locale",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@component",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@walletConfig",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@walletConnection",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@walletUtils",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@buyCrypto",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@storage",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@auth",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@utils",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@chain",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@modules",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@social",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@client",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@nft",
+			"syntaxKind": "block"
+		},
+		{
+			"tagName": "@account",
+			"syntaxKind": "block"
+		}
+	],
+	"supportForTags": {
+		"@contract": true,
+		"@wallet": true,
+		"@extension": true,
+		"@rpc": true,
+		"@transaction": true,
+		"@connectWallet": true,
+		"@theme": true,
+		"@locale": true,
+		"@component": true,
+		"@walletConfig": true,
+		"@walletConnection": true,
+		"@walletUtils": true,
+		"@buyCrypto": true,
+		"@storage": true,
+		"@auth": true,
+		"@utils": true,
+		"@chain": true,
+		"@modules": true,
+		"@social": true,
+		"@client": true,
+		"@nft": true,
+		"@account": true,
+		"@beta": true
+	}
 }