match viem tsconfig and build settings, ready to try publishing (#65)

* match viem tsconfig and build settings, ready to try publishing

* updated to more closely match viem

* more cleanup and matching, build working now I think

* more fixes

* build and import working, but not seeing types as expected

* closer, still not type checking how I want it to

* fix typecheck, revert: different errors on different machines

* bump version

* fix types for package

* add src/utils/index.ts

* version bump

* fix export

* version bump

* fixes

* improve exports

* version bump

* format and add more utils exports

* add export

* 17

* improve types

* add chains to export

* add export types, I think that will be the last for this

* attempt type fix

* fix types

* add typecheck to workflow

Author: wilsoncusack

.github/workflows/verify.yml

@@ -33,6 +33,32 @@ jobs:
 
       - name: Lint code
         run: pnpm format:check && pnpm lint
+
+  types:
+    name: Types
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+
+      - name: Set up node
+        uses: actions/setup-node@v3
+        with:
+          cache: pnpm
+          node-version: 18
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Check types
+        run: pnpm typecheck
 
   test:
     name: Test

.gitignore

@@ -24,4 +24,6 @@ yarn-error.log*
 bench
 dist
 cache
-node_modules
+node_modules
+tsconfig*.tsbuildinfo
+*.tgz

.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+  "editor.defaultFormatter": "dprint.dprint",
+  "editor.formatOnSave": true,
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "typescript.enablePromptUseWorkspaceTsdk": true,
+  "editor.codeActionsOnSave": {
+    "source.organizeImports.biome": true
+  }
+}

package.json

@@ -1,6 +1,49 @@
 {
-  "name": "op-viem",
-  "version": "0.1.0",
+  "name": "test-op-viem",
+  "version": "0.0.21-alpha",
+  "type": "module",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "typings": "./dist/types/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "!dist/**/*.tsbuildinfo",
+    "src/**/*.ts",
+    "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
+    "!src/**/*.bench.ts",
+    "!src/_test/**/*"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "default": "./dist/cjs/index.js"
+    },
+    "./chains": {
+      "types": "./dist/types/chains/index.d.ts",
+      "import": "./dist/esm/chains/index.js",
+      "default": "./dist/cjs/chains/index.js"
+    },
+    "./utils": {
+      "types": "./dist/types/utils/index.d.ts",
+      "import": "./dist/esm/utils/index.js",
+      "default": "./dist/cjs/utils/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "chains": [
+        "./dist/types/chains.d.ts"
+      ],
+      "utils": [
+        "./dist/types/utils/index.d.ts"
+      ]
+    }
+  },
   "devDependencies": {
     "@biomejs/biome": "1.0.0",
     "@eth-optimism/core-utils": "^0.12.3",
@@ -17,11 +60,17 @@
     "ethers": "^5.7.0",
     "react": "^18.1.0",
     "react-dom": "^18.1.0",
-    "typescript": "^5.2.2",
+    "rimraf": "^5.0.1",
+    "typescript": "5.0.4",
     "vitest": "^0.34.1",
     "wagmi": "^1.3.11"
   },
   "scripts": {
+    "build": "pnpm run clean && pnpm run build:cjs && pnpm run build:esm && pnpm run build:types",
+    "build:cjs": "tsc --project tsconfig.build.json --module commonjs --outDir ./dist/cjs --removeComments --verbatimModuleSyntax false && echo > ./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
+    "build:esm": "tsc --project tsconfig.build.json --module es2015 --outDir ./dist/esm && echo > ./dist/esm/package.json '{\"type\":\"module\",\"sideEffects\":false}'",
+    "build:types": "tsc --project tsconfig.build.json --module esnext --declarationDir ./dist/types --emitDeclarationOnly --declaration --declarationMap",
+    "clean": "rimraf dist",
     "format": "dprint fmt",
     "format:check": "dprint check",
     "lint": "biome check .",
@@ -40,6 +89,17 @@
     "@eth-optimism/contracts-ts": "^0.15.0"
   },
   "peerDependencies": {
-    "viem": "1.x"
+    "viem": "1.x",
+    "typescript": ">=5.0.4"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "pnpm": {
+    "overrides": {
+      "test-op-viem": "workspace:*"
+    }
   }
 }