feat(PSR12): стандарт наследуется от PSR12, обновлена документация

Nick Feting · Nick Feting · commit 00054dee1a05 · 2023-06-20T11:33:17.000+03:00
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -0,0 +1,16 @@
+<?php
+
+return (new PhpCsFixer\Config())
+    ->setUsingCache(false)
+    ->setRules([
+        '@PSR12'                 => true,
+        'indentation_type'       => true,
+        '@PhpCsFixer'            => true,
+        'array_syntax'           => [
+            'syntax' => 'short',
+        ],
+        'binary_operator_spaces' => [],
+        'braces'                 => [
+            'position_after_functions_and_oop_constructs' => 'same',
+        ],
+    ]);
diff --git a/.php_cs b/.php_cs
diff --git a/README.md b/README.md
@@ -1,20 +1,26 @@
-# Webpractik PHP Code standarts
+# Webpractik PHP Code standards
+
+Стандарт наследуется от [@PSR-12](https://www.php-fig.org/psr/psr-12/) ([рус](https://github.com/MiklyxoMaklai/rus-PSR/blob/master/accepted/psr-12.md)) за исключением:
 
-Стандарт наследуется от [@PSR-2](http://www.php-fig.org/psr/psr-2/) ([рус](https://svyatoslav.biz/misc/psr_translation/#_PSR-2)) за исключением:
 - Длина строки (шаблоны в Bitrix сложно валидировать)
-- Отключение требования не использовать пользовательский код вместе с классами (в Bitrix нужно порой вызывать модуль или компонент перед определением класса в связи со своей системой autoload)
+- Отключение требования не использовать пользовательский код вместе с классами (в Bitrix нужно порой вызывать модуль или компонент перед определением класса в связи со своей
+  системой autoload)
 
 Репозиторий содержит в себе
+
 1. Стандарт для [phpcs](https://github.com/squizlabs/PHP_CodeSniffer)
 2. Конфиг для [php-cs-fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer)
 
 ## Установка
-Устанавливаем глобально в систему. Не забываем что у вас в систем должен быть прописан path к [/vendor/bin/](https://github.com/webpractik/phpcs/blob/master/doc/linux-vendor.md).
+
+Устанавливаем глобально в систему. Не забываем что у вас в системе должен быть прописан path к [/vendor/bin/](https://github.com/webpractik/phpcs/blob/master/doc/linux-vendor.md).
+
 ```bash
 composer global require webpractik/php_code_style
 ```
 
 Устанавливаем путь к стандарту по умолчанию для phpcs
+
 ```bash
 # linux
 phpcs --config-set installed_paths "$HOME/.config/composer/vendor/webpractik/php_code_style"
@@ -25,10 +31,13 @@ phpcs --config-set installed_paths $HOME/.composer/vendor/webpractik/php_code_st
 # windows
 phpcs --config-set installed_paths "~/AppData/Roaming/Composer/vendor/webpractik/php_code_style"
 ```
+
 Если вы правильно сделали, то при наборе в консоли `phpcs -i` у вам должен появиться стандарт Webpractik среди прочих.
 
-Примечание: в windows иногда может некорректно на ~ реагировать, и прийдется прописать полный путь к файлу. Также может быть проблема если у вас в имени есть пробел. Решается симлинком.
+Примечание: в windows иногда может некорректно реагировать на '~', и прийдется прописать полный путь к файлу. Также может быть проблема если у вас в имени есть пробел. Решается
+симлинком.
 
 ## Настройка редакторов
+
 - [phpstorm](https://github.com/webpractik/phpcs/blob/master/doc/phpstorm.md)
 - [sublime-text](https://github.com/webpractik/phpcs/blob/master/doc/sublime.md)
diff --git a/Webpractik/ruleset.xml b/Webpractik/ruleset.xml
@@ -1,12 +1,12 @@
 <?xml version="1.0"?>
 <ruleset name="Webpractik">
-	<description>The Webpractik Bitrix coding standard.</description>
+    <description>The Webpractik Bitrix coding standard.</description>
 
-	<rule ref="PSR2">
-		<!-- Bitrix: даем возможность в компонентах подключать компоненты и модули вне класса -->
-		<exclude name="PSR1.Files.SideEffects"/>
+    <rule ref="PSR12">
+        <!-- Bitrix: даем возможность в компонентах подключать компоненты и модули вне класса -->
+        <exclude name="PSR1.Files.SideEffects"/>
 
-		<!-- Отключаем проверку длины строки =( -->
-		<exclude name="Generic.Files.LineLength"/>
-	</rule>
+        <!-- Отключаем проверку длины строки =( -->
+        <exclude name="Generic.Files.LineLength"/>
+    </rule>
 </ruleset>
diff --git a/composer.json b/composer.json
@@ -13,5 +13,5 @@
         "squizlabs/php_codesniffer": "3.*",
         "friendsofphp/php-cs-fixer": "*"
     },
-    "version": "1.1"
+    "version": "1.2"
 }
diff --git a/doc/phpstorm.md b/doc/phpstorm.md
@@ -1,30 +1,56 @@
-1. Открываем настройки ctrl+alt+S
-2. Фильтруем настройки введя "sniffer"
-3. В разделе ```Language => PHP => Code Sniffer```
-    - Выбираем local и указываем путь к бинарнику phpstorm, проверив корректность нажав validate.
+## PHP_CodeSniffer
 
+1. В разделе ```File | Settings | PHP | Quality Tools | PHP_CodeSniffer | Configuration```
+    - Выбираем CLI Interpreter с необходимой версий PHP
+    - PHP_CodeSniffer path указываем путь к бинарнику phpstorm, проверив корректность нажав validate.
     ```bash
     #Пример пути для linux
     /home/north/.config/composer/vendor/bin/phpcs
     ```
-4. В разделе ```Editor => Inspections => PHP => PHP Code Sniffer validation```
-    - устанавливаем галочки активируя проверку
+    - PHP Code Beautifier and Fixer Settings указываем путь к бинарнику
+    ```bash
+    #Пример пути для linux
+    /home/north/.config/composer/vendor/bin/phpcbf
+    ```
+
+2. В разделе ```File | Settings | PHP | Quality Tools | PHP_CodeSniffer```
+    - Включаем настройку
+    - Указываем Coding standard "Webpractik", если установили путь к стандарту по умолчанию, либо п.3
+
+3. (Если не настроен п.2) В разделе ```File | Settings | PHP | Quality Tools | PHP_CodeSniffer```
     - Выбираем Custom в выпадающем списке и прописываем путь к xml файлу
 
     ```bash
     #Пример пути для linux
     /home/north/.config/composer/vendor/webpractik/php_code_style/Webpractik/ruleset.xml
     ```
 
-5. Если хотим исключить какие блоки кода из проверки (например ядро CMS)
+4. Если хотим исключить какие блоки кода из проверки (например ядро CMS)
     - В настройках открываем Appearance => scopes
-    - Выбираем папку которую хотим исключить и нажимаем Exclude Recursively, называем наш scope например public
+    - Выбираем папку, которую хотим исключить, и нажимаем Exclude Recursively, называем наш scope например public
     - В разделе ```Editor => Inspections => PHP => PHP Code Sniffer validation```
-    
-        Нажимаем ```"+"``` и выбираем наш новый scope. Старый Everywhere отключаем, сняв галку.
-    
-        Теперь если вы зайдете в файлы ядра не следующему стандарту у вас не будет все гореть красным от подсветок.
-        
-        Пример настройки:
-        
-        ![Пример настройки](https://w6p.ru/MmU4Zj.png)
+
+      Нажимаем ```"+"``` и выбираем наш новый scope. Старый Everywhere отключаем, сняв галку.
+
+      Теперь если вы зайдете в файлы ядра, не следующему стандарту, у вас не будет все гореть красным от подсветок.
+
+      Пример настройки:
+
+      ![Пример настройки](https://w6p.ru/MmU4Zj.png)
+
+## PHP_CodeSniffer
+
+1. В разделе ```File | Settings | PHP | Quality Tools | PHP CS Fixer | Configuration```
+    - PHP CS Fixer path указываем путь к бинарнику phpstorm, проверив корректность нажав validate.
+    ```bash
+    #Пример пути для linux
+    /home/north/.config/composer/vendor/bin/php-cs-fixer
+    ```
+2. В разделе ```File | Settings | PHP | Quality Tools | PHP CS Fixer | Options```
+    - Ruleset: Custom
+    - Path указываем путь к конфигурации текущей библиотеки
+    ```bash
+    #Пример пути для linux
+    /home/north/.config/composer/vendor/webpractik/php_code_style/.php-cs-fixer.php
+    ```
+    - Включаем настройку
diff --git a/doc/sublime.md b/doc/sublime.md
@@ -1,22 +1,21 @@
 Устанавливаем [sublime-phpcs](http://benmatselby.github.io/sublime-phpcs/)
 
 Пример конфига для windows:
+
 ```json
 {
-	"show_debug": false,
-
-	"phpcs_executable_path": "~/AppData/Roaming/Composer/vendor/bin/phpcs.bat",
-	"phpcs_execute_on_save": true,
-	"phpcs_additional_args": {
-		"--standard": "Webpractik",
-		"-n": ""
-	},
-
-	"php_cs_fixer_executable_path": "~/AppData/Roaming/Composer/vendor/bin/php-cs-fixer.bat",
-	"php_cs_fixer_on_save": false,
-	"php_cs_fixer_additional_args": {
-		"--config": "~/AppData/Roaming/Composer/vendor/webpractik/php_code_style/.php_cs"
-	},
+    "show_debug": false,
+    "phpcs_executable_path": "~/AppData/Roaming/Composer/vendor/bin/phpcs.bat",
+    "phpcs_execute_on_save": true,
+    "phpcs_additional_args": {
+        "--standard": "Webpractik",
+        "-n": ""
+    },
+    "php_cs_fixer_executable_path": "~/AppData/Roaming/Composer/vendor/bin/php-cs-fixer.bat",
+    "php_cs_fixer_on_save": false,
+    "php_cs_fixer_additional_args": {
+        "--config": "~/AppData/Roaming/Composer/vendor/webpractik/php_code_style/.php-cs-fixer.php"
+    }
 }
 ````
 

Original file line number	Diff line number	Diff line change
`@@ -13,5 +13,5 @@`
`13`	`13`	`"squizlabs/php_codesniffer": "3.*",`
`14`	`14`	`"friendsofphp/php-cs-fixer": "*"`
`15`	`15`	`},`
`16`		`- "version": "1.1"`
	`16`	`+ "version": "1.2"`
`17`	`17`	`}`