Skip to content
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

Jump to bottom

feat: add doc for disabling SONAR rule preventing TODO comments #1460

Closed
wants to merge 1 commit into from
Closed

feat: add doc for disabling SONAR rule preventing TODO comments #1460

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
11 changes: 11 additions & 0 deletions content/en/contribute/code/static-analysis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,9 @@ Java:
- `threshold` 7 -> 4
- [`S3776`](https://rules.sonarsource.com/javascript/RSPEC-3776/) - Cognitive Complexity of functions should not be too high
- `threshold` 15 -> 5
- Disabled
- [`S1135`](https://rules.sonarsource.com/javascript/RSPEC-1135/) - Track uses of "TODO" tags
- Disabled because we typically use "TODO" tags to mark code as needing future updates which cannot be currently applied for reasons outside our direct control (e.g. requiring a dependency uplift).

JavaScript:

Expand All @@ -186,6 +189,8 @@ JavaScript:
- [`S3776`](https://rules.sonarsource.com/javascript/RSPEC-3776/) - Cognitive Complexity of functions should not be too high
- `threshold` 15 -> 5
- Disabled
- [`S1135`](https://rules.sonarsource.com/javascript/RSPEC-1135/) - Track uses of "TODO" tags
- Disabled because we typically use "TODO" tags to mark code as needing future updates which cannot be currently applied for reasons outside our direct control (e.g. requiring a dependency uplift).
- [`S2699`](https://rules.sonarsource.com/javascript/RSPEC-2699/) - Tests should include assertions
- Disabled due of rigidity of the rule when detecting `expect` imports and calls to imported functions that have assertions

Expand All @@ -197,6 +202,9 @@ Python:
- `threshold` 7 -> 4
- [`S3776`](https://rules.sonarsource.com/javascript/RSPEC-3776/) - Cognitive Complexity of functions should not be too high
- `threshold` 15 -> 5
- Disabled
- [`S1135`](https://rules.sonarsource.com/javascript/RSPEC-1135/) - Track uses of "TODO" tags
- Disabled because we typically use "TODO" tags to mark code as needing future updates which cannot be currently applied for reasons outside our direct control (e.g. requiring a dependency uplift).

TypeScript:

Expand All @@ -206,3 +214,6 @@ TypeScript:
- `threshold` 7 -> 4
- [`S3776`](https://rules.sonarsource.com/javascript/RSPEC-3776/) - Cognitive Complexity of functions should not be too high
- `threshold` 15 -> 5
- Disabled
- [`S1135`](https://rules.sonarsource.com/javascript/RSPEC-1135/) - Track uses of "TODO" tags
- Disabled because we typically use "TODO" tags to mark code as needing future updates which cannot be currently applied for reasons outside our direct control (e.g. requiring a dependency uplift).
Loading