+ .phpcs.xml to use rule PSR12 instead of the default rule PEAR…

… and manually ignore `vendor` & `bootstrap/cache` when running `phpc{s,bf}` as it doesn't support `.gitignore`: squizlabs/PHP_CodeSniffer#2242 * add one space before self-closing tags @ phpunit.xml & psalm.xml * fix all violation of PHPStorm inspection `Unnecessary fully qualified name` $ ./vendor/bin/phpcbf . && ./vendor/bin/pint @ be
n0099 · Sep 15, 2024 · be5d95f · be5d95f
1 parent 37dbe24
commit be5d95f
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 28 deletions.
diff --git a/.github/workflows/be_base.yml b/.github/workflows/be_base.yml
@@ -14,10 +14,10 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/be
-        # https://github.com/staabm/annotate-pull-request-from-checkstyle
       - run: >
           ./vendor/bin/phpstan analyse --error-format=checkstyle
           | tee >(cs2pr --notices-as-warnings --graceful-warnings --prepend-filename --prepend-source)
+        # https://github.com/staabm/annotate-pull-request-from-checkstyle
         shell: bash
 
   psalm:
@@ -65,4 +65,5 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/be
-      - run: ./vendor/bin/phpmd . github cleancode,codesize,controversial,design,naming,unusedcode --exclude vendor # https://github.com/phpmd/phpmd/issues/506
+      # https://github.com/phpmd/phpmd/issues/506
+      - run: ./vendor/bin/phpmd . github cleancode,codesize,controversial,design,naming,unusedcode --exclude vendor
diff --git a/be/.phpcs.xml b/be/.phpcs.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<ruleset>
+    <rule ref="PSR12" />
+    <arg name="extensions" value="php" />
+    <exclude-pattern>*.blade.php</exclude-pattern>
+    <exclude-pattern>_ide_helper*.php</exclude-pattern>
+    <!-- https://github.com/squizlabs/PHP_CodeSniffer/issues/2242 -->
+    <exclude-pattern>vendor/*</exclude-pattern>
+    <exclude-pattern>bootstrap/cache/*</exclude-pattern>
+</ruleset>
diff --git a/be/app/Helper.php b/be/app/Helper.php
@@ -149,7 +149,8 @@ public static function jsonDecode(string $json, bool $assoc = true)
     }
 
     public static function xmlResponse(string|\Stringable $xml): \Illuminate\Http\Response
-    { // https://laracasts.com/discuss/channels/laravel/syntax-error-unexpected-identifier-version-1
+    {
+        // https://laracasts.com/discuss/channels/laravel/syntax-error-unexpected-identifier-version-1
         return response('<?xml version="1.0" encoding="UTF-8"?>' . "\n$xml")
             ->withHeaders(['Content-Type' => 'text/xml']);
     }

diff --git a/be/app/Http/Controllers/ThreadsSitemap.php b/be/app/Http/Controllers/ThreadsSitemap.php
@@ -13,7 +13,8 @@ class ThreadsSitemap extends Controller
     public static int $maxUrls = 50000;
 
     public function query(Http\Request $request, int $fid): Http\Response
-    { // https://stackoverflow.com/questions/59554777/laravel-how-to-set-default-value-in-validator-at-post-registeration/78707950#78707950
+    {
+        // https://stackoverflow.com/questions/59554777/laravel-how-to-set-default-value-in-validator-at-post-registeration/78707950#78707950
         ['cursor' => $cursor] = $request->validate([
             'cursor' => 'integer',
         ]) + ['cursor' => 0];

diff --git a/be/app/Http/PostsQuery/BaseQuery.php b/be/app/Http/PostsQuery/BaseQuery.php
@@ -362,7 +362,7 @@ public function reOrderNestedPosts(Collection $nestedPosts): array
          * @param string $childPostTypePluralName
          * @return Collection<int, Collection<string, mixed|Collection<int, Collection<string, mixed>>>>
          */
