Initial commit

Author: seferov

.gitignore

@@ -0,0 +1,3 @@
+bin/typhp.phar
+vendor
+composer.lock

.travis.yml

@@ -0,0 +1,48 @@
+language: php
+
+php:
+  - 7.1
+  - 7.2
+  - 7.3
+  - 7.4snapshot
+
+stages:
+  - test
+  - typhp
+
+env:
+  matrix:
+    - DEPS="high"
+    - DEPS="low"
+  global:
+    - COMPOSER_MEMORY_LIMIT=-1
+    - DEFAULT_COMPOSER_FLAGS="--no-interaction --no-suggest --prefer-source"
+
+cache:
+  directories:
+    - ./vendor
+
+before_install:
+  - export INI_DIR=~/.phpenv/versions/$(phpenv version-name)/etc/conf.d
+  - echo memory_limit = 1G >> $INI_DIR/travis.ini
+  - if [[ -f $INI_DIR/xdebug.ini ]]; then phpenv config-rm xdebug.ini; fi
+  - composer clear-cache
+
+install:
+  - if [[ "$DEPS" = 'high' ]]; then travis_retry composer $DEFAULT_COMPOSER_FLAGS update; fi
+  - if [[ "$DEPS" = 'low' ]]; then travis_retry composer $DEFAULT_COMPOSER_FLAGS --prefer-lowest --prefer-stable update; fi
+
+script:
+  - vendor/bin/phpunit
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - php: 7.4snapshot
+
+jobs:
+  include:
+    - stage: typhp
+      php: 7.3
+      script:
+        - bin/typhp

.typhp.yml

@@ -0,0 +1,7 @@
+project:
+  directories:
+    - 'src'
+    - 'tests'
+  exclude:
+    directories:
+      - 'Functional/Scenarios/'

README.md

