mirror of https://github.com/oxc-project/oxc.git synced 2026-09-14 19:36:11 +08:00

Files

T

History

leaysgur e4298fb23a fix(formatter/jsdoc): follow CommonMark for interrupting lists and guard wrapping from creating them (#26098 )

Fixes #25825, #26026.

---

If the formatter adjusts the wrapping and causes list-like characters to appear at the beginning of a line, those characters will be mistakenly converted into a list in the next formatting step.

Therefore, it is necessary to guard meaningful characters so that they do not appear at the beginning of a line.

Also, fixed an issue where character that should have originally been interpreted as lists were not, aligning with the CommonMark behavior.

2026-08-26 07:11:32 +00:00

add-default-to-desc

…

comment-line-strategy

…

default

…

description-tag

…

description-with-dot

…

descriptions

fix(formatter/jsdoc): follow CommonMark for interrupting lists and guard wrapping from creating them (#26098 )

2026-08-26 07:11:32 +00:00

example-tag

…

files

…

keep-unparseable-indent

…

line-wrapping-balance

fix(formatter/jsdoc): follow CommonMark for interrupting lists and guard wrapping from creating them (#26098 )

2026-08-26 07:11:32 +00:00

main

…

misc

…

prefer-code-fences

…

single-tag

…

tag-group

…

template

…

typescript

…

README.md

…

README.md

JSDoc Conformance Fixtures

These fixtures test oxfmt's JSDoc formatting against prettier-plugin-jsdoc.

Structure

Each fixture consists of:

<name>.js / <name>.ts — input file
<name>.output.js / <name>.output.ts — expected output (generated by running prettier-plugin-jsdoc)
options.json (optional, per-file or per-directory) — plugin options override

Origin

Expected outputs were generated using prettier-plugin-jsdoc at commit 1bbf9ee with default options unless an options.json is present.

Default options: jsdocCapitalizeDescription: true, jsdocSingleLineComment: true, printWidth: 80.

Upstream snapshot reference: tests/__snapshots__/main.test.ts.snap