Skip to content

Commit 137bf08

Browse files
dougborgclaude
andcommitted
chore: complete mdformat → prettier swap (mcp build, docs)
The mcp server's semantic-release build_command was still installing mdformat at release time, and several agent/contributor docs still told users to use mdformat. Update both to match the new toolchain. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 38178a6 commit 137bf08

9 files changed

Lines changed: 19 additions & 19 deletions

File tree

.github/agents/documentation-writer.agent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ scope. But prefer this ordering when sections are present.
102102

103103
### Markdown Formatting
104104

105-
**Always use mdformat for consistency:**
105+
**Always use Prettier for consistency:**
106106

107107
```bash
108108
uv run poe format # Formats all markdown files
@@ -485,7 +485,7 @@ Before considering documentation complete:
485485

486486
- [ ] All code examples tested and working
487487
- [ ] Links verified (internal and external)
488-
- [ ] Formatting consistent with mdformat
488+
- [ ] Formatting consistent with Prettier
489489
- [ ] Spelling and grammar checked
490490
- [ ] Screenshots updated (if UI changes)
491491
- [ ] Version numbers current
@@ -506,7 +506,7 @@ Documentation should improve every time it's touched:
506506
## Critical Reminders
507507

508508
1. **Test all examples** - Don't document code that doesn't work
509-
1. **Format with mdformat** - Consistency is critical
509+
1. **Format with Prettier** - Consistency is critical
510510
1. **Update indexes** - Keep navigation current
511511
1. **Link validation** - Broken links frustrate users
512512
1. **Build verification** - Always build docs locally first

.github/agents/guides/COPILOT_ARCHITECTURE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ If agent needs more detail:
306306
When agent creates markdown file:
307307

308308
- `markdown.instructions.md` auto-loads (for `**/*.md`)
309-
- mdformat standards (88-char line length)
309+
- Prettier standards (88-char line length)
310310
- ATX-style headers
311311
- Code block language specification
312312

@@ -318,7 +318,7 @@ Agent follows `create-adr.prompt.md`:
318318
1. Copy template from `docs/adr/0000-template.md`
319319
1. Fill out ADR structure
320320
1. Update `docs/adr/README.md` index
321-
1. Format with mdformat
321+
1. Format with Prettier
322322
1. Validate links
323323

324324
#### Step 4: Result

.github/agents/guides/REFACTORING_SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ Created 4 shared guides eliminating duplication across all agents:
196196
- Standards: AAA pattern, fixtures, mocking, coverage goals
197197
1. **markdown.instructions.md** (224 lines)
198198
- Auto-applies to: `**/*.md`
199-
- Standards: mdformat, line length, headers, code blocks
199+
- Standards: Prettier, line length, headers, code blocks
200200

201201
**Created 5 reusable prompt files:**
202202

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ gh pr create
187187
### Code Quality
188188

189189
```bash
190-
uv run poe format # Format code (ruff + mdformat)
190+
uv run poe format # Format code (ruff + prettier)
191191
uv run poe format-check # Check formatting without changes
192192
uv run poe lint # Run all linting (ruff + mypy + yamllint)
193193
uv run poe fix # Auto-fix formatting and linting issues

.github/instructions/markdown.instructions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66

77
## Formatting Tool
88

9-
- **Always use mdformat** for consistency
9+
- **Always use Prettier** for consistency
1010
- Run `uv run poe format` to format all markdown files
1111
- Run `uv run poe format-check` to verify formatting
1212

1313
## Line Length
1414

1515
- **88 characters maximum** (matches ruff for code)
16-
- mdformat handles wrapping automatically
16+
- Prettier handles wrapping automatically (`proseWrap: always`)
1717

1818
## Headers
1919

@@ -54,8 +54,8 @@
5454
3. Step 3
5555
```
5656

57-
- Use `1.` numbering (mdformat handles sequential)
58-
- Don't manually number (mdformat fixes)
57+
- Use `1.` numbering (Prettier handles sequential)
58+
- Don't manually number (Prettier fixes)
5959

6060
### Task Lists
6161

@@ -118,7 +118,7 @@ key: value
118118
| Value 4 | Value 5 | Value 6 |
119119
```
120120
121-
- Use mdformat to align columns automatically
121+
- Use Prettier to align columns automatically
122122
- Include header separator row
123123
124124
## Images
@@ -220,7 +220,7 @@ Date: YYYY-MM-DD
220220
221221
## Critical Reminders
222222
223-
1. **Always format with mdformat** - Run before committing
223+
1. **Always format with Prettier** - Run before committing
224224
1. **Test code examples** - Ensure they actually work
225225
1. **Verify links** - Broken links frustrate users
226226
1. **Specify code block language** - Required for syntax highlighting

.github/prompts/create-adr.prompt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,4 +125,4 @@ Date: YYYY-MM-DD
125125
- [ ] Consequences are realistic
126126
- [ ] Alternatives are documented
127127
- [ ] Index is updated
128-
- [ ] Files are formatted with mdformat
128+
- [ ] Files are formatted with Prettier

docs/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ uv run poe test-integration
7272
- We use [Ruff](https://docs.astral.sh/ruff/) for code formatting and linting
7373
- [ty](https://astral.sh/blog/ty) for type checking (Astral's fast Rust-based type
7474
checker)
75-
- [mdformat](https://mdformat.readthedocs.io/) for Markdown formatting
75+
- [Prettier](https://prettier.io/) for Markdown formatting
7676

7777
All formatting is automated via `uv run poe format`.
7878

docs/adr/0014-github-copilot-custom-agents.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ organizing these agents and their supporting materials.
2323
- YAML frontmatter must follow specific format with `name`, `description`, `tools`
2424
properties
2525
- Progressive disclosure is critical - agents should load minimal context initially
26-
- Markdown formatters (mdformat) can break YAML frontmatter if not configured properly
26+
- Markdown formatters (Prettier) can break YAML frontmatter if not configured properly
2727

2828
**Project-Specific:**
2929

@@ -124,7 +124,7 @@ Agents use the `read` tool to load these guides only when needed.
124124
### Configuration Details
125125

126126
- **File extension**: `.agent.md` (distinguishes from regular markdown)
127-
- **mdformat exclusion**: Agent files excluded from mdformat to preserve YAML
127+
- **Prettier exclusion**: Agent files listed in `.prettierignore` to preserve YAML
128128
frontmatter
129129
- **CODEOWNERS**: `.github/CODEOWNERS` assigns ownership of Copilot configuration
130130
- **Validation**: Pre-commit hooks validate YAML syntax with yamllint
@@ -144,7 +144,7 @@ Agents use the `read` tool to load these guides only when needed.
144144
1. **Maintainability**: Clear separation of concerns makes updates easier
145145
1. **Discoverability**: Developers can invoke agents by role (@python-developer,
146146
@tdd-specialist, etc.)
147-
1. **Context preservation**: mdformat exclusion prevents YAML frontmatter corruption
147+
1. **Context preservation**: Prettier exclusion prevents YAML frontmatter corruption
148148

149149
### Negative Consequences
150150

statuspro_mcp_server/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ upload_to_repository = false
8383
remove_dist = false
8484
commit_author = "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"
8585
commit_message = "chore(release): mcp v{version}"
86-
build_command = "pip install mdformat mdformat-gfm mdformat-tables mdformat-toc && mdformat CHANGELOG.md --wrap 88"
86+
build_command = "pnpm exec prettier --write CHANGELOG.md"
8787
major_on_zero = false
8888
allow_zero_version = true
8989
tag_format = "mcp-v{version}"

0 commit comments

Comments
 (0)