update coverage information (#4859)

Co-authored-by: SonarTech <sonartech@sonarsource.com>

.github/workflows/PullRequestClosed.yml

@@ -14,7 +14,6 @@ jobs:
     # For external PR, ticket should be moved manually
     if: |
         github.event.pull_request.head.repo.full_name == github.repository
-        && github.event.pull_request.merged
     steps:
       - id: secrets
         uses: SonarSource/vault-action-wrapper@v3

.github/workflows/main.yml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   build-and-deploy:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     permissions:
       pull-requests: read # Get the list and metadata of open new-rule PRs
       contents: write # Get the contents of open new-rule PRs, the 'master'; write to 'gh-pages' branch

.github/workflows/update_coverage.yml

@@ -10,7 +10,6 @@ jobs:
     permissions:
       id-token: write # required by SonarSource/vault-action-wrapper
       contents: write
-      checks: read # required by fountainhead/action-wait-for-check
       actions: write # required by andymckay/cancel-action
     env:
       TMP_BRANCH: temporary/coverage_update
@@ -30,6 +29,7 @@ jobs:
         fetch-depth: 0
         path: 'rspec'
         token: ${{ fromJSON(steps.secrets.outputs.vault).coverage_github_token }}
+        ref: 'master'
 
     - uses: actions/setup-python@v4
       with:
@@ -73,40 +73,62 @@ jobs:
         git commit -m "update coverage information"
         git push --force-with-lease origin $TMP_BRANCH
 
-    - name: 'Wait for CI to succeed'
-      if: steps.gen-coverage.outputs.new_coverage == 'true'
-      uses: fountainhead/action-wait-for-check@v1.0.0
-      id: wait-for-build
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-        checkName: all_required_checks
-        ref: ${{ env.TMP_BRANCH }}
-        timeoutSeconds: 2400
-        intervalSeconds: 30
+    - name: 'Create a PR'
+      id: create-github-pr
+      working-directory: 'rspec'
+      env:
+        GH_TOKEN: ${{ fromJSON(steps.secrets.outputs.vault).coverage_github_token }}
+      run: |
+        PR_URL=$(gh pr create --head ${{ env.TMP_BRANCH }} --title "Update coverage information" --body "" --label "rspec system")
+        gh pr merge $PR_URL
 
-    - name: 'Push the updated coverage to master'
-      if: |
-        steps.gen-coverage.outputs.new_coverage == 'true' &&
-        steps.wait-for-build.outputs.conclusion == 'success' &&
-        (github.event_name != 'workflow_dispatch' || github.ref == format('refs/heads/{0}', github.event.repository.default_branch))
+    - name: 'Wait until the PR is merged'
+      id: wait-for-pr-to-merge
+      env:
+        GH_TOKEN: ${{ fromJSON(steps.secrets.outputs.vault).coverage_github_token }}
       working-directory: 'rspec'
       run: |
-        git checkout master
-        git merge $TMP_BRANCH
-        git push origin master
+        set -ueo pipefail
 
-    - name: 'Delete the temporary branch'
-      if: always() && steps.create-temp-branch.conclusion == 'success'
-      uses: dawidd6/action-delete-branch@v3
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        branches: ${{ env.TMP_BRANCH}}
+        # Implicitly referring to the PR corresponding to current branch
 
-    - name: 'Fail if the change breaks CI'
-      if: |
-        steps.gen-coverage.outputs.new_coverage == 'true' &&
-        steps.wait-for-build.outputs.conclusion != 'success'
-      run: exit 1
+        # Set timeout (20 minutes in seconds)
+        TIMEOUT=1200 # seconds
+        START_TIME=$(date +%s)
+        INTERVAL=20 # seconds
+
+        while true; do
+          # Check if the PR is merged
+          PR_STATE=$(gh pr view --json state,mergedAt -q '.state')
+          MERGED_AT=$(gh pr view --json state,mergedAt -q '.mergedAt')
+
+          if [[ "${PR_STATE}" == "MERGED" ]]; then
+            echo "PR merged at: $MERGED_AT"
+            exit 0
+          fi
+          echo "PR state is ${PR_STATE}"
+
+          # Check for timeout
+          CURRENT_TIME=$(date +%s)
+          ELAPSED_TIME=$((CURRENT_TIME - START_TIME))
+
+          if [[ "${ELAPSED_TIME}" -gt "${TIMEOUT}" ]]; then
+            echo "Timeout waiting for PR to merge."
+            exit 1
+          fi
+
+          # Wait for $INTERVAL seconds before checking again
+          sleep "$INTERVAL"
+        done
+
+    - name: 'Close PR and delete branch upon failure to merge'
+      if: ${{ failure() }}
+      env:
+        GH_TOKEN: ${{ fromJSON(steps.secrets.outputs.vault).coverage_github_token }}
+      working-directory: 'rspec'
+      run: |
+        PR_URL=$(gh pr view --json url --jq '.url')
+        gh pr close "$PR_URL" --delete-branch
 
     - name: 'Notify on slack about the failure'
       if: ${{ failure() }}

.github/workflows/update_quickfix_status.yml

@@ -25,7 +25,7 @@ on:
 jobs:
   update_quickfix_status:
     name: Update quick fix status
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     permissions:
       contents: write
       pull-requests: write

docs/header_names/allowed_framework_names.adoc

@@ -27,6 +27,7 @@
 * libxml2
 // Java
 * Android
+* Android WebView
 * Apache Commons
 * Apache Commons
 * Apache Commons Email
@@ -42,12 +43,13 @@
 * Java EE
 * Java JWT
 * Java SE
+* Java JDBC API
+* Java I/O API
 * Jdom2
 * JSP
 * Legacy Mongo Java API
 * OkHttp
 * Realm
-* Java Cryptography Extension
 * Apache HttpClient
 * Couchbase
 * SAX
@@ -96,6 +98,7 @@
 * Argon2-cffi
 * Bcrypt
 * Cryptodome
+* databases
 * Django
 * Django Templates
 * FastAPI
@@ -158,3 +161,5 @@
 * Go Standard Library
 // Kubernetes
 * Helm
+// Kotlin
+Jetpack Compose

docs/link_formatting.adoc

@@ -45,6 +45,7 @@ When web pages have massively long names like "Java™ Platform, Standard Editio
 * AWS blog - https://aws.amazon.com/blogs
 * Azure Documentation - https://learn.microsoft.com/en-us/azure/?product=popular
 * CERT - https://wiki.sei.cmu.edu/confluence/display/seccode
+* Clippy Lints - https://rust-lang.github.io/rust-clippy/master/index.html
 * {cpp} reference - https://en.cppreference.com/w/
 * {cpp} Core Guidelines - https://github.com/isocpp/CppCoreGuidelines/blob/e49158a/CppCoreGuidelines.md
 * CVE - https://cve.mitre.org

frontend/src/RulePage.tsx

@@ -158,7 +158,7 @@ const languageToJiraProject = new Map(Object.entries({
   'HTML': 'SONARHTML',
   'PHP': 'SONARPHP',
   'PLI': 'SONARPLI',
-  'PLSQL': 'SONARPLSQL',
+  'PLSQL': 'PLSQL',
   'RPG': 'SONARRPG',
   'APEX': 'SONARAPEX',
   'RUBY': 'SONARRUBY',
@@ -168,8 +168,8 @@ const languageToJiraProject = new Map(Object.entries({
   'GO': 'SONARGO',
   'SECRETS': 'SONARTEXT',
   'SWIFT': 'SONARSWIFT',
-  'TSQL': 'SONARTSQL',
-  'VB6': 'SONARVBSIX',
+  'TSQL': 'TSQL',
+  'VB6': 'VB6',
   'XML': 'SONARXML',
   'CLOUDFORMATION': 'SONARIAC',
   'TERRAFORM': 'SONARIAC',
@@ -320,7 +320,7 @@ function usePageMetadata(ruleid: string, language: string, classes: UsedStyles):
 
   if (coverage !== 'Not Covered') {
     prUrl = undefined;
-    branch = 'master'; 
+    branch = 'master';
   }
 
   return {

rules/S100/javascript/metadata.json

@@ -1,5 +1,9 @@
 {
   "title": "Function and method names should comply with a naming convention",
   "defaultQualityProfiles": [],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S101/javascript/metadata.json

@@ -2,5 +2,9 @@
   "defaultQualityProfiles": [
     "Sonar way"
   ],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S103/javascript/metadata.json

@@ -2,5 +2,9 @@
   "scope": "Main",
   "defaultQualityProfiles": [],
   "status": "deprecated",
-  "tags": []
-}
+  "tags": [],
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S104/javascript/metadata.json

@@ -1,3 +1,7 @@
 {
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S105/javascript/metadata.json

@@ -2,5 +2,9 @@
   "scope": "Main",
   "defaultQualityProfiles": [],
   "status": "deprecated",
-  "tags": []
-}
+  "tags": [],
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S106/javascript/metadata.json

@@ -3,7 +3,9 @@
     "bad-practice",
     "user-experience"
   ],
-  "defaultQualityProfiles": [
-    
+  "defaultQualityProfiles": [],
+  "compatibleLanguages": [
+    "js",
+    "ts"
   ]
-}
+}

rules/S106/rust/metadata.json

@@ -0,0 +1,7 @@
+{
+  "defaultQualityProfiles": [],
+  "tags": [
+    "bad-practice",
+    "clippy"
+  ]
+}

rules/S106/rust/rule.adoc

@@ -0,0 +1,39 @@
+:language_std_outputs: print!, println!
+
+== Why is this an issue?
+
+include::../description.adoc[]
+
+=== Code examples
+
+==== Noncompliant code example
+
+[source,rust,diff-id=1,diff-type=noncompliant]
+----
+fn do_something() {
+    println!("my message");  // Noncompliant, output directly to stdout without a logger
+}
+----
+
+==== Compliant solution
+
+[source,rust,diff-id=1,diff-type=compliant]
+----
+use log::{info, LevelFilter};
+use simple_logger::SimpleLogger;
+
+fn do_something() {
+    SimpleLogger::new().with_level(LevelFilter::Info).init().unwrap();
+    // ...
+    info!("my message");  // Compliant, output via logger
+    // ...
+}
+----
+
+== Resources
+
+=== Documentation
+
+* Clippy Lints - https://rust-lang.github.io/rust-clippy/master/index.html#print_stdout
+* OWASP - https://owasp.org/Top10/A09_2021-Security_Logging_and_Monitoring_Failures/[Top 10 2021 Category A9 - Security Logging and Monitoring Failures]
+* OWASP - https://owasp.org/www-project-top-ten/2017/A3_2017-Sensitive_Data_Exposure[Top 10 2017 Category A3 - Sensitive Data Exposure]

rules/S1066/javascript/metadata.json

@@ -1,4 +1,8 @@
 {
   "defaultQualityProfiles": [],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1067/javascript/metadata.json

@@ -1,3 +1,7 @@
 {
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1068/javascript/metadata.json

@@ -1,4 +1,8 @@
 {
-    "title": "Unused private class members should be removed",
-    "quickfix": "covered"
+  "title": "Unused private class members should be removed",
+  "quickfix": "covered",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
 }

rules/S107/javascript/metadata.json

@@ -2,5 +2,9 @@
   "defaultQualityProfiles": [
     "Sonar way"
   ],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S107/rust/metadata.json

@@ -0,0 +1,6 @@
+{
+  "tags": [
+    "brain-overload",
+    "clippy"
+  ]
+}

rules/S107/rust/noncompliant.adoc

@@ -0,0 +1,6 @@
+[source,rust]
+----
+fn set_coordinates(x1: i32, y1: i32, z1: i32, x2: i32, y2: i32, z2: i32) { // Noncompliant
+    // ...
+}
+----

rules/S107/rust/rule.adoc

@@ -0,0 +1,27 @@
+:language: rust
+
+include::../rule.adoc[]
+
+== Resources
+
+=== Documentation
+
+* Clippy Lints - https://rust-lang.github.io/rust-clippy/master/index.html#too_many_arguments
+
+ifdef::env-github,rspecator-view[]
+
+'''
+== Implementation Specification
+(visible only on this page)
+
+include::../message.adoc[]
+
+include::../parameters.adoc[]
+
+'''
+== Comments And Links
+(visible only on this page)
+
+include::../comments-and-links.adoc[]
+
+endif::env-github,rspecator-view[]

rules/S107/rust/split-example.adoc

@@ -0,0 +1,11 @@
+[source,rust]
+----
+// Each function does a part of what the original setCoordinates function was doing, so confusion risks are lower
+fn set_origin(x: i32, y: i32, z: i32) {
+    // ...
+}
+
+fn set_size(width: i32, height: i32, depth: i32) {
+    // ...
+}
+----

rules/S107/rust/struct-example.adoc

@@ -0,0 +1,17 @@
+[source,rust]
+----
+struct Point {
+    x: i32,
+    y: i32,
+}
+
+impl Point {
+    fn new(x: i32, y: i32) -> Point {
+        Point { x, y }
+    }
+}
+
+fn set_coordinates(p1: &mut Point, p2: &Point) {
+    // ...
+}
+----

rules/S1077/javascript/metadata.json

@@ -3,5 +3,9 @@
     "accessibility",
     "wcag2-a",
     "react"
+  ],
+  "compatibleLanguages": [
+    "js",
+    "ts"
   ]
-}
+}

rules/S108/javascript/metadata.json

@@ -1,4 +1,8 @@
 {
   "scope": "Main",
-  "quickfix": "covered"
-}
+  "quickfix": "covered",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1082/javascript/metadata.json

@@ -1,25 +1,31 @@
 {
-    "title": "Mouse events should have corresponding keyboard events",
-    "type": "BUG",
-    "status": "ready",
-    "remediation": {
-        "func": "Constant\/Issue",
-        "constantCost": "5min"
+  "title": "Mouse events should have corresponding keyboard events",
+  "type": "BUG",
+  "status": "ready",
+  "remediation": {
+    "func": "Constant/Issue",
+    "constantCost": "5min"
+  },
+  "tags": [
+    "accessibility",
+    "react"
+  ],
+  "defaultSeverity": "Minor",
+  "ruleSpecification": "RSPEC-1082",
+  "sqKey": "S1082",
+  "scope": "Main",
+  "defaultQualityProfiles": [
+    "Sonar way"
+  ],
+  "quickfix": "unknown",
+  "code": {
+    "impacts": {
+      "RELIABILITY": "LOW"
     },
-    "tags": [
-        "accessibility",
-        "react"
-    ],
-    "defaultSeverity": "Minor",
-    "ruleSpecification": "RSPEC-1082",
-    "sqKey": "S1082",
-    "scope": "Main",
-    "defaultQualityProfiles": ["Sonar way"],
-    "quickfix": "unknown",
-    "code": {
-        "impacts": {
-        "RELIABILITY": "LOW"
-        },
-        "attribute": "COMPLETE"
-    }
-}
+    "attribute": "COMPLETE"
+  },
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S109/javascript/metadata.json

@@ -1,3 +1,6 @@
 {
-  
-}
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1090/javascript/metadata.json

@@ -3,7 +3,7 @@
   "type": "CODE_SMELL",
   "status": "ready",
   "remediation": {
-    "func": "Constant\/Issue",
+    "func": "Constant/Issue",
     "constantCost": "5min"
   },
   "tags": [
@@ -14,12 +14,18 @@
   "ruleSpecification": "RSPEC-1090",
   "sqKey": "S1090",
   "scope": "All",
-  "defaultQualityProfiles": ["Sonar way"],
+  "defaultQualityProfiles": [
+    "Sonar way"
+  ],
   "quickfix": "infeasible",
   "code": {
     "impacts": {
       "RELIABILITY": "LOW"
     },
     "attribute": "CONVENTIONAL"
-  }
-}
+  },
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1105/javascript/metadata.json

@@ -2,5 +2,9 @@
   "scope": "Main",
   "defaultQualityProfiles": [],
   "status": "deprecated",
-  "tags": []
-}
+  "tags": [],
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1110/javascript/metadata.json

@@ -3,5 +3,9 @@
   "quickfix": "covered",
   "defaultQualityProfiles": [],
   "status": "deprecated",
-  "tags": []
-}
+  "tags": [],
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1116/javascript/metadata.json

@@ -4,5 +4,9 @@
   "quickfix": "covered",
   "defaultQualityProfiles": [],
   "status": "deprecated",
-  "tags": []
-}
+  "tags": [],
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1116/rust/metadata.json

@@ -0,0 +1,6 @@
+{
+  "tags": [
+    "unused",
+    "clippy"
+  ]
+}

rules/S1116/rust/rule.adoc

@@ -0,0 +1,49 @@
+== Why is this an issue?
+
+include::../description.adoc[]
+
+=== Code examples
+
+==== Noncompliant code example
+
+[source,rust,diff-id=1,diff-type=noncompliant]
+----
+fn main() {
+    let x = 5;
+
+    if x > 0 {
+        println!("x is positive");
+    }; // Noncompliant
+
+    match x {
+        1 => println!("x is one"),
+        2 => println!("x is two"),
+        _ => println!("x is something else"),
+    }; // Noncompliant
+}
+----
+
+==== Compliant solution
+
+[source,rust,diff-id=1,diff-type=compliant]
+----
+fn main() {
+    let x = 5;
+
+    if x > 0 {
+        println!("x is positive");
+    }
+
+    match x {
+        1 => println!("x is one"),
+        2 => println!("x is two"),
+        _ => println!("x is something else"),
+    }
+}
+----
+
+== Resources
+
+=== Documentation
+
+* Clippy Lints - https://rust-lang.github.io/rust-clippy/master/index.html#unnecessary_semicolon

rules/S1117/javascript/metadata.json

@@ -1,6 +1,9 @@
 {
   "title": "Variables should not be shadowed",
-  "defaultQualityProfiles": [
-  ],
-  "scope": "Main"
-}
+  "defaultQualityProfiles": [],
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1119/javascript/metadata.json

@@ -2,5 +2,9 @@
   "defaultQualityProfiles": [
     "Sonar way"
   ],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1121/javascript/metadata.json

@@ -2,5 +2,9 @@
   "defaultQualityProfiles": [
     "Sonar way"
   ],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1125/javascript/metadata.json

@@ -3,5 +3,9 @@
   "defaultQualityProfiles": [
     "Sonar way"
   ],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1126/javascript/metadata.json

@@ -3,5 +3,8 @@
     "Sonar way"
   ],
   "scope": "Main",
-  "quickfix": "covered"
-}
+  "quickfix": "covered",
+  "compatibleLanguages": [
+    "js"
+  ]
+}

rules/S1128/javascript/metadata.json

@@ -8,5 +8,9 @@
     "Sonar way"
   ],
   "scope": "Main",
-  "quickfix": "covered"
-}
+  "quickfix": "covered",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S113/javascript/metadata.json

@@ -3,5 +3,9 @@
   "quickfix": "covered",
   "defaultQualityProfiles": [],
   "status": "deprecated",
-  "tags": []
-}
+  "tags": [],
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1131/javascript/metadata.json

@@ -1,6 +1,10 @@
 {
-    "quickfix": "covered",
-    "defaultQualityProfiles": [],
-    "status": "deprecated",
-    "tags": []
-}
+  "quickfix": "covered",
+  "defaultQualityProfiles": [],
+  "status": "deprecated",
+  "tags": [],
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1134/javascript/metadata.json

@@ -2,5 +2,9 @@
   "defaultQualityProfiles": [
     "Sonar way"
   ],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1135/javascript/metadata.json

@@ -2,5 +2,9 @@
   "defaultQualityProfiles": [
     "Sonar way"
   ],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1143/javascript/metadata.json

@@ -2,5 +2,9 @@
   "defaultQualityProfiles": [
     "Sonar way"
   ],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1154/javascript/metadata.json

@@ -3,7 +3,7 @@
   "type": "BUG",
   "status": "deprecated",
   "remediation": {
-    "func": "Constant\/Issue",
+    "func": "Constant/Issue",
     "constantCost": "20min"
   },
   "tags": [
@@ -14,9 +14,7 @@
     "replacementRules": [
       "RSPEC-2201"
     ],
-    "legacyKeys": [
-
-    ]
+    "legacyKeys": []
   },
   "defaultSeverity": "Major",
   "ruleSpecification": "RSPEC-1154",
