refactor(cli): rename oxlint to oxc#977
Conversation
…cumentation accordingly
|
@zcyc is attempting to deploy a commit to the Better T Stack Team on Vercel. A member of the Team first needs to authorize it. |
zcyc
changed the title
WalkthroughRenames the addon identifier "oxlint" to "oxc" across docs, CLI, templates, types, setup functions, constants, and tests; updates function names, type enums, addon wiring, and related tests to use "oxc" with no behavioral changes. Changes
Possibly related PRs
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
apps/cli/README.md (1)
63-63:⚠️ Potential issue | 🟡 MinorInconsistent addon name in CLI help text.
Line 63 still shows
oxlintin the addons list while line 44 showsOxc. Update the CLI usage documentation to useoxcfor consistency.📝 Suggested fix
- --addons <types...> Additional addons (pwa, tauri, electrobun, starlight, biome, lefthook, husky, mcp, turborepo, nx, fumadocs, ultracite, oxlint, opentui, wxt, skills, none) + --addons <types...> Additional addons (pwa, tauri, electrobun, starlight, biome, lefthook, husky, mcp, turborepo, nx, fumadocs, ultracite, oxc, opentui, wxt, skills, none)
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 578fe4d7-5af6-4fac-9b63-842f382892da
📒 Files selected for processing (21)
README.mdapps/cli/README.mdapps/cli/src/constants.tsapps/cli/src/helpers/addons/addons-setup.tsapps/cli/src/helpers/addons/oxc-setup.tsapps/cli/src/helpers/addons/ultracite-setup.tsapps/cli/src/helpers/core/post-installation.tsapps/cli/src/prompts/addons.tsapps/cli/test/addons.test.tsapps/cli/test/external-commands.test.tsapps/cli/test/integration.test.tsapps/cli/test/silent-create-output.test.tsapps/web/content/docs/cli/options.mdxapps/web/content/docs/index.mdxapps/web/content/docs/project-structure.mdxapps/web/src/lib/constant.tsapps/web/src/lib/stack-utils.tspackages/template-generator/src/processors/readme-generator.tspackages/template-generator/src/templates.generated.tspackages/template-generator/templates/addons/lefthook/lefthook.yml.hbspackages/types/src/schemas.ts
| import { cliLog, createSpinner } from "../../utils/terminal-output"; | ||
|
|
||
| type UltraciteLinter = "biome" | "eslint" | "oxlint"; | ||
| type UltraciteLinter = "biome" | "eslint" | "oxc"; |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
Does Ultracite CLI accept "oxc" as a --linter option?
💡 Result:
No, Ultracite CLI does not accept "oxc" as a --linter option. The supported linter options are "biome", "eslint", and "oxlint" (part of the Oxc ecosystem). "oxc" refers to the broader Oxc project, but the specific linter is oxlint, used with commands like npx ultracite init --linter oxlint.
Citations:
- 1: https://docs.ultracite.ai/usage
- 2: https://github.com/haydenbleasel/ultracite
- 3: https://www.ultracite.ai/
- 4: https://www.ultracite.ai/providers/oxlint
- 5: https://docs.ultracite.ai/
Revert type change: "oxc" is not a valid Ultracite CLI linter option.
The change from "oxlint" to "oxc" in the UltraciteLinter type is incorrect. Ultracite CLI only accepts "biome", "eslint", and "oxlint" as valid --linter options. "oxc" refers to the broader Oxc project; the specific linter within that ecosystem is "oxlint". This applies to the LINTERS map as well (line 68). Revert both the type and mapping back to "oxlint".
zcyc
changed the title
There was a problem hiding this comment.
🧹 Nitpick comments (1)
packages/template-generator/src/processors/readme-generator.ts (1)
685-691: Avoid duplicatecheckscript entries when both linters are selected.If both
biomeandoxcare present, README scripts will listchecktwice. Consider emitting a single line with a combined description.Proposed refactor
- if (addons.includes("biome")) { - scripts += `\n- \`${packageManagerRunCmd} check\`: Run Biome formatting and linting`; - } - - if (addons.includes("oxc")) { - scripts += `\n- \`${packageManagerRunCmd} check\`: Run Oxlint and Oxfmt`; - } + const hasBiome = addons.includes("biome"); + const hasOxc = addons.includes("oxc"); + if (hasBiome || hasOxc) { + const checkDesc = + hasBiome && hasOxc + ? "Run Biome and Oxc formatting/linting" + : hasBiome + ? "Run Biome formatting and linting" + : "Run Oxlint and Oxfmt"; + scripts += `\n- \`${packageManagerRunCmd} check\`: ${checkDesc}`; + }
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 6d12e9d2-f821-4b28-8d1e-6f8ab97eb2e9
📒 Files selected for processing (5)
apps/cli/README.mdapps/cli/src/helpers/core/post-installation.tsapps/web/content/docs/cli/options.mdxpackages/template-generator/src/processors/readme-generator.tspackages/template-generator/src/templates.generated.ts
✅ Files skipped from review due to trivial changes (3)
- apps/web/content/docs/cli/options.mdx
- apps/cli/src/helpers/core/post-installation.ts
- apps/cli/README.md
🚧 Files skipped from review as they are similar to previous changes (1)
- packages/template-generator/src/templates.generated.ts
1 participant
Oxc = Oxlint + Oxfmt
Summary by CodeRabbit
Chores
Documentation
Tests