fix(docs): consistent style of configuration examples #12037
Closed
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
mrazauskas
commented
Nov 4, 2021
| authorize: () => { | ||
| return 'token'; | ||
| }, | ||
| authorize: () => 'token', |
There was a problem hiding this comment.
Synced with the code from examples folder.
|
On second thought, that JSON syntax of config snippets looks rather exotic in the JS ecosystem. Just try converting them to JS (with Only the eslint / prettier duo is unhappy now. So I will negotiate with them. |
|
@mrazauskas ping 😀 Would be wonderful to clean this up |
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
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
Configuration examples in the configuration API docs currently differ in syntax / style. Most of them are simply JSON snippets, some include
"jest"key, others are written in CJS syntax. All are correctly working, but consistency is missing.The docs have more consistency issues, but the focus of this PR is on the snippets and related matter:
"jest"key). It seemed least verbose and most reasonable. Copy-pasting into any other syntax works smoothly.Examplesubtitle. Seemed like context or file name is sufficient.Test plan
N/A