Skip to content

chore: remove default html.format from config#1764

Merged
cossssmin merged 2 commits into
masterfrom
chore/remove-format-default
Jun 23, 2026
Merged

chore: remove default html.format from config#1764
cossssmin merged 2 commits into
masterfrom
chore/remove-format-default

Conversation

@cossssmin

@cossssmin cossssmin commented Jun 23, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Chores
    • Updated default HTML processing settings to remove formatting behavior while keeping entity decoding enabled.
  • API Changes
    • Updated public typing for formatter options/config from FormatOptions to FormatConfig.
  • Tests
    • Updated tests to reflect the revised HTML defaults and the new configuration typing expectations.

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 1e5d579d-9ef1-4069-911b-5e11b0c0a055

📥 Commits

Reviewing files that changed from the base of the PR and between a75097c and 3619f10.

📒 Files selected for processing (4)
  • src/index.ts
  • src/tests/transformers/format.test.ts
  • src/transformers/format.ts
  • src/types/config.ts

📝 Walkthrough

Walkthrough

The PR removes the format: true property from the html block in the defaults configuration and its corresponding test assertion. The FormatOptions type from oxfmt is renamed to FormatConfig across the type system: the public type export, the HtmlConfig type, the format transformer implementation, and the test helper are all updated to use the new type name.

Changes

HTML format configuration update

Layer / File(s) Summary
Remove html.format default from config and test
src/config/defaults.ts, src/tests/render/basic.test.ts
defaults.html no longer includes format: true; the test assertion checking that default is deleted.
Rename FormatOptions to FormatConfig in type system and implementation
src/types/config.ts, src/transformers/format.ts, src/index.ts, src/tests/transformers/format.test.ts
The FormatOptions type is renamed to FormatConfig in the public API export, the HtmlConfig property type, the format transformer signature, and the test helper.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 50.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
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: removing the default html.format property from the configuration.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/remove-format-default

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.

@cossssmin cossssmin merged commit 4e7bc52 into master Jun 23, 2026
6 checks passed
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