本教程将指导您如何使用 npm 包 eslint-plugin-jestx。该包为 Jest 的扩展提供了一些有用的规则,以确保您的 Jest 单元测试代码质量更高。
安装
首先,请确保您安装了 npm,然后在命令行中输入以下命令:
npm install eslint-plugin-jestx --save-dev
配置
在您的项目根目录中打开 .eslintrc 配置文件,在其中添加以下内容:
-- -------------------- ---- ------- - ---------- - ------- -- ---------- - ------------------------- -- -------- - ----------------------------- -------- -------------------------------- -------- --------------------- ------- - -
这里我们使用了 Jest 的插件规则插件,将其扩展应用到了我们的配置中。同时,我们添加了三个规则:
jestx/no-standalone-expect
:禁止在非测试文件中使用expect
。jestx/valid-expect-in-promise
:如果使用了 promise,则必须使用expect
。jestx/valid-expect
: expect 语句必须在测试用例中使用。
您还可以根据您的实际需求更改这些规则。
使用
现在,当您运行 eslint 命令来检查您的代码时,您将看到与 Jest 相关的错误和警告。例如:
describe('MyTest', () => { test('it works', () => { expect(true).toBeDefined(); // 完美通过 }) })
describe('MyTest', () => { expect(true).toBeDefined(); // 报 eslint 格式错误 // 当前行不在测试用例内 })
describe('MyTest', () => { Promise.resolve('test').then((value) => { expect(value).toBe('test'); // 完美通过 }); })
describe('MyTest', () => { Promise.resolve('test').then((value) => { // 报 eslint 格式错误 // Promise 中必须使用 expect }); })
总结
借助 eslint-plugin-jestx,您可以使用规则集来实现 Jest 单元测试代码的自动化质量管理。这迫使您更小心地编写您的测试代码,并确保您在代码的早期发现问题。感谢阅读本教程,我希望您已经掌握了这个工具的使用,并开始在您的项目中使用它了。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6006734d890c4f72775837b1