Skip to content

[TCE-1399] change MagentoCSDocsParser to include the Magento2Framework patterns #341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
heliocodacy merged 2 commits into from
Oct 2, 2025
Merged

[TCE-1399] change MagentoCSDocsParser to include the Magento2Framework patterns #341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f45647a
[TCE-1399] change MagentoCSDocsParser to include the Magento2Framewor…
heliocodacy Oct 2, 2025
c2abb64
revert magento2 to 32
heliocodacy Oct 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,7 @@ phpstan.neon
###< phpunit/phpunit ###


composer.phar
composer.phar

#Ignore vscode AI rules
.github/instructions/codacy.instructions.md
2 changes: 1 addition & 1 deletion doc-generator/src/main/scala/codacy/codesniffer/docsgen/parsers/MagentoCSDocsParser.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ class MagentoCSDocsParser extends DocsParser {

override val checkoutCommit: String = VersionsHelper.magentoCS

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

@nowarn("msg=match may not be exhaustive")
override def patternIdPartsFor(relativizedFilePath: String): PatternIdParts = {
Expand Down
1 change: 1 addition & 0 deletions docs/description/Magento2Framework_Header_Copyright.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Header: Copyright
1 change: 1 addition & 0 deletions docs/description/Magento2Framework_Header_CopyrightAnotherExtensionsFiles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Header: Copyright Another Extensions Files
1 change: 1 addition & 0 deletions docs/description/Magento2Framework_Header_CopyrightGraphQL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Header: Copyright Graph QL
1 change: 1 addition & 0 deletions docs/description/Magento2Framework_Header_License.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Header: License
20 changes: 16 additions & 4 deletions docs/description/description.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,6 @@
"patternId" : "CakePHP_Formatting_BlankLineBeforeReturn",
"title" : "Formatting: Blank Line Before Return",
"parameters" : [ ]
}, {
"patternId" : "CakePHP_Functions_ClosureDeclaration",
"title" : "Functions: Closure Declaration",
"parameters" : [ ]
}, {
"patternId" : "CakePHP_NamingConventions_ValidFunctionName",
"title" : "Naming Conventions: Valid Function Name",
Expand Down Expand Up @@ -1038,6 +1034,22 @@
"patternId" : "MEQP1_Templates_XssTemplate",
"title" : "Templates: Xss Template",
"parameters" : [ ]
}, {
"patternId" : "Magento2Framework_Header_Copyright",
"title" : "Header: Copyright",
"parameters" : [ ]
}, {
"patternId" : "Magento2Framework_Header_CopyrightAnotherExtensionsFiles",
"title" : "Header: Copyright Another Extensions Files",
"parameters" : [ ]
}, {
"patternId" : "Magento2Framework_Header_CopyrightGraphQL",
"title" : "Header: Copyright Graph QL",
"parameters" : [ ]
}, {
"patternId" : "Magento2Framework_Header_License",
"title" : "Header: License",
"parameters" : [ ]
}, {
"patternId" : "Magento2_Annotation_MethodAnnotationStructure",
"title" : "Annotation: Method Annotation Structure",
Expand Down
35 changes: 28 additions & 7 deletions docs/patterns.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,6 @@
"parameters" : [ ],
"languages" : [ ],
"enabled" : false
}, {
"patternId" : "CakePHP_Functions_ClosureDeclaration",
"level" : "Info",
"category" : "CodeStyle",
"parameters" : [ ],
"languages" : [ ],
"enabled" : false
}, {
"patternId" : "CakePHP_NamingConventions_ValidFunctionName",
"level" : "Info",
Expand Down Expand Up @@ -1594,6 +1587,34 @@
"parameters" : [ ],
"languages" : [ ],
"enabled" : false
}, {
"patternId" : "Magento2Framework_Header_Copyright",
"level" : "Info",
"category" : "CodeStyle",
"parameters" : [ ],
"languages" : [ ],
"enabled" : false
}, {
"patternId" : "Magento2Framework_Header_CopyrightAnotherExtensionsFiles",
"level" : "Info",
"category" : "CodeStyle",
"parameters" : [ ],
"languages" : [ ],
"enabled" : false
}, {
"patternId" : "Magento2Framework_Header_CopyrightGraphQL",
"level" : "Info",
"category" : "CodeStyle",
"parameters" : [ ],
"languages" : [ ],
"enabled" : false
}, {
"patternId" : "Magento2Framework_Header_License",
"level" : "Info",
"category" : "CodeStyle",
"parameters" : [ ],
"languages" : [ ],
"enabled" : false
}, {
"patternId" : "Magento2_Annotation_MethodAnnotationStructure",
"level" : "Info",
Expand Down