@@ -27,8 +25,10 @@
       "EXP00-J."
     ]
   },
-  "defaultQualityProfiles": [
-
-  ],
-  "quickfix": "unknown"
-}
+  "defaultQualityProfiles": [],
+  "quickfix": "unknown",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1161/dart/rule.adoc

@@ -47,8 +47,6 @@ ifdef::env-github,rspecator-view[]
 
 The member '<method name>' overrides an inherited member but isn't annotated with '@override'.
 
-If the member is a setter, the method name will end with a `=` sign, to distinguish it from the corresponding getter.
-
 === Highlighting
 
 The identifier of the method, property or operator.

rules/S117/javascript/metadata.json

@@ -1,5 +1,9 @@
 {
   "title": "Variable, property and parameter names should comply with a naming convention",
   "defaultQualityProfiles": [],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1172/cfamily/rule.adoc

@@ -6,6 +6,8 @@ include::../description.adoc[]
 
 There are some cases when you want to have an unused parameter (usually because the function has to conform to a fixed prototype, or because it is virtual, or it will be called from a template). In this case, and if the parameter is never used, an accepted practice is to leave it unnamed. If it is only sometimes used (for instance, depending on conditional compilation), you may, since {cpp}17, use the ``\[[maybe_unused]]`` attribute to be explicit about it.
 
+In case of C, since C23 you can also leave the parameter unnamed if it is never used, or use the `\[[maybe_unused]]` attribute if it is only used sometimes.
+
 [source,cpp]
 ----
 void f([[maybe_unused]] int i) {

rules/S1172/javascript/metadata.json

@@ -1,6 +1,9 @@
 {
-  "defaultQualityProfiles": [
-  ],
+  "defaultQualityProfiles": [],
   "scope": "Main",
-  "quickfix": "covered"
-}
+  "quickfix": "covered",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1186/javascript/metadata.json

@@ -4,5 +4,9 @@
     "Sonar way"
   ],
   "scope": "Main",
-  "quickfix": "covered"
-}
+  "quickfix": "covered",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1192/javascript/metadata.json

