Add jscpd (#152)

* add jscpd report support * fix jscpd issues not reported * fix comment typo * fix test case * add multi-line comments support * remove octokit logging * go * fix styling * fix styling * remove local debugging * Apply suggestions from code review Co-authored-by: Plai <[email protected]> * apply suggestions to test --------- Co-authored-by: jeeyo <[email protected]> Co-authored-by: Plai <[email protected]>
codeleague · Aug 8, 2023 · ae8e86d · ae8e86d
1 parent 23909bc
commit ae8e86d
Show file tree

Hide file tree

Showing 26 changed files with 1,050 additions and 262 deletions.
diff --git a/README.md b/README.md
@@ -23,6 +23,9 @@ So it can be integrated with any CI with ease.
 - DartLint
 - SwiftLint (0.49.1 or later)
 
+#### Supported code duplication detectors.
+- jscpd
+
 #### Supported source controls
 - GitHub
 - GitHub Enterprise

diff --git a/package.json b/package.json
@@ -26,6 +26,7 @@
     "node": ">=14.0.0"
   },
   "devDependencies": {
+    "@jscpd/finder": "^3.5.5",
     "@octokit/types": "^6.34.0",
     "@types/jest": "^26.0.18",
     "@types/js-yaml": "^4.0.0",
@@ -45,7 +46,7 @@
     "typescript": "^4.1.2"
   },
   "dependencies": {
-    "@gitbeaker/node": "^35.7.0",
+    "@gitbeaker/rest": "^39.10.2",
     "@octokit/core": "^3.2.4",
     "@octokit/rest": "^18.12.0",
     "rimraf": "^3.0.2",

diff --git a/sample/jscpd/jscpd-report.json b/sample/jscpd/jscpd-report.json
@@ -0,0 +1,337 @@
+{
+  "statistics": {
+    "detectionDate": "2023-07-21T10:00:47.817Z",
+    "formats": {
+      "csharp": {
+        "sources": {
+          "/Users/codecoach/myproject/src/WebApi/Startuping/ALoader.cs": {
+            "lines": 10,
+            "tokens": 68,
+            "sources": 1,
+            "clones": 0,
+            "duplicatedLines": 0,
+            "duplicatedTokens": 0,
+            "percentage": 0,
+            "percentageTokens": 0,
+            "newDuplicatedLines": 0,
+            "newClones": 0
+          },
+          "/Users/codecoach/myproject/src/WebApi/Services/BService.cs": {
+            "lines": 58,
+            "tokens": 450,
+            "sources": 1,
+            "clones": 0,
+            "duplicatedLines": 0,
+            "duplicatedTokens": 0,
+            "percentage": 0,
+            "percentageTokens": 0,
+            "newDuplicatedLines": 0,
+            "newClones": 0
+          },
+          "/Users/codecoach/myproject/src/WebApi/Services/CService.cs": {
+            "lines": 27,
+            "tokens": 252,
+            "sources": 1,
+            "clones": 0,
+            "duplicatedLines": 0,
+            "duplicatedTokens": 0,
+            "percentage": 0,
+            "percentageTokens": 0,
+            "newDuplicatedLines": 0,
+            "newClones": 0
+          },
+          "/Users/codecoach/myproject/src/WebApi/Services/DService.cs": {
+            "lines": 35,
+            "tokens": 342,
+            "sources": 1,
+            "clones": 0,
+            "duplicatedLines": 0,
+            "duplicatedTokens": 0,
+            "percentage": 0,
+            "percentageTokens": 0,
+            "newDuplicatedLines": 0,
+            "newClones": 0
+          },
+          "/Users/codecoach/myproject/src/WebApi/Services/EService.cs": {
+            "lines": 84,
+            "tokens": 742,
+            "sources": 1,
+            "clones": 0,
+            "duplicatedLines": 0,
+            "duplicatedTokens": 0,
+            "percentage": 0,
+            "percentageTokens": 0,
+            "newDuplicatedLines": 0,
+            "newClones": 0
+          },
+          "/Users/codecoach/myproject/src/WebApi/Services/FService.cs": {
+            "lines": 35,
+            "tokens": 342,
+            "sources": 1,
+            "clones": 0,
+            "duplicatedLines": 0,
+            "duplicatedTokens": 0,
+            "percentage": 0,
+            "percentageTokens": 0,
+            "newDuplicatedLines": 0,
+            "newClones": 0
+          },
+          "/Users/codecoach/myproject/src/WebApi/Controllers/GController.cs": {
+            "lines": 46,
+            "tokens": 391,
+            "sources": 1,
+            "clones": 2,
+            "duplicatedLines": 20,
+            "duplicatedTokens": 187,
+            "percentage": 43.48,
+            "percentageTokens": 47.83,
+            "newDuplicatedLines": 0,
+            "newClones": 0
+          },
+          "/Users/codecoach/myproject/src/WebApi/Controllers/HController.cs": {
+            "lines": 40,
+            "tokens": 342,
+            "sources": 1,
+            "clones": 1,
+            "duplicatedLines": 10,
+            "duplicatedTokens": 92,
+            "percentage": 25,
+            "percentageTokens": 26.9,
+            "newDuplicatedLines": 0,
+            "newClones": 0
+          },
+          "/Users/codecoach/myproject/src/WebApi/Controllers/IController.cs": {
+            "lines": 77,
+            "tokens": 730,
+            "sources": 1,
+            "clones": 0,
+            "duplicatedLines": 0,
+            "duplicatedTokens": 0,
+            "percentage": 0,
+            "percentageTokens": 0,
+            "newDuplicatedLines": 0,
+            "newClones": 0
+          },
+          "/Users/codecoach/myproject/src/WebApi/Controllers/JController.cs": {
+            "lines": 26,
+            "tokens": 217,
+            "sources": 1,
+            "clones": 0,
+            "duplicatedLines": 0,
+            "duplicatedTokens": 0,
+            "percentage": 0,
+            "percentageTokens": 0,
+            "newDuplicatedLines": 0,
+            "newClones": 0
+          },
+          "/Users/codecoach/myproject/src/WebApi/Controllers/KController.cs": {
+            "lines": 34,
+            "tokens": 288,
+            "sources": 1,
+            "clones": 0,
+            "duplicatedLines": 0,
+            "duplicatedTokens": 0,
+            "percentage": 0,
+            "percentageTokens": 0,
+            "newDuplicatedLines": 0,
+            "newClones": 0
+          },
+          "/Users/codecoach/myproject/src/WebApi/Controllers/LController.cs": {
+            "lines": 38,
+            "tokens": 294,
+            "sources": 1,
+            "clones": 0,
+            "duplicatedLines": 0,
+            "duplicatedTokens": 0,
+            "percentage": 0,
+            "percentageTokens": 0,
+            "newDuplicatedLines": 0,
+            "newClones": 0
+          },
+          "/Users/codecoach/myproject/src/WebApi/Controllers/MController.cs": {
+            "lines": 44,
+            "tokens": 394,
+            "sources": 1,
+            "clones": 2,
+            "duplicatedLines": 17,
+            "duplicatedTokens": 166,
+            "percentage": 38.64,
+            "percentageTokens": 42.13,
+            "newDuplicatedLines": 0,
+            "newClones": 0
+          },
+          "/Users/codecoach/myproject/src/WebApi/Controllers/NController.cs": {
+            "lines": 51,
+            "tokens": 445,
+            "sources": 1,
+            "clones": 1,
+            "duplicatedLines": 7,
+            "duplicatedTokens": 71,
+            "percentage": 13.73,
+            "percentageTokens": 15.96,
+            "newDuplicatedLines": 0,
+            "newClones": 0
+          },
+          "/Users/codecoach/myproject/src/WebApi/Controllers/OController.cs": {
+            "lines": 26,
+            "tokens": 230,
+            "sources": 1,
+            "clones": 0,
+            "duplicatedLines": 0,
+            "duplicatedTokens": 0,
+            "percentage": 0,
+            "percentageTokens": 0,
+            "newDuplicatedLines": 0,
+            "newClones": 0
+          },
+          "/Users/codecoach/myproject/src/WebApi/Program.cs": {
+            "lines": 144,
+            "tokens": 1338,
+            "sources": 1,
+            "clones": 0,
+            "duplicatedLines": 0,
+            "duplicatedTokens": 0,
+            "percentage": 0,
+            "percentageTokens": 0,
+            "newDuplicatedLines": 0,
+            "newClones": 0
+          }
+        },
+        "total": {
+          "lines": 775,
+          "tokens": 6865,
+          "sources": 16,
+          "clones": 3,
+          "duplicatedLines": 27,
+          "duplicatedTokens": 258,
+          "percentage": 3.48,
+          "percentageTokens": 3.76,
+          "newDuplicatedLines": 0,
+          "newClones": 0
+        }
+      }
+    },
+    "total": {
+      "lines": 775,
+      "tokens": 6865,
+      "sources": 16,
+      "clones": 3,
+      "duplicatedLines": 27,
+      "duplicatedTokens": 258,
+      "percentage": 3.48,
+      "percentageTokens": 3.76,
+      "newDuplicatedLines": 0,
+      "newClones": 0
+    }
+  },
+  "duplicates": [
+    {
+      "format": "csharp",
+      "lines": 11,
+      "fragment": "using System.Threading.Tasks;\r\nusing Core.Models;\r\nusing Core.Services;\r\nusing Microsoft.AspNetCore.Mvc;\r\nusing Nelibur.ObjectMapper;\r\nusing Swashbuckle.AspNetCore.Annotations;\r\n\r\nnamespace WebApi.Controllers;\r\n\r\n[",
+      "tokens": 0,
+      "firstFile": {
+        "name": "src/WebApi/Controllers/HController.cs",
+        "start": 1,
+        "end": 11,
+        "startLoc": {
+          "line": 1,
+          "column": 2,
+          "position": 1
+        },
+        "endLoc": {
+          "line": 11,
+          "column": 2,
+          "position": 93
+        }
+      },
+      "secondFile": {
+        "name": "src/WebApi/Controllers/GController.cs",
+        "start": 1,
+        "end": 11,
+        "startLoc": {
+          "line": 1,
+          "column": 1,
+          "position": 0
+        },
+        "endLoc": {
+          "line": 11,
+          "column": 14,
+          "position": 92
+        }
+      }
+    },
+    {
+      "format": "csharp",
+      "lines": 11,
+      "fragment": "using System.Threading.Tasks;\r\nusing Core.Models;\r\nusing Core.Services;\r\nusing Microsoft.AspNetCore.Mvc;\r\nusing Nelibur.ObjectMapper;\r\nusing Swashbuckle.AspNetCore.Annotations;\r\n\r\nnamespace WebApi.Controllers;\r\n\r\n[Route(\"gradletalaiot\"",
+      "tokens": 0,
+      "firstFile": {
+        "name": "src/WebApi/Controllers/MController.cs",
+        "start": 2,
+        "end": 12,
+        "startLoc": {
+          "line": 2,
+          "column": 1,
+          "position": 6
+        },
+        "endLoc": {
+          "line": 12,
+          "column": 16,
+          "position": 101
+        }
+      },
+      "secondFile": {
+        "name": "src/WebApi/Controllers/GController.cs",
+        "start": 1,
+        "end": 11,
+        "startLoc": {
+          "line": 1,
+          "column": 1,
+          "position": 0
+        },
+        "endLoc": {
+          "line": 11,
+          "column": 7,
+          "position": 96
+        }
+      }
+    },
+    {
+      "format": "csharp",
+      "lines": 8,
+      "fragment": ";\r\nusing System.Threading.Tasks;\r\nusing Core.Models;\r\nusing Core.Services;\r\nusing Microsoft.AspNetCore.Mvc;\r\nusing Nelibur.ObjectMapper;\r\nusing Serilog",
+      "tokens": 0,
+      "firstFile": {
+        "name": "src/WebApi/Controllers/NController.cs",
+        "start": 2,
+        "end": 9,
+        "startLoc": {
+          "line": 2,
+          "column": 5,
+          "position": 15
+        },
+        "endLoc": {
+          "line": 9,
+          "column": 8,
+          "position": 86
+        }
+      },
+      "secondFile": {
+        "name": "src/WebApi/Controllers/MController.cs",
+        "start": 1,
+        "end": 8,
+        "startLoc": {
+          "line": 1,
+          "column": 7,
+          "position": 3
+        },
+        "endLoc": {
+          "line": 8,
+          "column": 12,
+          "position": 74
+        }
+      }
+    }
+  ]
+}
diff --git a/src/AnalyzerBot/@types/CommentTypes.ts b/src/AnalyzerBot/@types/CommentTypes.ts
@@ -1,6 +1,7 @@
 export interface Comment {
   file: string;
   line: number;
+  nLines?: number;
   text: string;
   errors: number;
   warnings: number;

diff --git a/src/AnalyzerBot/AnalyzerBot.spec.ts b/src/AnalyzerBot/AnalyzerBot.spec.ts
@@ -35,6 +35,7 @@ describe('AnalyzerBot', () => {
         {
           file: mockTouchFile,
           line: file1TouchLine,
+          nLines: 1,
           text:
             MessageUtil.createMessageWithEmoji(
               touchFileError.msg,
@@ -47,6 +48,7 @@ describe('AnalyzerBot', () => {
         {
           file: mockTouchFile,
           line: file2TouchLine,
+          nLines: 2,
           text:
             MessageUtil.createMessageWithEmoji(
               touchFileWarning.msg,