chore: migrate from Prettier to oxfmt for code formatting by yangshun · Pull Request #11824 · facebook/docusaurus

yangshun · 2026-03-20T13:12:18Z

Summary

Replace Prettier with oxfmt as the code formatter
Add .oxfmtrc.json configuration and remove .prettierrc / .prettierignore
Update lint-staged config, CI workflows, and VS Code extensions accordingly
Reformat codebase with oxfmt

Test plan

Verify oxfmt formats all files correctly
Verify CI lint workflow passes
Verify lint-staged works on pre-commit

Notes on CI

Argos: 1 visual diff is reported and is intended — caused by oxfmt reflowing some MDX content (e.g. footnote spacing, list item spacing, ternary indentation in code blocks). Please approve the Argos build to accept the new baseline.
Lighthouse Report: failure is environmental (fork PRs lack pull-requests: write to post the sticky comment); the audit itself ran successfully.

socket-security · 2026-03-20T13:13:17Z

Warning

Review the following alerts detected in dependencies.

According to your organization's Security Policy, it is recommended to resolve "Warn" alerts. Learn more about Socket for GitHub.

Action	Severity	Alert (click "▶" to expand/collapse)
Warn		Obfuscated code: npm `entities` is 91.0% likely obfuscated Confidence: 0.91 Location: Package overview From: `?` → `npm/@docusaurus/core@3.10.1` → `npm/@docusaurus/preset-classic@3.10.1` → `npm/entities@4.5.0` ℹ Read more on: This package \| This alert \| What is obfuscated code? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at `support@socket.dev`. Suggestion: Packages should not obfuscate their code. Consider not using packages with obfuscated code. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment `@SocketSecurity ignore npm/entities@4.5.0`. You can also ignore all packages with `@SocketSecurity ignore-all`. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		Obfuscated code: npm `entities` is 91.0% likely obfuscated Confidence: 0.91 Location: Package overview From: `?` → `npm/@docusaurus/core@3.10.1` → `npm/@docusaurus/preset-classic@3.10.1` → `npm/entities@6.0.1` ℹ Read more on: This package \| This alert \| What is obfuscated code? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at `support@socket.dev`. Suggestion: Packages should not obfuscate their code. Consider not using packages with obfuscated code. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment `@SocketSecurity ignore npm/entities@6.0.1`. You can also ignore all packages with `@SocketSecurity ignore-all`. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

View full report

netlify · 2026-03-20T13:15:23Z

✅ [V2]

Name	Link
🔨 Latest commit	`296451d`
🔍 Latest deploy log	https://app.netlify.com/projects/docusaurus-2/deploys/69fc7a7dde7df70008572059
😎 Deploy Preview	https://deploy-preview-11824--docusaurus-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

akshatsinha0 · 2026-03-26T07:31:46Z

Great Idea. Was searching for something like this.

argos-ci · 2026-04-08T15:34:47Z

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build	Status	Details	Updated (UTC)
default (Inspect)	⚠️ Changes detected (Review)	1 changed	May 7, 2026, 11:49 AM

slorber · 2026-04-28T14:54:54Z

@yangshun let me know if you want to update this PR. Now that we upgraded node it should pass CI.

yangshun · 2026-04-28T15:00:26Z

Sorry I dropped the ball on this, I'll update this PR within the next few days. Or if you want to take over go ahead as well.

Replace prettier invocation in per-package build scripts and refresh yarn.lock after switching from prettier to oxfmt.

yangshun · 2026-04-29T10:49:40Z

@slorber updated to latest Oxlint and rebased against origin/main. I eyeballed the rest of the changes, they look fine.

Lighthouse failure: Seems to fail for all non-maintainer PRs
Argos failure: Intended as the formatting of some code blocks have changed, and the Argos screenshot captures that difference. I'm not sure how to update on my end. Can I trouble you to make the necessary updates?

slorber · 2026-04-30T15:18:01Z

Thanks

I'll test a bit the Oxc plugin for Intellij soon to see if this isn't disruptive for me, and merge asap 👍

socket-security · 2026-05-07T10:44:38Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Package	Supply Chain Security	Quality
@docusaurus/faster@3.10.1
@docusaurus/module-type-aliases@3.10.1
@docusaurus/preset-classic@3.10.1
@docusaurus/types@3.10.1
@docusaurus/core@3.10.1
clsx@2.1.1
react@16.14.0 ⏵ 19.2.5	⁺¹	⁺⁷
prism-react-renderer@2.4.1
react-dom@16.14.0 ⏵ 19.2.5	⁺⁷	⁺³

