feat(eslint-plugin): [no-circular-imports] add new rule

[yeonjuan]

PR Checklist

• Addresses an existing open issue: fixes Rule proposal: detect and warn about circular imports #224
• That issue was marked as accepting prs
• Steps in Contributing were taken

Overview

In this pr, I implemented no-circular-import which checks circular-import using the information that TS has. see #224 (comment).

The current implementation lacks some handling compared to eslint-plugin-import/no-cycle. (dynamic-import, require..).

Before go any further, I have a question about the case with dynamic-import.

With this implementation way, it would be difficult to checks for modules that reference each other via dynamic import. Actually there is a way to traverse the ASTs in the TS to check for dynamic imports, but performance may be poor.

// foo.ts
const foo = () => import("./bar.ts");

// bar.ts
const bar = () => import("./foo.ts");

Should this be left as an edge case?

---

I've already left an inquiry on discord about this. I'd be interested to hear what other members think.

• https://discord.com/channels/1026804805894672454/1088474511759917106/1231620012306075798

I'm not sure if dynamic imports should be warned at all because (a) there are many ways they are not statically analyzable (b) one of their use cases is to avoid circular imports (by deferring them) - Josh-Cena

• https://discord.com/channels/1026804805894672454/1088474511759917106/1231507199348703313

[typescript-eslint]

Thanks for the PR, @yeonjuan!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

---

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

[netlify]

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	82f36a9
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/662be03a2275f900088944af
😎 Deploy Preview	https://deploy-preview-8965--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 97 (🟢 up 4 from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 98 (no change from production) PWA: 80 (no change from production) View the detailed breakdown and full score reports

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 82f36a9. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 31 targets

• nx test eslint-plugin --coverage=false
• nx test eslint-plugin
• nx test utils
• nx run types:build
• nx run repo-tools:postinstall-script
• nx test type-utils --coverage=false
• nx test typescript-eslint --coverage=false
• nx test visitor-keys --coverage=false
• nx test typescript-estree --coverage=false
• nx test utils --coverage=false
• nx test rule-schema-to-typescript-types --coverage=false
• nx test scope-manager --coverage=false
• nx test repo-tools --coverage=false
• nx test parser --coverage=false
• nx test eslint-plugin-internal --coverage=false
• nx run-many --target=lint --parallel --exclude eslint-plugin
• nx test typescript-eslint
• nx test visitor-keys
• nx test parser
• nx test type-utils
• nx test scope-manager
• nx test eslint-plugin-internal
• nx test typescript-estree
• nx test rule-schema-to-typescript-types
• nx test repo-tools
• nx test ast-spec --coverage=false
• nx run-many --target=build --parallel --exclude=website --exclude=website-eslint
• nx test ast-spec
• nx run-many --target=typecheck --parallel
• nx run integration-tests:test
• nx run repo-tools:generate-configs

---

Sent with 💌 from NxCloud.