Merge pull request #76 from magento-commerce/imported-magento-magento-coding-standard-287

[Imported] Version 11 master update

Author: svera

.github/workflows/php.yml

@@ -25,6 +25,11 @@ jobs:
     name: Tests with PHP ${{ matrix.php-version }} and ${{ matrix.dependencies }} dependencies
 
     steps:
+    - name: Setup node
+      uses: actions/setup-node@v2
+      with:
+        node-version: '16'
+
     - uses: actions/checkout@v2
 
     - name: Setup PHP
@@ -34,6 +39,11 @@ jobs:
       env:
         COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+    - name: Install dependencies
+      run: npm install
+    - name: Run ESLint
+      run: npm run eslint -- eslint/rules
+
     - name: Validate composer
       run: composer validate
 

.gitignore

@@ -1,5 +1,6 @@
 /vendor/*
 /bin/*
+/node_modules
 
 # IDE files
 .idea/

Magento2/Sniffs/Html/HtmlSelfClosingTagsSniff.php

@@ -0,0 +1,84 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento2\Sniffs\Html;
+
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Files\File;
+
+/**
+ * Sniff for self-closing tags
+ */
+class HtmlSelfClosingTagsSniff implements Sniff
+{
+    /**
+     * List of void elements
+     *
+     * https://www.w3.org/TR/html51/syntax.html#writing-html-documents-elements
+     *
+     * @var string[]
+     */
+    private $voidElements = [
+        'area',
+        'base',
+        'br',
+        'col',
+        'embed',
+        'hr',
+        'img',
+        'input',
+        'keygen',
+        'link',
+        'menuitem',
+        'meta',
+        'param',
+        'source',
+        'track',
+        'wbr',
+    ];
+
+    /**
+     * @inheritDoc
+     */
+    public function register()
+    {
+        return [T_INLINE_HTML];
+    }
+
+    /**
+     * Detect use of self-closing tag with non-void html element
+     *
+     * @param File $phpcsFile
+     * @param int $stackPtr
+     * @return int|void
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        if ($stackPtr !== 0) {
+            return;
+        }
+        $html = $phpcsFile->getTokensAsString($stackPtr, count($phpcsFile->getTokens()));
+
+        if (empty($html)) {
+            return;
+        }
+
+        if (preg_match_all('$<(\w{2,})\s?[^<]*\/>$', $html, $matches, PREG_SET_ORDER)) {
+            foreach ($matches as $match) {
+                if (!in_array($match[1], $this->voidElements)) {
+                    $phpcsFile->addError(
+                        'Avoid using self-closing tag with non-void html element'
+                        . ' - "' . $match[0]  . PHP_EOL,
+                        null,
+                        'HtmlSelfClosingNonVoidTag'
+                    );
+                }
+            }
+        }
+    }
+}

Magento2/Sniffs/Legacy/InstallUpgradeSniff.php

@@ -0,0 +1,77 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types = 1);
+
+namespace Magento2\Sniffs\Legacy;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+use SplFileInfo;
+
+class InstallUpgradeSniff implements Sniff
+{
+    private const ERROR_CODE = 'obsoleteScript';
+
+    /**
+     * @var string[]
+     */
+    private $wrongPrefixes = [
+        'install-' => 'Install scripts are obsolete. '
+            . 'Please use declarative schema approach in module\'s etc/db_schema.xml file',
+        'InstallSchema' => 'InstallSchema scripts are obsolete. '
+            . 'Please use declarative schema approach in module\'s etc/db_schema.xml file',
+        'InstallData' => 'InstallData scripts are obsolete. '
+            . 'Please use data patches approach in module\'s Setup/Patch/Data dir',
+        'data-install-' => 'Install scripts are obsolete. Please create class InstallData in module\'s Setup folder',
+        'upgrade-' => 'Upgrade scripts are obsolete. '
+            . 'Please use declarative schema approach in module\'s etc/db_schema.xml file',
+        'UpgradeSchema' => 'UpgradeSchema scripts are obsolete. '
+            . 'Please use declarative schema approach in module\'s etc/db_schema.xml file',
+        'UpgradeData' => 'UpgradeSchema scripts are obsolete. '
+            . 'Please use data patches approach in module\'s Setup/Patch/Data dir',
+        'data-upgrade-' => 'Upgrade scripts are obsolete. '
+            . 'Please use data patches approach in module\'s Setup/Patch/Data dir',
+        'recurring' => 'Recurring scripts are obsolete. Please create class Recurring in module\'s Setup folder',
+    ];
+
+    /**
+     * @inheritdoc
+     */
+    public function register(): array
+    {
+        return [
+            T_OPEN_TAG
+        ];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        if ($stackPtr > 0) {
+            return;
+        }
+        
+        $fileInfo = new SplFileInfo($phpcsFile->getFilename());
+
+        foreach ($this->wrongPrefixes as $prefix => $errorMessage) {
+            if (strpos($fileInfo->getFilename(), $prefix) === 0) {
+                $phpcsFile->addError($errorMessage, 0, self::ERROR_CODE);
+            }
+        }
+
+        if (preg_match('/(sql|data)/', $fileInfo->getPath()) === 1) {
+            $phpcsFile->addError(
+                $fileInfo->getFilename()." is in an invalid directory ".$fileInfo->getPath().":\n"
+                . "- Create a data patch within module's Setup/Patch/Data folder for data upgrades.\n"
+                . "- Use declarative schema approach in module's etc/db_schema.xml file for schema changes.",
+                0,
+                self::ERROR_CODE
+            );
+        }
+    }
+}