chore: switch Markdown formatting to proseWrap never by mheob · Pull Request #398 · mheob/config · GitHub
Skip to content

chore: switch Markdown formatting to proseWrap never - #398

Merged
kodiakhq[bot] merged 4 commits into
mainfrom
chore/update-deps-and-markdown-formatting
Aug 3, 2026
Merged

kodiakhq[bot] merged 4 commits into
mainfrom
chore/update-deps-and-markdown-formatting

Conversation

@mheob

@mheob mheob commented Aug 3, 2026 •

Copy link
Copy Markdown
Owner

Summary

Three focused commits:

  1. chore(repo): add gitbutler CLI skill — adds the GitButler CLI skill (SKILL.md plus concepts, examples, reference) under .claude/skills/gitbutler/, so version control goes through but instead of raw git write commands. Repo tooling only, no changeset.
  2. fix(deps): update workspace dependencies — bumps oxfmt (^0.62.0), oxlint (^1.77.0), tsdown (^0.22.14), @types/node (^26.1.2), turbo (^2.10.8), eslint-plugin-better-tailwindcss (^4.7.0), eslint-plugin-storybook (^10.5.6), and eslint-plugin-yml (^3.7.0). Raises the oxlint peer range in oxlint-config to ^1.77.0 and widens the oxfmt peer range in oxfmt-config to >=0.62.0 <1.0.0. commitlint.config.js picks up the new oxfmt arrow-parens default.
  3. feat(oxfmt): format markdown with proseWrap never — the *.md override now uses proseWrap: 'never' instead of printWidth: 130, keeping each paragraph on one line so documentation diffs stay minimal.

Changesets

  • .changeset/update-workspace-dependencies.md — patch for commitlint-config, oxfmt-config, internal; minor for oxlint-config (peer range bump)
  • .changeset/markdown-prose-wrap-never.md — minor for oxfmt-config

Verification

  • bun run build — 3/3 tasks successful
  • bun run lint — 0 warnings, 0 errors across all 5 packages

Breaking / behavioral notes

proseWrap: 'never' changes Markdown output for every consumer of @mheob/oxfmt-config. First format run after upgrading will unwrap existing hard-wrapped prose, producing a large one-time diff.

Summary by CodeRabbit

  • Style

    • Updated Markdown formatting to prevent automatic prose wrapping, preserving author-defined line breaks.
  • Documentation

    • Added comprehensive GitButler CLI guidance, including workflows for branching, commits, history editing, conflict resolution, recovery, and pull requests.
    • Added reference material covering concepts, commands, options, and practical examples.
  • Chores

    • Updated development tooling configuration and standardized minor formatting conventions.

@changeset-bot

changeset-bot Bot commented Aug 3, 2026 •

Copy link
Copy Markdown

@coderabbitai

coderabbitai Bot commented Aug 3, 2026 •

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@mheob, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 37 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 070755c3-26e4-4bef-9531-329f3c0a8d12

📥 Commits

Reviewing files that changed from the base of the PR and between 60141b7 and b288ccc.

📒 Files selected for processing (6)
  • .changeset/markdown-prose-wrap-never.md
  • CLAUDE.md
  • packages/commitlint-config/README.md
  • packages/oxfmt-config/README.md
  • packages/oxfmt-config/src/index.ts
  • packages/oxlint-config/README.md

Walkthrough

Changes

GitButler guidance