@@ -1,5 +1,7 @@
 {
-  "defaultQualityProfiles": [
-
+  "defaultQualityProfiles": [],
+  "compatibleLanguages": [
+    "js",
+    "ts"
   ]
-}
+}

rules/S1199/javascript/metadata.json

@@ -1,2 +1,6 @@
 {
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
 }

rules/S121/javascript/metadata.json

@@ -1,3 +1,7 @@
 {
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1219/javascript/metadata.json

@@ -2,5 +2,9 @@
   "defaultQualityProfiles": [
     "Sonar way"
   ],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S122/javascript/metadata.json

@@ -2,5 +2,9 @@
   "scope": "Main",
   "defaultQualityProfiles": [],
   "status": "deprecated",
-  "tags": []
-}
+  "tags": [],
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1226/javascript/metadata.json

@@ -1,4 +1,8 @@
 {
   "title": "Initial values of parameters, caught exceptions, and loop variables should not be ignored",
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S124/javascript/metadata.json

@@ -1,3 +1,6 @@
 {
-  
-}
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S125/javascript/metadata.json

@@ -3,5 +3,9 @@
     "Sonar way"
   ],
   "scope": "Main",
-  "quickfix": "covered"
-}
+  "quickfix": "covered",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S126/javascript/metadata.json

