Create rule S7197: Circular file imports should be resolved

[github-actions]

You can preview this rule here (updated a few minutes after each push).

Review

A dedicated reviewer checked the rule description successfully for:

• logical errors and incorrect information
• information gaps and missing content
• text style and tone
• PR summary and labels follow the guidelines

[sonarqube-next]

Quality Gate passed for 'rspec-tools'

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

[sonarqube-next]

Quality Gate passed for 'rspec-frontend'

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

[zglicz]

@gabriel-vivas-sonarsource - rspec PR if you would like to review

[gabriel-vivas-sonarsource]

I think we're good. Added a few suggestions, feel free to use what makes sense to you.

[gabriel-vivas-sonarsource]

Perhaps we can mention that the rule detects both direct cycles and indirect cycles, as these can be less intuitive but more prevalent. The example we provide is an indirect one.

Perhaps something like:

- This rule reports circular dependencies between source files caused by circular imports.
+ This rule detects circular dependencies between files, including indirect cycles spanning multiple files.

[gabriel-vivas-sonarsource]

I feel the example is confusing and incomplete, this is also the case in Java IMO.

What do you think about something like this below (no clue if the ASCII diagram would work though).

Non-compliant:

// ┌──────┐        ┌──────┐
// │  A   │ ─────▶ │  B   │
// └──────┘        └──────┘
//     ▲               │
//     └───────────────┘

// main.js
import { A } from "./A.js";
A();

// A.js
import { B } from "./B.js";
export function A() {
    console.log("A calls B");
    B();
}

// B.js
import { A } from "./A.js";
export function B() {
    console.log("B calls A");
    A();
}

Compliant:

// ┌──────┐     ┌────────┐     ┌──────┐
// │  A   │ ──▶ │ Shared │ ◀── │  B   │
// └──────┘     └────────┘     └──────┘

// main.js
import { A } from "./A.js";
A();

// A.js
import { callB } from "./shared.js";
export function A() {
    console.log("A calls B");
    callB();
}

// B.js
import { callA } from "./shared.js";
export function B() {
    console.log("B calls A");
    callA();
}

// shared.js
import { A } from "./A.js";
import { B } from "./B.js";
export function callA() { A(); }
export function callB() { B(); }