Skip to content

[PM-31180] Proposal use oxfmt instead of prettier#706

Open
Hinton wants to merge 6 commits intomainfrom
arch/oxfmt
Open

[PM-31180] Proposal use oxfmt instead of prettier#706
Hinton wants to merge 6 commits intomainfrom
arch/oxfmt

Conversation

@Hinton
Copy link
Member

@Hinton Hinton commented Jan 22, 2026

🎟️ Tracking

https://bitwarden.atlassian.net/browse/PM-31180

📔 Objective

Speeds up formatting almost by a factor of 7.

Oxlint: 0.6s
Prettier: ~4.1s

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

@github-actions
Copy link
Contributor

github-actions bot commented Jan 22, 2026

Logo
Checkmarx One – Scan Summary & Details9b470fcb-505d-41a0-b012-cd3186c53606

Fixed Issues (1)

Great job! The following issues were fixed in this Pull Request

Severity Issue Source File / Package
HIGH CVE-2025-64756 Npm-glob-11.0.3

@github-actions
Copy link
Contributor

github-actions bot commented Jan 22, 2026

🔍 SDK Breaking Change Detection Results

SDK Version: arch/oxfmt (2c58f3a)
Completed: 2026-01-29 09:53:56 UTC
Total Time: 246s

Client Status Details
typescript ❌ Breaking changes detected TypeScript compilation failed with new SDK version - View Details

Breaking change detection completed. View SDK workflow

@codecov
Copy link

codecov bot commented Jan 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.76%. Comparing base (c17008b) to head (2c58f3a).
⚠️ Report is 9 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #706      +/-   ##
==========================================
+ Coverage   79.62%   79.76%   +0.14%     
==========================================
  Files         293      299       +6     
  Lines       32780    33210     +430     
==========================================
+ Hits        26102    26491     +389     
- Misses       6678     6719      +41     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Hinton Hinton changed the title Proposal use oxfmt instead of prettier [PM-31180] Proposal use oxfmt instead of prettier Jan 23, 2026
@Hinton Hinton marked this pull request as ready for review January 23, 2026 14:16
@Hinton Hinton requested review from a team as code owners January 23, 2026 14:16
Copy link
Member Author

Choose a reason for hiding this comment

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

oxfmt also handles toml files. We can disable this if we want, but I think using this over cargo sort probably produces better result.

djsmith85
djsmith85 previously approved these changes Jan 27, 2026
Copy link
Contributor

@djsmith85 djsmith85 left a comment

Choose a reason for hiding this comment

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

Changes are looking good. I'm looking forward to the speed-improvements.

  • Replaces the usage of prettier
  • Deletes the prettier-config files so no cmd/extension picks up any rules by accident
  • Changes the githook to use oxfmt
  • Changes to package.json and toml files are minimal
  • Removes prettier from renovate and adds oxfmt
  • Instructions on README.md updated

Are we planning on also replacing this on clients?
Then we should follow up with a PR there and also update the contributing-docs. As a potential replacement for the prettier vscode plugin: oxc 🤷 ?

ike-kottlowski
ike-kottlowski previously approved these changes Jan 27, 2026
@Hinton Hinton dismissed stale reviews from ike-kottlowski and djsmith85 via 2c58f3a January 29, 2026 09:42
@Hinton
Copy link
Member Author

Hinton commented Jan 29, 2026

@djsmith85 I replaced the prettier extension recommendation with oxc and configured formatter for applicable files in vscode.

There actually is a PR up for clients

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants