Initial commit of PHPStan unused class rule.

Author: ianef

.gitignore

@@ -1,52 +1,15 @@
-# Cache and logs (Symfony2)
-/app/cache/*
-/app/logs/*
-!app/cache/.gitkeep
-!app/logs/.gitkeep
-
-# Email spool folder
-/app/spool/*
-
-# Cache, session files and logs (Symfony3)
-/var/cache/*
-/var/logs/*
-/var/sessions/*
-!var/cache/.gitkeep
-!var/logs/.gitkeep
-!var/sessions/.gitkeep
-
-# Logs (Symfony4)
-/var/log/*
-!var/log/.gitkeep
-
-# Parameters
-/app/config/parameters.yml
-/app/config/parameters.ini
-
 # Managed by Composer
 /app/bootstrap.php.cache
 /var/bootstrap.php.cache
 /bin/*
 !bin/console
-!bin/symfony_requirements
 /vendor/
 
-# Assets and user uploads
-/web/bundles/
-/web/uploads/
-
 # PHPUnit
-/app/phpunit.xml
 /phpunit.xml
 
 # Build data
 /build/
 
 # Composer PHAR
 /composer.phar
-
-# Backup entities generated with doctrine:generate:entities command
-**/Entity/*~
-
-# Embedded web-server pid file
-/.web-server-pid

.phpunit.result.cache

@@ -0,0 +1 @@
+{"version":1,"defects":{"Xact\\PHPStan\\Tests\\UnusedClassRuleTest::testRule":3},"times":{"Xact\\PHPStan\\Tests\\UnusedClassRuleTest::testRule":1.244}}

.vscode/launch.json

@@ -0,0 +1,31 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+
+        {
+            "name": "Listen for Xdebug",
+            "type": "php",
+            "request": "launch",
+            "port": 9003,
+            "log": true
+        },
+        {
+            "name": "Launch currently open script",
+            "type": "php",
+            "request": "launch",
+            "program": "${file}",
+            "cwd": "${fileDirname}",
+            "port": 0,
+            "runtimeArgs": [
+                "-dxdebug.start_with_request=yes"
+            ],
+            "env": {
+                "XDEBUG_MODE": "debug,develop",
+                "XDEBUG_CONFIG": "client_port=${port}"
+            }
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "intelephense.environment.phpVersion": "8.2.5",
+    "terminal.integrated.env.linux": {
+        "PHP_VERSION": "82"
+    }
+}

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 X.act Systems
+Copyright (c) 2023 X.act Systems and Ian Foulds
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -0,0 +1,40 @@
+# A collection of PHPStan extensions
+
+This repo contains some useful PHPStan extension for detecting errors in your code. The currently list of rules is:
+  - ==UnusedClassRule==
+
+## Install
+
+```bash
+composer require xactsystems/phpstan-extensions --dev
+```
+
+
+## Usage
+
+With [PHPStan extension installer](https://github.com/phpstan/extension-installer), everything is ready to run.
+
+Otherwise manually enable the extension:
+```yaml
+# phpstan.neon
+include:
+    'vendor/xactsystems/phpstan-extensions/config/extension.neon'
+    
+```
+
+## Rules
+### UnusedClassRule
+This rule scans for class declarations and use statements. If a class is declared but not used within the scanned source files, an error is generated.
+
+#### Excluding files
+You can exclude directories and individual files from being scanned by this rule:
+
+```yaml
+# phpstan.neon
+parameters:
+    unused_classes:
+        - 'src/Entity'
+        - 'src/Controller'
+        - 'src/Repositories'
+        - 'src/MyUnusedClass.php'
+```

composer.json

@@ -0,0 +1,52 @@
+{
+    "name": "xactsystems/phpstan-extensions",
+    "description": "A collection of PHPStan extensions found useful in our projects.",
+    "type": "phpstan-extension",
+    "version": "1.0.0",
+    "keywords": [
+        "phpstan",
+        "static analysis"
+    ],
+    "repositories": [
+        {
+            "type": "path",
+            "url": "../phpstan-src"
+        }
+    ],
+    "require": {
+        "php": "^7.4 || ^8.0",
+        "webmozart/assert": "^1.11"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^9.6",
+        "xactsystems/phpstan-dev": "dev-master"
+    },
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "Xact\\PHPStan\\": "src/",
+            "Xact\\PHPStan\\Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+    },
+    "authors": [
+        {
+            "name": "Ian Foulds",
+            "email": "ianfoulds@x-act.co.uk"
+        }
+    ],
+    "config": {
+        "allow-plugins": {
+            "xactsystems/phpstan-dev": true
+        }
+    },
+    "extra": {
+        "phpstan": {
+            "includes": [
+                "config/extension.neon"
+            ]
+        }
+    },
+    "minimum-stability": "dev"
+}