mirror of
https://github.com/oxc-project/oxc.git
synced 2026-11-04 10:29:58 +00:00
docs(oxfmt): update stale notes on the JSDoc string-out channel and fixture origins (#27824)
This commit is contained in:
1 parent
d3ff3f6622
commit
8a3a6c8764
2 files changed
+3
-1
No files matched your search
@@ -124,7 +124,8 @@ A separate string-out channel (the session's `string_embedder` service, NOT the
|
||||
- the embedder carries the caller's effective print width; both branches honor it (native via `PrintWidth` override, Prettier via `printWidth` in the options JSON), so a fence prints at the same width a JS/TS snippet in the same position would (see `upstream-jsdoc-bugs.md` #11 for the deliberate divergence from upstream's flat `printWidth - 4`)
|
||||
|
||||
NOTE: The string-out channel outlives the html rewrite; its full exit criterion is owned by `oxc_formatter_core`'s AGENTS.md (domain (4)).
|
||||
The half owned here: JSDoc's string-out is NOT structural, fences can move to IR-out (session dispatch inside the comment IR) once the printer grows a per-line prefix mechanism for the `*` continuation, deferred for verification time, not by design.
|
||||
The half owned here: JSDoc's string-out is NOT structural, fences can move to IR-out (session dispatch inside the comment IR).
|
||||
The printer already has the per-line prefix mechanism the `*` continuation needs (`prefix_align`); what remains is JSDoc emitting its output as lines plus embedded IR instead of one string, deferred for verification time, not by design.
|
||||
|
||||
### Tailwind CSS class sorting
|
||||
|
||||
|
||||
@@ -13,6 +13,7 @@ Each fixture consists of:
|
||||
## Origin
|
||||
|
||||
Expected outputs were generated using **prettier-plugin-jsdoc** at commit [`1bbf9ee`](https://github.com/hosseinmd/prettier-plugin-jsdoc/tree/1bbf9ee43e31f054cc27b7355b4dc53a90b31302) with default options unless an `options.json` is present.
|
||||
Fixtures pinning an entry of [`../upstream-jsdoc-bugs.md`](../upstream-jsdoc-bugs.md) hold oxfmt's output instead; the entry names its fixture.
|
||||
|
||||
Default options: `jsdocCapitalizeDescription: true`, `jsdocSingleLineComment: true`, `printWidth: 80`.
|
||||
|
||||
|
||||
Reference in new issue
Block a user