Skip to content

Commit 8607675

Browse files
authored
[TCE-1399] change MagentoCSDocsParser to include the Magento2Framework patterns (#341)
* [TCE-1399] change MagentoCSDocsParser to include the Magento2Framework patterns * revert magento2 to 32
1 parent 79e1765 commit 8607675

8 files changed

Lines changed: 53 additions & 13 deletions

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,7 @@ phpstan.neon
2626
###< phpunit/phpunit ###
2727

2828

29-
composer.phar
29+
composer.phar
30+
31+
#Ignore vscode AI rules
32+
.github/instructions/codacy.instructions.md

doc-generator/src/main/scala/codacy/codesniffer/docsgen/parsers/MagentoCSDocsParser.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ class MagentoCSDocsParser extends DocsParser {
1313

1414
override val checkoutCommit: String = VersionsHelper.magentoCS
1515

16-
override val sniffRegex: Regex = """.*(Magento2)\/Sniffs\/(.*?)\/(.*?)Sniff.php""".r
16+
override val sniffRegex: Regex = """.*(Magento2(?:Framework)?)\/Sniffs\/(.*?)\/(.*?)Sniff.php""".r
1717

1818
@nowarn("msg=match may not be exhaustive")
1919
override def patternIdPartsFor(relativizedFilePath: String): PatternIdParts = {
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Header: Copyright
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Header: Copyright Another Extensions Files
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Header: Copyright Graph QL
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Header: License

docs/description/description.json

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,6 @@
4040
"patternId" : "CakePHP_Formatting_BlankLineBeforeReturn",
4141
"title" : "Formatting: Blank Line Before Return",
4242
"parameters" : [ ]
43-
}, {
44-
"patternId" : "CakePHP_Functions_ClosureDeclaration",
45-
"title" : "Functions: Closure Declaration",
46-
"parameters" : [ ]
4743
}, {
4844
"patternId" : "CakePHP_NamingConventions_ValidFunctionName",
4945
"title" : "Naming Conventions: Valid Function Name",
@@ -1038,6 +1034,22 @@
10381034
"patternId" : "MEQP1_Templates_XssTemplate",
10391035
"title" : "Templates: Xss Template",
10401036
"parameters" : [ ]
1037+
}, {
1038+
"patternId" : "Magento2Framework_Header_Copyright",
1039+
"title" : "Header: Copyright",
1040+
"parameters" : [ ]
1041+
}, {
1042+
"patternId" : "Magento2Framework_Header_CopyrightAnotherExtensionsFiles",
1043+
"title" : "Header: Copyright Another Extensions Files",
1044+
"parameters" : [ ]
1045+
}, {
1046+
"patternId" : "Magento2Framework_Header_CopyrightGraphQL",
1047+
"title" : "Header: Copyright Graph QL",
1048+
"parameters" : [ ]
1049+
}, {
1050+
"patternId" : "Magento2Framework_Header_License",
1051+
"title" : "Header: License",
1052+
"parameters" : [ ]
10411053
}, {
10421054
"patternId" : "Magento2_Annotation_MethodAnnotationStructure",
10431055
"title" : "Annotation: Method Annotation Structure",

docs/patterns.json

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,6 @@
7070
"parameters" : [ ],
7171
"languages" : [ ],
7272
"enabled" : false
73-
}, {
74-
"patternId" : "CakePHP_Functions_ClosureDeclaration",
75-
"level" : "Info",
76-
"category" : "CodeStyle",
77-
"parameters" : [ ],
78-
"languages" : [ ],
79-
"enabled" : false
8073
}, {
8174
"patternId" : "CakePHP_NamingConventions_ValidFunctionName",
8275
"level" : "Info",
@@ -1594,6 +1587,34 @@
15941587
"parameters" : [ ],
15951588
"languages" : [ ],
15961589
"enabled" : false
1590+
}, {
1591+
"patternId" : "Magento2Framework_Header_Copyright",
1592+
"level" : "Info",
1593+
"category" : "CodeStyle",
1594+
"parameters" : [ ],
1595+
"languages" : [ ],
1596+
"enabled" : false
1597+
}, {
1598+
"patternId" : "Magento2Framework_Header_CopyrightAnotherExtensionsFiles",
1599+
"level" : "Info",
1600+
"category" : "CodeStyle",
1601+
"parameters" : [ ],
1602+
"languages" : [ ],
1603+
"enabled" : false
1604+
}, {
1605+
"patternId" : "Magento2Framework_Header_CopyrightGraphQL",
1606+
"level" : "Info",
1607+
"category" : "CodeStyle",
1608+
"parameters" : [ ],
1609+
"languages" : [ ],
1610+
"enabled" : false
1611+
}, {
1612+
"patternId" : "Magento2Framework_Header_License",
1613+
"level" : "Info",
1614+
"category" : "CodeStyle",
1615+
"parameters" : [ ],
1616+
"languages" : [ ],
1617+
"enabled" : false
15971618
}, {
15981619
"patternId" : "Magento2_Annotation_MethodAnnotationStructure",
15991620
"level" : "Info",

0 commit comments

Comments
 (0)