Add a sanity check for rules that should be mapped

[yassin-kammoun-sonarsource]

No description provided.

[sonarqube-next]

Quality Gate passed

Kudos, no new issues are introduced in this PR!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarQube

[ilia-kebets-sonarsource]

why wouldn't this be enough?

Suggested change

	const { rule } = require(path.join(ruleFolder, sonarKey));
	if (!mappedRules.some(mapped => mapped === rule)) {
	missing.push(sonarKey);
	}
	if (!mappedRules[sonarKey]) {
	missing.push(sonarKey);
	}

[ilia-kebets-sonarsource]

The check we want to implement is that we don't forget to add the rule redefinition/decoration/whatever, so it's the case where we:

1. write it, and its units tests in packages/src/ rules/Sxxxx/
2. forget to load it in packages/src/rules/index.ts

No?

[yassin-kammoun-sonarsource]

As I was saying in my comment, we are not able to do what you are suggesting because the keys in the mapping aren't Sonar keys:

SonarJS/packages/jsts/src/rules/index.ts

Lines 300 to 302 in 0b48c18

	rules['accessor-pairs'] = S2376;
	rules['anchor-has-content'] = S6827;
	rules['anchor-precedence'] = S5850;

We don't have rules['S2376'] = S2376; but rules['accessor-pairs'] = S2376; instead. This is why we need to check the other way around.

[ilia-kebets-sonarsource]

thanks for the explanation

[yassin-kammoun-sonarsource]

You're welcome :)

[ilia-kebets-sonarsource]

Isn't it O(n)?

• gather sonarKeys: n
• gather mappedRules: n
• find missing: n

[yassin-kammoun-sonarsource]

The current implementation is O(n^2) since we iterate with the for-loop O(n) over all the rules available in the folder rules/SXXX, and for each of them, we look for a matching mapped definition with mappedRules.some(mapped => mapped === rule)) O(n).

[ilia-kebets-sonarsource]

indeed

[ilia-kebets-sonarsource]

I think you can simplify it as per my comments. I'm open to discuss it if you think we need a more thorough check, but I don't see what it brings, except checking that require works.

[ilia-kebets-sonarsource]

LGTM!