Add clean code attributes to Delphi rules

integrated-application-development · Sep 15, 2023 · f2e4e5c · f2e4e5c
1 parent b8c9bb6
commit f2e4e5c
Show file tree

Hide file tree

Showing 120 changed files with 727 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Custom rules plugin API:
   - See: [Writing Custom Delphi Rules 101](docs/CUSTOM_RULES_101.md)
+- Rule metadata for the new [Clean Code Taxonomy](https://docs.sonarsource.com/sonarqube/10.2/user-guide/clean-code/).
 - Support for identifiers prefixed with 2 ampersands (`&&`).
 - `OleVariant` overloads for `VarArrayRedim` and `VarClear` intrinsics.
 - `InlineAssembly` analysis rule, which flags inline assembly usage.

diff --git a/.../src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/AddressOfSubroutine.json b/.../src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/AddressOfSubroutine.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "5min"
   },
+  "code": {
+    "attribute": "LOGICAL",
+    "impacts": {
+      "RELIABILITY": "HIGH"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Blocker",
   "scope": "ALL",

diff --git a/...checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/AssertMessage.json b/...checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/AssertMessage.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "3min"
   },
+  "code": {
+    "attribute": "CLEAR",
+    "impacts": {
+      "MAINTAINABILITY": "MEDIUM"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Major",
   "scope": "MAIN",

diff --git a/...ecks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/AssignedAndFree.json b/...ecks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/AssignedAndFree.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "5min"
   },
+  "code": {
+    "attribute": "EFFICIENT",
+    "impacts": {
+      "MAINTAINABILITY": "LOW"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Major",
   "scope": "ALL",

diff --git a/...checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/AttributeName.json b/...checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/AttributeName.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "15min"
   },
+  "code": {
+    "attribute": "IDENTIFIABLE",
+    "impacts": {
+      "MAINTAINABILITY": "LOW"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Minor",
   "scope": "ALL",

diff --git a/...cks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/BeginEndRequired.json b/...cks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/BeginEndRequired.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "10min"
   },
+  "code": {
+    "attribute": "FORMATTED",
+    "impacts": {
+      "MAINTAINABILITY": "LOW"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Minor",
   "scope": "ALL",

diff --git a/...ks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/CaseStatementSize.json b/...ks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/CaseStatementSize.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "1min"
   },
+  "code": {
+    "attribute": "CLEAR",
+    "impacts": {
+      "MAINTAINABILITY": "LOW"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Minor",
   "scope": "ALL",

diff --git a/...i-checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/CastAndFree.json b/...i-checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/CastAndFree.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "5min"
   },
+  "code": {
+    "attribute": "EFFICIENT",
+    "impacts": {
+      "MAINTAINABILITY": "MEDIUM"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Major",
   "scope": "ALL",

diff --git a/...src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/CatchingRawException.json b/...src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/CatchingRawException.json
@@ -6,6 +6,13 @@
     "func": "Constant/Issue",
     "constantCost": "15min"
   },
+  "code": {
+    "attribute": "FOCUSED",
+    "impacts": {
+      "MAINTAINABILITY": "MEDIUM",
+      "RELIABILITY": "MEDIUM"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Critical",
   "scope": "ALL",

diff --git a/...sources/org/sonar/l10n/delphi/rules/community-delphi/CharacterToCharacterPointerCast.json b/...sources/org/sonar/l10n/delphi/rules/community-delphi/CharacterToCharacterPointerCast.json
@@ -6,6 +6,13 @@
     "func": "Constant/Issue",
     "constantCost": "5min"
   },
+  "code": {
+    "attribute": "LOGICAL",
+    "impacts": {
+      "MAINTAINABILITY": "MEDIUM",
+      "RELIABILITY": "HIGH"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Critical",
   "scope": "ALL",

diff --git a/delphi-checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/ClassName.json b/delphi-checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/ClassName.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "15min"
   },
+  "code": {
+    "attribute": "IDENTIFIABLE",
+    "impacts": {
+      "MAINTAINABILITY": "LOW"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Minor",
   "scope": "ALL",

diff --git a/...-checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/ClassPerFile.json b/...-checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/ClassPerFile.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "1h"
   },
+  "code": {
+    "attribute": "MODULAR",
+    "impacts": {
+      "MAINTAINABILITY": "MEDIUM"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Major",
   "scope": "ALL",

diff --git a/...ain/resources/org/sonar/l10n/delphi/rules/community-delphi/CognitiveComplexityMethod.json b/...ain/resources/org/sonar/l10n/delphi/rules/community-delphi/CognitiveComplexityMethod.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "30min"
   },
+  "code": {
+    "attribute": "FOCUSED",
+    "impacts": {
+      "MAINTAINABILITY": "HIGH"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Critical",
   "scope": "ALL",

diff --git a/...main/resources/org/sonar/l10n/delphi/rules/community-delphi/CommentRegularExpression.json b/...main/resources/org/sonar/l10n/delphi/rules/community-delphi/CommentRegularExpression.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "20min"
   },
+  "code": {
+    "attribute": "CONVENTIONAL",
+    "impacts": {
+      "MAINTAINABILITY": "LOW"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Major",
   "scope": "ALL",

diff --git a/...cks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/CommentedOutCode.json b/...cks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/CommentedOutCode.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "3min"
   },
+  "code": {
+    "attribute": "FOCUSED",
+    "impacts": {
+      "MAINTAINABILITY": "LOW"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Minor",
   "scope": "ALL",

diff --git a/...checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/CompilerHints.json b/...checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/CompilerHints.json
@@ -6,6 +6,13 @@
     "func": "Constant/Issue",
     "constantCost": "30min"
   },
+  "code": {
+    "attribute": "LOGICAL",
+    "impacts": {
+      "MAINTAINABILITY": "LOW",
+      "RELIABILITY": "MEDIUM"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Critical",
   "scope": "ALL",

diff --git a/...cks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/CompilerWarnings.json b/...cks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/CompilerWarnings.json
@@ -6,6 +6,13 @@
     "func": "Constant/Issue",
     "constantCost": "30min"
   },
+  "code": {
+    "attribute": "LOGICAL",
+    "impacts": {
+      "MAINTAINABILITY": "LOW",
+      "RELIABILITY": "HIGH"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Critical",
   "scope": "ALL",

diff --git a/...-checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/ConstantName.json b/...-checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/ConstantName.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "15min"
   },
+  "code": {
+    "attribute": "IDENTIFIABLE",
+    "impacts": {
+      "MAINTAINABILITY": "LOW"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Minor",
   "scope": "ALL",

diff --git a/...ecks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/ConstructorName.json b/...ecks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/ConstructorName.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "1min"
   },
+  "code": {
+    "attribute": "IDENTIFIABLE",
+    "impacts": {
+      "MAINTAINABILITY": "LOW"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Minor",
   "scope": "ALL",

diff --git a/...n/resources/org/sonar/l10n/delphi/rules/community-delphi/ConstructorWithoutInherited.json b/...n/resources/org/sonar/l10n/delphi/rules/community-delphi/ConstructorWithoutInherited.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "5min"
   },
+  "code": {
+    "attribute": "COMPLETE",
+    "impacts": {
+      "RELIABILITY": "MEDIUM"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Major",
   "scope": "ALL",

diff --git a/...in/resources/org/sonar/l10n/delphi/rules/community-delphi/CyclomaticComplexityMethod.json b/...in/resources/org/sonar/l10n/delphi/rules/community-delphi/CyclomaticComplexityMethod.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "30min"
   },
+  "code": {
+    "attribute": "FOCUSED",
+    "impacts": {
+      "MAINTAINABILITY": "HIGH"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Critical",
   "scope": "ALL",

diff --git a/...s/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/DateFormatSettings.json b/...s/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/DateFormatSettings.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "5min"
   },
+  "code": {
+    "attribute": "LOGICAL",
+    "impacts": {
+      "RELIABILITY": "MEDIUM"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Major",
   "scope": "ALL",

diff --git a/...hecks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/DestructorName.json b/...hecks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/DestructorName.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "1min"
   },
+  "code": {
+    "attribute": "LOGICAL",
+    "impacts": {
+      "RELIABILITY": "HIGH"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Major",
   "scope": "ALL",

diff --git a/...in/resources/org/sonar/l10n/delphi/rules/community-delphi/DestructorWithoutInherited.json b/...in/resources/org/sonar/l10n/delphi/rules/community-delphi/DestructorWithoutInherited.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "30min"
   },
+  "code": {
+    "attribute": "COMPLETE",
+    "impacts": {
+      "RELIABILITY": "MEDIUM"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Major",
   "scope": "ALL",

diff --git a/...ks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/EmptyArgumentList.json b/...ks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/EmptyArgumentList.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "1min"
   },
+  "code": {
+    "attribute": "FORMATTED",
+    "impacts": {
+      "MAINTAINABILITY": "LOW"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Minor",
   "scope": "ALL",

diff --git a/...hi-checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/EmptyBlock.json b/...hi-checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/EmptyBlock.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "5min"
   },
+  "code": {
+    "attribute": "DISTINCT",
+    "impacts": {
+      "MAINTAINABILITY": "LOW"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Minor",
   "scope": "ALL",

diff --git a/...ks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/EmptyFieldSection.json b/...ks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/EmptyFieldSection.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "1min"
   },
+  "code": {
+    "attribute": "DISTINCT",
+    "impacts": {
+      "MAINTAINABILITY": "LOW"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Minor",
   "scope": "ALL",

diff --git a/delphi-checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/EmptyFile.json b/delphi-checks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/EmptyFile.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "5min"
   },
+  "code": {
+    "attribute": "DISTINCT",
+    "impacts": {
+      "MAINTAINABILITY": "LOW"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Minor",
   "scope": "ALL",

diff --git a/...ks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/EmptyFinallyBlock.json b/...ks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/EmptyFinallyBlock.json
@@ -6,6 +6,13 @@
     "func": "Constant/Issue",
     "constantCost": "5min"
   },
+  "code": {
+    "attribute": "CLEAR",
+    "impacts": {
+      "MAINTAINABILITY": "MEDIUM",
+      "RELIABILITY": "LOW"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Critical",
   "scope": "ALL",

diff --git a/...hecks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/EmptyInterface.json b/...hecks/src/main/resources/org/sonar/l10n/delphi/rules/community-delphi/EmptyInterface.json
@@ -6,6 +6,12 @@
     "func": "Constant/Issue",
     "constantCost": "20min"
   },
+  "code": {
+    "attribute": "DISTINCT",
+    "impacts": {
+      "MAINTAINABILITY": "LOW"
+    }
+  },
   "tags": [],
   "defaultSeverity": "Major",
   "scope": "ALL",