Layer / File(s) Summary
GitButler workspace concepts
.claude/skills/gitbutler/references/concepts.md
Documents workspace branches, CLI identifiers, dependencies, history operations, branch states, conflicts, and safe Git commands.
GitButler skill workflows
.claude/skills/gitbutler/SKILL.md
Defines command selection, mutation workflows, branch operations, conflict resolution, and Git command restrictions.
GitButler command reference and examples
.claude/skills/gitbutler/references/*
Adds categorized command syntax and end-to-end workflow examples.

Workspace tooling updates

Layer / File(s) Summary
Formatter and linter configuration
packages/oxfmt-config/src/index.ts, packages/oxfmt-config/package.json, packages/oxlint-config/package.json
Disables Markdown prose wrapping and updates formatter and linter peer ranges.
Workspace dependency updates
package.json, packages/*/package.json
Updates development dependencies for Node types, formatter, linter, build tooling, plugins, and Turbo.
Release metadata and syntax cleanup
.changeset/*, commitlint.config.js
Adds release metadata and applies a behavior-neutral callback formatting change.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Possibly related PRs

  • mheob/config#365: Updates the formatter and linter configuration packages affected by this change.
  • mheob/config#384: Updates overlapping tooling dependencies and Changesets.
  • mheob/config#389: Updates overlapping tooling dependencies and peer ranges.

Suggested labels: dependencies, prettier

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the primary Markdown formatting change in the pull request.
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/update-deps-and-markdown-formatting

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mheob mheob changed the title chore: update dependencies and switch Markdown formatting to proseWrap never chore: switch Markdown formatting to proseWrap never Aug 3, 2026
@socket-security

socket-security Bot commented Aug 3, 2026 •

Copy link
Copy Markdown

@mheob
mheob force-pushed the chore/update-deps-and-markdown-formatting branch from 60141b7 to 713b12b Compare August 3, 2026 16:52

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 6

🧹 Nitpick comments (1)
packages/oxfmt-config/src/index.ts (1)

14-14: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick win

Preserve the Markdown width for non-prose constructs.

proseWrap: 'never' changes paragraph wrapping, but it does not replace printWidth for tables and other width-sensitive Markdown output. Removing printWidth: 130 makes those constructs use the root/default width instead. If only paragraph wrapping should change, retain printWidth: 130 in this override. Oxfmt documents proseWrap and printWidth as separate options. (oxc.rs)

Proposed configuration
 			options: {
+				printWidth: 130,
 				proseWrap: 'never',
 			},
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@packages/oxfmt-config/src/index.ts` at line 14, Retain the printWidth: 130
setting in the Markdown formatter override alongside proseWrap: 'never'. Keep
paragraph wrapping disabled while preserving the existing width for tables and
other width-sensitive Markdown constructs.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.claude/skills/gitbutler/references/concepts.md:
- Line 9: Add the text language tag to each of the six fenced code blocks in
concepts.md, including the blocks at the referenced locations, so diagrams,
status output, and conceptual examples use tagged fences and satisfy
markdownlint MD040.

In @.claude/skills/gitbutler/references/reference.md:
- Around line 199-236: Align all `but squash` documentation with the official
contract by using positional sources and the supported `-m`/`-d` message flags,
removing references to `-t`/`-u` and uncommitted-file sources where unsupported.
Update `.claude/skills/gitbutler/references/reference.md` (199-236),
`.claude/skills/gitbutler/SKILL.md` (72-73),
`.claude/skills/gitbutler/references/concepts.md` (130-149), and
`.claude/skills/gitbutler/references/examples.md` (112-116, 134-136, 326-327)
consistently; every listed site requires documentation changes.
- Around line 249-269: Align every listed but move snippet with the official
positional CLI contract: use positional sources and targets, --after for
placement, and zz for unstacking. Update
.claude/skills/gitbutler/references/reference.md lines 249-269;
.claude/skills/gitbutler/SKILL.md lines 74-78, 121, and 143-145;
.claude/skills/gitbutler/references/concepts.md lines 111-121 and 151-158; and
.claude/skills/gitbutler/references/examples.md lines 154-155, 170-172, and
323-324, covering branch stacking/unstacking and multiple-source commit examples
without the unsupported --above, --below, --unstack, --branch, or -b forms.

In @.claude/skills/gitbutler/SKILL.md:
- Around line 88-97: Update the “get latest from main” guidance around `but
pull` so WIP parking with `but commit -b` and `but uncommit` is documented only
for an actual pull refusal caused by conflicting uncommitted changes. Remove any
implication that this recovery path applies to normal pull results with
conflicted commits; those must continue through the existing oldest-first `but
resolve` flow.

In `@package.json`:
- Around line 34-40: Align the packageManager Bun version in package.json with
the repository’s required bun@1.3.11 version, or consistently update the
documented repository requirement to bun@1.3.14; ensure the manifest and
documentation specify the same version.

In `@packages/oxfmt-config/package.json`:
- Line 45: Align the peer dependency ranges in
packages/oxfmt-config/package.json (45) and packages/oxlint-config/package.json
(54) with the release metadata: restore the previous compatible ranges, or
change both packages’ release entries to major bumps if the tightened ranges are
intentional. Update .changeset/markdown-prose-wrap-never.md (2-5) and
.changeset/update-workspace-dependencies.md (4-8) consistently with that choice.

---

Nitpick comments:
In `@packages/oxfmt-config/src/index.ts`:
- Line 14: Retain the printWidth: 130 setting in the Markdown formatter override
alongside proseWrap: 'never'. Keep paragraph wrapping disabled while preserving
the existing width for tables and other width-sensitive Markdown constructs.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 5a8fa3db-17a9-49fb-ba9c-9d54d94a08cb

📥 Commits

Reviewing files that changed from the base of the PR and between 404b97e and 60141b7.

⛔ Files ignored due to path filters (1)
  • bun.lock is excluded by !**/*.lock