@@ -0,0 +1,60 @@
+## TYPHP
+
+`typhp` is a simple tool checks whether type hint for arguments or return type declared.
+Unlike static analysis tools, it doesn't point out possible errors and issues
+but suggests typehint everything possible.
+
+#### For whom?
+- Who works projects using PHP 7.1 and higher. 
+- Who doesn't want to point out missing type hint and return type declarations in code review process
+by using it as part of CI pipeline.
+- Who love strict typing
+
+#### Features
+
+- Respects phpdoc; there are some rare cases mixed or compound types are needed.
+If such cases documented in phpdoc, `typhp` doesn't complain. For example: `@return array|bool`, `@param mixed $foo`, etc.
+- Analyses based on configuration. Include/exclude files and directories to be analysed.
+For optional config file, see the [current project example](https://github.com/seferov/typhp/blob/master/.typhp.yml)
+- Does NOT modifies your code
+
+## Installation
+
+Install via composer:
+
+`
+composer require seferov/typhp
+`
+
+To install globally
+
+`
+composer global require seferov/typhp
+`
+
+## Usage
+
+`
+vendor/bin/typhp analyse path
+`
+
+If config file (`.typhp.yml`) is present in project root, it can be run
+just by `vendor/bin/typhp`
+
+Example output
+
+<img src="example.png" />
+
+## Todo
+
+- [ ] Analyse closures
+
+- [ ] Check by PHP version. For example, don't suppress `@param object` for >= PHP 7.2
+
+- [ ] Better configuration
+ 
+- [ ] Check `declare(strict_types=1)` by config
+
+- [ ] Phar file
+
+- [ ] Github Actions

bin/typhp

@@ -0,0 +1,15 @@
+#!/usr/bin/env php
+<?php
+
+declare(strict_types=1);
+
+use Seferov\Typhp\Command\AnalyseCommand;
+use Symfony\Component\Console\Application;
+
+require_once __DIR__.'/../vendor/autoload.php';
+
+$application = new Application('Typed PHP');
+$analyseCommand = new AnalyseCommand();
+$application->add($analyseCommand);
+$application->setDefaultCommand($analyseCommand->getName());
+$application->run();

composer.json

@@ -0,0 +1,39 @@
+{
+    "name": "seferov/typhp",
+    "description": "Enforce type declaring",
+    "license": "MIT",
+    "type": "library",
+    "keywords": ["type hint", "strict typing"],
+    "require": {
+        "php": "^7.1",
+        "nikic/php-parser": "^4.2",
+        "phpdocumentor/reflection-docblock": "^4.3",
+        "symfony/console": "^4.3",
+        "symfony/finder": "^4.3",
+        "symfony/yaml": "^4.3",
+        "symfony/stopwatch": "^4.3",
+        "symfony/process": "^4.3",
+        "jean85/pretty-package-versions": "^1.2"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^7.5",
+        "symfony/var-dumper": "^4.3"
+    },
+    "autoload": {
+        "psr-4": {
+            "Seferov\\Typhp\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Seferov\\Typhp\\Tests\\": "tests"
+        }
+    },
+    "bin": ["bin/typhp"],
+    "authors": [
+        {
+            "name": "Farhad Safarov",
+            "email": "[email protected]"
+        }
+    ]
+}

example.png

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/7.5/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         forceCoversAnnotation="true"
+         beStrictAboutCoversAnnotation="true"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutTodoAnnotatedTests="true"
+         verbose="true">
+    <testsuites>
+        <testsuite name="default">
+            <directory suffix="Test.php">tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

phpunit.xml

@@ -0,0 +1,104 @@
+<?php
+
+namespace Seferov\Typhp;
+
+use phpDocumentor\Reflection\DocBlockFactory;
+use PhpParser\Node;
+use PhpParser\ParserFactory;
+use Seferov\Typhp\Issue\UntypedArgumentIssue;
+use Seferov\Typhp\Issue\UntypedReturnIssue;
+
+class Analyser
+{
+    /**
+     * @var string
+     */
+    private $code;
+    /**
+     * @var string
+     */
+    private $fileName;
+    /**
+     * @var IssueCollection
+     */
+    private $issueCollection;
+    /**
+     * @var DocBlockFactory
+     */
+    private $docBlockFactory;
+    /**
+     * @var DocBlockAnalyser
+     */
+    private $docBlockAnalyser;
+
+    public function __construct(string $fileName, string $code)
+    {
+        $this->code = $code;
+        $this->fileName = $fileName;
+        $this->issueCollection = new IssueCollection();
+        $this->docBlockFactory  = DocBlockFactory::createInstance();
+        $this->docBlockAnalyser  = new DocBlockAnalyser();
+    }
+
+    public function analyse(): IssueCollection
+    {
+        $this->issueCollection->empty();
+
+        $parser = (new ParserFactory)->create(ParserFactory::ONLY_PHP7);
+        $ast = $parser->parse($this->code);
+
+        foreach ($ast as $node) {
+            $this->analyseNode($node);
+        }
+
+        return $this->issueCollection;
+    }
+
+    private function analyseNode(Node $node): void
+    {
+        if ($node instanceof Node\FunctionLike) {
+            $this->analyseFunctionLike($node);
+        }
+
+        if (isset($node->stmts)) {
+            foreach ($node->stmts as $subNode) {
+                $this->analyseNode($subNode);
+            }
+        }
+    }
+
+    private function analyseFunctionLike(Node\FunctionLike $functionLike): void
+    {
+        $name = $functionLike->name;
+
+        $docBlock = null;
+        if ($functionLike->getDocComment()) {
+            try {
+                $docBlock = $this->docBlockFactory->create($functionLike->getDocComment()->getText());
+            } catch (\Exception $e) {
+            }
+        }
+
+        if ($docBlock && $this->docBlockAnalyser->isSuppressedByInheritDoc($docBlock)) {
+            return;
+        }
+
+        foreach ($functionLike->getParams() as $param) {
+            if (null === $param->type) {
+                if ($docBlock && $this->docBlockAnalyser->isParamSuppressedByDocBlock($param->var->name, $docBlock)) {
+                    continue;
+                }
+
+                $this->issueCollection->add(UntypedArgumentIssue::create($name->name, $name->getStartLine(), $param->var->name));
+            }
+        }
+
+        if (null === $functionLike->getReturnType() && '__construct' !== $name->name) {
+            if ($docBlock && $this->docBlockAnalyser->isReturnSuppressedByDocBlock($docBlock)) {
+                return;
+            }
+
+            $this->issueCollection->add(UntypedReturnIssue::create($name->name, $name->getStartLine()));
+        }
+    }
+}