Merge pull request #19 from n-peugnet/check-tools

Add phpstan and check composer script

.gitignore

@@ -1,3 +1,6 @@
+# editor files
+.vscode/*
+!.vscode/extensions.json
 
 ###> symfony/framework-bundle ###
 /.env.local
@@ -14,3 +17,4 @@
 .phpunit.result.cache
 /phpunit.xml
 ###< symfony/phpunit-bridge ###
+

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+    "recommendations": [
+        "felixfbecker.php-debug",
+        "bmewburn.vscode-intelephense-client",
+        "levacic.vscode-phpstan",
+        "st-pham.php-refactor-tool"
+    ]
+}

README.md

@@ -4,4 +4,10 @@ __G__ is the name of this __Sharable Network Tracker__.
 
 But it's kind of a temporary name.
 
-Alternatives names could be *Argali* or *Urial* as it refers to *Gazelle*, the main inspiration dor this project.
+Alternatives names could be *Argali* or *Urial* as it refers to *Gazelle*, the main inspiration dor this project.
+
+## Development
+
+### Run checks
+
+    composer check

build/console-loader.php

@@ -0,0 +1,9 @@
+<?php declare(strict_types = 1);
+
+use App\Kernel;
+use Symfony\Bundle\FrameworkBundle\Console\Application;
+use Symfony\Component\Dotenv\Dotenv;
+
+(new Dotenv())->bootEnv(dirname(__DIR__).'/.env');
+$kernel = new Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG']);
+return new Application($kernel);

composer.json

@@ -50,6 +50,10 @@
     },
     "require-dev": {
         "doctrine/doctrine-fixtures-bundle": "^3.4",
+        "phpstan/phpstan": "^0.12.65",
+        "phpstan/phpstan-deprecation-rules": "^0.12.6",
+        "phpstan/phpstan-phpunit": "^0.12.17",
+        "phpstan/phpstan-symfony": "^0.12.12",
         "symfony/browser-kit": "^5.2",
         "symfony/css-selector": "^5.2",
         "symfony/debug-bundle": "^5.2",
@@ -86,6 +90,19 @@
             "cache:clear": "symfony-cmd",
             "assets:install %PUBLIC_DIR%": "symfony-cmd"
         },
+        "check": [
+            "@phpstan",
+            "@check-symfony"
+        ],
+        "check-symfony": [
+            "@php bin/console --ansi lint:container",
+            "@php bin/console --ansi lint:twig",
+            "@php bin/console --ansi doctrine:schema:validate --skip-sync"
+        ],
+        "phpstan": [
+            "@php bin/console cache:warmup -q",
+            "phpstan analyse --ansi"
+        ],
         "post-install-cmd": [
             "@auto-scripts"
         ],

phpstan.neon

@@ -0,0 +1,16 @@
+includes:
+    - vendor/phpstan/phpstan-symfony/extension.neon
+    - vendor/phpstan/phpstan-symfony/rules.neon
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+    - vendor/phpstan/phpstan-deprecation-rules/rules.neon
+
+parameters:
+    level: 5
+    paths:
+        - src
+        - tests
+    excludes_analyse:
+        - vendor/*
+    symfony:
+        container_xml_path: var/cache/dev/App_KernelDevDebugContainer.xml
+        console_application_loader: build/console-loader.php

symfony.lock

@@ -139,6 +139,18 @@
     "phpdocumentor/type-resolver": {
         "version": "1.4.0"
     },
+    "phpstan/phpstan": {
+        "version": "0.12.65"
+    },
+    "phpstan/phpstan-deprecation-rules": {
+        "version": "0.12.6"
+    },
+    "phpstan/phpstan-phpunit": {
+        "version": "0.12.17"
+    },
+    "phpstan/phpstan-symfony": {
+        "version": "0.12.12"
+    },
     "psr/cache": {
         "version": "1.0.1"
     },