create psalm plugin

Author: azjezz

Diff for: .github/workflows/code-coverage.yml

@@ -15,9 +15,3 @@
 
 # php-cs-fixer cache
 .php_cs.cache
-
-# phpunit cache
-.phpunit.result.cache
-
-# test logs
-/tests/logs/*

Diff for: .github/workflows/security-analysis.yml

@@ -5,7 +5,6 @@ return PhpCsFixer\Config::create()
         \Symfony\Component\Finder\Finder::create()
             ->in([
                 __DIR__ . '/src',
-                __DIR__ . '/tests',
             ])
     )
     ->setRiskyAllowed(true)

Diff for: .github/workflows/unit-tests.yml

@@ -4,7 +4,6 @@
     <description>The coding standard for PHP Standard Library.</description>
 
     <file>src</file>
-    <file>tests</file>
 
     <arg name="basepath" value="."/>
     <arg name="colors"/>

Diff for: .gitignore

@@ -1,21 +1,62 @@
-# Repository Template
+# PSL Psalm Plugin
 
-![Unit tests status](https://github.com/php-standard-library/repository-template/workflows/unit%20tests/badge.svg)
-![Static analysis status](https://github.com/php-standard-library/repository-template/workflows/static%20analysis/badge.svg)
-![Security analysis status](https://github.com/php-standard-library/repository-template/workflows/security%20analysis/badge.svg)
-![Coding standards status](https://github.com/php-standard-library/repository-template/workflows/coding%20standards/badge.svg)
-[![Type Coverage](https://shepherd.dev/github/php-standard-library/repository-template/coverage.svg)](https://shepherd.dev/github/php-standard-library/repository-template)
+![Static analysis status](https://github.com/php-standard-library/psalm-plugin/workflows/static%20analysis/badge.svg)
+[![Type Coverage](https://shepherd.dev/github/php-standard-library/psalm-plugin/coverage.svg)](https://shepherd.dev/github/php-standard-library/psalm-plugin)
+[![Total Downloads](https://poser.pugx.org/php-standard-library/psalm-plugin/d/total.svg)](https://packagist.org/packages/php-standard-library/psalm-plugin)
+[![Latest Stable Version](https://poser.pugx.org/php-standard-library/psalm-plugin/v/stable.svg)](https://packagist.org/packages/php-standard-library/psalm-plugin)
+[![License](https://poser.pugx.org/php-standard-library/psalm-plugin/license.svg)](https://packagist.org/packages/php-standard-library/psalm-plugin)
+
+## Installation
+
+Supported installation method is via [composer](https://getcomposer.org):
+
+```shell
+composer install php-standard-library/psalm-plugin --dev
+```
+
+## Usage
+
+To enable the plugin, add the `Psl\Psalm\Plugin` class to your psalm configuration using `psalm-plugin` binary as follows:
+
+```shell
+php vendor/bin/psalm-plugin enable php-standard-library/psalm-plugin
+```
+
+## Type improvements
+
+Given the following example:
+
+```php
+use Psl\Type;
+
+$specification = Type\shape([
+  'name' => Type\string(),
+  'age' => Type\int(),
+  'location' => Type\optional(Type\shape([
+    'city' => Type\string(),
+    'state' => Type\string(),
+    'country' => Type\string(),
+  ]))
+]);
+
+$input = $specification->coerce($_GET['user']);
+
+/** @psalm-trace $input */
+```
+
+Psalm assumes that `$input` is of type `array<"age"|"location"|"name", array<"city"|"country"|"state", string>|int|string>`.
+
+If we enable the `php-standard-library/psalm-plugin` plugin, you will get a more specific
+and correct type of `array{name: string, age: int, location?: array{city: string, state: string, country: string}}`.
 
 ## Sponsors
 
 Thanks to our sponsors and supporters:
 
-
 | JetBrains |
 |---|
 | <a href="https://www.jetbrains.com/?from=PSL ( PHP Standard Library )" title="JetBrains" target="_blank"><img src="https://res.cloudinary.com/azjezz/image/upload/v1599239910/jetbrains_qnyb0o.png" height="120" /></a> |
 
-
 ## License
 
 The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.

Diff for: .php_cs.dist

@@ -1,7 +1,7 @@
 {
-    "name": "php-standard-library/repository-template",
-    "description": "PHP Standard Library: Repository Template",
-    "type": "library",
+    "name": "php-standard-library/psalm-plugin",
+    "description": "Psalm plugin for the PHP Standard Library",
+    "type": "psalm-plugin",
     "license": "MIT",
     "authors": [
         {
@@ -12,27 +12,16 @@
     "require": {
         "php": "^7.4 || ^8.0",
         "azjezz/psl": "^1.5",
-        "ext-bcmath": "*",
-        "ext-json": "*",
-        "ext-mbstring": "*",
-        "ext-sodium": "*",
-        "ext-intl": "*"
+        "vimeo/psalm": "^4.6"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.5",
         "friendsofphp/php-cs-fixer": "^2.18",
         "roave/security-advisories": "dev-master",
-        "squizlabs/php_codesniffer": "^3.5",
-        "vimeo/psalm": "dev-master"
+        "squizlabs/php_codesniffer": "^3.5"
     },
     "autoload": {
         "psr-4": {
-            "Psl\\": "src/"
-        }
-    },
-    "autoload-dev": {
-        "psr-4": {
-            "Psl\\Tests\\": "tests/"
+            "Psl\\Psalm\\": "src/"
         }
     },
     "scripts": {
@@ -46,18 +35,21 @@
         ],
         "type:check": "psalm",
         "type:coverage": "psalm --shepherd",
-        "test:unit": "phpunit",
         "code:coverage": "php-coveralls -v",
         "security:analysis": "psalm --taint-analysis",
         "check": [
             "@cs:check",
             "@type:check",
-            "@security:analysis",
-            "@test:unit"
+            "@security:analysis"
         ]
     },
     "config": {
         "process-timeout": 1200,
         "sort-packages": true
+    },
+    "extra": {
+        "psalm": {
+            "pluginClass": "Psl\\Psalm\\Plugin"
+        }
     }
-}
+}

Diff for: .phpcs.xml

@@ -43,6 +43,6 @@
     </issueHandlers>
 
     <plugins>
-        <pluginClass class="Psl\Integration\Psalm\Plugin" />
+        <pluginClass class="Psl\Psalm\Plugin" />
     </plugins>
 </psalm>

Diff for: README.md

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Psl\Psalm\EventHandler\Type\Optional;
+
+use Psalm\Plugin\EventHandler\Event\FunctionReturnTypeProviderEvent;
+use Psalm\Plugin\EventHandler\FunctionReturnTypeProviderInterface;
+use Psalm\Type;
+use Psl\Iter;
+
+final class FunctionReturnTypeProvider implements FunctionReturnTypeProviderInterface
+{
+    /**
+     * @return array<lowercase-string>
+     */
+    public static function getFunctionIds(): array
+    {
+        return [
+            'psl\type\optional'
+        ];
+    }
+
+    public static function getFunctionReturnType(FunctionReturnTypeProviderEvent $event): ?Type\Union
+    {
+        $argument = Iter\first($event->getCallArgs());
+        if (null === $argument) {
+            return null;
+        }
+
+        $type = $event
+        ->getStatementsSource()
+        ->getNodeTypeProvider()
+        ->getType($argument->value);
+
+        if (null === $type) {
+            return null;
+        }
+
+        $clone = clone $type;
+        $clone->possibly_undefined = true;
+
+        return $clone;
+    }
+}