Fix phpdoc, update README.md, clean tests, and update styleci.yml…

… configuration. (#7)
yii3-extensions · Jan 23, 2024 · af42eaf · af42eaf
1 parent c175b48
commit af42eaf
Show file tree

Hide file tree

Showing 41 changed files with 280 additions and 116 deletions.
diff --git a/.styleci.yml b/.styleci.yml
@@ -17,9 +17,11 @@ enabled:
   - combine_nested_dirname
   - declare_strict_types
   - dir_constant
+  - empty_loop_body_braces
   - fully_qualified_strict_types
   - function_to_constant
   - hash_to_slash_comment
+  - integer_literal_case
   - is_null
   - logical_operators
   - magic_constant_casing
@@ -56,7 +58,6 @@ enabled:
   - phpdoc_order
   - phpdoc_property
   - phpdoc_scalar
-  - phpdoc_separation
   - phpdoc_singular_inheritdoc
   - phpdoc_trim
   - phpdoc_trim_consecutive_blank_line_separation
@@ -78,9 +79,9 @@ enabled:
   - trailing_comma_in_multiline_array
   - unalign_double_arrow
   - unalign_equals
-  - empty_loop_body_braces
-  - integer_literal_case
   - union_type_without_spaces
 
 disabled:
   - function_declaration
+  - psr12_braces
+  - psr12_class_definition
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,9 @@
 Change Log
 ==========
 
-## 0.1.1 Under development
+## 0.1.1 January 23, 2024
+
+- Bug #7: Fix phpdoc, update `README.md`, clean tests, and update `styleci.yml` configuration (@terabytesoftw)
 
 ## 0.1.0 January 21, 2024
 

diff --git a/composer.json b/composer.json
@@ -42,11 +42,11 @@
         "sort-packages": true
     },
     "extra": {
-        "config-plugin-options": {
-            "source-directory": "config"
-        },
         "config-plugin": {
             "params": "yiisoft-aliases.php"
+        },
+        "config-plugin-options": {
+            "source-directory": "config"
         }
     },
     "scripts": {

diff --git a/docs/README.md b/docs/README.md
@@ -1,7 +1,10 @@
 ## Using assets
 
-Assets are files that are not processed by Webpack. They are copied directly to the output folder. This includes images,
-fonts, and any other files that you want to use in your project.
+Assets are files that Webpack does not process.
+
+They are copied directly to the output folder.
+
+This includes images, fonts, and any other files that you want to use in your project.
 
 To use an asset, you need to import it from JavaScript or CSS.
 
@@ -21,7 +24,7 @@ use Yii\Asset\Css\FontAwesome;
  * @var \Yiisoft\Assets\AssetManager $assetManager
  */
 
-// Register the asset bundle with a asset manager component.
+// Register the asset bundle with an asset manager component.
 $assetManager->register(FontAwesome::class);
 
 // Set parameters for the registered asset bundle a view component.
@@ -32,7 +35,7 @@ $this->addJsStrings($assetManager->getJsStrings());
 $this->addJsVars($assetManager->getJsVars());
 ```
 
-Also you can register the asset bundle via container configuration:
+Also, you can register the asset bundle via container configuration:
 
 ```php
 file: ./config/params.php

diff --git a/docs/testing.md b/docs/testing.md
@@ -10,6 +10,11 @@ To run the checker, execute the following command:
 composer run check-dependencies
 ```
 
+## Easy coding standard
+
+The code is checked with [Easy Coding Standard](https://github.com/easy-coding-standard/easy-coding-standard) and
+[PHP CS Fixer](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer). To run it:
+
 ## Mutation testing
 
 Mutation testing is checked with [Infection](https://infection.github.io/). To run it:

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,24 +1,24 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.2/phpunit.xsd"
-    bootstrap="tests/Support/bootstrap.php"
-    cacheDirectory=".phpunit.cache"
-    colors="true"
-    executionOrder="depends,defects"
-    failOnRisky="true"
-    failOnWarning="true"
-    stopOnFailure="false"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.2/phpunit.xsd"
+  bootstrap="tests/Support/bootstrap.php"
+  cacheDirectory=".phpunit.cache"
+  colors="true"
+  executionOrder="depends,defects"
+  failOnRisky="true"
+  failOnWarning="true"
+  stopOnFailure="false"
 >
-    <testsuites>
-        <testsuite name="Asset-Fontawesome-Free">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
+  <testsuites>
+    <testsuite name="Asset-Fontawesome-Free">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
 
-    <source>
-        <include>
-            <directory suffix=".php">./src</directory>
-        </include>
-    </source>
+  <source>
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+  </source>
 </phpunit>
diff --git a/src/Css/Depend/DependCdn.php b/src/Css/Depend/DependCdn.php
@@ -6,6 +6,9 @@
 
 use Yiisoft\Assets\AssetBundle;
 
+/**
+ * FontAwesome CDN CSS bundle.
+ */
 final class DependCdn extends AssetBundle
 {
     public bool $cdn = true;

diff --git a/src/Css/FontAwesome.php b/src/Css/FontAwesome.php
@@ -7,6 +7,11 @@
 use Yiisoft\Assets\AssetBundle;
 use Yiisoft\Files\PathMatcher\PathMatcher;
 
+use function defined;
+
+/**
+ * FontAwesome CSS bundle.
+ */
 final class FontAwesome extends AssetBundle
 {
     public string|null $basePath = '@assets';
@@ -23,7 +28,7 @@ public function __construct()
 
         $this->css = [$cssFiles];
         $this->publishOptions = [
-            'filter' => $pathMatcher->only("**/css/{$cssFiles}", "**/{$fontAwesomeFile}", '**/webfonts/*'),
+            'filter' => $pathMatcher->only("**/css/$cssFiles", "**/$fontAwesomeFile", '**/webfonts/*'),
         ];
     }
 }
diff --git a/src/Css/FontAwesomeBrand.php b/src/Css/FontAwesomeBrand.php
@@ -7,6 +7,11 @@
 use Yiisoft\Assets\AssetBundle;
 use Yiisoft\Files\PathMatcher\PathMatcher;
 
+use function defined;
+
+/**
+ * FontAwesome brand CSS bundle.
+ */
 final class FontAwesomeBrand extends AssetBundle
 {
     public string|null $basePath = '@assets';
@@ -23,7 +28,7 @@ public function __construct()
 
         $this->css = [$cssFiles];
         $this->publishOptions = [
-            'filter' => $pathMatcher->only("**/css/{$cssFiles}", "**/{$fontAwesomeFile}", '**/webfonts/fa-brands*'),
+            'filter' => $pathMatcher->only("**/css/$cssFiles", "**/$fontAwesomeFile", '**/webfonts/fa-brands*'),
         ];
     }
 }
diff --git a/src/Css/FontAwesomeBrandCdn.php b/src/Css/FontAwesomeBrandCdn.php
@@ -6,6 +6,9 @@
 
 use Yiisoft\Assets\AssetBundle;
 
+/**
+ * FontAwesome brand CDN CSS bundle.
+ */
 final class FontAwesomeBrandCdn extends AssetBundle
 {
     public bool $cdn = true;

diff --git a/src/Css/FontAwesomeCdn.php b/src/Css/FontAwesomeCdn.php
@@ -6,6 +6,9 @@
 
 use Yiisoft\Assets\AssetBundle;
 
+/**
+ * FontAwesome all CDN CSS bundle.
+ */
 final class FontAwesomeCdn extends AssetBundle
 {
     public bool $cdn = true;

diff --git a/src/Css/FontAwesomeRegular.php b/src/Css/FontAwesomeRegular.php
@@ -7,6 +7,11 @@
 use Yiisoft\Assets\AssetBundle;
 use Yiisoft\Files\PathMatcher\PathMatcher;
 
+use function defined;
+
+/**
+ * FontAwesome regular CSS bundle.
+ */
 final class FontAwesomeRegular extends AssetBundle
 {
     public string|null $basePath = '@assets';

diff --git a/src/Css/FontAwesomeRegularCdn.php b/src/Css/FontAwesomeRegularCdn.php
@@ -6,6 +6,9 @@
 
 use Yiisoft\Assets\AssetBundle;
 
+/**
+ * FontAwesome regular CDN CSS bundle.
+ */
 final class FontAwesomeRegularCdn extends AssetBundle
 {
     public bool $cdn = true;

diff --git a/src/Css/FontAwesomeSolid.php b/src/Css/FontAwesomeSolid.php
@@ -7,6 +7,11 @@
 use Yiisoft\Assets\AssetBundle;
 use Yiisoft\Files\PathMatcher\PathMatcher;
 
+use function defined;
+
+/**
+ * FontAwesome solid CSS bundle.
+ */
 final class FontAwesomeSolid extends AssetBundle
 {
     public string|null $basePath = '@assets';
@@ -24,7 +29,7 @@ public function __construct()
 
         $this->css = [$cssFiles];
         $this->publishOptions = [
-            'filter' => $pathMatcher->only("**/css/{$cssFiles}", "**/{$fontAwesomeFile}", '**/webfonts/fa-solid*'),
+            'filter' => $pathMatcher->only("**/css/$cssFiles", "**/$fontAwesomeFile", '**/webfonts/fa-solid*'),
         ];
     }
 }
diff --git a/src/Css/FontAwesomeSolidCdn.php b/src/Css/FontAwesomeSolidCdn.php
@@ -6,6 +6,9 @@
 
 use Yiisoft\Assets\AssetBundle;
 
+/**
+ * FontAwesome solid CDN CSS bundle.
+ */
 final class FontAwesomeSolidCdn extends AssetBundle
 {
     public bool $cdn = true;

diff --git a/src/Js/Depend/DependCdn.php b/src/Js/Depend/DependCdn.php
@@ -6,6 +6,9 @@
 
 use Yiisoft\Assets\AssetBundle;
 
+/**
+ * FontAwesome CDN JS bundle.
+ */
 final class DependCdn extends AssetBundle
 {
     public bool $cdn = true;

diff --git a/src/Js/FontAwesome.php b/src/Js/FontAwesome.php
@@ -7,6 +7,11 @@
 use Yiisoft\Assets\AssetBundle;
 use Yiisoft\Files\PathMatcher\PathMatcher;
 
+use function defined;
+
+/**
+ * FontAwesome JS bundle.
+ */
 final class FontAwesome extends AssetBundle
 {
     public string|null $basePath = '@assets';
@@ -23,7 +28,7 @@ public function __construct()
 
         $this->js = [$jsFiles];
         $this->publishOptions = [
-            'filter' => $pathMatcher->only("**/js/{$jsFiles}", "**/{$fontAwesomeFile}", '**/webfonts/*'),
+            'filter' => $pathMatcher->only("**/js/$jsFiles", "**/$fontAwesomeFile", '**/webfonts/*'),
         ];
     }
 }
diff --git a/src/Js/FontAwesomeBrand.php b/src/Js/FontAwesomeBrand.php
@@ -7,6 +7,11 @@
 use Yiisoft\Assets\AssetBundle;
 use Yiisoft\Files\PathMatcher\PathMatcher;
 
+use function defined;
+
+/**
+ * FontAwesome brand JS bundle.
+ */
 final class FontAwesomeBrand extends AssetBundle
 {
     public string|null $basePath = '@assets';
@@ -24,7 +29,7 @@ public function __construct()
 
         $this->js = [$jsFiles];
         $this->publishOptions = [
-            'filter' => $pathMatcher->only("**/js/{$jsFiles}", "**/{$fontAwesomeFile}", '**/webfonts/fa-brands*'),
+            'filter' => $pathMatcher->only("**/js/$jsFiles", "**/$fontAwesomeFile", '**/webfonts/fa-brands*'),
         ];
     }
 }
diff --git a/src/Js/FontAwesomeBrandCdn.php b/src/Js/FontAwesomeBrandCdn.php
@@ -6,6 +6,9 @@
 
 use Yiisoft\Assets\AssetBundle;
 
+/**
+ * FontAwesome brand CDN JS bundle.
+ */
 final class FontAwesomeBrandCdn extends AssetBundle
 {
     public bool $cdn = true;

diff --git a/src/Js/FontAwesomeCdn.php b/src/Js/FontAwesomeCdn.php
@@ -6,6 +6,9 @@
 
 use Yiisoft\Assets\AssetBundle;
 
+/**
+ * FontAwesome all CDN JS bundle.
+ */
 final class FontAwesomeCdn extends AssetBundle
 {
     public bool $cdn = true;

diff --git a/src/Js/FontAwesomeRegular.php b/src/Js/FontAwesomeRegular.php
@@ -7,6 +7,11 @@
 use Yiisoft\Assets\AssetBundle;
 use Yiisoft\Files\PathMatcher\PathMatcher;
 
+use function defined;
+
+/**
+ * FontAwesome regular JS bundle.
+ */
 final class FontAwesomeRegular extends AssetBundle
 {
     public string|null $basePath = '@assets';
@@ -23,7 +28,7 @@ public function __construct()
 
         $this->js = [$jsFiles];
         $this->publishOptions = [
-            'filter' => $pathMatcher->only("**/js/{$jsFiles}", "**/{$fontAwesomeFile}", '**/webfonts/fa-regular*'),
+            'filter' => $pathMatcher->only("**/js/$jsFiles", "**/$fontAwesomeFile", '**/webfonts/fa-regular*'),
         ];
     }
 }
diff --git a/src/Js/FontAwesomeRegularCdn.php b/src/Js/FontAwesomeRegularCdn.php
@@ -6,6 +6,9 @@
 
 use Yiisoft\Assets\AssetBundle;
 
+/**
+ * FontAwesome regular CDN JS bundle.
+ */
 final class FontAwesomeRegularCdn extends AssetBundle
 {
     public bool $cdn = true;

diff --git a/src/Js/FontAwesomeSolid.php b/src/Js/FontAwesomeSolid.php
@@ -7,6 +7,11 @@
 use Yiisoft\Assets\AssetBundle;
 use Yiisoft\Files\PathMatcher\PathMatcher;
 
+use function defined;
+
+/**
+ * FontAwesome solid JS bundle.
+ */
 final class FontAwesomeSolid extends AssetBundle
 {
     public string|null $basePath = '@assets';
@@ -23,7 +28,7 @@ public function __construct()
 
         $this->js = [$jsFiles];
         $this->publishOptions = [
-            'filter' => $pathMatcher->only("**/{$jsFiles}", "**/{$fontAwesomeFile}", '**/webfonts/fa-solid*'),
+            'filter' => $pathMatcher->only("**/$jsFiles", "**/$fontAwesomeFile", '**/webfonts/fa-solid*'),
         ];
     }
 }