@@ -1,3 +1,7 @@
 {
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S126/rust/metadata.json

@@ -0,0 +1,7 @@
+{
+  "tags": [
+    "clippy"
+  ],
+  "defaultQualityProfiles": [
+  ]
+}

rules/S126/rust/rule.adoc

@@ -0,0 +1,33 @@
+== Why is this an issue?
+
+include::../description.adoc[]
+
+=== Noncompliant code example
+
+[source,rust,diff-id=1,diff-type=noncompliant]
+----
+if x == 0 {
+    do_something();
+} else if x == 1 {
+    do_something_else();
+}
+----
+
+=== Compliant solution
+
+[source,rust,diff-id=1,diff-type=compliant]
+----
+if x == 0 {
+    do_something();
+} else if x == 1 {
+    do_something_else();
+} else {
+    panic!("Unexpected value for x");
+}
+----
+
+== Resources
+
+=== Documentation
+
+* Clippy Lints - https://rust-lang.github.io/rust-clippy/master/index.html#else_if_without_else

rules/S1264/javascript/metadata.json

@@ -3,5 +3,9 @@
     "Sonar way"
   ],
   "scope": "Main",
-  "quickfix": "covered"
-}
+  "quickfix": "covered",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S128/javascript/metadata.json

@@ -2,5 +2,9 @@
   "defaultQualityProfiles": [
     "Sonar way"
   ],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1289/cobol/rule.adoc

