Skip to content

Format Markdown at a 180 column width - #162

Merged
wallstop merged 1 commit into
mainfrom
t162-md-line-length-180
Oct 10, 2026
Merged

wallstop merged 1 commit into
mainfrom
t162-md-line-length-180

Conversation

@wallstop

@wallstop wallstop commented Oct 10, 2026 •

Copy link
Copy Markdown
Owner

DISCLOSURE: LLM-GENERATED TEXT

Why: Markdown still wrapped at 80 columns while C# moved to 180, so the CHANGELOG and docs read as narrow fragments.

What:

  • Add Prettier 3.9.9 with printWidth: 180 and proseWrap: always.
  • Reflow 19 tracked Markdown files; CHANGELOG entries now fit one or two lines.
  • Gate the check in llm-lint.yml on both OSes and trigger on **/*.md.
  • Exempt the generated skills index and SKILL.md frontmatter contracts.
  • Escape unescaped table-cell pipes found in forbidden-patterns.md.

Follows #161


Note

Low Risk
Documentation and CI tooling only; no Unity runtime or editor code changes.

Overview
Adds Prettier 3.9.9 for tracked Markdown with 180-column prose wrap (aligned with CSharpier), via .prettierrc.json, .prettierignore (skips .llm/skills/ and other generated/local trees), and npm run format:md / format:md:check.

CI and docs: llm-lint.yml runs npm install then format:md:check on Ubuntu and Windows, and path filters now include **/*.md and the Prettier config files. Agent guidance in .llm/context.md and the ship-changes skill treats Markdown formatting as a gate alongside CSharpier. .gitignore adds node_modules/.

Content pass: Nineteen Markdown files are reflowed (README, CHANGELOG, devcontainer and MCP docs, etc.); forbidden-patterns.md gets wider tables with escaped pipe characters in cells. package.json drops the empty dependencies object and pins Prettier under devDependencies.

Reviewed by Cursor Bugbot for commit b04792a. Bugbot is set up for automated code reviews on this repo. Configure here.

Users asked for the 180 line-length concept to cover Markdown too,
CHANGELOG in particular, whose entries wrapped at 80. Add Prettier
(pinned 3.9.9, matching unity-helpers) with printWidth 180 and
proseWrap always, reflow 19 tracked Markdown files, and gate the check
in the llm-lint workflow on both OSes with a Markdown trigger path.

The generated skills index and SKILL.md frontmatter contracts are
excluded through .prettierignore: the harness owns their format and
requires single-line frontmatter. Escaping the pipes in code spans
inside one forbidden-patterns table row fixes a pre-existing rendering
defect the formatter exposed; a per-table pipe-count sweep found no
other instance.

Validation: format check, llm lints, file lengths, line endings,
strict mkdocs build, npm pack, and 23/23 harness self-tests pass.
Markdown rendering is content-identical (verified by whitespace-
normalized comparison of all files against HEAD); word count moves by
one re-wrapped blockquote marker. No C# changed, so Unity suites carry
over from 73b8beb (357/357, 15/15).
@wallstop
wallstop merged commit a6128df into main Oct 10, 2026
5 checks passed
@wallstop
wallstop deleted the t162-md-line-length-180 branch October 10, 2026 04:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant