prettier jsdoc (bump, relax, more packages) #9438
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
kriskowal
approved these changes
May 31, 2024
Deploying agoric-sdk with
|
| Latest commit: |
0ecec09
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d6d487de.agoric-sdk.pages.dev |
| Branch Preview URL: | https://ta-prettier-jsdoc.agoric-sdk.pages.dev |
Chris-Hibbert
approved these changes
May 31, 2024
| space | ||
| ); | ||
| const { consume, produce } = /** | ||
| * @type {BootstrapPowers & { |
There was a problem hiding this comment.
can you make the warning here go away? (visible in github)
| @@ -364,10 +363,12 @@ harden(buildZoe); | |||
| * @param {BootstrapPowers & { | |||
| * consume: { loadCriticalVat: ERef<VatLoader<PriceAuthorityVat>> }; | |||
| * }} powers | |||
| * <<<<<<< HEAD | |||
turadg
force-pushed
the
ta/prettier-jsdoc
branch
2 times, most recently
from
61b2e92 to
a1f52c6
Compare
we mostly use it for the types formatting and .ts has that in the AST
style: separate typedef from fn signature
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.
Description
I've found myself adjusting whitespace in
packages/orchestrationjsdoc. @kriskowal reminded me of the prettier plugin, which wasn't enabled in that package. We had an opt-in list because of bugs encountered in the past, like unstable formatting. (E.g. adding a newline on each save). In the latest version I'm only seeing that behavior when there's@typedefmixed into a function signature definition, which isn't good form anyway. I expect whenever we see that behavior we can simply improve our Jsdoc to get around it.This bumps the plugin version to latest and adds several packages.
One config change is to stop the
jsdocCommentLineStrategythat defaulted to "singleLine", because it makes a single* @importcomment turn into a single line and we almost always want it to be easy to add another line. I changed to "keep" instead of "multiline" so one can use the tighter format when they wish.Security Considerations
n/a, whitespace and whitespace config
Scaling Considerations
"
Documentation Considerations
"
Testing Considerations
"
Upgrade Considerations
"