vitest/prefer-expect-resolves Style
它的作用
在测试 promise 时，优先使用 await expect(...).resolves，而不是 expect(await ...)。
为什么这不好？
在处理 promise 时，测试其解析值主要有两种方式：
- 在
expect上使用resolve修饰符 （await expect(...).resolves.<matcher>风格） - 对 promise 使用
await，并断言其结果 （expect(await ...).<matcher>风格）
虽然第二种风格在某种程度上对 jest 的依赖更少，但如果 promise 被拒绝，它会被视为一般错误，从而导致 jest 的行为和输出 更不可预测。
此外，优先使用第一种风格还能确保与其 rejects 对应风格保持一致，因为没有办法“await”一个拒绝。
示例
以下是此规则的错误代码示例：
javascript
it("passes", async () => {
expect(await someValue()).toBe(true);
});
it("is true", async () => {
const myPromise = Promise.resolve(true);
expect(await myPromise).toBe(true);
});以下是此规则的正确代码示例：
javascript
it("passes", async () => {
await expect(someValue()).resolves.toBe(true);
});
it("is true", async () => {
const myPromise = Promise.resolve(true);
await expect(myPromise).resolves.toBe(true);
});
it("errors", async () => {
await expect(Promise.reject(new Error("oh noes!"))).rejects.toThrowError("oh noes!");
});如何使用
To enable this rule using the config file or in the CLI, you can use:
json
{
"plugins": ["vitest"],
"rules": {
"vitest/prefer-expect-resolves": "error"
}
}ts
import { defineConfig } from "oxlint";
export default defineConfig({
plugins: ["vitest"],
rules: {
"vitest/prefer-expect-resolves": "error",
},
});bash
oxlint --deny vitest/prefer-expect-resolves --vitest-plugin版本
此规则在 v0.2.14 中添加。