Add Vaimo Parser (#301)

codacy · Nov 11, 2024 · 91192f9 · 91192f9
1 parent cf98a30
commit 91192f9
Showing 10 changed files with 95 additions and 0 deletions.
diff --git a/doc-generator/src/main/scala/codacy/codesniffer/docsgen/Generator.scala b/doc-generator/src/main/scala/codacy/codesniffer/docsgen/Generator.scala
@@ -29,6 +29,7 @@ class Generator() {
          new PHPCSSecurityAuditDocsParser(),
          new SlevomatCSDocsParser(),
          new SymfonyDocsParser(),
+         new VaimoUKParser(),
          new VipWordPressDocsParser(),
          new WordPressCSDocsParser()
     )

diff --git a/doc-generator/src/main/scala/codacy/codesniffer/docsgen/VersionsHelper.scala b/doc-generator/src/main/scala/codacy/codesniffer/docsgen/VersionsHelper.scala
@@ -22,4 +22,5 @@ object VersionsHelper {
   lazy val slevomatCS = properties("slevomat/coding-standard").str.replace("^","")
   lazy val codesniffer = properties("squizlabs/php_codesniffer").str.replace("^","")
   lazy val wordpress = properties("wp-coding-standards/wpcs").str.replace("^","")
+  lazy val vaimoUK = properties("vaimo/uk-phpcs-standards").str.replace("^","")
 }
diff --git a/doc-generator/src/main/scala/codacy/codesniffer/docsgen/parsers/DocsParser.scala b/doc-generator/src/main/scala/codacy/codesniffer/docsgen/parsers/DocsParser.scala
@@ -87,6 +87,7 @@ trait DocsParser {
 
   private[this] def withRepo[A](repositoryURL: String, checkoutCommit: String)(f: File => A): Either[Throwable, A] = {
     val dir = Files.createTempDirectory("")
+    println(s"Cloning $repositoryURL into $dir")
     for {
       _ <- Right(
         CommandRunner

diff --git a/doc-generator/src/main/scala/codacy/codesniffer/docsgen/parsers/VaimoUKParser.scala b/doc-generator/src/main/scala/codacy/codesniffer/docsgen/parsers/VaimoUKParser.scala
@@ -0,0 +1,44 @@
+package codacy.codesniffer.docsgen.parsers
+
+import codacy.codesniffer.docsgen.VersionsHelper
+import scala.util.matching.Regex
+
+import better.files.File
+import com.codacy.plugins.api.results.Pattern
+
+import scala.annotation.nowarn
+
+class VaimoUKParser extends DocsParser {
+
+  override val repositoryURL = "https://bitbucket.org/vaimo/uk-phpcs-standards.git"
+
+  override val checkoutCommit: String = VersionsHelper.vaimoUK
+
+
+  override val sniffRegex: Regex = """.*(Vaimo)\/Sniffs\/(.*?)\/(.*?)Sniff.php""".r
+
+   @nowarn("msg=match may not be exhaustive")
+  override def patternIdPartsFor(relativizedFilePath: String): PatternIdParts = {
+    val sniffRegex(vaimoVersion, sniffType, patternName) = relativizedFilePath
+    PatternIdParts(vaimoVersion, sniffType, patternName)
+  }
+
+override def descriptionWithDocs(rootDir: File,
+                                   patternIdParts: PatternIdParts,
+                                   patternFile: File
+  ): (Pattern.Description, Option[String]) = {
+    (description(patternIdParts, rootDir),
+     this.parseExtendedDescription("Vaimo\\Sniffs\\Custom", "Vaimo", patternIdParts, rootDir)
+    )
+  }
+
+    private[this] def description(patternIdParts: PatternIdParts, rootDir: File): Pattern.Description = {
+    val caseRegexPattern = """((?<=\p{Ll})\p{Lu}|\p{Lu}(?=\p{Ll}))""".r
+    val patternName = caseRegexPattern.replaceAllIn(patternIdParts.patternName, " $1").trim
+    val sniffName = caseRegexPattern.replaceAllIn(patternIdParts.sniffType, " $1").trim
+    val title = Pattern.Title(s"$sniffName: $patternName")
+    val extended = this.parseDescription("Vaimo\\Sniffs\\Custom", "Vaimo", patternIdParts, rootDir)
+    Pattern.Description(patternIdParts.patternId, title, extended, None, Set.empty)
+  }
+}
+
diff --git a/docs/description/Vaimo_Custom_ArrayAccess.md b/docs/description/Vaimo_Custom_ArrayAccess.md
@@ -0,0 +1 @@
+Custom: Array Access
diff --git a/docs/description/Vaimo_Custom_FixMultilineIf.md b/docs/description/Vaimo_Custom_FixMultilineIf.md
@@ -0,0 +1 @@
+Custom: Fix Multiline If
diff --git a/docs/description/Vaimo_Custom_LegacyDocblockTags.md b/docs/description/Vaimo_Custom_LegacyDocblockTags.md
@@ -0,0 +1 @@
+Custom: Legacy Docblock Tags
diff --git a/docs/description/Vaimo_Custom_NoPhpCsDisable.md b/docs/description/Vaimo_Custom_NoPhpCsDisable.md
@@ -0,0 +1 @@
+Custom: No Php Cs Disable
diff --git a/docs/description/description.json b/docs/description/description.json
@@ -4103,6 +4103,22 @@
   "patternId" : "Symfony_Whitespace_DiscourageFitzinator",
   "title" : "Whitespace: Discourage Fitzinator",
   "parameters" : [ ]
+}, {
+  "patternId" : "Vaimo_Custom_ArrayAccess",
+  "title" : "Custom: Array Access",
+  "parameters" : [ ]
+}, {
+  "patternId" : "Vaimo_Custom_FixMultilineIf",
+  "title" : "Custom: Fix Multiline If",
+  "parameters" : [ ]
+}, {
+  "patternId" : "Vaimo_Custom_LegacyDocblockTags",
+  "title" : "Custom: Legacy Docblock Tags",
+  "parameters" : [ ]
+}, {
+  "patternId" : "Vaimo_Custom_NoPhpCsDisable",
+  "title" : "Custom: No Php Cs Disable",
+  "parameters" : [ ]
 }, {
   "patternId" : "WordPressVIPMinimum_Classes_DeclarationCompatibility",
   "title" : "Classes: Declaration Compatibility",

diff --git a/docs/patterns.json b/docs/patterns.json
@@ -6374,6 +6374,34 @@
     "parameters" : [ ],
     "languages" : [ ],
     "enabled" : false
+  }, {
+    "patternId" : "Vaimo_Custom_ArrayAccess",
+    "level" : "Info",
+    "category" : "CodeStyle",
+    "parameters" : [ ],
+    "languages" : [ ],
+    "enabled" : false
+  }, {
+    "patternId" : "Vaimo_Custom_FixMultilineIf",
+    "level" : "Info",
+    "category" : "CodeStyle",
+    "parameters" : [ ],
+    "languages" : [ ],
+    "enabled" : false
+  }, {
+    "patternId" : "Vaimo_Custom_LegacyDocblockTags",
+    "level" : "Info",
+    "category" : "CodeStyle",
+    "parameters" : [ ],
+    "languages" : [ ],
+    "enabled" : false
+  }, {
+    "patternId" : "Vaimo_Custom_NoPhpCsDisable",
+    "level" : "Info",
+    "category" : "CodeStyle",
+    "parameters" : [ ],
+    "languages" : [ ],
+    "enabled" : false
   }, {
     "patternId" : "WordPressVIPMinimum_Classes_DeclarationCompatibility",
     "level" : "Info",