The journey towards new CI

.github/workflows/phpstan.yml

@@ -0,0 +1,44 @@
+name: phpstan
+
+on:
+  push:
+    paths-ignore:
+      - 'Docs/**'
+  pull_request:
+    paths-ignore:
+      - 'Docs/**'
+
+
+jobs:
+  phpstan:
+    name: phpstan
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.1
+          coverage: none
+
+      - name: Get Composer cache directory
+        id: composer-cache
+        run: |
+          echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v3
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: PHPStan
+        run: vendor/bin/phpstan analyse --no-ansi --no-progress -c phpstan.neon

.github/workflows/tests.yml

@@ -0,0 +1,48 @@
+name: Tests
+
+on:
+  push:
+    paths-ignore:
+      - 'Docs/**'
+  pull_request:
+    paths-ignore:
+      - 'Docs/**'
+
+jobs:
+  tests:
+    strategy:
+      fail-fast: true
+      matrix:
+        php: ["7.3", "7.4", "8.0", "8.1", "8.2", "8.3"]
+
+    name: "PHP ${{ matrix.php }}"
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "${{ matrix.php }}"
+          coverage: none
+
+      - name: Get Composer cache directory
+        id: composer-cache
+        run: |
+          echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v3
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ matrix.php }}-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: PHPUnit
+        run: ./vendor/bin/phpunit

Docs/1-installation.md

@@ -7,7 +7,7 @@ next: 2-basic-usage
 
 # Installation as library
 
-First off, you need to have at least PHP 7.1.3, and [composer] installed, and then you can install
+First off, you need to have at least PHP 7.3, and [composer] installed, and then you can install
 KeyLighter into your project by simply executing:
 
 ```bash

Language/GreedyLanguage.php

@@ -135,7 +135,7 @@ private function _tokens($source, $offset = 0, $additional = [], $embedded = fal
     {
         $result = new UnprocessedTokens();
 
-        /** @var Language $language */
+        /** @var Rule $rule */
         foreach ($this->_rules($embedded) as $rule) {
             foreach ($rule->match($source) as $token) {
                 $result->add($token, $offset);
@@ -174,7 +174,7 @@ private function _rules($embedded = false)
      *
      * @param $embedded
      *
-     * @return Rule|Rule[]
+     * @return Rule|Rule[]|array<string, array<int, Rule>>
      */
     public function getEnds($embedded = false)
     {

Language/Php.php

@@ -134,8 +134,7 @@ function (
                             $match,
                             TokenFactoryInterface $factory
                         ) use (
-                            $annotationNameRule,
-                            $allowedInAttributes
+                            $annotationNameRule
                         ) {
                             yield $factory->create(
                                 Token::NAME,

Matcher/RegexMatcher.php

@@ -28,8 +28,8 @@ class RegexMatcher implements MatcherInterface
     /**
      * RegexMatcher constructor.
      *
-     * @param            $regex
-     * @param array|null $groups
+     * @param       $regex
+     * @param array $groups
      */
     public function __construct($regex, array $groups = [1 => null])
     {

Matcher/WordMatcher.php

@@ -67,12 +67,12 @@ public function __construct(array $words, array $options = [])
 
     public function merge(array $words)
     {
-        return new static(array_merge($this->words, $words), $this->options);
+        return new self(array_merge($this->words, $words), $this->options);
     }
 
     public function subtract(array $words)
     {
-        return new static(array_diff($this->words, $words), $this->options);
+        return new self(array_diff($this->words, $words), $this->options);
     }
 
     public function getWords()

Parser/DelegateTokenFactory.php

@@ -28,8 +28,8 @@ class DelegateTokenFactory implements TokenFactoryInterface
     /**
      * DelegateTokenFactory constructor.
      *
-     * @param callable (TokenFactoryInterface $factory, array $params) $function
-     * @param TokenFactoryInterface|null                               $factory
+     * @param callable(TokenFactoryInterface, array $params): (Token|null) $function
+     * @param TokenFactoryInterface|null                                   $factory
      */
     public function __construct(callable $function, TokenFactoryInterface $factory = null)
     {

Parser/OpenRule.php

@@ -25,7 +25,7 @@ class OpenRule extends Rule
     /**
      * @param $source
      *
-     * @return Token[]
+     * @return Token[]|iterable<Token>
      */
     public function match($source)
     {

Parser/Rule.php

@@ -29,7 +29,7 @@
  *
  * @package Kadet\Highlighter\Parser
  *
- * @property Language              $language
+ * @property Language|false|null   $language
  * @property Language              $inject
  * @property integer               $priority
  * @property string                $type
@@ -40,7 +40,7 @@
 class Rule
 {
     /**
-     * @var Validator
+     * @var Validator|false
      */
     public $validator = false;
     private $_matcher;
@@ -106,7 +106,7 @@ public function setMatcher(MatcherInterface $matcher)
     /**
      * @param $source
      *
-     * @return Token[]|\Iterator
+     * @return iterable<Token>|\Iterator
      */
     public function match($source)
     {
@@ -120,7 +120,7 @@ public function __get($option)
 
     public function __set($option, $value)
     {
-        return $this->_options[$option] = $value;
+        $this->_options[$option] = $value;
     }
 
     public function enable()

Parser/Token/Token.php

@@ -26,6 +26,13 @@
 use Kadet\Highlighter\Parser\Validator\Validator;
 use Kadet\Highlighter\Utils\Helper;
 
+/**
+ * Class Token
+ *
+ * @package Kadet\Highlighter\Parser\Token
+ *
+ * @mixin Rule
+ */
 class Token
 {
     public const NAME  = null;
@@ -37,7 +44,10 @@ class Token
     public $pos;
     public $name;
     public $id;
+
+    /** @var Rule */
     public $rule;
+
     public $options;
 
     # region >>> cache

README.md

@@ -1,9 +1,8 @@
 ![Logo](https://keylighter.kadet.net/img/logo.png)
 
 [![Packagist](https://img.shields.io/packagist/v/kadet/keylighter.svg?style=flat-square)](https://packagist.org/packages/kadet/keylighter)
-[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/kadet1090/keylighter.svg?style=flat-square)](https://scrutinizer-ci.com/g/kadet1090/KeyLighter/?branch=master)
-[![Travis build](https://img.shields.io/travis/kadet1090/KeyLighter.svg?style=flat-square)](https://travis-ci.org/kadet1090/KeyLighter)
-[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/kadet1090/keylighter.svg?style=flat-square)](https://scrutinizer-ci.com/g/kadet1090/KeyLighter/?branch=master)
+[![GitHub Actions](https://github.com/kadet1090/keylighter/actions/workflows/tests.yml/badge.svg?event=push)](https://github.com/kadet1090/KeyLighter/actions?query=branch:master)
+[![GitHub Actions](https://github.com/kadet1090/keylighter/actions/workflows/phpstan.yml/badge.svg?event=push)](https://github.com/kadet1090/KeyLighter/actions?query=branch:master)
 [![Try it](https://img.shields.io/badge/www-try%20it-FF9700.svg?style=flat-square)](https://keylighter.kadet.net)
 
 [![stability: stable](https://img.shields.io/badge/Public%20API-stable-green.svg?style=flat-square)](Docs/2-basic-usage.md)
@@ -30,7 +29,7 @@ KeyLighter is supposed to do the same thing - for code.
 $ composer require kadet/keylighter
 ```
 