📒 Files selected for processing (13)
  • .changeset/markdown-prose-wrap-never.md
  • .changeset/update-workspace-dependencies.md
  • .claude/skills/gitbutler/SKILL.md
  • .claude/skills/gitbutler/references/concepts.md
  • .claude/skills/gitbutler/references/examples.md
  • .claude/skills/gitbutler/references/reference.md
  • commitlint.config.js
  • package.json
  • packages/commitlint-config/package.json
  • packages/internal/package.json
  • packages/oxfmt-config/package.json
  • packages/oxfmt-config/src/index.ts
  • packages/oxlint-config/package.json

Comment thread .claude/skills/gitbutler/references/concepts.md
Comment thread .claude/skills/gitbutler/references/reference.md
Comment thread .claude/skills/gitbutler/references/reference.md
Comment thread .claude/skills/gitbutler/SKILL.md
Comment thread package.json
Comment thread packages/oxfmt-config/package.json
@sonarqubecloud

sonarqubecloud Bot commented Aug 3, 2026

Copy link
Copy Markdown

@kodiakhq
kodiakhq Bot merged commit 9afa237 into main Aug 3, 2026
10 checks passed
@kodiakhq
kodiakhq Bot deleted the chore/update-deps-and-markdown-formatting branch August 3, 2026 17:12
kodiakhq Bot pushed a commit that referenced this pull request Aug 3, 2026
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated.


# Releases
## @mheob/oxfmt-config@1.3.0

### Minor Changes

- [#398](#398) ([@mheob](https://github.com/mheob)): Format Markdown with `proseWrap: 'never'` instead of a `printWidth` of `130`. Prose is now kept on a single line per paragraph, which keeps diffs on documentation changes minimal. Widen the `oxfmt` peer range to `>=0.62.0 <1.0.0`.

### Patch Changes

- [#398](#398) ([@mheob](https://github.com/mheob)): Update dependencies across the workspace, including `oxfmt` (^0.62.0), `oxlint` (^1.77.0), `tsdown` (^0.22.14), `@types/node` (^26.1.2), `turbo` (^2.10.8), `eslint-plugin-better-tailwindcss` (^4.7.0), `eslint-plugin-storybook` (^10.5.6), and `eslint-plugin-yml` (^3.7.0). Bump the `oxlint` peer range in `oxlint-config` to `^1.77.0`.
## @mheob/oxlint-config@2.4.0

### Minor Changes

- [#398](#398) ([@mheob](https://github.com/mheob)): Update dependencies across the workspace, including `oxfmt` (^0.62.0), `oxlint` (^1.77.0), `tsdown` (^0.22.14), `@types/node` (^26.1.2), `turbo` (^2.10.8), `eslint-plugin-better-tailwindcss` (^4.7.0), `eslint-plugin-storybook` (^10.5.6), and `eslint-plugin-yml` (^3.7.0). Bump the `oxlint` peer range in `oxlint-config` to `^1.77.0`.
## @mheob/commitlint-config@2.0.4

### Patch Changes

- [#398](#398) ([@mheob](https://github.com/mheob)): Update dependencies across the workspace, including `oxfmt` (^0.62.0), `oxlint` (^1.77.0), `tsdown` (^0.22.14), `@types/node` (^26.1.2), `turbo` (^2.10.8), `eslint-plugin-better-tailwindcss` (^4.7.0), `eslint-plugin-storybook` (^10.5.6), and `eslint-plugin-yml` (^3.7.0). Bump the `oxlint` peer range in `oxlint-config` to `^1.77.0`.
## @mheob/internal@0.0.1

### Patch Changes

- [#398](#398) ([@mheob](https://github.com/mheob)): Update dependencies across the workspace, including `oxfmt` (^0.62.0), `oxlint` (^1.77.0), `tsdown` (^0.22.14), `@types/node` (^26.1.2), `turbo` (^2.10.8), `eslint-plugin-better-tailwindcss` (^4.7.0), `eslint-plugin-storybook` (^10.5.6), and `eslint-plugin-yml` (^3.7.0). Bump the `oxlint` peer range in `oxlint-config` to `^1.77.0`.
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