Merge pull request #20 from wundii/dev

version 0.1.0

Author: wundii

README.md

@@ -1,10 +1,62 @@
-# PHPLint 
+# PHPLint - the fastest way to check your syntax
 
 [![PHP-Tests](https://github.com/wundii/PHPLint/actions/workflows/code_quality.yml/badge.svg)](https://github.com/wundii/PHPLint/actions/workflows/code_quality.yml)
 [![PHPStan](https://img.shields.io/badge/PHPStan-level%208-brightgreen.svg?style=flat)](https://phpstan.org/)
+[![Downloads](https://img.shields.io/packagist/dt/wundii/phplint.svg?style=flat)](https://packagist.org/packages/wundii/phplint)
 
-## Installation
+This program is one of the fastest tools for static code analysis and error detection in PHP source code.
+The native php lint checking is used here.
+
+## Installation and Usage
+
+```shell
+composer require wundii/phplint --dev
+```
+
+```shell
+php vendor/bin/phplint
+php vendor/bin/phplint --config=phplint.php
+php vendor/bin/phplint --help
+```
+
+### Functionality over the config file (phplint.php)
++ php cgi executable (default: php)
++ paths (default: src)
++ skip
++ memory limit (default: 512M)
++ async processes (default: 10)
++ enable warnings (default: true)
++ enable notice (default: true)
++ ignore exit code (default: false)
++ ignore process bar (default: false)
+
+## Development for PHPLint
+
+### composer scripts
+
+```shell
+composer rector-dry
+composer rector-apply
+composer phpstan
+composer ecs-dry
+composer ecs-apply
+composer phpunit
+composer cache-clear
+```
+
+### complete checks before merge
 
 ```shell
-placeholder
-```
+composer complete-check
+```
+
+### To-do list for version 1.0.0
++ [ ] add symfony cache-system
++ [ ] refactor LintConsoleOutput class
++ [ ] refactor LintConfig class
+
+## Feedback and Contributions
+I welcome feedback, bug reports and contributions from the community! 
+If you found a bug or have a suggestion for improvement, please create an issue. 
+
+Every contribution is welcome!

bin/phplint

@@ -3,4 +3,4 @@
 
 declare(strict_types=1);
 
-require_once __DIR__ . '/phplint.php';
+require_once __DIR__ . DIRECTORY_SEPARATOR . 'phplint.php';

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "wundii/phplint",
-  "description": "This tool checks the syntax and style of PHP files",
+  "description": "This tool is the fast way, to checks the syntax of your PHP files.",
   "license": "MIT",
   "authors": [
     {
@@ -14,11 +14,11 @@
   "require": {
     "php": ">=8.1",
     "ext-json": "*",
-    "symfony/config": "6.*",
-    "symfony/console": "6.*",
-    "symfony/dependency-injection": "6.*",
-    "symfony/finder": "6.*",
-    "symfony/process": "6.*"
+    "symfony/config": "^6.0",
+    "symfony/console": "^6.0",
+    "symfony/dependency-injection": "^6.0",
+    "symfony/finder": "^6.0",
+    "symfony/process": "^6.0"
   },
   "require-dev": {
     "phpstan/phpstan": "^1.10",

phpunit.xml

@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
-         colors="true"
          bootstrap="tests/bootstrap.php"
          cacheDirectory="cache/phpunit"
-         stopOnError ="true"
+         colors="true"
+         failOnRisky="true"
+         failOnWarning="true"
          testdox="true"
-         defaultTestSuite="main"
 >
   <php>
     <ini name="display_errors" value="1"/>
@@ -22,8 +22,12 @@
       <directory>tests/Main/DependencyInjection</directory>
       <directory>tests/Main/Finder</directory>
       <directory>tests/Main/Process</directory>
+      <directory>tests/Main/Lint</directory>
       <directory>tests/Main/Console</directory>
     </testsuite>
+    <testsuite name="e2e">
+      <directory>tests/E2E/Console</directory>
+    </testsuite>
   </testsuites>
   <source>
     <include>

src/Config/LintConfig.php

@@ -27,9 +27,23 @@ final class LintConfig
 
     private int $asyncProcess = 10;
 
-    private bool $allowWarning = true;
+    private bool $enableWarning = true;
 
-    private bool $allowNotice = true;
+    private bool $enableNotice = true;
+
+    private bool $ignoreExitCode = false;
+
+    private bool $ignoreProcessBar = false;
+
+    /**
+     * @todo not implemented
+     */
+    private bool $cache = true;
+
+    /**
+     * @todo not implemented
+     */
+    private string $cacheDirectory = '.phplint';
 
     public function getPhpCgiExecutable(): string
     {
@@ -147,23 +161,63 @@ public function setAsyncProcess(int $asyncProcess): void
         $this->asyncProcess = $asyncProcess;
     }
 
-    public function isAllowWarning(): bool
+    public function isEnableWarning(): bool
+    {
+        return $this->enableWarning;
+    }
+
+    public function disableWarning(): void
+    {
+        $this->enableWarning = false;
+    }
+
+    public function isEnableNotice(): bool
+    {
+        return $this->enableNotice;
+    }
+
+    public function disableNotice(): void
+    {
+        $this->enableNotice = false;
+    }
+
+    public function isIgnoreExitCode(): bool
+    {
+        return $this->ignoreExitCode;
+    }
+
+    public function ignoreExitCode(): void
+    {
+        $this->ignoreExitCode = true;
+    }
+
+    public function isIgnoreProcessBar(): bool
+    {
+        return $this->ignoreProcessBar;
+    }
+
+    public function ignoreProcessBar(): void
+    {
+        $this->ignoreProcessBar = true;
+    }
+
+    public function isCache(): bool
     {
-        return $this->allowWarning;
+        return $this->cache;
     }
 
-    public function setAllowWarning(bool $allowWarning): void
+    public function setCache(bool $cache): void
     {
-        $this->allowWarning = $allowWarning;
+        $this->cache = $cache;
     }
 
-    public function isAllowNotice(): bool
+    public function getCacheDirectory(): string
     {
-        return $this->allowNotice;
+        return $this->cacheDirectory;
     }
 
-    public function setAllowNotice(bool $allowNotice): void
+    public function setCacheDirectory(string $cacheDirectory): void
     {
-        $this->allowNotice = $allowNotice;
+        $this->cacheDirectory = $cacheDirectory;
     }
 }

src/Console/Commands/LintCommand.php

@@ -56,6 +56,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $usageExecuteTime = Helper::formatTime(microtime(true) - $startExecuteTime);
 
-        return (int) $this->lintConsoleOutput->finishApplication($usageExecuteTime);
+        $exitCode = (int) $this->lintConsoleOutput->finishApplication($usageExecuteTime);
+
+        if ($this->lintConfig->isIgnoreExitCode()) {
+            return self::SUCCESS;
+        }
+
+        return $exitCode;
     }
 }

src/Console/LintApplication.php

@@ -29,7 +29,7 @@ final class LintApplication
     /**
      * @var string
      */
-    public const VERSION = '0.0.1';
+    public const VERSION = '0.1.0';
 
     public function __construct(
         private readonly LintCommand $lintCommand,

src/Console/Output/LintConsoleOutput.php

@@ -4,7 +4,8 @@
 
 namespace PHPLint\Console\Output;
 
-use PHPLint\Console\ConsoleColorEnum;
+use PHPLint\Config\LintConfig;
+use PHPLint\Console\OutputColorEnum;
 use PHPLint\Process\LintProcessResult;
 use PHPLint\Process\StatusEnum;
 use Symfony\Component\Console\Helper\Helper;
@@ -27,7 +28,8 @@ final class LintConsoleOutput
     private int $countFiles = 0;
 
     public function __construct(
-        private readonly SymfonyStyle $symfonyStyle
+        private readonly SymfonyStyle $symfonyStyle,
+        private readonly LintConfig $lintConfig,
     ) {
     }
 
@@ -62,29 +64,38 @@ public function finishApplication(string $executionTime): bool
 
     public function progressBarStart(int $count): void
     {
-        $this->symfonyStyle->writeln('Linting files...');
-        $this->symfonyStyle->newLine();
+        if ($this->lintConfig->isIgnoreProcessBar()) {
+            return;
+        }
 
         $this->symfonyStyle->progressStart($count);
     }
 
     public function progressBarAdvance(): void
     {
+        if ($this->lintConfig->isIgnoreProcessBar()) {
+            return;
+        }
+
         $this->symfonyStyle->progressAdvance();
     }
 
     public function progressBarFinish(): void
     {
+        if ($this->lintConfig->isIgnoreProcessBar()) {
+            return;
+        }
+
         $this->symfonyStyle->progressFinish();
     }
 
     public function messageByProcessResult(LintProcessResult $lintProcessResult): void
     {
-        $consoleColorEnum = match ($lintProcessResult->getStatus()) {
-            StatusEnum::OK => ConsoleColorEnum::GREEN,
-            StatusEnum::NOTICE => ConsoleColorEnum::BLUE,
-            StatusEnum::WARNING => ConsoleColorEnum::YELLOW,
-            default => ConsoleColorEnum::RED,
+        $outputColorEnum = match ($lintProcessResult->getStatus()) {
+            StatusEnum::OK => OutputColorEnum::GREEN,
+            StatusEnum::NOTICE => OutputColorEnum::BLUE,
+            StatusEnum::WARNING => OutputColorEnum::YELLOW,
+            default => OutputColorEnum::RED,
         };
 
         ++$this->countFiles;
@@ -97,25 +108,29 @@ public function messageByProcessResult(LintProcessResult $lintProcessResult): vo
         );
         $line02 = sprintf(
             '<fg=%s;options=bold>%s</>: <fg=%s>%s</>',
-            $consoleColorEnum->getBrightValue(),
+            $outputColorEnum->getBrightValue(),
             ucfirst($lintProcessResult->getStatus()->value),
-            $consoleColorEnum->value,
+            $outputColorEnum->value,
             $lintProcessResult->getResult(),
         );
 
         $this->symfonyStyle->writeln($line01);
         $this->symfonyStyle->writeln($line02);
-        $this->loadCodeSnippet($lintProcessResult->getFilename(), (int) $lintProcessResult->getLine(), $consoleColorEnum);
+        $this->loadCodeSnippet($lintProcessResult->getFilename(), (int) $lintProcessResult->getLine(), $outputColorEnum);
         $this->symfonyStyle->newLine();
 
         $this->isSuccess = false;
     }
 
-    private function loadCodeSnippet(string $filename, int $line, ConsoleColorEnum $consoleColorEnum): void
+    private function loadCodeSnippet(string $filename, int $line, OutputColorEnum $outputColorEnum): void
     {
         $lineStart = $line - self::SNIPPED_LINE;
         $lineEnd = $line + (self::SNIPPED_LINE - 1);
 
+        if (! file_exists($filename)) {
+            return;
+        }
+
         $content = file_get_contents($filename);
         if ($content === false) {
             return;
@@ -126,25 +141,25 @@ private function loadCodeSnippet(string $filename, int $line, ConsoleColorEnum $
         $lineCnt = 0;
         foreach ($contentArray as $contentLine) {
             if ($lineCnt >= $lineStart && $lineCnt < $lineEnd) {
-                $lineNumberPost = $lineCnt + 1;
-                $tmp = str_pad((string) $lineNumberPost, self::LINE_LENGTH, '0', STR_PAD_LEFT);
-                $lineNumberPre = substr($tmp, 0, self::LINE_LENGTH - strlen((string) $lineNumberPost));
+                $lineNumber = $lineCnt + 1;
+                $tmp = str_pad((string) $lineNumber, self::LINE_LENGTH, '0', STR_PAD_LEFT);
+                $lineNumberPrefix = substr($tmp, 0, self::LINE_LENGTH - strlen((string) $lineNumber));
 
                 if ($lineCnt + 1 === $line) {
                     $result = sprintf(
-                        '<fg=%s;options=bold>%s</><fg=%s>%s</><fg=blue;options=bold>:</> <fg=%s>%s</>',
-                        $consoleColorEnum->getBrightValue(),
-                        $lineNumberPre,
-                        $consoleColorEnum->value,
-                        $lineNumberPost,
-                        $consoleColorEnum->value,
+                        '<fg=%s>%s</><fg=%s;options=bold>%s</><fg=gray>|</> <fg=%s>%s</>',
+                        $outputColorEnum->getBrightValue(),
+                        $lineNumberPrefix,
+                        $outputColorEnum->value,
+                        $lineNumber,
+                        $outputColorEnum->value,
                         $contentLine,
                     );
                 } else {
                     $result = sprintf(
-                        '<fg=gray;options=bold>%s</><fg=white>%s</><fg=blue;options=bold>:</> <fg=white>%s</>',
-                        $lineNumberPre,
-                        $lineNumberPost,
+                        '<fg=gray>%s</><fg=white;options=bold>%s</><fg=gray>|</> <fg=white>%s</>',
+                        $lineNumberPrefix,
+                        $lineNumber,
                         $contentLine,
                     );
                 }

src/Console/ConsoleColorEnum.php src/Console/OutputColorEnum.phpsrc/Console/ConsoleColorEnum.php renamed to src/Console/OutputColorEnum.php

@@ -4,7 +4,7 @@
 
 namespace PHPLint\Console;
 
-enum ConsoleColorEnum: string
+enum OutputColorEnum: string
 {
     case BLACK = 'black';
     case RED = 'red';