Skip to content

The content after @defaultValue should remain on the same line #427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
octogonz merged 3 commits into from
May 28, 2025
Merged

The content after @defaultValue should remain on the same line #427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dc89058
The content after @defaultValue should remain on the same line
spike-rabbit Sep 12, 2024
d77ce2a
Update default-value-inline-content_2024-09-12-09-25.json
D4N14L Oct 2, 2024
07deca4
Merge remote-tracking branch 'remotes/origin/main' into default-value…
octogonz Nov 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions common/changes/@microsoft/tsdoc/default-value-inline-content_2024-09-12-09-25.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@microsoft/tsdoc",
"comment": "Ensure TSDocEmitter does not emit a newline for the text after `@defaultValue` tags.",
"type": "patch"
}
],
"packageName": "@microsoft/tsdoc"
}
5 changes: 4 additions & 1 deletion tsdoc/src/emitters/TSDocEmitter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,10 @@ export class TSDocEmitter {
this._ensureLineSkipped();
this._renderNode(docBlock.blockTag);

if (docBlock.blockTag.tagNameWithUpperCase === StandardTags.returns.tagNameWithUpperCase) {
if (
docBlock.blockTag.tagNameWithUpperCase === StandardTags.returns.tagNameWithUpperCase ||
docBlock.blockTag.tagNameWithUpperCase === StandardTags.defaultValue.tagNameWithUpperCase
) {
this._writeContent(' ');
this._hangingParagraph = true;
}
Expand Down
3 changes: 3 additions & 0 deletions tsdoc/src/emitters/__tests__/TSDocEmitter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ test('02 Emit a basic comment', () => {
* line1
* line2
* \`\`\`
* @defaultValue value
*
* @public @readonly
*/
Expand Down Expand Up @@ -114,6 +115,8 @@ Object {
* line2
* \`\`\`
*
* @defaultValue value
*
* @public @readonly
*/
",
Expand Down