feat: use oxlint to speed up lint by EurFelux · Pull Request #10168 · CherryHQ/cherry-studio

EurFelux · 2025-09-14T18:55:25Z

What this PR does

Add oxlint to speed up the linting process without replacing eslint.

In my development environment, eslint takes about 18 seconds to lint the entire codebase, whereas oxlint takes less than 1 second. However, despite its remarkable speed, oxlint currently supports a limited set of rules, and some of its rule behaviors differ from their corresponding eslint plugins, making it impossible to fully replace eslint.

yarn test:lint will run checks using both oxlint and eslint sequentially. By first using oxlint, we can quickly identify and eliminate most issues, throwing errors early on. This significantly improves efficiency, whether in CI or local development.
Using the official vscode plugin oxc for oxlint can also greatly enhance linting speed during local development.
The job order for PR CI has been adjusted; now the lint check will run before the format check, as oxlint is significantly faster than Prettier. (NOTE: Biome's formatting speed is also much faster than Prettier, but its linting speed isn't as good as oxlint's. We might consider replacing Prettier with Biome.)

Since eslint has not been completely replaced, it still needs to check every file in the CI environment, resulting in no improvement in runtime. However, because oxlint can provide an extremely fast one-time check, the PR CI will fail more quickly when there are lint errors.

Fixes #

Why we need it and why it was done in this way

The following tradeoffs were made:

The following alternatives were considered:

Links to places where the discussion took place:

Breaking changes

If this PR introduces breaking changes, please describe the changes and the impact on users.

Special notes for your reviewer

Checklist

This checklist is not enforcing, but it's a reminder of items that could be relevant to every PR.
Approvers are expected to review this list.

PR: The PR description is expressive enough and will help future contributors
Code: Write code that humans can understand and Keep it simple
Refactor: You have left the code cleaner than you found it (Boy Scout Rule)
Upgrade: Impact of this change on upgrade flows was considered and addressed if required
Documentation: A user-guide update was considered and is present (link) or not required. You want a user-guide update if it's a user facing feature.

Release note

Add new eslint plugin to enhance linting capabilities with oxlint rules

Add oxlint plugin as recommended in the documentation to enhance linting capabilities

Add oxlint alongside eslint in test:lint and lint scripts for enhanced static analysis

Configure oxlint with a comprehensive set of rules for JavaScript/TypeScript code quality checks

- Add oxc to editor code actions on save - Update oxlint configs to use eslint, typescript, and unicorn presets - Extend ignore patterns in oxlint configuration - Simplify oxlint command in package.json scripts - Add oxlint-tsgolint dependency

- Add src/preload to eslint ignore patterns - Update oxlint env to es2022 and add environment overrides - Adjust several lint rule severities and configurations

…name The linter was changed from ESLint to oxlint, so the directive needs to be updated accordingly.

The error description was incorrectly showing in production and hiding in development. Fix the logic to show detailed errors only in development mode

EurFelux · 2025-09-14T21:20:25Z

@claude review

claude · 2025-09-14T21:20:38Z

Claude finished @EurFelux's task —— View job

Code Review: Add oxlint to speed up linting

Summary

This PR successfully integrates oxlint as a pre-linter to speed up the linting process. The implementation is well-structured and maintains compatibility with the existing eslint setup while providing significant performance improvements (18s → <1s for the entire codebase).

✅ Strengths

Non-disruptive Integration: The implementation smartly uses oxlint as a first-pass linter while preserving eslint for rules not yet supported by oxlint. This ensures no regression in code quality.
Proper Configuration Management:
- The .oxlintrc.json configuration properly mirrors the environment settings from eslint
- Correct use of eslint-plugin-oxlint to disable overlapping rules and avoid double-checking
- Appropriate rule selection with clear comments for disabled rules
Command Structure: The test:lint command properly chains oxlint and eslint with --deny-warnings flag, ensuring fast failure on lint errors.
Developer Experience: Including the oxc VS Code extension in recommendations will improve the local development experience.

🔍 Observations

Code Changes: The source file modifications (39 files) appear to be fixes for issues caught by oxlint's stricter or different rule implementations:
- Removed unused variables/imports
- Fixed comment formatting (// NODE → // NOTE in src/main/utils/index.ts:39)
- Corrected conditional logic (MessageErrorBoundary.tsx:21)
- Other minor linting corrections

Rule Differences: Some oxlint rules are intentionally disabled with comments indicating they may be enabled in the future:

"oxc/only-used-in-recursion": "off", // manually off because of existing warning
"unicorn/no-empty-file": "off", // may turn it on in the future

TypeScript Rules: Good handling of TypeScript-specific rules with appropriate severity levels (warn vs error).

⚠️ Minor Issues

Duplicate Entry in ignorePatterns: Line 19 in .oxlintrc.json duplicates line 17:

"src/main/integration/nutstore/sso/lib/**",  // Line 17
"src/main/integration/cherryin/index.js",
"src/main/integration/nutstore/sso/lib/**",  // Line 19 (duplicate)

Comment Typo: Line 137 has a typo: "bacause" should be "because"

"oxc/only-used-in-recursion": "off", // manually off bacause of existing warning

📝 Suggestions

Documentation: Consider adding a brief note in the project's README or contributing guide about the two-stage linting approach, explaining why both oxlint and eslint are used.
CI Pipeline: Ensure the CI pipeline uses the same yarn test:lint command to benefit from the speed improvements.
Future Roadmap: Consider documenting which eslint rules are still needed and tracking oxlint's progress on supporting them, to eventually simplify to a single linter when possible.
Performance Metrics: It would be valuable to add the performance improvement metrics to the PR description for future reference.

Verdict

This is a well-executed integration that provides immediate performance benefits while maintaining code quality standards. The approach is pragmatic and the implementation is clean. With the minor fixes mentioned above, this PR is ready for merge.

Recommended: Approve with minor suggestions ✅

beyondkmp · 2025-09-15T01:13:08Z

Note

This comment was translated by Claude.

Currently, eslint uses the simple-import-sort plugin, which oxlint has not implemented yet (oxc-project/oxc#7197). If we keep both, it will cause the import order to be different.

Original Content

目前eslint用了simple-import-sort plugin，oxlint是没有实现的（https://github.com/oxc-project/oxc/discussions/7197），两个都保留的话，会导致这个import的顺序不一样。

EurFelux · 2025-09-15T01:15:15Z

Note

This comment was translated by Claude.

Why? If oxlint doesn't have it, won't it just use eslint's instead? There's no conflict either.

Original Content

Note

This comment was translated by Claude.

Currently, eslint uses the simple-import-sort plugin, which oxlint has not implemented yet (oxc-project/oxc#7197). If we keep both, it will cause the import order to be different.

Original Content
目前eslint用了simple-import-sort plugin，oxlint是没有实现的（https://github.com/[oxc-project/oxc/discussions/7197](https://github.com/oxc-project/oxc/discussions/7197)），两个都保留的话，会导致这个import的顺序不一样。

为啥？oxlint没有的话，不是就用eslint的了吗，也没有冲突啊。

beyondkmp · 2025-09-15T01:16:46Z

Note

This comment was translated by Claude.

oxlint has its own sorting rules, so it's also fine to not enable oxlint's own sorting.

Original Content

oxlint有自己一套排序的，那就是不要启用oxlint自己的排序也是可以的。

EurFelux · 2025-09-15T01:20:44Z

Note

This comment was translated by Claude.

I checked and there is an eslint/sort-imports rule, but it's not enabled in the configuration, and it's not a default rule either.

Original Content

Note

This comment was translated by Claude.

oxlint has its own sorting rules, so it's also fine to not enable oxlint's own sorting.

Original Content

看了一下，是有eslint/sort-imports这个规则，不过配置里面没有开的，这个也不是默认规则。

beyondkmp · 2025-09-15T01:37:35Z

Note

This comment was translated by Claude.

It seems there's no improvement after all. eslint is still slow, even though oxlint is fast.

Original Content

好像也没有提升了，eslint还是很慢，虽然oxlint快。

beyondkmp · 2025-09-15T01:45:53Z

Note

This comment was translated by Claude.

How about we try a complete replacement? If there are rule differences, we can re-lint and format all the code, and from then on use oxlint as the standard. That would be really awesome.

Original Content

要不就是全部替换看下，如果有规则不一样，直接代码都重新lint和format下，后面都以oxlint为准，这样就真的非常爽了。

alephpiece · 2025-09-15T01:54:35Z

Note

This comment was translated by Claude.

How about we try a complete replacement? If there are rule differences, we can re-lint and format all the code, and from then on use oxlint as the standard. That would be really awesome.

If we do a complete replacement, it's best to put lint and format in one PR. After it's done, it will also be easier to update the blame ignore.

Original Content

How about we try a complete replacement? If there are rule differences, we can re-lint and format all the code, and from then on use oxlint as the standard. That would be really awesome.

全部替换的话最好把 lint 和 format 放在一个 pr 里面，做完之后也好改 blame ignore

EurFelux · 2025-09-15T05:27:57Z

Note

This comment was translated by Claude.

For example, the exhaustive-deps rule for react hooks - although oxlint will report issues, it reports them in different places. If we want to drop eslint, we'd have to change eslint-disable comments in many places. Also, the auto-fix feature for this rule won't be available, which is quite inconvenient. This rule is mainly what makes me hesitant to replace eslint. I haven't looked closely at other rules yet.

Original Content

比如react hooks的exhaustive-deps这个规则，oxlint虽然会报告问题，但是报告问题的地方不一样，如果要丢掉eslint的话，就要改特别多地方的eslint-disable的注释。而且这个规则的自动修复功能也用不了，还挺不方便的。主要是这个规则让我不太想替掉eslint，其他规则倒是没有细看过。

EurFelux · 2025-09-15T05:33:36Z

oxc-project/oxc#12392
oxc-project/oxc#13311

EurFelux · 2025-09-15T05:37:40Z

It seems there's no improvement after all. eslint is still slow, even though oxlint is fast.

If eslint isn't completely replaced, the entire linting process cannot be fully accelerated, because eslint still needs to be run again after oxlint. While oxlint allows most issues to be flagged earlier, it doesn't yet support all existing rules.

GeorgeDong32

我这边测试没啥问题，oxlint能覆盖基础规则尽早发现基础错误也是件好事，虽然现阶段还是要eslint兜底

EurFelux · 2025-09-15T09:42:17Z

@0xfullex

…xlint

camc314 · 2025-09-16T08:46:18Z

.oxlintrc.json

+  // We don't use the React plugin here because its behavior differs slightly from that of ESLint's React plugin.
+  "plugins": ["unicorn", "typescript", "oxc", "import"],


Looks like 2x issue preventing you from using react plugin.

First being a bug which should be fixed in the next version here: oxc-project/oxc#13815

The second being:

⚠ eslint-plugin-react(no-children-prop): Avoid passing children using a prop. ╭─[src/renderer/src/components/DraggableList/virtual-list.tsx:188:23] 187 │ virtualizer={virtualizer} 188 │ children={children} · ──────── 189 │ disabled={disabled} ╰──── help: The canonical way to pass children in React is to use JSX elements

Which i think you should just disable in your oxlint config as it's not enabled in your eslint config?

Thanks for using oxlint!

Thank you for following up on this issue! no-children-prop is not a big deal because just few errors here. Once the issue with exhaustive-deps is resolved, we can replace the eslint react plugin with the oxlint React plugin.

awesome, going to try and do a release today 🤞

EurFelux added 12 commits September 14, 2025 22:58

build: add eslint-plugin-oxlint dependency

50a9a3a

Add new eslint plugin to enhance linting capabilities with oxlint rules

build(eslint): add oxlint plugin to eslint config

6a87d3c

Add oxlint plugin as recommended in the documentation to enhance linting capabilities

build: add oxlint v1.15.0 as a dependency

020d8c5

build: add oxlint to linting commands

26387fe

Add oxlint alongside eslint in test:lint and lint scripts for enhanced static analysis

build: add oxlint configuration file

d4fd8fa

Configure oxlint with a comprehensive set of rules for JavaScript/TypeScript code quality checks

fix: lint warning

f29d31d

chore: update oxlintrc from eslint.recommended

e3f87f4

refactor(lint): update eslint and oxlint configurations

7f9cab4

- Add src/preload to eslint ignore patterns - Update oxlint env to es2022 and add environment overrides - Adjust several lint rule severities and configurations

fix: lint error

c6935a9

fix(file): replace eslint-disable with oxlint-disable in sanitizeFile…

3a92040

…name The linter was changed from ESLint to oxlint, so the directive needs to be updated accordingly.

fix: enforce stricter linting by failing on warnings in test:lint script

cb81241

EurFelux requested a review from 0xfullex as a code owner September 14, 2025 18:55

EurFelux added 5 commits September 15, 2025 03:06

feat: add recommended ts-eslint rules into exlint

ef58b90

docs: remove outdated comment in oxlint config file

fb89f2c

style: disable typescript/no-require-imports rule in oxlint config

bb8f802

docs(utils): fix comment typo from NODE to NOTE

89a1236

fix(MessageErrorBoundary): correct error description display condition

0561a3a

The error description was incorrectly showing in production and hiding in development. Fix the logic to show detailed errors only in development mode

EurFelux requested review from GeorgeDong32 and beyondkmp September 14, 2025 19:14

chore: add oxc-vscode extension to recommended list

a4b0ad8

ci(workflows): reorder format check step in pr-ci.yml

b6a353a

chore: update yarn.lock

e821e04

DeJeune approved these changes Sep 15, 2025

View reviewed changes

GeorgeDong32 reviewed Sep 15, 2025

View reviewed changes

beyondkmp approved these changes Sep 15, 2025

View reviewed changes

Merge branch 'main' of github.com:CherryHQ/cherry-studio into chore/o…

c116c16

…xlint

0xfullex approved these changes Sep 15, 2025

View reviewed changes

EurFelux merged commit 4d1d3e3 into main Sep 15, 2025
6 checks passed

EurFelux deleted the chore/oxlint branch September 15, 2025 16:12

camc314 reviewed Sep 16, 2025

View reviewed changes

		// We don't use the React plugin here because its behavior differs slightly from that of ESLint's React plugin.
		"plugins": ["unicorn", "typescript", "oxc", "import"],

Comments

Conversation

EurFelux commented Sep 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does

Why we need it and why it was done in this way

Breaking changes

Special notes for your reviewer

Checklist

Release note

Uh oh!

EurFelux commented Sep 14, 2025

Uh oh!

claude bot commented Sep 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review: Add oxlint to speed up linting

Summary

✅ Strengths

🔍 Observations

⚠️ Minor Issues

📝 Suggestions

Verdict

Uh oh!

beyondkmp commented Sep 15, 2025 • edited by kangfenmao Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

EurFelux commented Sep 15, 2025 • edited by kangfenmao Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

beyondkmp commented Sep 15, 2025 • edited by kangfenmao Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

EurFelux commented Sep 15, 2025 • edited by kangfenmao Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

beyondkmp commented Sep 15, 2025 • edited by kangfenmao Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

beyondkmp commented Sep 15, 2025 • edited by kangfenmao Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alephpiece commented Sep 15, 2025 • edited by kangfenmao Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

EurFelux commented Sep 15, 2025 • edited by kangfenmao Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

EurFelux commented Sep 15, 2025

Uh oh!

EurFelux commented Sep 15, 2025

Uh oh!

GeorgeDong32 left a comment

Choose a reason for hiding this comment

Uh oh!

EurFelux commented Sep 15, 2025

Uh oh!

Uh oh!

camc314 Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

EurFelux Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

camc314 Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

EurFelux commented Sep 14, 2025 •

edited

Loading

claude bot commented Sep 14, 2025 •

edited

Loading

beyondkmp commented Sep 15, 2025 •

edited by kangfenmao

Loading

EurFelux commented Sep 15, 2025 •

edited by kangfenmao

Loading

beyondkmp commented Sep 15, 2025 •

edited by kangfenmao

Loading

EurFelux commented Sep 15, 2025 •

edited by kangfenmao

Loading

beyondkmp commented Sep 15, 2025 •

edited by kangfenmao

Loading

beyondkmp commented Sep 15, 2025 •

edited by kangfenmao

Loading

alephpiece commented Sep 15, 2025 •

edited by kangfenmao

Loading

EurFelux commented Sep 15, 2025 •

edited by kangfenmao

Loading