Skip to content

Commit 79e1765

Browse files
add vaimo phpcs-rulesets (#317)
* add vaimo phpcs-rulesets
1 parent 91192f9 commit 79e1765

28 files changed

+452
-9
lines changed

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"doctrine/coding-standard": "^12.0.0",
77
"drupal/coder": "^8.3.24",
88
"escapestudios/symfony2-coding-standard": "^3.13.0",
9-
"magento/magento-coding-standard": "^32.0",
9+
"magento/magento-coding-standard": "32.0",
1010
"magento/marketplace-eqp": "^4.0.0",
1111
"pheromone/phpcs-security-audit": "^2.0.1",
1212
"phpcompatibility/php-compatibility": "9.3.5",

doc-generator/src/main/scala/codacy/codesniffer/docsgen/Generator.scala

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ class Generator() {
2929
new PHPCSSecurityAuditDocsParser(),
3030
new SlevomatCSDocsParser(),
3131
new SymfonyDocsParser(),
32+
new VaimoParser(),
3233
new VaimoUKParser(),
3334
new VipWordPressDocsParser(),
3435
new WordPressCSDocsParser()

doc-generator/src/main/scala/codacy/codesniffer/docsgen/VersionsHelper.scala

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,5 @@ object VersionsHelper {
2323
lazy val codesniffer = properties("squizlabs/php_codesniffer").str.replace("^","")
2424
lazy val wordpress = properties("wp-coding-standards/wpcs").str.replace("^","")
2525
lazy val vaimoUK = properties("vaimo/uk-phpcs-standards").str.replace("^","")
26+
lazy val vaimo = properties("vaimo/phpcs-rulesets").str.replace("^","")
2627
}
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
2+
package codacy.codesniffer.docsgen.parsers
3+
4+
import codacy.codesniffer.docsgen.VersionsHelper
5+
import scala.util.matching.Regex
6+
7+
import better.files.File
8+
import com.codacy.plugins.api.results.Pattern
9+
10+
import scala.annotation.nowarn
11+
12+
class VaimoParser extends DocsParser {
13+
14+
override val repositoryURL = "https://bitbucket.org/vaimo/phpcs-rulesets"
15+
16+
override val checkoutCommit: String = VersionsHelper.vaimo
17+
18+
19+
override val sniffRegex: Regex = """.*(Vaimo)\/Sniffs\/(.*?)\/(.*?)Sniff.php""".r
20+
21+
@nowarn("msg=match may not be exhaustive")
22+
override def patternIdPartsFor(relativizedFilePath: String): PatternIdParts = {
23+
val sniffRegex(vaimoVersion, sniffType, patternName) = relativizedFilePath
24+
PatternIdParts(vaimoVersion, sniffType, patternName)
25+
}
26+
27+
override def descriptionWithDocs(rootDir: File,
28+
patternIdParts: PatternIdParts,
29+
patternFile: File
30+
): (Pattern.Description, Option[String]) = {
31+
(description(patternIdParts, rootDir),
32+
this.parseExtendedDescription("Vaimo\\Sniffs\\Custom", "Vaimo", patternIdParts, rootDir)
33+
)
34+
}
35+
36+
private[this] def description(patternIdParts: PatternIdParts, rootDir: File): Pattern.Description = {
37+
val caseRegexPattern = """((?<=\p{Ll})\p{Lu}|\p{Lu}(?=\p{Ll}))""".r
38+
val patternName = caseRegexPattern.replaceAllIn(patternIdParts.patternName, " $1").trim
39+
val sniffName = caseRegexPattern.replaceAllIn(patternIdParts.sniffType, " $1").trim
40+
val title = Pattern.Title(s"$sniffName: $patternName")
41+
val extended = this.parseDescription("Vaimo\\Sniffs\\Custom", "Vaimo", patternIdParts, rootDir)
42+
Pattern.Description(patternIdParts.patternId, title, extended, None, Set.empty)
43+
}
44+
}
45+
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Commenting: Type Hint
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Classes: Constant Declaration Order
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Classes: Object Instantiation
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Classes: Property Underscore
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Classes: Protected Member
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Classes: Undefined Property

0 commit comments

Comments
 (0)