在我的Node.js项目中使用Oxlint

在我的Node.js项目中使用Oxlint

💡 原文英文,约500词,阅读约需2分钟。
📝

内容提要

在Node.js项目中添加了Oxlint作为快速代码检查工具,并与ESLint集成,更新了lint脚本和CI工作流。尽管Oxlint运行正常,但Prettier在提交时未能执行,导致CI失败,同时发现lint-staged设置不当。

🎯

关键要点

  • 在Node.js项目中添加了Oxlint作为快速代码检查工具。
  • Oxlint比ESLint快50到100倍,且不需要配置。
  • 通过安装eslint-plugin-oxlint将Oxlint与ESLint集成。
  • 更新了package.json中的lint脚本,使Oxlint在ESLint之前运行。
  • 使用lint-staged将Oxlint添加到预提交钩子中。
  • 在CI工作流中添加了Oxlint的运行步骤。
  • 为VSCode工作区推荐了Oxc扩展。
  • 在package.json中添加了缺失的Prettier脚本。
  • 更新了贡献文档,建议在提交前运行lint和format脚本。
  • 设置了VSCode编辑器以匹配Prettier的默认设置。
  • 测试后Oxlint运行正常,但CI因Prettier未运行而失败。
  • 发现lint-staged设置不当,导致Prettier和ESLint并发运行。
  • 删除了冗余的.prettierignore文件。

延伸问答

Oxlint在Node.js项目中的主要功能是什么?

Oxlint是一个快速的代码检查工具,旨在捕捉错误或无用的代码,且不需要任何配置。

如何将Oxlint与ESLint集成?

通过安装eslint-plugin-oxlint并在eslint.config.mjs中添加相应配置,可以将Oxlint与ESLint集成。

在CI工作流中如何添加Oxlint的运行步骤?

在CI工作流中,可以通过添加一条命令,如'npx -y oxlint@0.10.3 --deny-warnings',来运行Oxlint。

为什么CI作业会因Prettier未运行而失败?

CI作业失败是因为在提交时Prettier没有运行,导致代码格式未被正确处理。

如何在VSCode中推荐使用Oxlint?

可以在项目的.vscode/extensions.json文件中添加'Oxc'扩展到推荐列表中。

lint-staged的设置有什么问题?

发现lint-staged设置不当,导致Prettier和ESLint并发运行,从而引发竞争条件。

➡️

继续阅读