Merge pull request #30 from noplanman/code_checks

Add PHP code sniffer and linter

Author: noplanman

CHANGELOG.md

@@ -5,6 +5,7 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
 
 ## [Unreleased]
 ### Added
+- Code checkers to ensure coding standard.
 ### Changed
 - Bumped Manager to 1.5.
 - Logging is now decoupled with custom Monolog logger.

commands/HelpCommand.php

@@ -13,6 +13,7 @@
 use Longman\TelegramBot\Commands\Command;
 use Longman\TelegramBot\Commands\UserCommand;
 use Longman\TelegramBot\Entities\ServerResponse;
+use Longman\TelegramBot\Exception\TelegramException;
 
 /**
  * User "/help" command
@@ -79,7 +80,7 @@ public function execute(): ServerResponse
             foreach ($user_commands as $user_command) {
                 $text .= '/' . $user_command->getName() . ' - ' . $user_command->getDescription() . PHP_EOL;
             }
-            if ($safe_to_show && \count($admin_commands) > 0) {
+            if ($safe_to_show && count($admin_commands) > 0) {
                 $text .= PHP_EOL . '*Admin Commands List*:' . PHP_EOL;
                 foreach ($admin_commands as $admin_command) {
                     $text .= '/' . $admin_command->getName() . ' - ' . $admin_command->getDescription() . PHP_EOL;
@@ -112,24 +113,25 @@ public function execute(): ServerResponse
      * Get all available User and Admin commands to display in the help list.
      *
      * @return Command[][]
+     * @throws TelegramException
      */
     protected function getUserAdminCommands(): array
     {
         // Only get enabled Admin and User commands that are allowed to be shown.
         /** @var Command[] $commands */
-        $commands = array_filter($this->telegram->getCommandsList(), function ($command) {
+        $commands = array_filter($this->telegram->getCommandsList(), static function ($command) {
             /** @var Command $command */
             return !$command->isSystemCommand() && $command->showInHelp() && $command->isEnabled();
         });
         ksort($commands);
 
-        $user_commands = array_filter($commands, function ($command) {
+        $user_commands = array_filter($commands, static function ($command) {
             /** @var Command $command */
             return $command->isUserCommand();
         });
         ksort($user_commands);
 
-        $admin_commands = array_filter($commands, function ($command) {
+        $admin_commands = array_filter($commands, static function ($command) {
             /** @var Command $command */
             return $command->isAdminCommand();
         });

commands/NewchatmembersCommand.php

@@ -14,6 +14,7 @@
 use Longman\TelegramBot\Entities\ChatMember;
 use Longman\TelegramBot\Entities\ServerResponse;
 use Longman\TelegramBot\Entities\User;
+use Longman\TelegramBot\Exception\TelegramException;
 use Longman\TelegramBot\Request;
 use TelegramBot\SupportBot\Helpers;
 
@@ -54,7 +55,7 @@ class NewchatmembersCommand extends SystemCommand
 
     /**
      * @inheritdoc
-     * @throws \Longman\TelegramBot\Exception\TelegramException
+     * @throws TelegramException
      */
     public function execute(): ServerResponse
     {
@@ -78,15 +79,15 @@ public function execute(): ServerResponse
      * @param array $new_users
      *
      * @return ServerResponse
-     * @throws \Longman\TelegramBot\Exception\TelegramException
+     * @throws TelegramException
      */
     private function refreshWelcomeMessage(array $new_users): ServerResponse
     {
         if (empty($new_users)) {
             return Request::emptyResponse();
         }
 
-        $new_users_text = implode(', ', array_map(function (User $new_user) {
+        $new_users_text = implode(', ', array_map(static function (User $new_user) {
             return '<a href="tg://user?id=' . $new_user->getId() . '">' . filter_var($new_user->getFirstName(), FILTER_SANITIZE_SPECIAL_CHARS) . '</a>';
         }, $new_users));
 
@@ -125,7 +126,7 @@ private function isUserAllowedToAddBot(): bool
         ])->getResult();
 
         if ($chat_member instanceof ChatMember) {
-            return \in_array($chat_member->getStatus(), ['creator', 'administrator'], true);
+            return in_array($chat_member->getStatus(), ['creator', 'administrator'], true);
         }
 
         return false;

commands/StartCommand.php

@@ -12,6 +12,7 @@
 
 use Longman\TelegramBot\Commands\SystemCommand;
 use Longman\TelegramBot\Entities\ServerResponse;
+use Longman\TelegramBot\Exception\TelegramException;
 
 /**
  * System "/start" command
@@ -45,7 +46,7 @@ class StartCommand extends SystemCommand
 
     /**
      * @inheritdoc
-     * @throws \Longman\TelegramBot\Exception\TelegramException
+     * @throws TelegramException
      */
     public function execute(): ServerResponse
     {

composer.json

@@ -27,9 +27,19 @@
         "elvanto/litemoji": "^1.4",
         "monolog/monolog": "^1.24"
     },
+    "require-dev": {
+        "squizlabs/php_codesniffer": "^3.4",
+        "jakub-onderka/php-parallel-lint": "^1.0"
+    },
     "autoload": {
         "psr-4": {
             "TelegramBot\\SupportBot\\": "src"
         }
+    },
+    "scripts": {
+        "check-code": [
+            "vendor/bin/parallel-lint . --exclude vendor",
+            "vendor/bin/phpcs"
+        ]
     }
 }

composer.lock

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<ruleset>
+    <arg value="snp"/>
+    <arg name="colors"/>
+    <arg name="extensions" value="php"/>
+
+    <file>.</file>
+    <exclude-pattern>*/vendor/*</exclude-pattern>
+
+    <rule ref="PSR12"/>
+</ruleset>

phpcs.xml.dist

@@ -18,6 +18,7 @@
 use Monolog\Logger;
 use Psr\Log\NullLogger;
 use TelegramBot\TelegramBotManager\BotManager;
+use Throwable;
 
 // Composer autoloader.
 require_once __DIR__ . '/../vendor/autoload.php';
@@ -58,15 +59,15 @@
     $bot->run();
 } catch (TelegramLogException $e) {
     // Silence... beautiful silence =)
-} catch (\Throwable $e) {
+} catch (Throwable $e) {
     TelegramLog::error($e->getMessage());
 }
 
 /**
  * Initialise the logging.
  *
  */
-function initLogging()
+function initLogging(): void
 {
     // Logging.
     $logging_paths = json_decode(getenv('TG_LOGGING'), true) ?? [];

public/manager.php

@@ -14,6 +14,7 @@
 use Github\Client;
 use Longman\TelegramBot\Entities\ServerResponse;
 use Longman\TelegramBot\Exception\TelegramException;
+use Longman\TelegramBot\Request;
 use Longman\TelegramBot\Telegram;
 use Longman\TelegramBot\TelegramLog;
 use Monolog\Formatter\LineFormatter;
@@ -63,7 +64,8 @@
  *
  * @param array $data
  */
-function handleRelease($data) {
+function handleRelease(array $data): void
+{
     $repo    = $data['repository'];
     $release = $data['release'];
     $action  = $data['action'];
@@ -96,7 +98,8 @@ function handleRelease($data) {
  *
  * @return string
  */
-function parseReleaseBody($body, $user, $repo) {
+function parseReleaseBody($body, $user, $repo): string
+{
     // Replace headers with bold text.
     $body = preg_replace_callback('~### (?<header>.*)~', static function ($matches) {
         return "*{$matches['header']}*";
@@ -142,7 +145,8 @@ function parseReleaseBody($body, $user, $repo) {
  *
  * @return ServerResponse|null
  */
-function sendTelegramMessage($chat_id, $text) {
+function sendTelegramMessage($chat_id, $text): ?ServerResponse
+{
     try {
         new Telegram(getenv('TG_API_KEY'));
 
@@ -153,7 +157,7 @@ function sendTelegramMessage($chat_id, $text) {
 
         $parse_mode = 'markdown';
 
-        return Longman\TelegramBot\Request::sendMessage(compact('chat_id', 'text', 'parse_mode'));
+        return Request::sendMessage(compact('chat_id', 'text', 'parse_mode'));
     } catch (TelegramException $e) {
         TelegramLog::error($e->getMessage());
     } catch (Throwable $e) {

public/webhooks/github.php

@@ -11,13 +11,15 @@
 
 namespace TelegramBot\SupportBot\Webhooks;
 
-class Utils {
+class Utils
+{
     /**
      * Log the incoming webhook data.
      *
      * @param string $path
      */
-    public static function logWebhookData($path): void {
+    public static function logWebhookData($path): void
+    {
         $f = fopen($path, 'ab+');
         fwrite($f, sprintf(
             "%s\ninput:  %s\nGET:    %s\nPOST:   %s\nSERVER: %s\n\n",