NGSTACK-938 add new hooks for linter, prettier and ts compiler

Author: JakovKnezovicc

src/Action/CheckForTypescriptErrors.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Netgen\GitHooks\Action;
+
+use CaptainHook\App\Config;
+use CaptainHook\App\Config\Action as ActionConfig;
+use CaptainHook\App\Console\IO;
+use SebastianFeldmann\Cli\Processor\ProcOpen as Processor;
+use SebastianFeldmann\Git\Repository;
+
+use function escapeshellarg;
+use function sprintf;
+
+final class CheckForTypescriptErrors extends Action
+{
+    protected const ERROR_MESSAGE = 'Committed code has typescript errors. Please check the output for suggested diff.';
+
+    protected function doExecute(Config $config, IO $io, Repository $repository, ActionConfig $action): void
+    {
+        $configDirs = $action->getOptions()->get('config_dirs', ['.']);
+        $typescriptCompilerCommand = $action->getOptions()->get('typescript_compiler_command', 'npx tsc');
+        $typescriptCompilerOptions = $action->getOptions()->get('typescript_compiler_options', '--noEmit');
+
+        $io->write(sprintf('Running %s on files:', $typescriptCompilerCommand), true, IO::VERBOSE);
+        foreach ($configDirs as $dir) {
+            $io->write(sprintf('  - %s', $dir), true, IO::VERBOSE);
+
+            $result = $this->checkTypescriptErrors($dir, $typescriptCompilerCommand, $typescriptCompilerOptions);
+            $io->write($result['output']);
+
+            if ($result['success'] !== true) {
+                $this->throwError($action, $io);
+            }
+        }
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    protected function checkTypescriptErrors(string $dir, string $typescriptCompilerCommand, string $typescriptCompilerOptions): array
+    {
+        $process = new Processor();
+        $result = $process->run($typescriptCompilerCommand . '  ' . $typescriptCompilerOptions . '  --project ' . escapeshellarg($dir));
+
+        return [
+            'success' => $result->isSuccessful(),
+            'output' => $result->getStdOut(),
+        ];
+    }
+}

src/Action/CheckLinter.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Netgen\GitHooks\Action;
+
+use CaptainHook\App\Config;
+use CaptainHook\App\Config\Action as ActionConfig;
+use CaptainHook\App\Console\IO;
+use SebastianFeldmann\Cli\Processor\ProcOpen as Processor;
+use SebastianFeldmann\Git\Repository;
+
+use function escapeshellarg;
+use function sprintf;
+
+final class CheckLinter extends Action
+{
+    protected const ERROR_MESSAGE = 'Committed JS code did not pass linter. Please check the output for suggested diff.';
+
+    protected function doExecute(Config $config, IO $io, Repository $repository, ActionConfig $action): void
+    {
+        $directories = $action->getOptions()->get('directories', ['assets']);
+        $linterCommand = $action->getOptions()->get('linter_command', 'pnpm eslint');
+
+        $io->write(sprintf('Running %s on files:', $linterCommand), true, IO::VERBOSE);
+
+        $result = $this->checkLinter($directories, $linterCommand);
+        $io->write($result['output']);
+
+        if ($result['success'] !== true) {
+            $this->throwError($action, $io);
+        }
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    protected function checkLinter(array $directories, string $linterCommand): array
+    {
+        $process = new Processor();
+        $cliString = $linterCommand;
+
+        foreach ($directories as $directory) {
+            $cliString .= '  ' . escapeshellarg($directory);
+        }
+
+        $result = $process->run($cliString);
+
+        return [
+            'success' => $result->isSuccessful(),
+            'output' => $result->getStdOut(),
+        ];
+    }
+}

src/Action/CheckPrettier.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Netgen\GitHooks\Action;
+
+use CaptainHook\App\Config;
+use CaptainHook\App\Config\Action as ActionConfig;
+use CaptainHook\App\Console\IO;
+use SebastianFeldmann\Cli\Processor\ProcOpen as Processor;
+use SebastianFeldmann\Git\Repository;
+use Symfony\Component\Finder\Finder;
+
+use function escapeshellarg;
+use function preg_filter;
+use function preg_match;
+use function sprintf;
+
+final class CheckPrettier extends Action
+{
+    protected const ERROR_MESSAGE = 'Committed code was not formatted correctly. Please check the output for suggested diff.';
+
+    protected function doExecute(Config $config, IO $io, Repository $repository, ActionConfig $action): void
+    {
+        $extensions = $action->getOptions()->get('extensions', ['js', 'jsx', 'ts', 'tsx', 'css', 'scss']);
+        $excludedFiles = $action->getOptions()->get('excluded_files') ?? [];
+        $directories = $action->getOptions()->get('directories', ['assets']);
+        $prettierCommand = $action->getOptions()->get('prettier_command', 'pnpm prettier');
+        $formatOptions = $action->getOptions()->get('prettier_options', '--check');
+
+        $finder = new Finder();
+        $finder->in($directories)->files()->name(preg_filter('/^/', '*.', $extensions));
+
+        if ($finder->hasResults()) {
+            $io->write(sprintf('Running %s on files:', $prettierCommand), true, IO::VERBOSE);
+
+            foreach ($finder as $file) {
+                if ($this->shouldSkipFileCheck($file, $excludedFiles)) {
+                    continue;
+                }
+
+                $result = $this->checkPrettier($file->getPath(), $prettierCommand, $formatOptions);
+                $io->write($result['output']);
+
+                if ($result['success'] !== true) {
+                    $this->throwError($action, $io);
+                }
+            }
+        }
+    }
+
+    /**
+     * @param string[] $excludedFiles
+     */
+    protected function shouldSkipFileCheck(string $file, array $excludedFiles): bool
+    {
+        foreach ($excludedFiles as $excludedFile) {
+            // File definition using regexp
+            if ($excludedFile[0] === '/') {
+                if (preg_match($excludedFile, $file) === 1) {
+                    return true;
+                }
+
+                continue;
+            }
+            if ($excludedFile === $file) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    protected function checkPrettier(string $file, string $prettierCommand, string $prettierOptions): array
+    {
+        $process = new Processor();
+        $result = $process->run($prettierCommand . ' ' . $prettierOptions . '  ' . escapeshellarg($file));
+
+        return [
+            'success' => $result->isSuccessful(),
+            'output' => $result->getStdOut(),
+        ];
+    }
+}