Merge pull request #7 from vechainfoundation/pre-commit-hooks

Pre commit hooks

.eslintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["custom/library"],
+};

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit "$1"

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no-install lint-staged

apps/sample-react-app/package.json

@@ -10,7 +10,7 @@
     "build": "react-app-rewired build",
     "test": "react-app-rewired test",
     "eject": "react-app-rewired eject",
-    "lint": "eslint src/**/*",
+    "lint": "eslint src --ext .js,.jsx,.ts,.tsx",
     "clean": "rm -rf build node_modules .turbo"
   },
   "dependencies": {
@@ -74,4 +74,4 @@
       "last 1 safari version"
     ]
   }
-}
+}

apps/sample-react-app/src/Components/AddressIcon.tsx

@@ -1,5 +1,5 @@
 import React from "react";
-import type { HTMLChakraProps} from "@chakra-ui/react";
+import type { HTMLChakraProps } from "@chakra-ui/react";
 import { Img } from "@chakra-ui/react";
 import { getPicassoImgSrc } from "../Utils/AccountUtils";
 

apps/sample-react-app/src/Components/shared/Dialog.tsx

@@ -1,5 +1,4 @@
-import type {
-  HTMLChakraProps} from "@chakra-ui/react";
+import type { HTMLChakraProps } from "@chakra-ui/react";
 import {
   Modal,
   ModalBody,

apps/sample-react-app/src/Components/shared/StyledCard.tsx

@@ -1,10 +1,5 @@
-import type {
-  HTMLChakraProps} from "@chakra-ui/react";
-import {
-  Card,
-  CardBody,
-  useColorModeValue,
-} from "@chakra-ui/react";
+import type { HTMLChakraProps } from "@chakra-ui/react";
+import { Card, CardBody, useColorModeValue } from "@chakra-ui/react";
 import React from "react";
 
 interface StyledCardProps extends HTMLChakraProps<"div"> {

apps/sample-react-app/src/Logos/Logo.tsx

@@ -1,4 +1,4 @@
-import type { HTMLChakraProps} from "@chakra-ui/react";
+import type { HTMLChakraProps } from "@chakra-ui/react";
 import { Image, useColorModeValue } from "@chakra-ui/react";
 import React from "react";
 

commitlint.config.js

@@ -0,0 +1 @@
+module.exports = { extends: ["@commitlint/config-conventional"] };

package.json

@@ -10,14 +10,34 @@
     "format": "prettier --write \"**/*.{ts,tsx,md}\"",
     "lint": "turbo run lint",
     "build": "turbo run build",
-    "test": "turbo run test"
+    "test": "turbo run test",
+    "prepare": "husky install"
   },
   "devDependencies": {
+    "@commitlint/config-conventional": "^18.0.0",
+    "commitlint": "^18.0.0",
     "eslint": "^8.4.1",
+    "eslint-config-custom": "workspace:*",
     "eslint-plugin-prefer-arrow": "1.2.3",
+    "husky": "^8.0.0",
+    "lint-staged": "^15.0.2",
     "prettier": "^2.5.1",
     "tsconfig": "workspace:*",
     "turbo": "latest"
   },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx,json,md}": [
+      "prettier --write",
+      "git add"
+    ],
+    "*.{js,jsx,ts,tsx}": [
+      "eslint"
+    ]
+  },
   "packageManager": "[email protected]"
-}
+}

packages/react-vendor/README.md

@@ -1,135 +1 @@
 # React Vendor
