🐛 fix: Typedoc doc generation bugs (#604)

## Description - Bad public path - More explicit entrypoints ## Testing Explain the quality checks that have been done on the code changes ## Additional Information - [ ] I read the [contributing docs](../docs/contributing.md) (if this is your first contribution) Your ENS/address: Co-authored-by: Will Cory <[email protected]>
evmts · Oct 24, 2023 · 43d6702 · 43d6702 · vercel · Oct 24, 2023
1 parent 408b942
commit 43d6702
Show file tree

Hide file tree

Showing 87 changed files with 1,371 additions and 852 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -80,3 +80,21 @@ jobs:
         with:
           name: "@evmts/blockexplorer"
           working-directory: "./blockexplorer"
+      - name: 'Report @evmts/runtime Coverage'
+        if: always() # Also generate the report if tests are failing
+        uses:  davelosert/vitest-coverage-report-action@v2
+        with:
+          name: "@evmts/runtime"
+          working-directory: "./runtime"
+      - name: 'Report @evmts/solc Coverage'
+        if: always() # Also generate the report if tests are failing
+        uses:  davelosert/vitest-coverage-report-action@v2
+        with:
+          name: "@evmts/solc"
+          working-directory: "./solc"
+      - name: 'Report @evmts/unplugin Coverage'
+        if: always() # Also generate the report if tests are failing
+        uses:  davelosert/vitest-coverage-report-action@v2
+        with:
+          name: "@evmts/unplugin"
+          working-directory: "./bundlers/unplugin"
diff --git a/blockexplorer/doc/README.md b/blockexplorer/doc/README.md
@@ -1,4 +1,4 @@
-@evmts/blockexplorer / [Exports](/reference/blockexplorer/modules.md)
+@evmts/blockexplorer / [Exports](modules.md)
 
 <p align="center">
   <a href="https://evmts.dev/">

diff --git a/blockexplorer/doc/classes/SafeStandardBlockExplorer.md b/blockexplorer/doc/classes/SafeStandardBlockExplorer.md
@@ -1,4 +1,4 @@
-[@evmts/blockexplorer](/reference/blockexplorer/README.md) / [Exports](/reference/blockexplorer/modules.md) / SafeStandardBlockExplorer
+[@evmts/blockexplorer](../README.md) / [Exports](../modules.md) / SafeStandardBlockExplorer
 
 # Class: SafeStandardBlockExplorer
 
@@ -22,20 +22,20 @@ const txUrlEffect = etherscan.getTxUrl('0x1234')
 
 ### Constructors
 
-- [constructor](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md#constructor)
+- [constructor](SafeStandardBlockExplorer.md#constructor)
 
 ### Properties
 
-- [chainId](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md#chainid)
-- [name](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md#name)
-- [url](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md#url)
-- [ERRORS](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md#errors)
+- [chainId](SafeStandardBlockExplorer.md#chainid)
+- [name](SafeStandardBlockExplorer.md#name)
+- [url](SafeStandardBlockExplorer.md#url)
+- [ERRORS](SafeStandardBlockExplorer.md#errors)
 
 ### Methods
 
-- [getAddressUrl](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md#getaddressurl)
-- [getBlockUrl](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md#getblockurl)
-- [getTxUrl](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md#gettxurl)
+- [getAddressUrl](SafeStandardBlockExplorer.md#getaddressurl)
+- [getBlockUrl](SafeStandardBlockExplorer.md#getblockurl)
+- [getTxUrl](SafeStandardBlockExplorer.md#gettxurl)
 
 ## Constructors
 
@@ -47,7 +47,7 @@ const txUrlEffect = etherscan.getTxUrl('0x1234')
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `options` | [`BlockExplorerOptions`](/reference/blockexplorer/interfaces/BlockExplorerOptions.md) | The options for the BlockExplorer. |
+| `options` | [`BlockExplorerOptions`](../interfaces/BlockExplorerOptions.md) | The options for the BlockExplorer. |
 
 #### Defined in
 

diff --git a/blockexplorer/doc/classes/StandardBlockExplorer.md b/blockexplorer/doc/classes/StandardBlockExplorer.md
@@ -1,4 +1,4 @@
-[@evmts/blockexplorer](/reference/blockexplorer/README.md) / [Exports](/reference/blockexplorer/modules.md) / StandardBlockExplorer
+[@evmts/blockexplorer](../README.md) / [Exports](../modules.md) / StandardBlockExplorer
 
 # Class: StandardBlockExplorer
 
@@ -21,21 +21,21 @@ const txUrl = etherscan.getTxUrl('0x1234')
 
 ### Constructors
 
-- [constructor](/reference/blockexplorer/classes/StandardBlockExplorer.md#constructor)
+- [constructor](StandardBlockExplorer.md#constructor)
 
 ### Properties
 
-- [chainId](/reference/blockexplorer/classes/StandardBlockExplorer.md#chainid)
-- [name](/reference/blockexplorer/classes/StandardBlockExplorer.md#name)
-- [safeBlockExplorer](/reference/blockexplorer/classes/StandardBlockExplorer.md#safeblockexplorer)
-- [url](/reference/blockexplorer/classes/StandardBlockExplorer.md#url)
-- [ERRORS](/reference/blockexplorer/classes/StandardBlockExplorer.md#errors)
+- [chainId](StandardBlockExplorer.md#chainid)
+- [name](StandardBlockExplorer.md#name)
+- [safeBlockExplorer](StandardBlockExplorer.md#safeblockexplorer)
+- [url](StandardBlockExplorer.md#url)
+- [ERRORS](StandardBlockExplorer.md#errors)
 
 ### Methods
 
-- [getAddressUrl](/reference/blockexplorer/classes/StandardBlockExplorer.md#getaddressurl)
-- [getBlockUrl](/reference/blockexplorer/classes/StandardBlockExplorer.md#getblockurl)
-- [getTxUrl](/reference/blockexplorer/classes/StandardBlockExplorer.md#gettxurl)
+- [getAddressUrl](StandardBlockExplorer.md#getaddressurl)
+- [getBlockUrl](StandardBlockExplorer.md#getblockurl)
+- [getTxUrl](StandardBlockExplorer.md#gettxurl)
 
 ## Constructors
 
@@ -47,7 +47,7 @@ const txUrl = etherscan.getTxUrl('0x1234')
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `options` | [`BlockExplorerOptions`](/reference/blockexplorer/interfaces/BlockExplorerOptions.md) | The options for the BlockExplorer. |
+| `options` | [`BlockExplorerOptions`](../interfaces/BlockExplorerOptions.md) | The options for the BlockExplorer. |
 
 #### Defined in
 
@@ -77,7 +77,7 @@ ___
 
 ### safeBlockExplorer
 
-• **safeBlockExplorer**: [`SafeStandardBlockExplorer`](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md)
+• **safeBlockExplorer**: [`SafeStandardBlockExplorer`](SafeStandardBlockExplorer.md)
 
 #### Defined in
 

diff --git a/blockexplorer/doc/interfaces/BlockExplorerOptions.md b/blockexplorer/doc/interfaces/BlockExplorerOptions.md
@@ -1,14 +1,14 @@
-[@evmts/blockexplorer](/reference/blockexplorer/README.md) / [Exports](/reference/blockexplorer/modules.md) / BlockExplorerOptions
+[@evmts/blockexplorer](../README.md) / [Exports](../modules.md) / BlockExplorerOptions
 
 # Interface: BlockExplorerOptions<\>
 
 ## Table of contents
 
 ### Properties
 
-- [chainId](/reference/blockexplorer/interfaces/BlockExplorerOptions.md#chainid)
-- [name](/reference/blockexplorer/interfaces/BlockExplorerOptions.md#name)
-- [url](/reference/blockexplorer/interfaces/BlockExplorerOptions.md#url)
+- [chainId](BlockExplorerOptions.md#chainid)
+- [name](BlockExplorerOptions.md#name)
+- [url](BlockExplorerOptions.md#url)
 
 ## Properties
 

diff --git a/blockexplorer/doc/modules.md b/blockexplorer/doc/modules.md
@@ -1,22 +1,22 @@
-[@evmts/blockexplorer](/reference/blockexplorer/README.md) / Exports
+[@evmts/blockexplorer](README.md) / Exports
 
 # @evmts/blockexplorer
 
 ## Table of contents
 
 ### Classes
 
-- [SafeStandardBlockExplorer](/reference/blockexplorer/classes/SafeStandardBlockExplorer.md)
-- [StandardBlockExplorer](/reference/blockexplorer/classes/StandardBlockExplorer.md)
+- [SafeStandardBlockExplorer](classes/SafeStandardBlockExplorer.md)
+- [StandardBlockExplorer](classes/StandardBlockExplorer.md)
 
 ### Interfaces
 
-- [BlockExplorerOptions](/reference/blockexplorer/interfaces/BlockExplorerOptions.md)
+- [BlockExplorerOptions](interfaces/BlockExplorerOptions.md)
 
 ### Type Aliases
 
-- [Address](/reference/blockexplorer/modules.md#address)
-- [Hex](/reference/blockexplorer/modules.md#hex)
+- [Address](modules.md#address)
+- [Hex](modules.md#hex)
 
 ## Type Aliases
 

diff --git a/blockexplorer/typedoc.json b/blockexplorer/typedoc.json
@@ -1,8 +1,7 @@
 {
 	"$schema": "https://typedoc.org/schema.json",
 	"out": "./doc",
-	"entryPoints": ["./src/index.js"],
-	"publicPath": "/reference/blockexplorer/",
+	"entryPoints": ["./src/blockExplorer.js"],
 	"plugin": ["typedoc-plugin-markdown"],
 	"gitRevision": "main"
 }
diff --git a/bundlers/bun/docs/README.md b/bundlers/bun/docs/README.md
@@ -1,4 +1,4 @@
-@evmts/bun-plugin / [Exports](/reference/bun-plugin/modules.md)
+@evmts/bun-plugin / [Exports](modules.md)
 
 # @evmts/plugin-bun
 

diff --git a/bundlers/bun/docs/modules.md b/bundlers/bun/docs/modules.md
@@ -1,12 +1,12 @@
-[@evmts/bun-plugin](/reference/bun-plugin/README.md) / Exports
+[@evmts/bun-plugin](README.md) / Exports
 
 # @evmts/bun-plugin
 
 ## Table of contents
 
 ### Functions
 
-- [evmtsBunPlugin](/reference/bun-plugin/modules.md#evmtsbunplugin)
+- [evmtsBunPlugin](modules.md#evmtsbunplugin)
 
 ## Functions
 

diff --git a/bundlers/bun/typedoc.json b/bundlers/bun/typedoc.json
@@ -2,7 +2,6 @@
 	"$schema": "https://typedoc.org/schema.json",
 	"out": "./docs",
 	"entryPoints": ["./src/index.js"],
-	"publicPath": "/reference/bun-plugin/",
 	"plugin": ["typedoc-plugin-markdown"],
 	"gitRevision": "main"
 }
diff --git a/bundlers/bundler/typedoc.json b/bundlers/bundler/typedoc.json
@@ -4,12 +4,8 @@
 	"entryPoints": [
 		"./src/bundler.js",
 		"./src/createCache.js",
-		"./src/unplugin.js",
-		"./src/runtime/index.js",
-		"./src/solc/index.js",
-		"./src/utils/index.js"
+		"./src/solc/types.js"
 	],
-	"publicPath": "/reference/bundler/",
 	"plugin": ["typedoc-plugin-markdown"],
 	"gitRevision": "main"
 }
diff --git a/bundlers/esbuild/docs/README.md b/bundlers/esbuild/docs/README.md
@@ -1,4 +1,4 @@
-@evmts/esbuild-plugin / [Exports](/reference/esbuild-plugin/modules.md)
+@evmts/esbuild-plugin / [Exports](modules.md)
 
 # @evmts/plugin
 

diff --git a/bundlers/esbuild/docs/modules.md b/bundlers/esbuild/docs/modules.md
@@ -1,12 +1,12 @@
-[@evmts/esbuild-plugin](/reference/esbuild-plugin/README.md) / Exports
+[@evmts/esbuild-plugin](README.md) / Exports
 
 # @evmts/esbuild-plugin
 
 ## Table of contents
 
 ### Functions
 
-- [esbuildPluginEvmts](/reference/esbuild-plugin/modules.md#esbuildpluginevmts)
+- [esbuildPluginEvmts](modules.md#esbuildpluginevmts)
 
 ## Functions
 

diff --git a/bundlers/esbuild/typedoc.json b/bundlers/esbuild/typedoc.json
@@ -2,7 +2,6 @@
 	"$schema": "https://typedoc.org/schema.json",
 	"out": "./docs",
 	"entryPoints": ["./src/index.js"],
-	"publicPath": "/reference/esbuild-plugin/",
 	"plugin": ["typedoc-plugin-markdown"],
 	"gitRevision": "main"
 }
diff --git a/bundlers/rollup/docs/README.md b/bundlers/rollup/docs/README.md
@@ -1,4 +1,4 @@
-@evmts/rollup-plugin / [Exports](/reference/rollup-plugin/modules.md)
+@evmts/rollup-plugin / [Exports](modules.md)
 
 # @evmts/plugin
 

diff --git a/bundlers/rollup/docs/modules.md b/bundlers/rollup/docs/modules.md
@@ -1,12 +1,12 @@
-[@evmts/rollup-plugin](/reference/rollup-plugin/README.md) / Exports
+[@evmts/rollup-plugin](README.md) / Exports
 
 # @evmts/rollup-plugin
 
 ## Table of contents
 
 ### Functions
 
-- [rollupPluginEvmts](/reference/rollup-plugin/modules.md#rolluppluginevmts)
+- [rollupPluginEvmts](modules.md#rolluppluginevmts)
 
 ## Functions
 

diff --git a/bundlers/rollup/typedoc.json b/bundlers/rollup/typedoc.json
@@ -2,7 +2,6 @@
 	"$schema": "https://typedoc.org/schema.json",
 	"out": "./docs",
 	"entryPoints": ["./src/index.js"],
-	"publicPath": "/reference/rollup-plugin/",
 	"plugin": ["typedoc-plugin-markdown"],
 	"gitRevision": "main"
 }
diff --git a/bundlers/rspack/docs/README.md b/bundlers/rspack/docs/README.md
@@ -1,4 +1,4 @@
-@evmts/rspack-plugin / [Exports](/reference/rspack-plugin/modules.md)
+@evmts/rspack-plugin / [Exports](modules.md)
 
 # @evmts/rspack-plugin
 

diff --git a/bundlers/rspack/docs/modules.md b/bundlers/rspack/docs/modules.md
@@ -1,12 +1,12 @@
-[@evmts/rspack-plugin](/reference/rspack-plugin/README.md) / Exports
+[@evmts/rspack-plugin](README.md) / Exports
 
 # @evmts/rspack-plugin
 
 ## Table of contents
 
 ### Functions
 
-- [rspackPluginEvmts](/reference/rspack-plugin/modules.md#rspackpluginevmts)
+- [rspackPluginEvmts](modules.md#rspackpluginevmts)
 
 ## Functions
 

diff --git a/bundlers/rspack/typedoc.json b/bundlers/rspack/typedoc.json
@@ -2,7 +2,6 @@
 	"$schema": "https://typedoc.org/schema.json",
 	"out": "./docs",
 	"entryPoints": ["./src/index.js"],
-	"publicPath": "/reference/rspack-plugin/",
 	"plugin": ["typedoc-plugin-markdown"],
 	"gitRevision": "main"
 }
diff --git a/bundlers/unplugin/docs/README.md b/bundlers/unplugin/docs/README.md
@@ -1,4 +1,4 @@
-@evmts/unplugin / [Exports](/reference/unplugin/modules.md)
+@evmts/unplugin / [Exports](modules.md)
 
 <p align="center">
   <a href="https://evmts.dev/">

diff --git a/bundlers/unplugin/docs/modules.md b/bundlers/unplugin/docs/modules.md
@@ -1,17 +1,17 @@
-[@evmts/unplugin](/reference/unplugin/README.md) / Exports
+[@evmts/unplugin](README.md) / Exports
 
 # @evmts/unplugin
 
 ## Table of contents
 
 ### Type Aliases
 
-- [CompilerOption](/reference/unplugin/modules.md#compileroption)
+- [CompilerOption](modules.md#compileroption)
 
 ### Functions
 
-- [createUnplugin](/reference/unplugin/modules.md#createunplugin)
-- [evmtsUnplugin](/reference/unplugin/modules.md#evmtsunplugin)
+- [createUnplugin](modules.md#createunplugin)
+- [evmtsUnplugin](modules.md#evmtsunplugin)
 
 ## Type Aliases
 

diff --git a/bundlers/unplugin/typedoc.json b/bundlers/unplugin/typedoc.json
@@ -2,7 +2,6 @@
 	"$schema": "https://typedoc.org/schema.json",
 	"out": "./docs",
 	"entryPoints": ["./src/index.js"],
-	"publicPath": "/reference/unplugin/",
 	"plugin": ["typedoc-plugin-markdown"],
 	"gitRevision": "main"
 }
diff --git a/bundlers/vite/docs/README.md b/bundlers/vite/docs/README.md
@@ -1,4 +1,4 @@
-@evmts/vite-plugin / [Exports](/reference/vite-plugin/modules.md)
+@evmts/vite-plugin / [Exports](modules.md)
 
 # @evmts/plugin
 

diff --git a/bundlers/vite/docs/modules.md b/bundlers/vite/docs/modules.md
@@ -1,12 +1,12 @@
-[@evmts/vite-plugin](/reference/vite-plugin/README.md) / Exports
+[@evmts/vite-plugin](README.md) / Exports
 
 # @evmts/vite-plugin
 
 ## Table of contents
 
 ### Functions
 
-- [vitePluginEvmts](/reference/vite-plugin/modules.md#vitepluginevmts)
+- [vitePluginEvmts](modules.md#vitepluginevmts)
 
 ## Functions
 

diff --git a/bundlers/vite/typedoc.json b/bundlers/vite/typedoc.json
@@ -2,7 +2,6 @@
 	"$schema": "https://typedoc.org/schema.json",
 	"out": "./docs",
 	"entryPoints": ["./src/index.js"],
-	"publicPath": "/reference/vite-plugin/",
 	"plugin": ["typedoc-plugin-markdown"],
 	"gitRevision": "main"
 }
diff --git a/bundlers/webpack/docs/README.md b/bundlers/webpack/docs/README.md
@@ -1,4 +1,4 @@
-@evmts/webpack-plugin / [Exports](/reference/webpack-plugin/modules.md)
+@evmts/webpack-plugin / [Exports](modules.md)
 
 # @evmts/plugin