oxidecomputer / oxidecomputer/prettier-plugin-asciidoc

an attribute entry in a description item text position is left verbatim while normalized everywhere else

Open
#218 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

conformance mechanism:inline-vocabulary obligation:completeness
Dominant language
TypeScript
Stars
0
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Found during the blockform re-review (blockform-rereview.md, divergences assessment, Sep 5); reproduced at that tip with plain formatAdoc on documents neither blockform commit touches, so it is a live gap on main independent of that lane.

Mechanism: in a description item text position (term:: def followed by an attribute-entry line, no + continuation) the formatter leaves the entry bytes verbatim, while the same entry is normalized in every other position (:name: value -> :name: value, :name!: -> :!name:). Both spellings are render-preserved and idempotent - a missed normalization (spelling-preserved cell), not a corruption.

Fix shape: extend the entry normalization to the item-text position if and only if the reading there is proven identical to the entry reading elsewhere (the blockform fold-licence work shows how position changes a line class - verify the oracle actually reads the line as an attribute entry there before normalizing). Retires the two attrentry-* exception rows this gap keeps in the confluence table. Related: #217 (normal-form axis survey).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with blockform-rereview.md, especially the divergences assessment, and reproduce the issue with plain formatAdoc on main. Compare the entry reading in the description-item text position with the other positions, using the blockform fold-licence work and #217 as context. Done means normalization applies only when the reading is identical and the two attrentry-* exception rows are retired from the confluence table.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.