Add watch option (#18)

Author: maelanleborgne

config/services.php

@@ -18,7 +18,9 @@
                 abstract_arg('path to typescript files'),
                 abstract_arg('path to compiled directory'),
                 param('kernel.project_dir'),
+                abstract_arg('path to the binaries download directory'),
                 abstract_arg('path to the swc binary'),
+                abstract_arg('path to the watchexec binary'),
             ])
         ->set('sensiolabs_typescript.command.build', TypeScriptBuildCommand::class)
             ->args([

doc/index.rst

@@ -45,7 +45,7 @@ Then run the command:
 .. code-block:: terminal
 
     # To compile only the typescript files
-    $ php bin/console typescript:build
+    $ php bin/console typescript:build --watch
 
     # To compile ALL your assets
     $ php bin/console asset-map:compile

src/Command/TypeScriptBuildCommand.php

@@ -6,6 +6,7 @@
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 
@@ -21,22 +22,42 @@ public function __construct(
         parent::__construct();
     }
 
+    public function configure(): void
+    {
+        $this->addOption('watch', 'w', InputOption::VALUE_NONE, 'Watch for changes and recompile');
+    }
+
     public function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
         $this->typeScriptBuilder->setOutput($io);
 
-        foreach ($this->typeScriptBuilder->runBuild() as $process) {
-            $process->wait(function ($type, $buffer) use ($io) {
-                $io->write($buffer);
-            });
+        $watch = $input->getOption('watch');
+        $processes = [];
+        foreach ($this->typeScriptBuilder->createAllBuildProcess($watch) as $process) {
+            $processes[] = $process;
+        }
+
+        if (0 === \count($processes)) {
+            $io->success('No TypeScript files to compile');
+
+            return self::SUCCESS;
+        }
 
-            if (!$process->isSuccessful()) {
-                $io->error('TypeScript build failed');
+        do {
+            foreach ($processes as $index => $process) {
+                if ($process->isRunning()) {
+                    continue;
+                }
+                if (!$process->isSuccessful()) {
+                    $io->error('TypeScript build failed');
 
-                return self::FAILURE;
+                    return self::FAILURE;
+                }
+                unset($processes[$index]);
             }
-        }
+            usleep(100000);
+        } while (\count($processes) > 0);
 
         return self::SUCCESS;
     }

src/DependencyInjection/SensiolabsTypeScriptExtension.php

@@ -28,7 +28,9 @@ public function load(array $configs, ContainerBuilder $container): void
         $container->findDefinition('sensiolabs_typescript.builder')
             ->replaceArgument(0, $config['source_dir'])
             ->replaceArgument(1, '%kernel.project_dir%/var/typescript')
-            ->replaceArgument(3, $config['binary']);
+            ->replaceArgument(3, $config['binary_download_dir'])
+            ->replaceArgument(4, $config['swc_binary'])
+            ->replaceArgument(5, $config['watchexec_binary']);
 
         $container->findDefinition('sensiolabs_typescript.js_asset_compiler')
             ->replaceArgument(0, $config['source_dir'])
@@ -57,10 +59,19 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->end()
                     ->defaultValue(['%kernel.project_dir%/assets'])
                 ->end()
-                    ->scalarNode('binary')
+                ->scalarNode('binary_download_dir')
+                    ->info('The directory where the SWC and Watchexec binaries will be downloaded')
+                    ->defaultValue('%kernel.project_dir%/var')
+                ->end()
+                ->scalarNode('swc_binary')
                     ->info('The SWC binary to use')
                     ->defaultNull()
-            ->end();
+                ->end()
+                ->scalarNode('watchexec_binary')
+                    ->info('The Watchexec binary to use')
+                    ->defaultNull()
+                ->end()
+        ;
 
         return $treeBuilder;
     }

src/EventListener/PreAssetsCompileListener.php

@@ -18,7 +18,7 @@ public function __invoke(PreAssetsCompileEvent $event): void
         $output = new SymfonyStyle(new ArrayInput([]), $event->getOutput());
         $this->typeScriptBuilder
             ->setOutput($output);
-        foreach ($this->typeScriptBuilder->runBuild() as $process) {
+        foreach ($this->typeScriptBuilder->createAllBuildProcess() as $process) {
             $process->wait(function ($type, $buffer) use ($output) {
                 $output->write($buffer);
             });

src/Tools/TypeScriptBinary.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Sensiolabs\TypeScriptBundle\Tools;
+
+use Symfony\Component\Process\Process;
+
+class TypeScriptBinary
+{
+    public function __construct(
+        private readonly string $pathToExecutable,
+    ) {
+        if (!file_exists($this->pathToExecutable)) {
+            throw new \Exception(sprintf('The Typescript binary could not be found at the provided path : "%s"', $this->pathToExecutable));
+        }
+    }
+
+    /**
+     * @param non-empty-list<string> $args
+     */
+    public function createProcess(array $args): Process
+    {
+        array_unshift($args, $this->pathToExecutable);
+
+        return new Process($args);
+    }
+}

src/TypeScriptBinary.php renamed to src/Tools/TypescriptBinaryFactory.php

@@ -1,126 +1,93 @@
 <?php
 
-namespace Sensiolabs\TypeScriptBundle;
+namespace Sensiolabs\TypeScriptBundle\Tools;
 
+use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\HttpClient\HttpClient;
-use Symfony\Component\Process\Process;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
-class TypeScriptBinary
+class TypescriptBinaryFactory
 {
     private const VERSION = 'v1.3.92';
     private const SWC_RELEASE_URL_PATTERN = 'https://github.com/swc-project/swc/releases/download/%s/%s';
 
     public function __construct(
         private readonly string $binaryDownloadDir,
-        private readonly ?string $binaryPath,
-        private ?SymfonyStyle $output = null,
         private ?HttpClientInterface $httpClient = null,
-        private ?string $binaryName = null,
+        private ?OutputInterface $output = null,
     ) {
         $this->httpClient = $httpClient ?? HttpClient::create();
     }
 
-    /**
-     * @param array<string> $args
-     */
-    public function createProcess(array $args): Process
+    public function getBinaryFromPath($pathToExecutable): TypeScriptBinary
     {
-        if (null === $this->binaryPath) {
-            $binary = $this->getDefaultBinaryPath();
-            if (!is_file($binary)) {
-                $this->downloadBinary();
-            }
-        } else {
-            $binary = $this->binaryPath;
-        }
-
-        array_unshift($args, $binary);
-
-        return new Process($args);
+        return new TypeScriptBinary($pathToExecutable);
     }
 
-    public function downloadBinary(): void
+    public function getBinaryFromServerSpecs($os, $machine, $kernel): TypeScriptBinary
     {
-        $targetPath = $this->getDefaultBinaryPath();
-        if (file_exists($targetPath)) {
-            return;
-        }
-
-        if (!is_dir($this->binaryDownloadDir)) {
-            mkdir($this->binaryDownloadDir, 0777, true);
+        $binaryName = self::getBinaryNameFromServerSpecs($os, $machine, $kernel);
+        if (!file_exists($this->binaryDownloadDir.'/'.$binaryName)) {
+            $this->downloadAndExtract($binaryName);
         }
 
-        $url = sprintf(self::SWC_RELEASE_URL_PATTERN, self::VERSION, $this->getBinaryName());
-        $this->output?->note(sprintf('Downloading TypeScript binary to %s...', $targetPath));
-
-        $response = $this->httpClient->request('GET', $url, [
-            'on_progress' => function (int $dlNow, int $dlSize, array $info) use (&$progressBar): void {
-                if (0 === $dlSize) {
-                    return;
-                }
-
-                if (!$progressBar) {
-                    $progressBar = $this->output?->createProgressBar($dlSize);
-                }
+        return $this->getBinaryFromPath($this->binaryDownloadDir.'/'.$binaryName);
+    }
 
-                $progressBar?->setProgress($dlNow);
-            },
-        ]);
-        $fileHandler = fopen($targetPath, 'w');
-        foreach ($this->httpClient->stream($response) as $chunk) {
-            fwrite($fileHandler, $chunk->getContent());
-        }
+    public function setOutput(?SymfonyStyle $output): self
+    {
+        $this->output = $output;
 
-        fclose($fileHandler);
-        chmod($targetPath, 7770);
-        $progressBar?->finish();
-        $this->output?->writeln('');
+        return $this;
     }
 
-    private function getBinaryName(): string
+    public function setHttpClient(HttpClientInterface $client): self
     {
-        if (null !== $this->binaryName) {
-            return $this->binaryName;
-        }
-        $os = strtolower(\PHP_OS);
-        $machine = strtolower(php_uname('m'));
+        $this->httpClient = $client;
 
+        return $this;
+    }
+
+    public static function getBinaryNameFromServerSpecs(
+        $os,
+        $machine,
+        $kernel,
+    ) {
+        list($os, $machine, $kernel) = [strtolower($os), strtolower($machine), strtolower($kernel)];
         if (str_contains($os, 'darwin')) {
             if ('arm64' === $machine) {
-                return $this->binaryName = 'swc-darwin-arm64';
+                return 'swc-darwin-arm64';
             }
 
             if ('x86_64' === $machine) {
-                return $this->binaryName = 'swc-darwin-x64';
+                return 'swc-darwin-x64';
             }
 
             throw new \Exception(sprintf('No matching machine found for Darwin platform (Machine: %s).', $machine));
         }
 
         if (str_contains($os, 'linux')) {
-            $kernel = strtolower(php_uname('r'));
             $kernelVersion = str_contains($kernel, 'musl') ? 'musl' : 'gnu';
             if ('arm64' === $machine || 'aarch64' === $machine) {
-                return $this->binaryName = 'swc-linux-arm64-'.$kernelVersion;
+                return 'swc-linux-arm64-'.$kernelVersion;
             }
             if ('x86_64' === $machine) {
-                return $this->binaryName = 'swc-linux-x64-'.$kernelVersion;
+                return 'swc-linux-x64-'.$kernelVersion;
             }
 
             throw new \Exception(sprintf('No matching machine found for Linux platform (Machine: %s).', $machine));
         }
 
         if (str_contains($os, 'win')) {
             if ('x86_64' === $machine) {
-                return $this->binaryName = 'swc-win32-x64-msvc';
+                return 'swc-win32-x64-msvc';
             }
             if ('amd64' === $machine) {
-                return $this->binaryName = 'swc-win32-arm64-msvc';
+                return 'swc-win32-arm64-msvc';
             }
             if ('i586' === $machine) {
-                return $this->binaryName = 'swc-win32-ia32-msvc';
+                return 'swc-win32-ia32-msvc';
             }
 
             throw new \Exception(sprintf('No matching machine found for Windows platform (Machine: %s).', $machine));
@@ -129,8 +96,45 @@ private function getBinaryName(): string
         throw new \Exception(sprintf('Unknown platform or architecture (OS: %s, Machine: %s).', $os, $machine));
     }
 
-    private function getDefaultBinaryPath(): string
+    private function downloadAndExtract($binaryName): void
     {
-        return $this->binaryDownloadDir.'/'.$this->getBinaryName();
+        if (!is_dir($this->binaryDownloadDir)) {
+            mkdir($this->binaryDownloadDir, 0777, true);
+        }
+        $targetPath = $this->binaryDownloadDir.'/'.$binaryName;
+        if (file_exists($targetPath)) {
+            return;
+        }
+        $url = sprintf(self::SWC_RELEASE_URL_PATTERN, self::VERSION, $binaryName);
+
+        if ($this->output?->isVerbose()) {
+            $this->output?->note(sprintf('Downloading SWC binary from "%s" to "%s"...', $url, $targetPath));
+        } else {
+            $this->output?->note('Downloading SWC binary ...');
+        }
+
+        $response = $this->httpClient->request('GET', $url, [
+            'on_progress' => function (int $dlNow, int $dlSize, array $info) use (&$progressBar): void {
+                if (0 === $dlSize) {
+                    return;
+                }
+
+                if (!$progressBar) {
+                    $progressBar = $this->output?->createProgressBar($dlSize);
+                }
+
+                $progressBar?->setProgress($dlNow);
+            },
+        ]);
+        $fileHandler = fopen($targetPath, 'w');
+        foreach ($this->httpClient->stream($response) as $chunk) {
+            fwrite($fileHandler, $chunk->getContent());
+        }
+
+        fclose($fileHandler);
+        $progressBar?->finish();
+        $this->output?->writeln('');
+
+        chmod($this->binaryDownloadDir.'/'.$binaryName, 7770);
     }
 }