-To use **KeyLighter** you just need PHP 7.1.3 or later, no special extensions 
+To use **KeyLighter** you just need PHP 7.3 or later, no special extensions 
 required.
 
 ## Global installation
@@ -213,7 +212,7 @@ without any problem.
 Even though it wasn't supposed to be fastest code highlighter in PHP it is still 
 quite fast, more than 2x faster than [GeSHi](https://geshi.org/).
 
-## Testing ![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/kadet1090/keylighter.svg?style=flat-square)
+## Testing
 **KeyLighter** uses `phpunit` for testing:
 ```bash
 $ ./vendor/bin/phpunit

Utils/Console.php

@@ -21,7 +21,7 @@
 class Console
 {
     /**
-     * @var ConsoleHelper
+     * @var ConsoleHelper|null
      */
     private static $_instance;
 

changelog.md

@@ -27,7 +27,7 @@
  * **PHP** now supports features from PHP 8.x
 
 ## Changed
- * **BC BREAK** KeyLighter requires PHP 7.1.3+ now (instead of PHP 5.5 as previously)
+ * **BC BREAK** KeyLighter requires PHP 7.3+ now (instead of PHP 5.5 as previously)
  * **BC BREAK** `LaTexFormatter` and `CliFormatter` no longer have `$styles` in constructor, now you should set styles v
  via option `styles` `['styles' => [...]]`
  * renamed `Kadet\Highlighter\Language\Language::getAliases` to `getMetadata` as it now stores not only aliases

composer.json

@@ -9,11 +9,12 @@
     }
   ],
   "require": {
-    "php": "^7.1.3 | ^8.0"
+    "php": "^7.3|^8.0"
   },
   "require-dev": {
     "ext-json": "*",
     "easybook/geshi": "v1.0.8.19",
+    "phpstan/phpstan": "^1.10",
     "phpunit/phpunit": "^9.4",
     "squizlabs/php_codesniffer": "^3.5",
     "symfony/console": "^4.4",
@@ -33,6 +34,9 @@
     "bin/keylighter"
   ],
   "config": {
+    "platform": {
+      "php": "7.3.33"
+    },
     "sort-packages": true
   }
 }