import/no-cycle Restriction
它的作用
确保不存在通过其依赖关系回到此模块的可解析路径。
这包括深度为 1 的循环(被导入的模块又导入我)直到某个实际上 无限大的值,如果未设置 maxDepth 选项。
为什么这不好?
依赖循环会导致令人困惑的架构,使错误变得难以发现。 常见的情况是导入一个由循环依赖导致的 undefined 值。
示例
以下是此规则的错误代码示例:
javascript
// dep-b.js
import "./dep-a.js";
export function b() {
/* ... */
}javascript
// dep-a.js
import { b } from "./dep-b.js"; // reported: 检测到依赖循环。
export function a() {
/* ... */
}在这个示例中,dep-a.js 和 dep-b.js 相互导入,形成了一个循环 依赖,这会带来问题。
以下是此规则的正确代码示例:
javascript
// dep-b.js
export function b() {
/* ... */
}javascript
// dep-a.js
import { b } from "./dep-b.js"; // no circular dependency
export function a() {
/* ... */
}在这个修正后的版本中,dep-b.js 不再导入 dep-a.js,从而打破了循环。
配置
此规则接受一个包含以下属性的配置对象:
allowUnsafeDynamicCyclicDependency
type: boolean
default: false
如果链中至少有一个动态导入,则允许循环依赖
ignoreExternal
type: boolean
default: false
忽略外部模块
ignoreTypes
type: boolean
default: true
忽略仅类型导入
maxDepth
type: integer
default: 4294967295
要遍历的最大依赖深度
如何使用
To enable this rule using the config file or in the CLI, you can use:
json
{
"plugins": ["import"],
"rules": {
"import/no-cycle": "error"
}
}ts
import { defineConfig } from "oxlint";
export default defineConfig({
plugins: ["import"],
rules: {
"import/no-cycle": "error",
},
});bash
oxlint --deny import/no-cycle --import-plugin版本
此规则在 v0.0.13 中添加。
