This repository has been archived by the owner on Aug 31, 2023. It is now read-only.
feat(rome_js_formatter): Indent Doc comments #3129
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
Deploying with
|
| Latest commit: |
d89d467
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://9903a1bb.tools-8rn.pages.dev |
| Branch Preview URL: | https://feat-doc-comments.tools-8rn.pages.dev |
MichaReiser
force-pushed
the
feat/doc-comments
branch
from
5b6740c
to
6816c07
Compare
MichaReiser
commented
Aug 29, 2022
Comment on lines
+90
to
+119
| #[derive(Eq, PartialEq, Copy, Clone, Debug, Default)] | ||
| pub struct JsCommentStyle; | ||
|
|
||
| impl CommentStyle<JsLanguage> for JsCommentStyle { |
There was a problem hiding this comment.
I moved this from context.rs
| CONNECTING: Object.freeze({ kind: "CONNECTING" }), | ||
| NOT_CONNECTED: Object.freeze({ kind: "NOT_CONNECTED" }), | ||
| }); | ||
| - | ||
| -/* A comment */ | ||
| -/** | ||
| - * A type that can be written to a buffer. | ||
| +/* A comment */ /** |
There was a problem hiding this comment.
Prettier inserts a line break here. We aren't able to do this yet because Prettier only does so if the doc is a trailing comment of a node. We'll only have this distinction (at least in a cheap way) after the comments refactor.
The only difference is that the block comments start on the same line. A user can fix this by manually inserting a line break, which is what they also have to do for other block comments that start on the same line.
ematipico
reviewed
Aug 29, 2022
crates/rome_js_formatter/tests/specs/prettier/js/comments/trailing-jsdocs.js.snap
Show resolved
Hide resolved
|
!bench_formatter |
Formatter Benchmark Results |
ematipico
reviewed
Aug 30, 2022
ematipico
approved these changes
Aug 30, 2022
This PR adds support for indenting js doc comments.
```javascript
/*
* a comment
*/
```
Becomes
```javascript
/*
* a comment
*
```
The PR introduces a new `LeadingCommentRule` type on the `CstFormatContext` that is used to format any leading comment. This allows languages to implement formatting of a comment's content, something that wasn't possible before.
## Tests
**Average compatibility**: 83.70 -> 84.04
<details>
<summary>Definition</summary>
$$average = \frac\{\sum_{file}^\{files}compatibility_\{file}}\{files}$$
</details>
**Compatible lines**: 80.79 -> 81.22
MichaReiser
force-pushed
the
feat/doc-comments
branch
from
d89d467
to
5fd2ac8
Compare
ematipico
pushed a commit
that referenced
this pull request
Sep 5, 2022
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.
This PR adds support for indenting js doc comments.
Becomes
The PR introduces a new
LeadingCommentRuletype on theCstFormatContextthat is used to format any leading comment. This allows languages to implement formatting of a comment's content, something that wasn't possible before.Tests
Average compatibility: 83.70 -> 84.04
Compatible lines: 80.79 -> 81.22