Disable useless phpunit doc block additions (#1)

* Disable useless phpunit doc block additions

* Configure github actions, add phpunit test, configure gitattributes

* Add phpunit version with php 7.4 support

---------

Co-authored-by: n.gnato <[email protected]>

Author: developerstudservis

.gitattributes

@@ -0,0 +1,4 @@
+/.gitignore  export-ignore
+/.github     export-ignore
+/tests       export-ignore
+/phpunit.xml export-ignore

.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: CI
+
+on: push
+
+jobs:
+  php-tests:
+
+    strategy:
+      matrix:
+        php:
+          - 7.4
+          - 8.0
+          - 8.1
+          - 8.2
+          - 8.3
+        prefer:
+          - lowest
+          - stable
+
+    name: Test on PHP ${{ matrix.php }} with ${{ matrix.prefer }} composer prefer option
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+
+      - name: Check PHP Version
+        run: php -v
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v4
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-${{ matrix.php }}-composer-${{ hashFiles('**/composer.json') }}-${{ matrix.prefer }}-
+          restore-keys: |
+            ${{ runner.os }}-php-${{ matrix.php }}-composer-${{ matrix.prefer }}-
+
+      - name: Install dependencies
+        if: steps.composer-cache.outputs.cache-hit != 'true'
+        run: composer update --prefer-${{ matrix.prefer }} --prefer-dist --no-progress
+
+      - name: Run tests
+        run: vendor/bin/phpunit

.gitignore

@@ -1,3 +1,5 @@
 /.idea/
 /vendor/
+
+/.phpunit.cache
 /composer.lock

composer.json

@@ -15,5 +15,8 @@
     "files": [
       "./src/config_builder.php"
     ]
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^9.6 | ^10.5"
   }
 }

phpunit.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheDirectory=".phpunit.cache"
+         executionOrder="depends,defects"
+         requireCoverageMetadata="false"
+         beStrictAboutCoverageMetadata="true"
+         beStrictAboutOutputDuringTests="true"
+         failOnRisky="true"
+         failOnWarning="true">
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <source restrictDeprecations="true" restrictNotices="true" restrictWarnings="true">
+        <include>
+            <directory>src</directory>
+        </include>
+    </source>
+</phpunit>

src/rules.php

@@ -39,6 +39,10 @@
     'no_break_comment'                                 => false,
     'no_superfluous_phpdoc_tags'                       => true,
     'nullable_type_declaration_for_default_null_value' => true,
+
+    'php_unit_test_class_requires_covers' => false,
+    'php_unit_internal_class' => false,
+
     'ordered_class_elements'                           => ['order' => [
         'use_trait',
         'case',

tests/config_builderTest.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace StudService\PhpCsFixerTests;
+
+use PhpCsFixer\Finder;
+use PHPUnit\Framework\TestCase;
+use function StudService\PhpCsFixer\build_config;
+
+class config_builderTest extends TestCase
+{
+    public function test_build_config()
+    {
+        $config = build_config(new Finder());
+
+        $this->assertFalse($config->getRiskyAllowed());
+        $this->assertSame("\n", $config->getLineEnding());
+    }
+}