Apply stricter coding standard (#435)

thephpleague · May 9, 2020 · 6ac414f · 6ac414f
1 parent d4d1b7d
commit 6ac414f
Show file tree

Hide file tree

Showing 300 changed files with 2,154 additions and 2,081 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 /.idea/
+/.phpcs-cache
 /build/
 /docs/_site/
 /docs/Gemfile.lock

diff --git a/.styleci.yml b/.styleci.yml
diff --git a/.travis.yml b/.travis.yml
@@ -26,6 +26,9 @@ jobs:
     - name: phpstan
       php: 7.2
       env: 'PHPSTAN=true'
+    - name: phpcs
+      php: 7.2
+      env: 'PHPCS=true'
     - name: rips
       php: 7.2
       env: 'RIPS=true'
@@ -59,6 +62,7 @@ install:
 
 script:
   - if [[ $PHPSTAN ]]; then vendor/bin/phpstan analyse; fi
+  - if [[ $PHPCS ]]; then vendor/bin/phpcs; fi
   - if [[ $PHPUNIT ]]; then vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover; fi
   - |
     if [[ $RIPS ]]; then

diff --git a/composer.json b/composer.json
@@ -33,7 +33,8 @@
         "phpstan/phpstan": "^0.12",
         "phpunit/phpunit": "^8.5",
         "scrutinizer/ocular": "^1.5",
-        "symfony/finder": "^4.2"
+        "symfony/finder": "^4.2",
+        "unleashedtech/php-coding-standard": "^2.1"
     },
     "conflict": {
         "scrutinizer/ocular": "1.7.*"

diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<ruleset>
+    <arg name="basepath" value="."/>
+    <arg name="extensions" value="php"/>
+    <arg name="parallel" value="80"/>
+    <arg name="cache" value=".phpcs-cache"/>
+    <arg name="colors"/>
+
+    <!-- Ignore warnings, show progress of the run and show sniff names -->
+    <arg value="nps"/>
+
+    <!-- Directories to be checked -->
+    <file>src</file>
+    <file>tests/unit</file>
+    <file>tests/functional</file>
+
+    <!-- Include full Unleashed Coding Standard -->
+    <rule ref="Unleashed"/>
+</ruleset>
diff --git a/src/CommonMarkConverter.php b/src/CommonMarkConverter.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the league/commonmark package.
  *
@@ -46,10 +48,9 @@ class CommonMarkConverter implements MarkdownConverterInterface
     /**
      * Create a new commonmark converter instance.
      *
-     * @param array<string, mixed>      $config
-     * @param EnvironmentInterface|null $environment
+     * @param array<string, mixed> $config
      */
-    public function __construct(array $config = [], EnvironmentInterface $environment = null)
+    public function __construct(array $config = [], ?EnvironmentInterface $environment = null)
     {
         if ($environment === null) {
             $environment = Environment::createCommonMarkEnvironment();
@@ -62,7 +63,7 @@ public function __construct(array $config = [], EnvironmentInterface $environmen
         $this->environment = $environment;
 
         $this->markdownParser = new MarkdownParser($environment);
-        $this->htmlRenderer = new HtmlRenderer($environment);
+        $this->htmlRenderer   = new HtmlRenderer($environment);
     }
 
     public function getEnvironment(): EnvironmentInterface
@@ -73,13 +74,11 @@ public function getEnvironment(): EnvironmentInterface
     /**
      * Converts CommonMark to HTML.
      *
-     * @param string $commonMark
-     *
-     * @throws \RuntimeException
+     * @param string $commonMark The Markdown to convert
      *
-     * @return string
+     * @return string Rendered HTML
      *
-     * @api
+     * @throws \RuntimeException
      */
     public function convertToHtml(string $commonMark): string
     {
@@ -93,11 +92,7 @@ public function convertToHtml(string $commonMark): string
      *
      * @see Converter::convertToHtml
      *
-     * @param string $commonMark
-     *
      * @throws \RuntimeException
-     *
-     * @return string
      */
     public function __invoke(string $commonMark): string
     {

diff --git a/src/Configuration/Configuration.php b/src/Configuration/Configuration.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the league/commonmark package.
  *
@@ -27,16 +29,25 @@ public function __construct(array $config = [])
         $this->config = $config;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function merge(array $config = []): void
     {
         $this->config = \array_replace_recursive($this->config, $config);
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function replace(array $config = []): void
     {
         $this->config = $config;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function get(?string $key = null, $default = null)
     {
         if ($key === null) {
@@ -48,13 +59,16 @@ public function get(?string $key = null, $default = null)
             return $this->getConfigByPath($key, $default);
         }
 
-        if (!isset($this->config[$key])) {
+        if (! isset($this->config[$key])) {
             return $default;
         }
 
         return $this->config[$key];
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function set(string $key, $value = null): void
     {
         // accept a/b/c as ['a']['b']['c']
@@ -66,17 +80,16 @@ public function set(string $key, $value = null): void
     }
 
     /**
-     * @param string      $keyPath
-     * @param string|null $default
+     * @param mixed|null $default
      *
      * @return mixed|null
      */
     private function getConfigByPath(string $keyPath, $default = null)
     {
         $keyArr = \explode('/', $keyPath);
-        $data = $this->config;
+        $data   = $this->config;
         foreach ($keyArr as $k) {
-            if (!\is_array($data) || !isset($data[$k])) {
+            if (! \is_array($data) || ! isset($data[$k])) {
                 return $default;
             }
 
@@ -87,19 +100,18 @@ private function getConfigByPath(string $keyPath, $default = null)
     }
 
     /**
-     * @param string      $keyPath
-     * @param string|null $value
+     * @param mixed|null $value
      */
     private function setByPath(string $keyPath, $value = null): void
     {
-        $keyArr = \explode('/', $keyPath);
+        $keyArr  = \explode('/', $keyPath);
         $pointer = &$this->config;
         while (($k = \array_shift($keyArr)) !== null) {
-            if (!\is_array($pointer)) {
+            if (! \is_array($pointer)) {
                 $pointer = [];
             }
 
-            if (!isset($pointer[$k])) {
+            if (! isset($pointer[$k])) {
                 $pointer[$k] = null;
             }
 

diff --git a/src/Configuration/ConfigurationAwareInterface.php b/src/Configuration/ConfigurationAwareInterface.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the league/commonmark package.
  *

diff --git a/src/Configuration/ConfigurationInterface.php b/src/Configuration/ConfigurationInterface.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the league/commonmark package.
  *
@@ -17,17 +19,13 @@ interface ConfigurationInterface
      * Merge an existing array into the current configuration
      *
      * @param array<string, mixed> $config
-     *
-     * @return void
      */
     public function merge(array $config = []): void;
 
     /**
      * Replace the entire array with something else
      *
      * @param array<string, mixed> $config
-     *
-     * @return void
      */
     public function replace(array $config = []): void;
 
@@ -36,8 +34,7 @@ public function replace(array $config = []): void;
      *
      * The key can be a string or a slash-delimited path to a nested value
      *
-     * @param string|null $key
-     * @param mixed|null  $default
+     * @param mixed|null $default
      *
      * @return mixed|null
      */
@@ -48,10 +45,7 @@ public function get(?string $key = null, $default = null);
      *
      * The key can be a string or a slash-delimited path to a nested value
      *
-     * @param string     $key
      * @param mixed|null $value
-     *
-     * @return void
      */
     public function set(string $key, $value = null): void;
 }
diff --git a/src/Delimiter/Delimiter.php b/src/Delimiter/Delimiter.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the league/commonmark package.
  *
@@ -48,24 +50,16 @@ final class Delimiter implements DelimiterInterface
     /** @var int|null */
     private $index;
 
-    /**
-     * @param string                  $char
-     * @param int                     $numDelims
-     * @param AbstractStringContainer $node
-     * @param bool                    $canOpen
-     * @param bool                    $canClose
-     * @param int|null                $index
-     */
     public function __construct(string $char, int $numDelims, AbstractStringContainer $node, bool $canOpen, bool $canClose, ?int $index = null)
     {
-        $this->char = $char;
-        $this->length = $numDelims;
+        $this->char           = $char;
+        $this->length         = $numDelims;
         $this->originalLength = $numDelims;
-        $this->inlineNode = $node;
-        $this->canOpen = $canOpen;
-        $this->canClose = $canClose;
-        $this->active = true;
-        $this->index = $index;
+        $this->inlineNode     = $node;
+        $this->canOpen        = $canOpen;
+        $this->canClose       = $canClose;
+        $this->active         = true;
+        $this->index          = $index;
     }
 
     public function canClose(): bool

diff --git a/src/Delimiter/DelimiterInterface.php b/src/Delimiter/DelimiterInterface.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 /*
  * This file is part of the league/commonmark package.
  *