Fix types warnings #123

icepy · 2022-05-15T07:30:32Z

Closes #121

typedoc default only exports from the direct entrypoints are included

i used this plugin.

https://github.com/Gerrit0/typedoc-plugin-missing-exports

vercel · 2022-05-15T07:30:37Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
essential-eth	✅ Ready (Inspect)	Visit Preview	May 16, 2022 at 0:50AM (UTC)

arimgibson

This looks great, thanks @icepy ! @dawsbot is ultimately in charge of approving and merging 😁

…al-eth into pr/123

arimgibson · 2022-05-15T18:03:31Z

tsconfig.json

+    "entryPoints": ["src/index.ts"],
+    "json": "scripts/markdown-magic/typedoc.out.json",
+    "plugin": ["typedoc-plugin-missing-exports"]
+  }


pretty option is enabled by default with typedoc, could be expressly defined though

that's great!

codecov · 2022-05-15T23:18:42Z

Codecov Report

Merging #123 (5081906) into master (42034bb) will not change coverage.
The diff coverage is 100.00%.

❗ Current head 5081906 differs from pull request most recent head e190617. Consider uploading reports for the commit e190617 to get more accurate results

@@           Coverage Diff           @@
##           master     #123   +/-   ##
=======================================
  Coverage   85.58%   85.58%           
=======================================
  Files          37       37           
  Lines         888      888           
  Branches      258      258           
=======================================
  Hits          760      760           
  Misses        113      113           
  Partials       15       15

Impacted Files	Coverage Δ
src/providers/FallthroughProvider.ts	`90.00% <ø> (ø)`
src/index.ts	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 42034bb...e190617. Read the comment docs.

dawsbot · 2022-05-15T23:27:18Z

This is not yet working with Docusaurus. You can tell because "RPCBlock" is not an anchor in the docusaurus site (https://essential-eth-git-fork-icepy-fix-types-warnings-earnifi.vercel.app/docs/api/modules)

Let's revisit this after hearing from the core team in Gerrit0/typedoc-plugin-missing-exports#13

Gerrit0 · 2022-05-16T00:20:58Z

While this does remove the warnings, it does not really address the reason that the warnings were there in the first place. If a user of this package wants to reference ConstructorOptions to construct an object and pass it to a few of their functions before creating a FallthroughProvider, they have a few choices:

Import the type from the internal path, and hope it never changes: import { ConstructorOptions } from "essential-eth/lib/esm/providers/FallthroughProvider"
Derive the type from the exported type: type ConstructorOptions = ConstructorParameters<typeof FallthroughProvider>[1]
Copy the definition and manually keep it up to date when updating the library.

dawsbot · 2022-05-16T00:49:48Z

Thank you for the explanation @Gerrit0 🙏

arimgibson · 2022-05-16T06:45:56Z

src/providers/FallthroughProvider.ts

@@ -10,7 +10,7 @@ const promiseTimeout = (prom: Promise<any>, time: number) =>
    ),
  ]);