-
-## Usage
-
-- Wrap a `ConnexVendorProvider` around your application:
-
-```typescript jsx
-export const SampleApp: React.FC = () => {
-
-  // So that we can use the genesis ID
-  const thor = new Connex.Thor({
-    node: "https://mainnet.vechain.org/",
-    network: "main",
-  });
-
-  return (
-    <ConnexVendorProvider
-      defaultWallet={{ source: "sync2" }}
-      genesisId={thor.genesis.id}
-    >
-      <Account />
-    </ConnexVendorProvider>
-  );
-};
-
-```
-
-- Selecting a wallet source
-
-```typescript jsx
-// https://docs.walletconnect.com/cloud/explorer#setting-up-a-new-project
-
-const walletConnectProjectId = "yourProjectId";
-const walletConnectMetadata = "yourMetadata";
-
-const mobileWalletOptions: MobileWalletOptions = {
-  projectId: "yourProjectId",
-  metadata: {
-    name: "My dApp",
-    description: "My dApp description",
-    url: window.location.origin,
-    icons: [`${window.location.origin}/images/logo/my-dapp.png`],
-  },
-};
-
-const SelectWallet: React.FC = (): JSX.Element => {
-    const { setWallet, wallet } = useConnexVendor();
-
-    const handleOptionChange = (event: ChangeEvent<HTMLInputElement>) => {
-      const { value } = event.target;
-
-      switch (value) {
-        case "sync2":
-        case "sync": {
-          setWallet({ source: value });
-          break;
-        }
-        case "veworld-extension": {
-          // validate the extension is installed
-          if (!window.vechain) return;
-          setWallet({ source: value });
-          break;
-        }
-        case "veworld-mobile": {
-          // pass in the options for VeWorld Mobile
-          setWallet({ source: value, options: mobileWalletOptions });
-          break;
-        }
-      }
-    };
-
-    /**
-     * TODO: Create a component to select the wallet
-     * - you should disable veworld extension option if `window.vechain` is not defined
-     */
-
-    return (
-      <div>
-        <h2>Select a Wallet</h2>
-        <form>
-          {/*TODO: Create a component to select the wallet*/}
-        </form>
-
-        <p>Selected Wallet: {wallet.source}</p>
-      </div>
-    )
-      ;
-  }
-;
-```
-
-- Vendor Usage:
-
-```typescript jsx
-const IdentifyUser: React.FC = (): JSX.Element => {
-  const { vendor } = useConnexVendor();
-
-  const [account, setAccount] = useState<string>();
-
-  const requestSignCertificate = useCallback(
-    async (msg: Connex.Vendor.CertMessage): Promise<string> => {
-      const response = await vendor.sign("cert", msg).request();
-
-      //TODO: Validate signature / signer
-
-      return response.annex.signer;
-    },
-    [vendor]
-  );
-
-  const identifyUser = useCallback((): void => {
-    requestSignCertificate({
-      purpose: "identification",
-      payload: {
-        type: "text",
-        content: "Hello, VeChain!",
-      },
-    })
-      .then(setAccount)
-      .catch((err) => {
-        throw err;
-      });
-  }, [requestSignCertificate]);
-
-  return (
-    <>
-      <button onClick={identifyUser} type="button">
-        Identify
-      </button>
-
-      {account ? <p>Account: {account}</p> : null}
-    </>
-  );
-};
-```

packages/react-vendor/package.json

@@ -10,7 +10,7 @@
     "build": "tsup src/index.tsx --format cjs --dts --external react",
     "clean": "rm -rf dist node_modules .turbo",
     "dev": "tsup src/index.tsx --format cjs --watch --dts --external react",
-    "lint": "eslint src/**/*"
+    "lint": "eslint src --ext .js,.jsx,.ts,.tsx"
   },
   "dependencies": {
     "@vechain/connex": "2.1.0",
@@ -28,4 +28,4 @@
     "tsup": "^5.10.1",
     "typescript": "4.9.5"
   }
-}
+}

packages/tsconfig/base.json

@@ -16,7 +16,5 @@
     "skipLibCheck": true,
     "strict": true
   },
-  "exclude": [
-    "node_modules"
-  ]
-}
+  "exclude": ["node_modules"]
+}

packages/tsconfig/package.json

@@ -11,4 +11,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

packages/tsconfig/react-app.json

@@ -8,11 +8,7 @@
     "declarationMap": false,
     "incremental": true,
     "jsx": "preserve",
-    "lib": [
-      "dom",
-      "dom.iterable",
-      "esnext"
-    ],
+    "lib": ["dom", "dom.iterable", "esnext"],
     "module": "esnext",
     "noEmit": true,
     "resolveJsonModule": true,

packages/tsconfig/react-library.json

@@ -4,10 +4,7 @@
   "extends": "./base.json",
   "compilerOptions": {
     "jsx": "react-jsx",
-    "lib": [
-      "ES2020",
-      "dom"
-    ],
+    "lib": ["ES2020", "dom"],
     "sourceMap": false,
     "module": "ESNext",
     "target": "ES6"

packages/wallet-connect/README.md

@@ -1 +1 @@
-# `wallet-connect`
+# `wallet-connect`

packages/wallet-connect/package.json

@@ -9,7 +9,7 @@
     "build": "tsup src/index.ts --format cjs --dts",
     "clean": "rm -rf dist node_modules .turbo",
     "dev": "tsup src/index.ts --format cjs --watch --dts",
-    "lint": "eslint src/**/*"
+    "lint": "eslint src --ext .js,.jsx,.ts,.tsx"
   },
   "dependencies": {
     "@walletconnect/modal": "2.6.2",
@@ -25,4 +25,4 @@
     "tsup": "^5.10.1",
     "typescript": "4.9.5"
   }
-}
+}