@@ -30,6 +30,8 @@ MOVE "John" TO FIRST_NAME.
 
 ``++FILLER++`` top level data items and top level data items which have sub data items with a ``++VALUE++`` clause are not checked by this rule.
 
+``++EXTERNAL++`` data items are not checked by this rule.
+
 ifdef::env-github,rspecator-view[]
 
 '''

rules/S1291/javascript/metadata.json

@@ -1,2 +1,6 @@
 {
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
 }

rules/S1301/javascript/metadata.json

@@ -3,5 +3,9 @@
   "defaultQualityProfiles": [
     "Sonar way"
   ],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S131/javascript/metadata.json

@@ -5,5 +5,9 @@
   "tags": [
     "cwe",
     "type-dependent"
+  ],
+  "compatibleLanguages": [
+    "js",
+    "ts"
   ]
-}
+}

rules/S1313/javascript/metadata.json

@@ -1,5 +1,9 @@
 {
   "defaultQualityProfiles": [
     "Sonar way"
+  ],
+  "compatibleLanguages": [
+    "js",
+    "ts"
   ]
-}
+}

rules/S1314/javascript/metadata.json

@@ -2,5 +2,9 @@
   "defaultQualityProfiles": [
     "Sonar way"
   ],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1321/javascript/metadata.json

@@ -1,3 +1,5 @@
 {
-
-}
+  "compatibleLanguages": [
+    "js"
+  ]
+}

rules/S134/javascript/metadata.json

@@ -1,3 +1,7 @@
 {
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S135/javascript/metadata.json

@@ -1,4 +1,8 @@
 {
   "defaultQualityProfiles": [],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S138/javascript/metadata.json

@@ -1,5 +1,7 @@
 {
-  "defaultQualityProfiles": [
-
+  "defaultQualityProfiles": [],
+  "compatibleLanguages": [
+    "js",
+    "ts"
   ]
-}
+}

rules/S139/javascript/metadata.json

@@ -2,5 +2,9 @@
   "scope": "Main",
   "defaultQualityProfiles": [],
   "status": "deprecated",
-  "tags": []
-}
+  "tags": [],
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1438/javascript/metadata.json

@@ -1,6 +1,10 @@
 {
-    "quickfix": "covered",
-    "defaultQualityProfiles": [],
-    "status": "deprecated",
-    "tags": []
-}
+  "quickfix": "covered",
+  "defaultQualityProfiles": [],
+  "status": "deprecated",
+  "tags": [],
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1439/javascript/metadata.json

@@ -2,5 +2,9 @@
   "title": "Only \"while\", \"do\", \"for\" and \"switch\" statements should be labelled",
   "defaultQualityProfiles": [
     "Sonar way"
+  ],
+  "compatibleLanguages": [
+    "js",
+    "ts"
   ]
-}
+}

rules/S1440/javascript/metadata.json

@@ -1,5 +1,7 @@
 {
-  "defaultQualityProfiles": [
-
+  "defaultQualityProfiles": [],
+  "compatibleLanguages": [
+    "js",
+    "ts"
   ]
-}
+}

rules/S1441/javascript/metadata.json

@@ -2,13 +2,11 @@
   "title": "Quotes for string literals should be used consistently",
   "type": "CODE_SMELL",
   "remediation": {
-    "func": "Constant\/Issue",
+    "func": "Constant/Issue",
     "constantCost": "1min"
   },
   "extra": {
-    "replacementRules": [
-
-    ],
+    "replacementRules": [],
     "legacyKeys": [
       "SingleQuote"
     ]
@@ -26,5 +24,9 @@
       "MAINTAINABILITY": "MEDIUM"
     },
     "attribute": "FORMATTED"
-  }
-}
+  },
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1442/javascript/metadata.json

@@ -1,3 +1,5 @@
 {
-  
-}
+  "compatibleLanguages": [
+    "js"
+  ]
+}

rules/S1444/javascript/metadata.json

@@ -1,4 +1,7 @@
 {
-    "title": "Public \"static\" fields should be read-only",
-    "quickfix": "covered"
-}
+  "title": "Public \"static\" fields should be read-only",
+  "quickfix": "covered",
+  "compatibleLanguages": [
+    "ts"
+  ]
+}

rules/S1451/javascript/metadata.json

@@ -1,3 +1,7 @@
 {
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1472/javascript/metadata.json

@@ -1,3 +1,6 @@
 {
-  
-}
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1479/javascript/metadata.json

@@ -2,5 +2,9 @@
   "defaultQualityProfiles": [
     "Sonar way"
   ],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1481/javascript/metadata.json

@@ -3,5 +3,8 @@
   "defaultQualityProfiles": [
     "Sonar way"
   ],
-  "scope": "Main"
-}
+  "scope": "Main",
+  "compatibleLanguages": [
+    "js"
+  ]
+}

rules/S1488/javascript/metadata.json

@@ -1,6 +1,9 @@
 {
-  "defaultQualityProfiles": [
-  ],
+  "defaultQualityProfiles": [],
   "scope": "Main",
-  "quickfix": "covered"
-}
+  "quickfix": "covered",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1488/rust/metadata.json

@@ -0,0 +1,7 @@
+{
+  "title": "Local variables should not be declared and then immediately returned",
+  "tags": [
+    "clumsy",
+    "clippy"
+  ]
+}

rules/S1488/rust/rule.adoc

@@ -0,0 +1,34 @@
+== Why is this an issue?
+
+Declaring a variable only to immediately return it is considered a bad practice because it adds unnecessary complexity to the code. This practice can make the code harder to read and understand, as it introduces an extra step that doesn't add any value. Instead of declaring a variable and then immediately returning, it is generally better to return or throw the value directly. This makes the code cleaner, simpler, and easier to understand.
+
+== How to fix it
+
+Declaring a variable only to immediately return it is considered a bad practice because it adds unnecessary complexity to the code. To fix the issue, return the value directly.
+
+=== Code examples
+
+==== Noncompliant code example
+
+[source,rust,diff-id=1,diff-type=noncompliant]
+----
+fn compute_duration_in_milliseconds(hours: u32, minutes: u32, seconds: u32) -> u32 {
+    let duration = (((hours * 60) + minutes) * 60 + seconds) * 1000;
+    duration
+}
+----
+
+==== Compliant solution
+
+[source,rust,diff-id=1,diff-type=compliant]
+----
+fn compute_duration_in_milliseconds(hours: u32, minutes: u32, seconds: u32) -> u32 {
+    (((hours * 60) + minutes) * 60 + seconds) * 1000
+}
+----
+
+== Resources
+
+=== Documentation
+
+* Clippy Lints - https://rust-lang.github.io/rust-clippy/master/index.html#let_and_return

rules/S1515/javascript/metadata.json

@@ -1,3 +1,6 @@
 {
-  
-}
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1516/javascript/metadata.json

@@ -1,3 +1,6 @@
 {
-  
-}
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1523/javascript/metadata.json

@@ -1,5 +1,9 @@
 {
   "defaultQualityProfiles": [
     "Sonar way"
+  ],
+  "compatibleLanguages": [
+    "js",
+    "ts"
   ]
-}
+}

rules/S1525/javascript/metadata.json

@@ -3,12 +3,10 @@
   "type": "VULNERABILITY",
   "status": "deprecated",
   "remediation": {
-    "func": "Constant\/Issue",
+    "func": "Constant/Issue",
     "constantCost": "5min"
   },
-  "tags": [
-
-  ],
+  "tags": [],
   "extra": {
     "replacementRules": [
       "RSPEC-4507"
@@ -21,8 +19,10 @@
   "ruleSpecification": "RSPEC-1525",
   "sqKey": "S1525",
   "scope": "Main",
-  "defaultQualityProfiles": [
-
-  ],
-  "quickfix": "unknown"
-}
+  "defaultQualityProfiles": [],
+  "quickfix": "unknown",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1526/javascript/metadata.json

@@ -9,7 +9,7 @@
   },
   "status": "ready",
   "remediation": {
-    "func": "Constant\/Issue",
+    "func": "Constant/Issue",
     "constantCost": "10min"
   },
   "tags": [
@@ -26,5 +26,9 @@
   "sqKey": "S1526",
   "scope": "Main",
   "defaultQualityProfiles": [],
-  "quickfix": "unknown"
-}
+  "quickfix": "unknown",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1527/javascript/metadata.json

@@ -1,3 +1,5 @@
 {
-  
-}
+  "compatibleLanguages": [
+    "js"
+  ]
+}

rules/S1528/javascript/metadata.json

@@ -9,16 +9,14 @@
   },
   "status": "ready",
   "remediation": {
-    "func": "Constant\/Issue",
+    "func": "Constant/Issue",
     "constantCost": "5min"
   },
   "tags": [
     "suspicious"
   ],
   "extra": {
-    "replacementRules": [
-
-    ],
+    "replacementRules": [],
     "legacyKeys": [
       "ArrayAndObjectConstructors"
     ]
@@ -27,8 +25,10 @@
   "ruleSpecification": "RSPEC-1528",
   "sqKey": "S1528",
   "scope": "Main",
-  "defaultQualityProfiles": [
-
-  ],
-  "quickfix": "covered"
-}
+  "defaultQualityProfiles": [],
+  "quickfix": "covered",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1529/javascript/metadata.json

@@ -9,16 +9,12 @@
   },
   "status": "ready",
   "remediation": {
-    "func": "Constant\/Issue",
+    "func": "Constant/Issue",
     "constantCost": "5min"
   },
-  "tags": [
-
-  ],
+  "tags": [],
   "extra": {
-    "replacementRules": [
-
-    ],
+    "replacementRules": [],
     "legacyKeys": [
       "BitwiseOperators"
     ]
@@ -30,5 +26,9 @@
   "defaultQualityProfiles": [
     "Sonar way"
   ],
-  "quickfix": "unknown"
-}
+  "quickfix": "unknown",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1530/javascript/metadata.json

@@ -9,7 +9,7 @@
   },
   "status": "ready",
   "remediation": {
-    "func": "Constant\/Issue",
+    "func": "Constant/Issue",
     "constantCost": "5min"
   },
   "tags": [
@@ -17,9 +17,7 @@
     "user-experience"
   ],
   "extra": {
-    "replacementRules": [
-
-    ],
+    "replacementRules": [],
     "legacyKeys": [
       "FunctionDeclarationsWithinBlocks"
     ]
@@ -28,8 +26,10 @@
   "ruleSpecification": "RSPEC-1530",
   "sqKey": "S1530",
   "scope": "Main",
-  "defaultQualityProfiles": [
-
-  ],
-  "quickfix": "unknown"
-}
+  "defaultQualityProfiles": [],
+  "quickfix": "unknown",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1533/javascript/metadata.json

@@ -9,16 +9,14 @@
   },
   "status": "ready",
   "remediation": {
-    "func": "Constant\/Issue",
+    "func": "Constant/Issue",
     "constantCost": "1min"
   },
   "tags": [
     "pitfall"
   ],
   "extra": {
-    "replacementRules": [
-
-    ],
+    "replacementRules": [],
     "legacyKeys": [
       "PrimitiveWrappers"
     ]
@@ -30,5 +28,9 @@
   "defaultQualityProfiles": [
     "Sonar way"
   ],
-  "quickfix": "covered"
-}
+  "quickfix": "covered",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}

rules/S1534/javascript/metadata.json

@@ -9,16 +9,14 @@
   },
   "status": "ready",
   "remediation": {
-    "func": "Constant\/Issue",
+    "func": "Constant/Issue",
     "constantCost": "5min"
   },
   "tags": [
     "pitfall"
   ],
   "extra": {
-    "replacementRules": [
-
-    ],
+    "replacementRules": [],
     "legacyKeys": [
       "DuplicatePropertyName"
     ]
@@ -30,5 +28,9 @@
   "defaultQualityProfiles": [
     "Sonar way"
   ],
-  "quickfix": "covered"
-}
+  "quickfix": "covered",
+  "compatibleLanguages": [
+    "js",
+    "ts"
+  ]
+}