Skip to content

docs(linter): Add configuration option docs for import/no-cycle rule. #15136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 30, 2025
Merged

docs(linter): Add configuration option docs for import/no-cycle rule. #15136

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions crates/oxc_linter/src/rules/import/no_cycle.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ use cow_utils::CowUtils;
use oxc_diagnostics::OxcDiagnostic;
use oxc_macros::declare_oxc_lint;
use oxc_span::{CompactStr, Span};
use schemars::JsonSchema;

use crate::{
ModuleRecord,
Expand All @@ -20,13 +21,14 @@ fn no_cycle_diagnostic(span: Span, paths: &str) -> OxcDiagnostic {
}

/// <https://github.com/import-js/eslint-plugin-import/blob/v2.29.1/docs/rules/no-cycle.md>
#[derive(Debug, Clone)]
#[derive(Debug, Clone, JsonSchema)]
#[serde(rename_all = "camelCase", default)]
pub struct NoCycle {
/// maximum dependency depth to traverse
/// Maximum dependency depth to traverse
max_depth: u32,
/// ignore type only imports
/// Ignore type-only imports
ignore_types: bool,
/// ignore external modules
/// Ignore external modules
ignore_external: bool,
/// Allow cyclic dependency if there is at least one dynamic import in the chain
allow_unsafe_dynamic_cyclic_dependency: bool,
Expand Down Expand Up @@ -87,7 +89,8 @@ declare_oxc_lint!(
/// In this corrected version, `dep-b.js` no longer imports `dep-a.js`, breaking the cycle.
NoCycle,
import,
restriction
restriction,
config = NoCycle,
);

impl Rule for NoCycle {
Expand Down
Loading