-interface ConstructorOptions {
+export interface ConstructorOptions {


@dawsbot I figured this type was worth exporting, but it can be ignored if not

arimgibson · 2022-05-16T06:55:06Z

@dawsbot take a look at my most recent commit when ya get a chance. I went through it manually; i.e. exported some of the missing types and ignored others that shouldn't be exported (used internally).

Couple things I found along the way worth mentioning to explain why I did what I did:

Using the @ignore tag before a type/function/etc that you are purposely not exporting will still throw a warning if that type/function/etc is referenced by something that is being exported
Same with @internal even with the --excludeInternal option set as true
intentionallyNotExported doesn't support glob or regex, hence having to add Transaction and Block as separate lines

dawsbot · 2022-05-16T12:40:13Z

Great fixes @arimgibson! I'm having trouble running Docusaurus locally in this branch, but I see that on remote, this generates the docs just fine.

I'll debug locally and hopefully have this solved in just a few hours. Traveling today, so I'll be mostly offline ✈️

Here's my stack trace:

cd docusaurus && npm i && npm run start

SyntaxError: /Users/db/code/scratch/essential-eth/docusaurus/docs/api/classes/internal_.BaseContract.md: Expected corresponding JSX closing tag for <internal>. (8:78)
   6 |       components={components}>
   7 |
>  8 | <p><a parentName="p" {...{"href":"/docs/api/namespaces/internal_"}}><internal></a>{`.BaseContract`}</p>
     |                                                                               ^
   9 | <h2 {...{"id":"hierarchy"}}>{`Hierarchy`}</h2>
  10 | <ul>
  11 | <li parentName="ul">
SyntaxError: /Users/db/code/scratch/essential-eth/docusaurus/docs/api/classes/internal_.BaseProvider.md: Expected corresponding JSX closing tag for <internal>. (8:78)
   6 |       components={components}>
   7 |
>  8 | <p><a parentName="p" {...{"href":"/docs/api/namespaces/internal_"}}><internal></a>{`.BaseProvider`}</p>
     |                                                                               ^
   9 | <h2 {...{"id":"hierarchy"}}>{`Hierarchy`}</h2>
  10 | <ul>
  11 | <li parentName="ul">
SyntaxError: /Users/db/code/scratch/essential-eth/docusaurus/docs/api/enums/internal_.Comparison.md: Expected corresponding JSX closing tag for <internal>. (8:78)
   6 |       components={components}>
   7 |
>  8 | <p><a parentName="p" {...{"href":"/docs/api/namespaces/internal_"}}><internal></a>{`.Comparison`}</p>
     |                                                                               ^
   9 | <h2 {...{"id":"enumeration-members"}}>{`Enumeration members`}</h2>
  10 | <h3 {...{"id":"eq"}}>{`EQ`}</h3>
  11 | <p>{`• `}<strong parentName="p">{`EQ`}</strong>{` = `}<inlineCode parentName="p">{`0`}</inlineCode></p>
SyntaxError: /Users/db/code/scratch/essential-eth/docusaurus/docs/api/enums/internal_.RoundingMode.md: Expected corresponding JSX closing tag for <internal>. (8:78)
   6 |       components={components}>
   7 |
>  8 | <p><a parentName="p" {...{"href":"/docs/api/namespaces/internal_"}}><internal></a>{`.RoundingMode`}</p>
     |                                                                               ^
   9 | <h2 {...{"id":"enumeration-members"}}>{`Enumeration members`}</h2>
  10 | <h3 {...{"id":"rounddown"}}>{`RoundDown`}</h3>
  11 | <p>{`• `}<strong parentName="p">{`RoundDown`}</strong>{` = `}<inlineCode parentName="p">{`0`}</inlineCode></p>
SyntaxError: /Users/db/code/scratch/essential-eth/docusaurus/docs/api/interfaces/internal_.ArrayLike.md: Expected corresponding JSX closing tag for <internal>. (8:78)
   6 |       components={components}>
   7 |
>  8 | <p><a parentName="p" {...{"href":"/docs/api/namespaces/internal_"}}><internal></a>{`.ArrayLike`}</p>
     |                                                                               ^
   9 | <h2 {...{"id":"type-parameters"}}>{`Type parameters`}</h2>
  10 | <table>
  11 | <thead parentName="table">
SyntaxError: /Users/db/code/scratch/essential-eth/docusaurus/docs/api/interfaces/internal_.Big.md: Expected corresponding JSX closing tag for <internal>. (8:78)
   6 |       components={components}>
   7 |
>  8 | <p><a parentName="p" {...{"href":"/docs/api/namespaces/internal_"}}><internal></a>{`.Big`}</p>
     |                                                                               ^
   9 | <h2 {...{"id":"properties"}}>{`Properties`}</h2>
  10 | <h3 {...{"id":"c"}}>{`c`}</h3>
  11 | <p>{`• `}<strong parentName="p">{`c`}</strong>{`: `}<inlineCode parentName="p">{`number`}</inlineCode>{`[]`}</p>
SyntaxError: /Users/db/code/scratch/essential-eth/docusaurus/docs/api/interfaces/internal_.BigConstructor.md: Expected corresponding JSX closing tag for <internal>. (8:78)
   6 |       components={components}>
   7 |
>  8 | <p><a parentName="p" {...{"href":"/docs/api/namespaces/internal_"}}><internal></a>{`.BigConstructor`}</p>
     |                                                                               ^
   9 | <h2 {...{"id":"callable"}}>{`Callable`}</h2>
  10 | <h3 {...{"id":"bigconstructor"}}>{`BigConstructor`}</h3>
  11 | <p>{`▸ `}<strong parentName="p">{`BigConstructor`}</strong>{`(`}<inlineCode parentName="p">{`value`}</inlineCode>{`): `}<a parentName="p" {...{"href":"/docs/api/namespaces/internal_#big"}}><inlineCode parentName="a">{`Big`}</inlineCode></a></p>
SyntaxError: /Users/db/code/scratch/essential-eth/docusaurus/docs/api/interfaces/internal_.ConstructorOptions.md: Expected corresponding JSX closing tag for <internal>. (8:78)
   6 |       components={components}>
   7 |
>  8 | <p><a parentName="p" {...{"href":"/docs/api/namespaces/internal_"}}><internal></a>{`.ConstructorOptions`}</p>
     |                                                                               ^
   9 | <h2 {...{"id":"properties"}}>{`Properties`}</h2>
  10 | <h3 {...{"id":"timeoutduration"}}>{`timeoutDuration`}</h3>
  11 | <p>{`• `}<inlineCode parentName="p">{`Optional`}</inlineCode>{` `}<strong parentName="p">{`timeoutDuration`}</strong>{`: `}<inlineCode parentName="p">{`number`}</inlineCode></p>
SyntaxError: /Users/db/code/scratch/essential-eth/docusaurus/docs/api/interfaces/internal_.RPCBlock.md: Expected corresponding JSX closing tag for <internal>. (8:78)
   6 |       components={components}>
   7 |
>  8 | <p><a parentName="p" {...{"href":"/docs/api/namespaces/internal_"}}><internal></a>{`.RPCBlock`}</p>
     |                                                                               ^
   9 | <p>{`Exact response from backend`}</p>
  10 | <h2 {...{"id":"properties"}}>{`Properties`}</h2>
  11 | <h3 {...{"id":"basefeepergas"}}>{`baseFeePerGas`}</h3>
SyntaxError: /Users/db/code/scratch/essential-eth/docusaurus/docs/api/interfaces/internal_.RPCBlockTransaction.md: Expected corresponding JSX closing tag for <internal>. (8:78)
   6 |       components={components}>
   7 |
>  8 | <p><a parentName="p" {...{"href":"/docs/api/namespaces/internal_"}}><internal></a>{`.RPCBlockTransaction`}</p>
     |                                                                               ^
   9 | <p>{`What JSONRPC responds with in getBlock transaction array`}</p>
  10 | <h2 {...{"id":"hierarchy"}}>{`Hierarchy`}</h2>
  11 | <ul>
SyntaxError: /Users/db/code/scratch/essential-eth/docusaurus/docs/api/interfaces/internal_.RPCLog.md: Expected corresponding JSX closing tag for <internal>. (8:78)
   6 |       components={components}>
   7 |
>  8 | <p><a parentName="p" {...{"href":"/docs/api/namespaces/internal_"}}><internal></a>{`.RPCLog`}</p>
     |                                                                               ^
   9 | <h2 {...{"id":"properties"}}>{`Properties`}</h2>
  10 | <h3 {...{"id":"address"}}>{`address`}</h3>
  11 | <p>{`• `}<strong parentName="p">{`address`}</strong>{`: `}<inlineCode parentName="p">{`string`}</inlineCode></p>
SyntaxError: /Users/db/code/scratch/essential-eth/docusaurus/docs/api/interfaces/internal_.RPCTransaction.md: Expected corresponding JSX closing tag for <internal>. (8:78)
   6 |       components={components}>
   7 |
>  8 | <p><a parentName="p" {...{"href":"/docs/api/namespaces/internal_"}}><internal></a>{`.RPCTransaction`}</p>
     |                                                                               ^
   9 | <h2 {...{"id":"hierarchy"}}>{`Hierarchy`}</h2>
  10 | <ul>
  11 | <li parentName="ul">
SyntaxError: /Users/db/code/scratch/essential-eth/docusaurus/docs/api/interfaces/internal_.RPCTransactionReceipt.md: Expected corresponding JSX closing tag for <internal>. (8:78)
   6 |       components={components}>
   7 |
>  8 | <p><a parentName="p" {...{"href":"/docs/api/namespaces/internal_"}}><internal></a>{`.RPCTransactionReceipt`}</p>
     |                                                                               ^
   9 | <h2 {...{"id":"properties"}}>{`Properties`}</h2>
  10 | <h3 {...{"id":"blockhash"}}>{`blockHash`}</h3>
  11 | <p>{`• `}<strong parentName="p">{`blockHash`}</strong>{`: `}<inlineCode parentName="p">{`string`}</inlineCode></p>
client (webpack 5.71.0) compiled with 13 errors

icepy added 3 commits May 15, 2022 15:21

fix: typedoc types warnings

71613d6

chore: merge pre commit check

f93d722

chore: merge pre commit check

771e024

vercel bot deployed to Preview May 15, 2022 07:31 View deployment

arimgibson linked an issue May 15, 2022 that may be closed by this pull request

Export all forgotten types #121

Closed

arimgibson approved these changes May 15, 2022

View reviewed changes

arimgibson added 2 commits May 15, 2022 12:01

🔧 Migrate typedoc settings to tsconfig.json

2993f58

🔧 Migrate typedoc settings to tsconfig.json

54428c2

vercel bot deployed to Preview May 15, 2022 18:02 View deployment

Merge branch 'fix-types-warnings' of https://github.com/icepy/essenti…

6b9e686

…al-eth into pr/123

vercel bot deployed to Preview May 15, 2022 18:02 View deployment

arimgibson reviewed May 15, 2022

View reviewed changes

dawsbot added 2 commits May 15, 2022 16:16

Merge remote-tracking branch 'origin/master' into fix-types-warnings

00503ee

remove commited typedoc out

2ff5a49

vercel bot deployed to Preview May 15, 2022 23:18 View deployment

dawsbot added the Blocked label May 15, 2022

🚨 🔧 Manually exported missing types, reverted plugin

5081906

vercel bot deployed to Preview May 16, 2022 06:44 View deployment

arimgibson reviewed May 16, 2022

View reviewed changes

arimgibson removed the Blocked label May 16, 2022

bump docusaurus deps

e190617

dawsbot merged commit 54468c4 into dawsbot:master May 16, 2022

vercel bot deployed to Preview May 16, 2022 12:50 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix types warnings #123

Fix types warnings #123

icepy commented May 15, 2022 •

edited by dawsbot

Loading

vercel bot commented May 15, 2022 •

edited

Loading

arimgibson left a comment

arimgibson May 15, 2022 •

edited

Loading

icepy May 15, 2022

codecov bot commented May 15, 2022 •

edited

Loading

dawsbot commented May 15, 2022 •

edited

Loading

Gerrit0 commented May 16, 2022

dawsbot commented May 16, 2022

arimgibson May 16, 2022

arimgibson commented May 16, 2022 •

edited

Loading

dawsbot commented May 16, 2022 •

edited

Loading

Fix types warnings #123

Fix types warnings #123

Conversation

icepy commented May 15, 2022 • edited by dawsbot Loading

vercel bot commented May 15, 2022 • edited Loading

arimgibson left a comment

Choose a reason for hiding this comment

arimgibson May 15, 2022 • edited Loading

Choose a reason for hiding this comment

icepy May 15, 2022

Choose a reason for hiding this comment

codecov bot commented May 15, 2022 • edited Loading

Codecov Report

dawsbot commented May 15, 2022 • edited Loading

Gerrit0 commented May 16, 2022

dawsbot commented May 16, 2022

arimgibson May 16, 2022

Choose a reason for hiding this comment

arimgibson commented May 16, 2022 • edited Loading

dawsbot commented May 16, 2022 • edited Loading

icepy commented May 15, 2022 •

edited by dawsbot

Loading

vercel bot commented May 15, 2022 •

edited

Loading

arimgibson May 15, 2022 •

edited

Loading

codecov bot commented May 15, 2022 •

edited

Loading

dawsbot commented May 15, 2022 •

edited

Loading

arimgibson commented May 16, 2022 •

edited

Loading

dawsbot commented May 16, 2022 •

edited

Loading