feat: add comment to config #3345
Merged
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
anxolin
force-pushed
the
add-comments-to-config
branch
from
30e9c99 to
f2d6b7f
Compare
anxolin
commented
Nov 7, 2023
| // Add values | ||
| const resultWithValues = Object.keys(VALUES_BY_PARAM_NAME).reduce((acc, propName) => { | ||
| return acc.replace(new RegExp(`("${propName}".* )(".*")(.*)$`, 'gm'), `$1${VALUES_BY_PARAM_NAME[propName]}$3`) | ||
| }, resultWithComments) |
There was a problem hiding this comment.
this helps to solve the issue serialising the provider, see description of the PR
anxolin
force-pushed
the
add-comments-to-config
branch
from
b78e6ef to
44de9c8
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
Follow up on #3337
This PR allows us to easily add comments to the params in the generated sippet, additionally makes some proposals to improve the documentation, and add identation support to show better the config in the HTML snippet
Add comments
Before:
After:
Allow to add values to params
Some values like the
ethereum.providerwhere not added because they don't serialise too well.This PR also adds a simple way to add it back:
Before:
After:
Remove some parameters
It also removes the
envparameter. I think makes people more confused than it helps them. If they want, they can still find it in the docsI actually don't love this parameter. I think it should be the
baseURLthat we pass. But probably is fine by now. Maybe someone wants to use an IPFS oneSanitize params moved to a const
Add identation support to improve HTML snippet
Before:
After:
Change some config descriptions
Changed the documentation for some config params
Test
Open the modal and check the 3 snipets