chore: fix verification of README code snippets #6868
Draft
+187
−25
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nflaig
commented
Jun 9, 2024
| @@ -54,7 +54,7 @@ describe("web3_provider", function () { | |||
| mutateProvider: false, | |||
| }); | |||
|
|
|||
| const web3 = new Web3(nonVerifiedProvider); | |||
| const web3 = new Web3(verifiedProvider); //TODO: type is not compatible | |||
There was a problem hiding this comment.
@nazarhussain the verifiedProvider is not compatible with what Web3 expects, and it's not clear to me why you would pass the nonVerifiedProvider provider as it is not mutated, meaning the prover is not used at all..
Same in the README, the example does not make sense to me.
Performance Report✔️ no performance regression detected Full benchmark results
|
nazarhussain
requested changes
Jun 10, 2024
| { | ||
| "extends": "../../tsconfig.json", | ||
| "compilerOptions": {}, | ||
| // `typescript-docs-verifier` uses `ts-node` to compile README snippets |
There was a problem hiding this comment.
If you want to add comments in JSON, rename those to .jsoc extension so it does not highlight as error.
There was a problem hiding this comment.
that's really only highlighted this way in the diff, we have comments in other tsconfig files as well
Lines 12 to 15 in 14855ea
tsconfig itself supports comments as is, might be able to remove this if upstream issue is fixed
| @@ -54,7 +54,7 @@ describe("web3_provider", function () { | |||
| mutateProvider: false, | |||
| }); | |||
|
|
|||
| const web3 = new Web3(nonVerifiedProvider); | |||
| const web3 = new Web3(verifiedProvider); //TODO: type is not compatible | |||
There was a problem hiding this comment.
Suggested change
| const web3 = new Web3(verifiedProvider); //TODO: type is not compatible | |
| const web3 = new Web3(nonVerifiedProvider); |
There was a problem hiding this comment.
Because we want to get the accounts via normal RPC and then verify it through our ELRpc object.
There was a problem hiding this comment.
the examples in the README show otherwise
There was a problem hiding this comment.
as per README we pass the verifiedProvider to Web3 but the types are not compatible, the example in the README does not work
lodestar/packages/prover/README.md
Line 54 in 14855ea
| // and hence it is required to disable `transpileOnly` mode as it disables | ||
| // all type checks. Set at root to be directly forwarded to `ts-node` until | ||
| // https://github.com/bbc/typescript-docs-verifier/issues/31 is resolved | ||
| "transpileOnly": false |
There was a problem hiding this comment.
If you want to set this it should go under ts-node not on the root level.
"ts-node": {
"transpileOnly": true
}There was a problem hiding this comment.
This made me think if that config is actually have any effect or not.
There was a problem hiding this comment.
this is passed directly to ts-node by the typescript-docs-verifier module that's why it has to be in root, see code comment and issue bbc/typescript-docs-verifier#31
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Code snippets in README files are currently not validated, and some are broken. We should make sure that examples can be copy-pasted and are runnable
Description
Fix verification of README code snippets
There is a bug in
typescript-docs-verifierwhich requires to have a override tsconfig per project and passts-nodeoptions in root as extends does not work.Workaround can be removed once bbc/typescript-docs-verifier#31 is resolved.
Closes #6300