View full report

slorber

LGTM 👍

Additional notes:

Removed the prettier xml plugin
Kept https://github.com/prettier/stylelint-config-prettier, also works to avoid css conflicts with oxfmt, but we'll likely be able to remove it after upgrading Stylelint
// oxfmt-ignore exists but do not work everywhere. For now, it's safer to use // prettier-ignore, also supported (see oxc-project/website#1092)
Removed --no-error-on-unmatched-pattern because otherwise it hides a bug: theme JS files are not pretty when swizzling them as JS. We want to ensure they remain formatted after the migration.

Otherwise it looks good and fast 👍

slorber · 2026-05-07T11:44:20Z

  "types": "src/plugin-ideal-image.d.ts",
  "scripts": {
-    "build": "tsc --build && node ../../admin/scripts/copyUntypedFiles.js && prettier --config ../../.prettierrc --write \"lib/theme/**/*.js\"",
+    "build": "tsc --build && node ../../admin/scripts/copyUntypedFiles.js && oxfmt \"lib/theme/**/*.js\"",


FYI I removed the --no-error-on-unmatched-pattern on purpose

lib files are usually generated/ignored, but for lib/theme we definitely want to format them well because it's what users will get when swizzling with JS. (for TS we swizzle from source so it's already formatted)

slorber · 2026-05-07T11:45:09Z

+    "packages/docusaurus-*/lib/*",
+
+    "packages/create-docusaurus/lib/*",
+    "!packages/docusaurus-*/lib/theme/**",


Needed to format js files for js swizzle CLI, otherwise we get an error without --no-error-on-unmatched-pattern because oxfmt doesn't format them

meta-cla Bot added the CLA Signed Signed Facebook CLA label Mar 20, 2026

yangshun marked this pull request as ready for review April 8, 2026 15:14

yangshun requested review from Josh-Cena and slorber as code owners April 8, 2026 15:14

yangshun marked this pull request as draft April 8, 2026 15:19

slorber added pr: maintenance This PR does not produce any behavior differences to end users when upgrading. Argos Add this label to run UI visual regression tests. See argos.yml GH action. labels Apr 8, 2026

yangshun added 4 commits April 29, 2026 15:36

chore: migrate from Prettier to oxfmt for code formatting

a1ca456

chore: bump oxfmt to ^0.47.0

6b0606f

chore: update package build scripts to use oxfmt

58a2c11

Replace prettier invocation in per-package build scripts and refresh yarn.lock after switching from prettier to oxfmt.

chore: format codebase with oxfmt

7d84045

yangshun force-pushed the ys/oxfmt branch from 914608b to 7d84045 Compare April 29, 2026 08:45

chore: remove unused oxfmt entries from project-words.txt

54cdc64

yangshun marked this pull request as ready for review April 29, 2026 10:37

Merge branch 'main' into ys/oxfmt

794c458

slorber added 2 commits May 7, 2026 12:32

change some prettier refs

0f367fa

remove prettier from deps, remove @prettier/plugin-xml

4b2ba8a

slorber added 2 commits May 7, 2026 13:01

fix project words

5c01fc7

fix formatting of lib/theme files for swizzling

296451d

slorber approved these changes May 7, 2026

View reviewed changes

slorber merged commit 190ef6f into facebook:main May 7, 2026
36 of 39 checks passed

Uh oh!

Conversation

yangshun commented Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Notes on CI

Uh oh!

socket-security Bot commented Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify Bot commented Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ [V2]

Uh oh!

akshatsinha0 commented Mar 26, 2026

Uh oh!

argos-ci Bot commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

slorber commented Apr 28, 2026

Uh oh!

yangshun commented Apr 28, 2026

Uh oh!

yangshun commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

slorber commented Apr 30, 2026

Uh oh!

socket-security Bot commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

slorber left a comment

Choose a reason for hiding this comment

Uh oh!

slorber May 7, 2026

Choose a reason for hiding this comment

Uh oh!

slorber May 7, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

yangshun commented Mar 20, 2026 •

edited

Loading

socket-security Bot commented Mar 20, 2026 •

edited

Loading

netlify Bot commented Mar 20, 2026 •

edited

Loading

argos-ci Bot commented Apr 8, 2026 •

edited

Loading

yangshun commented Apr 29, 2026 •

edited

Loading

socket-security Bot commented May 7, 2026 •

edited

Loading