From f45647a4d0c14ce365aed50607c455f135e3334a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9lio=20Rocha?= Date: Thu, 2 Oct 2025 14:55:00 +0100 Subject: [PATCH 1/2] [TCE-1399] change MagentoCSDocsParser to include the Magento2Framework patterns --- .gitignore | 5 ++- composer.json | 2 +- .../docsgen/parsers/MagentoCSDocsParser.scala | 2 +- .../Magento2Framework_Header_Copyright.md | 1 + ..._Header_CopyrightAnotherExtensionsFiles.md | 1 + ...gento2Framework_Header_CopyrightGraphQL.md | 1 + .../Magento2Framework_Header_License.md | 1 + docs/description/description.json | 20 ++++++++--- docs/patterns.json | 35 +++++++++++++++---- 9 files changed, 54 insertions(+), 14 deletions(-) create mode 100644 docs/description/Magento2Framework_Header_Copyright.md create mode 100644 docs/description/Magento2Framework_Header_CopyrightAnotherExtensionsFiles.md create mode 100644 docs/description/Magento2Framework_Header_CopyrightGraphQL.md create mode 100644 docs/description/Magento2Framework_Header_License.md diff --git a/.gitignore b/.gitignore index 1e6a825f..b6a76b22 100755 --- a/.gitignore +++ b/.gitignore @@ -26,4 +26,7 @@ phpstan.neon ###< phpunit/phpunit ### -composer.phar \ No newline at end of file +composer.phar + +#Ignore vscode AI rules +.github/instructions/codacy.instructions.md diff --git a/composer.json b/composer.json index 92bc0110..f8fc6f09 100644 --- a/composer.json +++ b/composer.json @@ -6,7 +6,7 @@ "doctrine/coding-standard": "^12.0.0", "drupal/coder": "^8.3.24", "escapestudios/symfony2-coding-standard": "^3.13.0", - "magento/magento-coding-standard": "32.0", + "magento/magento-coding-standard": "38.0", "magento/marketplace-eqp": "^4.0.0", "pheromone/phpcs-security-audit": "^2.0.1", "phpcompatibility/php-compatibility": "9.3.5", diff --git a/doc-generator/src/main/scala/codacy/codesniffer/docsgen/parsers/MagentoCSDocsParser.scala b/doc-generator/src/main/scala/codacy/codesniffer/docsgen/parsers/MagentoCSDocsParser.scala index dde5e317..3f2b53f0 100644 --- a/doc-generator/src/main/scala/codacy/codesniffer/docsgen/parsers/MagentoCSDocsParser.scala +++ b/doc-generator/src/main/scala/codacy/codesniffer/docsgen/parsers/MagentoCSDocsParser.scala @@ -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 = { diff --git a/docs/description/Magento2Framework_Header_Copyright.md b/docs/description/Magento2Framework_Header_Copyright.md new file mode 100644 index 00000000..c9ef4555 --- /dev/null +++ b/docs/description/Magento2Framework_Header_Copyright.md @@ -0,0 +1 @@ +Header: Copyright diff --git a/docs/description/Magento2Framework_Header_CopyrightAnotherExtensionsFiles.md b/docs/description/Magento2Framework_Header_CopyrightAnotherExtensionsFiles.md new file mode 100644 index 00000000..c0b6d4fa --- /dev/null +++ b/docs/description/Magento2Framework_Header_CopyrightAnotherExtensionsFiles.md @@ -0,0 +1 @@ +Header: Copyright Another Extensions Files diff --git a/docs/description/Magento2Framework_Header_CopyrightGraphQL.md b/docs/description/Magento2Framework_Header_CopyrightGraphQL.md new file mode 100644 index 00000000..8eeb485c --- /dev/null +++ b/docs/description/Magento2Framework_Header_CopyrightGraphQL.md @@ -0,0 +1 @@ +Header: Copyright Graph QL diff --git a/docs/description/Magento2Framework_Header_License.md b/docs/description/Magento2Framework_Header_License.md new file mode 100644 index 00000000..eae2760e --- /dev/null +++ b/docs/description/Magento2Framework_Header_License.md @@ -0,0 +1 @@ +Header: License diff --git a/docs/description/description.json b/docs/description/description.json index 40601ad2..77cf1ef3 100644 --- a/docs/description/description.json +++ b/docs/description/description.json @@ -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", @@ -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", diff --git a/docs/patterns.json b/docs/patterns.json index 035b34a7..ccc590b8 100644 --- a/docs/patterns.json +++ b/docs/patterns.json @@ -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", @@ -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", From c2abb64b3d6697f51e220d44b8bc52638e790bd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9lio=20Rocha?= Date: Thu, 2 Oct 2025 15:16:23 +0100 Subject: [PATCH 2/2] revert magento2 to 32 --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index f8fc6f09..92bc0110 100644 --- a/composer.json +++ b/composer.json @@ -6,7 +6,7 @@ "doctrine/coding-standard": "^12.0.0", "drupal/coder": "^8.3.24", "escapestudios/symfony2-coding-standard": "^3.13.0", - "magento/magento-coding-standard": "38.0", + "magento/magento-coding-standard": "32.0", "magento/marketplace-eqp": "^4.0.0", "pheromone/phpcs-security-audit": "^2.0.1", "phpcompatibility/php-compatibility": "9.3.5",