-        $setSortingKeyFromCurrentAndChildPosts = function (Collection $curPost, string $childPostTypePluralName): \Illuminate\Support\Collection {
+        $setSortingKeyFromCurrentAndChildPosts = function (Collection $curPost, string $childPostTypePluralName): Collection {
             /** @var Collection<int, Collection<string, mixed>> $childPosts sorted child posts */
             $childPosts = $curPost[$childPostTypePluralName];
             $curPost[$childPostTypePluralName] = $childPosts->values(); // reset keys
@@ -394,12 +394,12 @@ public function reOrderNestedPosts(Collection $nestedPosts): array
 
             return $curPost;
         };
-        $sortBySortingKey = fn(Collection $posts): \Illuminate\Support\Collection => $posts
+        $sortBySortingKey = fn(Collection $posts): Collection => $posts
             ->sortBy(fn(Collection $i) => $i['sortingKey'], descending: $this->orderByDesc);
         $removeSortingKey = /**
-         * @psalm-return \Illuminate\Support\Collection<array-key, \Illuminate\Support\Collection>
+         * @psalm-return Collection<array-key, Collection>
          */
-        static fn(Collection $posts): \Illuminate\Support\Collection => $posts
+        static fn(Collection $posts): Collection => $posts
             ->map(fn(Collection $i) => $i->except('sortingKey'));
         $ret = $removeSortingKey($sortBySortingKey(
             $nestedPosts->map(

diff --git a/be/app/Http/PostsQuery/IndexQuery.php b/be/app/Http/PostsQuery/IndexQuery.php
@@ -46,12 +46,10 @@ public function query(QueryParams $params, ?string $cursor): self
                         ->selectRaw("{$fid} AS fid, COUNT(*) AS count")
                         ->where($postIDName, $postID))
                 ->reduce(/**
-                 * @return \Illuminate\Contracts\Database\Query\Builder|\Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder
-                 *
-                 * @psalm-return \Illuminate\Contracts\Database\Query\Builder|\Illuminate\Database\Eloquent\Builder<\Illuminate\Database\Eloquent\Model>|\Illuminate\Database\Query\Builder
+                 * @return BuilderContract|EloquentBuilder|QueryBuilder
+                 * @psalm-return BuilderContract|EloquentBuilder<\Illuminate\Database\Eloquent\Model>|QueryBuilder
                  */
-                    static fn(?BuilderContract $acc, EloquentBuilder|QueryBuilder $cur): \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder|\Illuminate\Contracts\Database\Query\Builder =>
-                        $acc === null ? $cur : $acc->union($cur),
+                    static fn(?BuilderContract $acc, EloquentBuilder|QueryBuilder $cur): EloquentBuilder|QueryBuilder|BuilderContract => $acc === null ? $cur : $acc->union($cur),
                 )
                 ->get()
                 ->where('count', '!=', 0);

diff --git a/be/phpunit.xml b/be/phpunit.xml
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
          bootstrap="vendor/autoload.php"
@@ -18,16 +18,16 @@
         </include>
     </source>
     <php>
-        <env name="APP_ENV" value="testing"/>
-        <env name="APP_MAINTENANCE_DRIVER" value="file"/>
-        <env name="BCRYPT_ROUNDS" value="4"/>
-        <env name="CACHE_STORE" value="array"/>
-        <!-- <env name="DB_CONNECTION" value="sqlite"/> -->
-        <!-- <env name="DB_DATABASE" value=":memory:"/> -->
-        <env name="MAIL_MAILER" value="array"/>
-        <env name="PULSE_ENABLED" value="false"/>
-        <env name="QUEUE_CONNECTION" value="sync"/>
-        <env name="SESSION_DRIVER" value="array"/>
-        <env name="TELESCOPE_ENABLED" value="false"/>
+        <env name="APP_ENV" value="testing" />
+        <env name="APP_MAINTENANCE_DRIVER" value="file" />
+        <env name="BCRYPT_ROUNDS" value="4" />
+        <env name="CACHE_STORE" value="array" />
+        <!-- <env name="DB_CONNECTION" value="sqlite" /> -->
+        <!-- <env name="DB_DATABASE" value=":memory:" /> -->
+        <env name="MAIL_MAILER" value="array" />
+        <env name="PULSE_ENABLED" value="false" />
+        <env name="QUEUE_CONNECTION" value="sync" />
+        <env name="SESSION_DRIVER" value="array" />
+        <env name="TELESCOPE_ENABLED" value="false" />
     </php>
 </phpunit>
diff --git a/be/psalm.xml b/be/psalm.xml
@@ -9,12 +9,12 @@
     findUnusedCode="true"
 >
     <projectFiles>
-        <directory name="app"/>
+        <directory name="app" />
         <ignoreFiles>
-            <directory name="vendor"/>
+            <directory name="vendor" />
         </ignoreFiles>
     </projectFiles>
     <plugins>
-        <pluginClass class="Psalm\LaravelPlugin\Plugin"/>
+        <pluginClass class="Psalm\LaravelPlugin\Plugin" />
     </plugins>
 </psalm>