feat: run prettier on all files + wallet rpc examples (#12)

web3 · Oct 30, 2024 · f7cd6ac · f7cd6ac
1 parent 169b12c
commit f7cd6ac
Show file tree

Hide file tree

Showing 45 changed files with 693 additions and 450 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -9,53 +9,53 @@ on:
       - '**'
 
 jobs:
-    build:
-        name: Build
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v3
-            - uses: actions/setup-node@v3
-              with:
-                cache: yarn
-                node-version: '18'
-            - name: Install deps
-              run: yarn install --frozen-lockfile
-            - name: Build
-              run: yarn build
-            - name: Lint
-              run: yarn run lint
-            - name: Tests
-              run: yarn run test
-
-    maybe-release:
-        name: release
-        runs-on: ubuntu-latest
-        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-        steps:
-            - uses: google-github-actions/release-please-action@v3
-              id: release
-              with:
-                release-type: node
-                package-name: release-please-action
-                changelog-types: '[{"type":"feat","section":"Features","hidden":false},{"type":"fix","section":"Bug Fixes","hidden":false},{"type":"chore","section":"Miscellaneous","hidden":true}]'
-            
-            - uses: actions/checkout@v3
-              if: ${{ steps.release.outputs.release_created }}
-            
-            - uses: actions/setup-node@v3
-              with:
-                cache: 'yarn'
-                node-version: 18
-                registry-url: 'https://registry.npmjs.org'
-              if: ${{ steps.release.outputs.release_created }}
-            
-            - run: yarn install --frozen-lockfile
-              if: ${{ steps.release.outputs.release_created }}
-            
-            - run: yarn build
-              if: ${{ steps.release.outputs.release_created }}
-
-            - run: yarn publish --access public
-              env:
-                NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
-              if: ${{ steps.release.outputs.release_created }}
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          cache: yarn
+          node-version: '18'
+      - name: Install deps
+        run: yarn install --frozen-lockfile
+      - name: Build
+        run: yarn build
+      - name: Lint
+        run: yarn run lint
+      - name: Tests
+        run: yarn run test
+
+  maybe-release:
+    name: release
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          release-type: node
+          package-name: release-please-action
+          changelog-types: '[{"type":"feat","section":"Features","hidden":false},{"type":"fix","section":"Bug Fixes","hidden":false},{"type":"chore","section":"Miscellaneous","hidden":true}]'
+
+      - uses: actions/checkout@v3
+        if: ${{ steps.release.outputs.release_created }}
+
+      - uses: actions/setup-node@v3
+        with:
+          cache: 'yarn'
+          node-version: 18
+          registry-url: 'https://registry.npmjs.org'
+        if: ${{ steps.release.outputs.release_created }}
+
+      - run: yarn install --frozen-lockfile
+        if: ${{ steps.release.outputs.release_created }}
+
+      - run: yarn build
+        if: ${{ steps.release.outputs.release_created }}
+
+      - run: yarn publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+        if: ${{ steps.release.outputs.release_created }}
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -19,7 +19,7 @@ permissions:
 # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
 # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
 concurrency:
-  group: "pages"
+  group: 'pages'
   cancel-in-progress: false
 
 jobs:

diff --git a/.github/workflows/pr_title.yml b/.github/workflows/pr_title.yml
@@ -1,4 +1,4 @@
-name: "Semantic PR"
+name: 'Semantic PR'
 
 on:
   pull_request_target:

diff --git a/.prettierrc.json b/.prettierrc.json
@@ -1,3 +1,9 @@
 {
-  "trailingComma": "all"
+  "semi": true,
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 90,
+  "tabWidth": 2,
+  "endOfLine": "auto",
+  "bracketSpacing": true
 }
diff --git a/README.md b/README.md
@@ -35,10 +35,10 @@ pnpm add web3-plugin-wallet-rpc
 ### Register plugin
 
 ```typescript
-import { Web3 } from "web3";
-import { WalletRpcPlugin } from "web3-plugin-wallet-rpc";
+import { Web3 } from 'web3';
+import { WalletRpcPlugin } from 'web3-plugin-wallet-rpc';
 
-const web3 = new Web3("https://eth.llamarpc.com");
+const web3 = new Web3('https://eth.llamarpc.com');
 web3.registerPlugin(new WalletRpcPlugin());
 ```
 
@@ -51,15 +51,15 @@ Invokes the `wallet_addEthereumChain` method as defined in [EIP-3085](https://ei
 ```typescript
 await web3.walletRpc.addEthereumChain({
   chainId: 5000,
-  blockExplorerUrls: ["https://mantlescan.xyz"],
-  chainName: "Mantle",
-  iconUrls: ["https://icons.llamao.fi/icons/chains/rsz_mantle.jpg"],
+  blockExplorerUrls: ['https://mantlescan.xyz'],
+  chainName: 'Mantle',
+  iconUrls: ['https://icons.llamao.fi/icons/chains/rsz_mantle.jpg'],
   nativeCurrency: {
-    name: "Mantle",
-    symbol: "MNT",
+    name: 'Mantle',
+    symbol: 'MNT',
     decimals: 18,
   },
-  rpcUrls: ["https://rpc.mantle.xyz"],
+  rpcUrls: ['https://rpc.mantle.xyz'],
 });
 ```
 
@@ -77,10 +77,10 @@ Invokes the `wallet_watchAsset` method as defined in [EIP-747](https://eips.ethe
 
 ```typescript
 await web3.walletRpc.watchAsset({
-  type: "ERC20",
+  type: 'ERC20',
   options: {
-    address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
-    symbol: "USDC",
+    address: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
+    symbol: 'USDC',
   },
 });
 ```
@@ -122,14 +122,14 @@ Invokes the `wallet_updateEthereumChain` method as defined in [EIP-2015](https:/
 ```typescript
 await web3.walletRpc.updateEthereumChain({
   chainId: 5000,
-  blockExplorerUrls: ["https://mantlescan.xyz"],
-  chainName: "Mantle",
+  blockExplorerUrls: ['https://mantlescan.xyz'],
+  chainName: 'Mantle',
   nativeCurrency: {
-    name: "Mantle",
-    symbol: "MNT",
+    name: 'Mantle',
+    symbol: 'MNT',
     decimals: 18,
   },
-  rpcUrls: ["https://rpc.mantle.xyz"],
+  rpcUrls: ['https://rpc.mantle.xyz'],
 });
 ```
 
@@ -139,7 +139,7 @@ Invokes the `wallet_getOwnedAssets` method as defined in [EIP-2256](https://eips
 
 ```typescript
 const ownedAssets = await web3.walletRpc.getOwnedAssets({
-  address: "0xa5653e88D9c352387deDdC79bcf99f0ada62e9c6",
+  address: '0xa5653e88D9c352387deDdC79bcf99f0ada62e9c6',
 });
 ```
 

diff --git a/package.json b/package.json
@@ -21,11 +21,16 @@
   ],
   "packageManager": "[email protected]",
   "scripts": {
-    "lint": "cd packages/web3-plugin-wallet-rpc && yarn lint",
     "build": "cd packages/web3-plugin-wallet-rpc && yarn build",
     "build:docs": "cd packages/web3-plugin-wallet-rpc && yarn build:docs",
     "test": "cd packages/web3-plugin-wallet-rpc && yarn test",
+    "lint": "yarn lint:plugin && yarn lint:example",
+    "lint:plugin": "cd packages/web3-plugin-wallet-rpc && yarn lint",
     "lint:example": "cd packages/example-react-app && yarn lint",
-    "start:example": "cd packages/example-react-app && yarn start"
+    "format": "prettier --write .",
+    "start:example": "yarn build && cd packages/example-react-app && yarn start"
+  },
+  "devDependencies": {
+    "prettier": "^3.3.3"
   }
 }
diff --git a/packages/example-react-app/package.json b/packages/example-react-app/package.json
@@ -8,22 +8,24 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@types/node": "^16.18.108",
-    "@types/react": "^18.3.8",
-    "@types/react-dom": "^18.3.0",
-    "@types/uuid": "^10.0.0",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
-    "react-scripts": "5.0.1",
-    "typescript": "5.3.x",
     "uuid": "^10.0.0",
     "web3": "^4.14.0",
-    "web3-eth": "^4.9.0",
     "web3-plugin-wallet-rpc": "*"
   },
+  "devDependencies": {
+    "@types/node": "^16.18.108",
+    "@types/react": "^18.3.8",
+    "@types/react-dom": "^18.3.0",
+    "@types/uuid": "^10.0.0",
+    "eslint": "8",
+    "react-scripts": "5.0.1",
+    "typescript": "5.3.x"
+  },
   "scripts": {
     "start": "react-scripts start",
-    "lint": "eslint 'src/**/*.{ts,tsx}'"
+    "lint": "eslint 'src/**/*.{js,ts,tsx}'"
   },
   "eslintConfig": {
     "extends": [

diff --git a/packages/example-react-app/public/index.html b/packages/example-react-app/public/index.html
@@ -1,14 +1,11 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="utf-8" />
     <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta name="theme-color" content="#000000" />
-    <meta
-      name="description"
-      content="Web3.js Wallet RPC Methods Demonstration dApp"
-    />
+    <meta name="description" content="Web3.js Wallet RPC Methods Demonstration dApp" />
     <!--
       manifest.json provides metadata used when your web app is installed on a
       user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/

diff --git a/packages/example-react-app/src/AccountDetail.tsx b/packages/example-react-app/src/AccountDetail.tsx