From dae95cea90fd0268f73b27fff0bb11772800cd75 Mon Sep 17 00:00:00 2001 From: Ruud Kamphuis Date: Thu, 23 May 2024 13:24:31 +0200 Subject: [PATCH 01/15] Do not require `http_client` service This makes it possible to use AssetMapper with `http_client` disabled on the framework. Example: ```php $configurator->extension( 'framework', [ 'http_client' => [ 'enabled' => false, ], 'asset_mapper' => [ 'paths' => [ 'assets/', ], ], ] ); ``` --- ImportMap/ImportMapUpdateChecker.php | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/ImportMap/ImportMapUpdateChecker.php b/ImportMap/ImportMapUpdateChecker.php index b64a067..3c22499 100644 --- a/ImportMap/ImportMapUpdateChecker.php +++ b/ImportMap/ImportMapUpdateChecker.php @@ -11,16 +11,20 @@ namespace Symfony\Component\AssetMapper\ImportMap; +use Symfony\Component\HttpClient\HttpClient; use Symfony\Contracts\HttpClient\HttpClientInterface; class ImportMapUpdateChecker { private const URL_PACKAGE_METADATA = 'https://registry.npmjs.org/%s'; + private readonly HttpClientInterface $httpClient; + public function __construct( private readonly ImportMapConfigReader $importMapConfigReader, - private readonly HttpClientInterface $httpClient, + ?HttpClientInterface $httpClient = null, ) { + $this->httpClient = $httpClient ?? HttpClient::create(); } /** From 05c56ffb0003da4fc1568c36dd7379277c042e45 Mon Sep 17 00:00:00 2001 From: Christian Flothmann Date: Fri, 24 May 2024 13:05:21 +0200 Subject: [PATCH 02/15] use constructor property promotion --- Event/PreAssetsCompileEvent.php | 8 +++----- MappedAsset.php | 35 +++++++-------------------------- 2 files changed, 10 insertions(+), 33 deletions(-) diff --git a/Event/PreAssetsCompileEvent.php b/Event/PreAssetsCompileEvent.php index 972e78a..1ce0862 100644 --- a/Event/PreAssetsCompileEvent.php +++ b/Event/PreAssetsCompileEvent.php @@ -21,11 +21,9 @@ */ class PreAssetsCompileEvent extends Event { - private OutputInterface $output; - - public function __construct(OutputInterface $output) - { - $this->output = $output; + public function __construct( + private OutputInterface $output, + ) { } public function getOutput(): OutputInterface diff --git a/MappedAsset.php b/MappedAsset.php index 763e3cc..6bb828d 100644 --- a/MappedAsset.php +++ b/MappedAsset.php @@ -34,28 +34,11 @@ final class MappedAsset public readonly string $digest; public readonly bool $isPredigested; - public readonly bool $isVendor; /** - * Assets whose content affects the content of this asset. - * - * @var MappedAsset[] - */ - private array $dependencies = []; - - /** - * @var string[] - */ - private array $fileDependencies = []; - - /** - * @var JavaScriptImport[] - */ - private array $javaScriptImports = []; - - /** - * @param MappedAsset[] $dependencies assets that the content of this asset depends on - * @param string[] $fileDependencies files that the content of this asset depends on + * @param MappedAsset[] $dependencies assets that the content of this asset depends on + * @param string[] $fileDependencies files that the content of this asset depends on + * @param JavaScriptImport[] $javaScriptImports */ public function __construct( public readonly string $logicalPath, @@ -65,10 +48,10 @@ public function __construct( ?string $content = null, ?string $digest = null, ?bool $isPredigested = null, - bool $isVendor = false, - array $dependencies = [], - array $fileDependencies = [], - array $javaScriptImports = [], + public readonly bool $isVendor = false, + private array $dependencies = [], + private array $fileDependencies = [], + private array $javaScriptImports = [], ) { if (null !== $sourcePath) { $this->sourcePath = $sourcePath; @@ -87,10 +70,6 @@ public function __construct( if (null !== $isPredigested) { $this->isPredigested = $isPredigested; } - $this->isVendor = $isVendor; - $this->dependencies = $dependencies; - $this->fileDependencies = $fileDependencies; - $this->javaScriptImports = $javaScriptImports; } /** From e6d23dfbfcb1161c780903fe8c0836e1a2cd8dc9 Mon Sep 17 00:00:00 2001 From: "Alexander M. Turek" Date: Thu, 20 Jun 2024 17:52:34 +0200 Subject: [PATCH 03/15] Prefix all sprintf() calls --- AssetMapper.php | 2 +- AssetMapperDevServerSubscriber.php | 2 +- AssetMapperRepository.php | 4 +-- Command/AssetMapperCompileCommand.php | 16 +++++------ Command/ImportMapAuditCommand.php | 14 +++++----- Command/ImportMapInstallCommand.php | 2 +- Command/ImportMapOutdatedCommand.php | 6 ++-- Command/ImportMapRemoveCommand.php | 4 +-- Command/ImportMapRequireCommand.php | 8 +++--- Command/ImportMapUpdateCommand.php | 2 +- Command/VersionProblemCommandTrait.php | 4 +-- Compiler/CssAssetUrlCompiler.php | 4 +-- Compiler/JavaScriptImportPathCompiler.php | 12 ++++---- Factory/MappedAssetFactory.php | 4 +-- ImportMap/ImportMapAuditor.php | 2 +- ImportMap/ImportMapConfigReader.php | 8 +++--- ImportMap/ImportMapEntries.php | 2 +- ImportMap/ImportMapGenerator.php | 22 +++++++-------- ImportMap/ImportMapManager.php | 4 +-- ImportMap/ImportMapRenderer.php | 8 +++--- ImportMap/ImportMapUpdateChecker.php | 8 +++--- ImportMap/ImportMapVersionChecker.php | 2 +- ImportMap/RemotePackageDownloader.php | 12 ++++---- ImportMap/RemotePackageStorage.php | 12 ++++---- ImportMap/Resolver/JsDelivrEsmResolver.php | 28 +++++++++---------- .../JavaScriptImportPathCompilerTest.php | 6 ++-- Tests/Factory/MappedAssetFactoryTest.php | 2 +- Tests/ImportMap/ImportMapManagerTest.php | 4 +-- .../ImportMap/ImportMapVersionCheckerTest.php | 2 +- 29 files changed, 103 insertions(+), 103 deletions(-) diff --git a/AssetMapper.php b/AssetMapper.php index 4afcf63..05e7952 100644 --- a/AssetMapper.php +++ b/AssetMapper.php @@ -46,7 +46,7 @@ public function allAssets(): iterable foreach ($this->mapperRepository->all() as $logicalPath => $filePath) { $asset = $this->getAsset($logicalPath); if (null === $asset) { - throw new \LogicException(sprintf('Asset "%s" could not be found.', $logicalPath)); + throw new \LogicException(\sprintf('Asset "%s" could not be found.', $logicalPath)); } yield $asset; } diff --git a/AssetMapperDevServerSubscriber.php b/AssetMapperDevServerSubscriber.php index abdedfa..5de0fc0 100644 --- a/AssetMapperDevServerSubscriber.php +++ b/AssetMapperDevServerSubscriber.php @@ -127,7 +127,7 @@ public function onKernelRequest(RequestEvent $event): void $asset = $this->findAssetFromCache($pathInfo); if (!$asset) { - throw new NotFoundHttpException(sprintf('Asset with public path "%s" not found.', $pathInfo)); + throw new NotFoundHttpException(\sprintf('Asset with public path "%s" not found.', $pathInfo)); } $this->profiler?->disable(); diff --git a/AssetMapperRepository.php b/AssetMapperRepository.php index f79d173..d000dbf 100644 --- a/AssetMapperRepository.php +++ b/AssetMapperRepository.php @@ -149,7 +149,7 @@ private function getDirectories(): array foreach ($this->paths as $path => $namespace) { if ($filesystem->isAbsolutePath($path)) { if (!file_exists($path) && $this->debug) { - throw new \InvalidArgumentException(sprintf('The asset mapper directory "%s" does not exist.', $path)); + throw new \InvalidArgumentException(\sprintf('The asset mapper directory "%s" does not exist.', $path)); } $this->absolutePaths[realpath($path)] = $namespace; @@ -163,7 +163,7 @@ private function getDirectories(): array } if ($this->debug) { - throw new \InvalidArgumentException(sprintf('The asset mapper directory "%s" does not exist.', $path)); + throw new \InvalidArgumentException(\sprintf('The asset mapper directory "%s" does not exist.', $path)); } } diff --git a/Command/AssetMapperCompileCommand.php b/Command/AssetMapperCompileCommand.php index 10f0796..bb54194 100644 --- a/Command/AssetMapperCompileCommand.php +++ b/Command/AssetMapperCompileCommand.php @@ -69,26 +69,26 @@ protected function execute(InputInterface $input, OutputInterface $output): int $this->compiledConfigReader->removeConfig(ImportMapGenerator::IMPORT_MAP_CACHE_FILENAME); $entrypointFiles = []; foreach ($this->importMapGenerator->getEntrypointNames() as $entrypointName) { - $path = sprintf(ImportMapGenerator::ENTRYPOINT_CACHE_FILENAME_PATTERN, $entrypointName); + $path = \sprintf(ImportMapGenerator::ENTRYPOINT_CACHE_FILENAME_PATTERN, $entrypointName); $this->compiledConfigReader->removeConfig($path); $entrypointFiles[$entrypointName] = $path; } $manifest = $this->createManifestAndWriteFiles($io); $manifestPath = $this->compiledConfigReader->saveConfig(AssetMapper::MANIFEST_FILE_NAME, $manifest); - $io->comment(sprintf('Manifest written to %s', $this->shortenPath($manifestPath))); + $io->comment(\sprintf('Manifest written to %s', $this->shortenPath($manifestPath))); $importMapPath = $this->compiledConfigReader->saveConfig(ImportMapGenerator::IMPORT_MAP_CACHE_FILENAME, $this->importMapGenerator->getRawImportMapData()); - $io->comment(sprintf('Import map data written to %s.', $this->shortenPath($importMapPath))); + $io->comment(\sprintf('Import map data written to %s.', $this->shortenPath($importMapPath))); foreach ($entrypointFiles as $entrypointName => $path) { $this->compiledConfigReader->saveConfig($path, $this->importMapGenerator->findEagerEntrypointImports($entrypointName)); } - $styledEntrypointNames = array_map(fn (string $entrypointName) => sprintf('%s', $entrypointName), array_keys($entrypointFiles)); - $io->comment(sprintf('Entrypoint metadata written for %d entrypoints (%s).', \count($entrypointFiles), implode(', ', $styledEntrypointNames))); + $styledEntrypointNames = array_map(fn (string $entrypointName) => \sprintf('%s', $entrypointName), array_keys($entrypointFiles)); + $io->comment(\sprintf('Entrypoint metadata written for %d entrypoints (%s).', \count($entrypointFiles), implode(', ', $styledEntrypointNames))); if ($this->isDebug) { - $io->warning(sprintf( + $io->warning(\sprintf( 'Debug mode is enabled in your project: Symfony will not serve any changed assets until you delete the files in the "%s" directory again.', $this->shortenPath(\dirname($manifestPath)) )); @@ -104,7 +104,7 @@ private function shortenPath(string $path): string private function createManifestAndWriteFiles(SymfonyStyle $io): array { - $io->comment(sprintf('Compiling and writing asset files to %s', $this->shortenPath($this->assetsFilesystem->getDestinationPath()))); + $io->comment(\sprintf('Compiling and writing asset files to %s', $this->shortenPath($this->assetsFilesystem->getDestinationPath()))); $manifest = []; foreach ($this->assetMapper->allAssets() as $asset) { if (null !== $asset->content) { @@ -117,7 +117,7 @@ private function createManifestAndWriteFiles(SymfonyStyle $io): array $manifest[$asset->logicalPath] = $asset->publicPath; } ksort($manifest); - $io->comment(sprintf('Compiled %d assets', \count($manifest))); + $io->comment(\sprintf('Compiled %d assets', \count($manifest))); return $manifest; } diff --git a/Command/ImportMapAuditCommand.php b/Command/ImportMapAuditCommand.php index c4c5acb..369377a 100644 --- a/Command/ImportMapAuditCommand.php +++ b/Command/ImportMapAuditCommand.php @@ -44,7 +44,7 @@ protected function configure(): void $this->addOption( name: 'format', mode: InputOption::VALUE_REQUIRED, - description: sprintf('The output format ("%s")', implode(', ', $this->getAvailableFormatOptions())), + description: \sprintf('The output format ("%s")', implode(', ', $this->getAvailableFormatOptions())), default: 'txt', ); } @@ -63,7 +63,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int return match ($format) { 'txt' => $this->displayTxt($audit), 'json' => $this->displayJson($audit), - default => throw new \InvalidArgumentException(sprintf('Supported formats are "%s".', implode('", "', $this->getAvailableFormatOptions()))), + default => throw new \InvalidArgumentException(\sprintf('Supported formats are "%s".', implode('", "', $this->getAvailableFormatOptions()))), }; } @@ -79,7 +79,7 @@ private function displayTxt(array $audit): int } foreach ($packageAudit->vulnerabilities as $vulnerability) { $rows[] = [ - sprintf('%s', self::SEVERITY_COLORS[$vulnerability->severity] ?? 'default', ucfirst($vulnerability->severity)), + \sprintf('%s', self::SEVERITY_COLORS[$vulnerability->severity] ?? 'default', ucfirst($vulnerability->severity)), $vulnerability->summary, $packageAudit->package, $packageAudit->version ?? 'n/a', @@ -113,7 +113,7 @@ private function displayTxt(array $audit): int $this->io->newLine(); } - $this->io->text(sprintf('%d package%s found: %d audited / %d skipped', + $this->io->text(\sprintf('%d package%s found: %d audited / %d skipped', $packagesCount, 1 === $packagesCount ? '' : 's', $packagesCount - $packagesWithoutVersionCount, @@ -121,7 +121,7 @@ private function displayTxt(array $audit): int )); if (0 < $packagesWithoutVersionCount) { - $this->io->warning(sprintf('Unable to retrieve versions for package%s: %s', + $this->io->warning(\sprintf('Unable to retrieve versions for package%s: %s', 1 === $packagesWithoutVersionCount ? '' : 's', implode(', ', $packagesWithoutVersion) )); @@ -134,10 +134,10 @@ private function displayTxt(array $audit): int if (!$count) { continue; } - $vulnerabilitySummary[] = sprintf('%d %s', $count, ucfirst($severity)); + $vulnerabilitySummary[] = \sprintf('%d %s', $count, ucfirst($severity)); $vulnerabilityCount += $count; } - $this->io->text(sprintf('%d vulnerabilit%s found: %s', + $this->io->text(\sprintf('%d vulnerabilit%s found: %s', $vulnerabilityCount, 1 === $vulnerabilityCount ? 'y' : 'ies', implode(' / ', $vulnerabilitySummary), diff --git a/Command/ImportMapInstallCommand.php b/Command/ImportMapInstallCommand.php index f9a42da..8f67656 100644 --- a/Command/ImportMapInstallCommand.php +++ b/Command/ImportMapInstallCommand.php @@ -63,7 +63,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int return Command::SUCCESS; } - $io->success(sprintf( + $io->success(\sprintf( 'Downloaded %d package%s into %s.', \count($downloadedPackages), 1 === \count($downloadedPackages) ? '' : 's', diff --git a/Command/ImportMapOutdatedCommand.php b/Command/ImportMapOutdatedCommand.php index ac188a0..14b7615 100644 --- a/Command/ImportMapOutdatedCommand.php +++ b/Command/ImportMapOutdatedCommand.php @@ -46,7 +46,7 @@ protected function configure(): void ->addOption( name: 'format', mode: InputOption::VALUE_REQUIRED, - description: sprintf('The output format ("%s")', implode(', ', $this->getAvailableFormatOptions())), + description: \sprintf('The output format ("%s")', implode(', ', $this->getAvailableFormatOptions())), default: 'txt', ) ->setHelp(<<<'EOT' @@ -88,9 +88,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int foreach ($displayData as $datum) { $color = self::COLOR_MAPPING[$datum['latest-status']] ?? 'default'; $table->addRow([ - sprintf('%s', $color, $datum['name']), + \sprintf('%s', $color, $datum['name']), $datum['current'], - sprintf('%s', $color, $datum['latest']), + \sprintf('%s', $color, $datum['latest']), ]); } $table->render(); diff --git a/Command/ImportMapRemoveCommand.php b/Command/ImportMapRemoveCommand.php index 82d6fe4..58bfe46 100644 --- a/Command/ImportMapRemoveCommand.php +++ b/Command/ImportMapRemoveCommand.php @@ -55,9 +55,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int $this->importMapManager->remove($packageList); if (1 === \count($packageList)) { - $io->success(sprintf('Removed "%s" from importmap.php.', $packageList[0])); + $io->success(\sprintf('Removed "%s" from importmap.php.', $packageList[0])); } else { - $io->success(sprintf('Removed %d items from importmap.php.', \count($packageList))); + $io->success(\sprintf('Removed %d items from importmap.php.', \count($packageList))); } return Command::SUCCESS; diff --git a/Command/ImportMapRequireCommand.php b/Command/ImportMapRequireCommand.php index 19b5dfb..b3ccb1d 100644 --- a/Command/ImportMapRequireCommand.php +++ b/Command/ImportMapRequireCommand.php @@ -96,7 +96,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int foreach ($packageList as $packageName) { $parts = ImportMapManager::parsePackageName($packageName); if (null === $parts) { - $io->error(sprintf('Package "%s" is not a valid package name format. Use the format PACKAGE@VERSION - e.g. "lodash" or "lodash@^4"', $packageName)); + $io->error(\sprintf('Package "%s" is not a valid package name format. Use the format PACKAGE@VERSION - e.g. "lodash" or "lodash@^4"', $packageName)); return Command::FAILURE; } @@ -116,18 +116,18 @@ protected function execute(InputInterface $input, OutputInterface $output): int if (1 === \count($newPackages)) { $newPackage = $newPackages[0]; - $message = sprintf('Package "%s" added to importmap.php', $newPackage->importName); + $message = \sprintf('Package "%s" added to importmap.php', $newPackage->importName); $message .= '.'; } else { $names = array_map(fn (ImportMapEntry $package) => $package->importName, $newPackages); - $message = sprintf('%d new items (%s) added to the importmap.php!', \count($newPackages), implode(', ', $names)); + $message = \sprintf('%d new items (%s) added to the importmap.php!', \count($newPackages), implode(', ', $names)); } $messages = [$message]; if (1 === \count($newPackages)) { - $messages[] = sprintf('Use the new package normally by importing "%s".', $newPackages[0]->importName); + $messages[] = \sprintf('Use the new package normally by importing "%s".', $newPackages[0]->importName); } $io->success($messages); diff --git a/Command/ImportMapUpdateCommand.php b/Command/ImportMapUpdateCommand.php index 2c3c615..afd17cd 100644 --- a/Command/ImportMapUpdateCommand.php +++ b/Command/ImportMapUpdateCommand.php @@ -64,7 +64,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int $this->renderVersionProblems($this->importMapVersionChecker, $output); if (0 < \count($packages)) { - $io->success(sprintf( + $io->success(\sprintf( 'Updated %s package%s in importmap.php.', implode(', ', array_map(static fn (ImportMapEntry $entry): string => $entry->importName, $updatedPackages)), 1 < \count($updatedPackages) ? 's' : '', diff --git a/Command/VersionProblemCommandTrait.php b/Command/VersionProblemCommandTrait.php index cc8c143..2131920 100644 --- a/Command/VersionProblemCommandTrait.php +++ b/Command/VersionProblemCommandTrait.php @@ -24,12 +24,12 @@ private function renderVersionProblems(ImportMapVersionChecker $importMapVersion $problems = $importMapVersionChecker->checkVersions(); foreach ($problems as $problem) { if (null === $problem->installedVersion) { - $output->writeln(sprintf('[warning] %s requires %s but it is not in the importmap.php. You may need to run "php bin/console importmap:require %s".', $problem->packageName, $problem->dependencyPackageName, $problem->dependencyPackageName)); + $output->writeln(\sprintf('[warning] %s requires %s but it is not in the importmap.php. You may need to run "php bin/console importmap:require %s".', $problem->packageName, $problem->dependencyPackageName, $problem->dependencyPackageName)); continue; } - $output->writeln(sprintf('[warning] %s requires %s@%s but version %s is installed.', $problem->packageName, $problem->dependencyPackageName, $problem->requiredVersionConstraint, $problem->installedVersion)); + $output->writeln(\sprintf('[warning] %s requires %s@%s but version %s is installed.', $problem->packageName, $problem->dependencyPackageName, $problem->requiredVersionConstraint, $problem->installedVersion)); } } } diff --git a/Compiler/CssAssetUrlCompiler.php b/Compiler/CssAssetUrlCompiler.php index 09a8beb..b023fd2 100644 --- a/Compiler/CssAssetUrlCompiler.php +++ b/Compiler/CssAssetUrlCompiler.php @@ -39,14 +39,14 @@ public function compile(string $content, MappedAsset $asset, AssetMapperInterfac try { $resolvedSourcePath = Path::join(\dirname($asset->sourcePath), $matches[1]); } catch (RuntimeException $e) { - $this->handleMissingImport(sprintf('Error processing import in "%s": ', $asset->sourcePath).$e->getMessage(), $e); + $this->handleMissingImport(\sprintf('Error processing import in "%s": ', $asset->sourcePath).$e->getMessage(), $e); return $matches[0]; } $dependentAsset = $assetMapper->getAssetFromSourcePath($resolvedSourcePath); if (null === $dependentAsset) { - $message = sprintf('Unable to find asset "%s" referenced in "%s". The file "%s" ', $matches[1], $asset->sourcePath, $resolvedSourcePath); + $message = \sprintf('Unable to find asset "%s" referenced in "%s". The file "%s" ', $matches[1], $asset->sourcePath, $resolvedSourcePath); if (is_file($resolvedSourcePath)) { $message .= 'exists, but it is not in a mapped asset path. Add it to the "paths" config.'; } else { diff --git a/Compiler/JavaScriptImportPathCompiler.php b/Compiler/JavaScriptImportPathCompiler.php index 9a0546a..82d6de9 100644 --- a/Compiler/JavaScriptImportPathCompiler.php +++ b/Compiler/JavaScriptImportPathCompiler.php @@ -115,7 +115,7 @@ public function compile(string $content, MappedAsset $asset, AssetMapperInterfac $relativeImportPath = $this->makeRelativeForJavaScript($relativeImportPath); return str_replace($importedModule, $relativeImportPath, $fullImportString); - }, $content, -1, $count, \PREG_OFFSET_CAPTURE) ?? throw new RuntimeException(sprintf('Failed to compile JavaScript import paths in "%s". Error: "%s".', $asset->sourcePath, preg_last_error_msg())); + }, $content, -1, $count, \PREG_OFFSET_CAPTURE) ?? throw new RuntimeException(\sprintf('Failed to compile JavaScript import paths in "%s". Error: "%s".', $asset->sourcePath, preg_last_error_msg())); } public function supports(MappedAsset $asset): bool @@ -194,7 +194,7 @@ private function findAssetForRelativeImport(string $importedModule, MappedAsset } catch (RuntimeException $e) { // avoid warning about vendor imports - these are often comments if (!$asset->isVendor) { - $this->handleMissingImport(sprintf('Error processing import in "%s": ', $asset->sourcePath).$e->getMessage(), $e); + $this->handleMissingImport(\sprintf('Error processing import in "%s": ', $asset->sourcePath).$e->getMessage(), $e); } return null; @@ -215,14 +215,14 @@ private function findAssetForRelativeImport(string $importedModule, MappedAsset return null; } - $message = sprintf('Unable to find asset "%s" imported from "%s".', $importedModule, $asset->sourcePath); + $message = \sprintf('Unable to find asset "%s" imported from "%s".', $importedModule, $asset->sourcePath); if (is_file($resolvedSourcePath)) { - $message .= sprintf('The file "%s" exists, but it is not in a mapped asset path. Add it to the "paths" config.', $resolvedSourcePath); + $message .= \sprintf('The file "%s" exists, but it is not in a mapped asset path. Add it to the "paths" config.', $resolvedSourcePath); } else { try { - if (null !== $assetMapper->getAssetFromSourcePath(sprintf('%s.js', $resolvedSourcePath))) { - $message .= sprintf(' Try adding ".js" to the end of the import - i.e. "%s.js".', $importedModule); + if (null !== $assetMapper->getAssetFromSourcePath(\sprintf('%s.js', $resolvedSourcePath))) { + $message .= \sprintf(' Try adding ".js" to the end of the import - i.e. "%s.js".', $importedModule); } } catch (CircularAssetsException) { // avoid circular error if there is self-referencing import comments diff --git a/Factory/MappedAssetFactory.php b/Factory/MappedAssetFactory.php index 0b5b376..89fd03d 100644 --- a/Factory/MappedAssetFactory.php +++ b/Factory/MappedAssetFactory.php @@ -38,7 +38,7 @@ public function __construct( public function createMappedAsset(string $logicalPath, string $sourcePath): ?MappedAsset { if (isset($this->assetsBeingCreated[$logicalPath])) { - throw new CircularAssetsException($this->assetsCache[$logicalPath], sprintf('Circular reference detected while creating asset for "%s": "%s".', $logicalPath, implode(' -> ', $this->assetsBeingCreated).' -> '.$logicalPath)); + throw new CircularAssetsException($this->assetsCache[$logicalPath], \sprintf('Circular reference detected while creating asset for "%s": "%s".', $logicalPath, implode(' -> ', $this->assetsBeingCreated).' -> '.$logicalPath)); } $this->assetsBeingCreated[$logicalPath] = $logicalPath; @@ -98,7 +98,7 @@ private function getDigest(MappedAsset $asset, ?string $content): array private function compileContent(MappedAsset $asset): ?string { if (!is_file($asset->sourcePath)) { - throw new RuntimeException(sprintf('Asset source path "%s" could not be found.', $asset->sourcePath)); + throw new RuntimeException(\sprintf('Asset source path "%s" could not be found.', $asset->sourcePath)); } if (!$this->compiler->supports($asset)) { diff --git a/ImportMap/ImportMapAuditor.php b/ImportMap/ImportMapAuditor.php index f53e8df..f62b031 100644 --- a/ImportMap/ImportMapAuditor.php +++ b/ImportMap/ImportMapAuditor.php @@ -66,7 +66,7 @@ public function audit(): array ]); if (200 !== $response->getStatusCode()) { - throw new RuntimeException(sprintf('Error %d auditing packages. Response: '.$response->getContent(false), $response->getStatusCode())); + throw new RuntimeException(\sprintf('Error %d auditing packages. Response: '.$response->getContent(false), $response->getStatusCode())); } foreach ($response->toArray() as $advisory) { diff --git a/ImportMap/ImportMapConfigReader.php b/ImportMap/ImportMapConfigReader.php index fef7db5..7ed39ea 100644 --- a/ImportMap/ImportMapConfigReader.php +++ b/ImportMap/ImportMapConfigReader.php @@ -43,7 +43,7 @@ public function getEntries(): ImportMapEntries foreach ($importMapConfig ?? [] as $importName => $data) { $validKeys = ['path', 'version', 'type', 'entrypoint', 'package_specifier']; if ($invalidKeys = array_diff(array_keys($data), $validKeys)) { - throw new \InvalidArgumentException(sprintf('The following keys are not valid for the importmap entry "%s": "%s". Valid keys are: "%s".', $importName, implode('", "', $invalidKeys), implode('", "', $validKeys))); + throw new \InvalidArgumentException(\sprintf('The following keys are not valid for the importmap entry "%s": "%s". Valid keys are: "%s".', $importName, implode('", "', $invalidKeys), implode('", "', $validKeys))); } $type = isset($data['type']) ? ImportMapType::tryFrom($data['type']) : ImportMapType::JS; @@ -51,10 +51,10 @@ public function getEntries(): ImportMapEntries if (isset($data['path'])) { if (isset($data['version'])) { - throw new RuntimeException(sprintf('The importmap entry "%s" cannot have both a "path" and "version" option.', $importName)); + throw new RuntimeException(\sprintf('The importmap entry "%s" cannot have both a "path" and "version" option.', $importName)); } if (isset($data['package_specifier'])) { - throw new RuntimeException(sprintf('The importmap entry "%s" cannot have both a "path" and "package_specifier" option.', $importName)); + throw new RuntimeException(\sprintf('The importmap entry "%s" cannot have both a "path" and "package_specifier" option.', $importName)); } $entries->add(ImportMapEntry::createLocal($importName, $type, $data['path'], $isEntrypoint)); @@ -65,7 +65,7 @@ public function getEntries(): ImportMapEntries $version = $data['version'] ?? null; if (null === $version) { - throw new RuntimeException(sprintf('The importmap entry "%s" must have either a "path" or "version" option.', $importName)); + throw new RuntimeException(\sprintf('The importmap entry "%s" must have either a "path" or "version" option.', $importName)); } $packageModuleSpecifier = $data['package_specifier'] ?? $importName; diff --git a/ImportMap/ImportMapEntries.php b/ImportMap/ImportMapEntries.php index 25e681c..c971f3d 100644 --- a/ImportMap/ImportMapEntries.php +++ b/ImportMap/ImportMapEntries.php @@ -45,7 +45,7 @@ public function has(string $importName): bool public function get(string $importName): ImportMapEntry { if (!$this->has($importName)) { - throw new \InvalidArgumentException(sprintf('The importmap entry "%s" does not exist.', $importName)); + throw new \InvalidArgumentException(\sprintf('The importmap entry "%s" does not exist.', $importName)); } return $this->entries[$importName]; diff --git a/ImportMap/ImportMapGenerator.php b/ImportMap/ImportMapGenerator.php index 80bbaad..89579fb 100644 --- a/ImportMap/ImportMapGenerator.php +++ b/ImportMap/ImportMapGenerator.php @@ -121,26 +121,26 @@ public function getRawImportMapData(): array */ public function findEagerEntrypointImports(string $entryName): array { - if ($this->compiledConfigReader->configExists(sprintf(self::ENTRYPOINT_CACHE_FILENAME_PATTERN, $entryName))) { - return $this->compiledConfigReader->loadConfig(sprintf(self::ENTRYPOINT_CACHE_FILENAME_PATTERN, $entryName)); + if ($this->compiledConfigReader->configExists(\sprintf(self::ENTRYPOINT_CACHE_FILENAME_PATTERN, $entryName))) { + return $this->compiledConfigReader->loadConfig(\sprintf(self::ENTRYPOINT_CACHE_FILENAME_PATTERN, $entryName)); } $rootImportEntries = $this->importMapConfigReader->getEntries(); if (!$rootImportEntries->has($entryName)) { - throw new \InvalidArgumentException(sprintf('The entrypoint "%s" does not exist in "importmap.php".', $entryName)); + throw new \InvalidArgumentException(\sprintf('The entrypoint "%s" does not exist in "importmap.php".', $entryName)); } if (!$rootImportEntries->get($entryName)->isEntrypoint) { - throw new \InvalidArgumentException(sprintf('The entrypoint "%s" is not an entry point in "importmap.php". Set "entrypoint" => true to make it available as an entrypoint.', $entryName)); + throw new \InvalidArgumentException(\sprintf('The entrypoint "%s" is not an entry point in "importmap.php". Set "entrypoint" => true to make it available as an entrypoint.', $entryName)); } if ($rootImportEntries->get($entryName)->isRemotePackage()) { - throw new \InvalidArgumentException(sprintf('The entrypoint "%s" is a remote package and cannot be used as an entrypoint.', $entryName)); + throw new \InvalidArgumentException(\sprintf('The entrypoint "%s" is a remote package and cannot be used as an entrypoint.', $entryName)); } $asset = $this->findAsset($rootImportEntries->get($entryName)->path); if (!$asset) { - throw new \InvalidArgumentException(sprintf('The path "%s" of the entrypoint "%s" mentioned in "importmap.php" cannot be found in any asset map paths.', $rootImportEntries->get($entryName)->path, $entryName)); + throw new \InvalidArgumentException(\sprintf('The path "%s" of the entrypoint "%s" mentioned in "importmap.php" cannot be found in any asset map paths.', $rootImportEntries->get($entryName)->path, $entryName)); } return $this->findEagerImports($asset); @@ -181,7 +181,7 @@ private function addImplicitEntries(ImportMapEntry $entry, array $currentImportE if ($javaScriptImport->addImplicitlyToImportMap) { if (!$importedAsset = $this->assetMapper->getAsset($javaScriptImport->assetLogicalPath)) { // should not happen at this point, unless something added a bogus JavaScriptImport to this asset - throw new LogicException(sprintf('Cannot find imported JavaScript asset "%s" in asset mapper.', $javaScriptImport->assetLogicalPath)); + throw new LogicException(\sprintf('Cannot find imported JavaScript asset "%s" in asset mapper.', $javaScriptImport->assetLogicalPath)); } $nextEntry = ImportMapEntry::createLocal( @@ -240,7 +240,7 @@ private function findEagerImports(MappedAsset $asset): array // Follow its imports! if (!$javaScriptAsset = $this->assetMapper->getAsset($javaScriptImport->assetLogicalPath)) { // should not happen at this point, unless something added a bogus JavaScriptImport to this asset - throw new LogicException(sprintf('Cannot find JavaScript asset "%s" (imported in "%s") in asset mapper.', $javaScriptImport->assetLogicalPath, $asset->logicalPath)); + throw new LogicException(\sprintf('Cannot find JavaScript asset "%s" (imported in "%s") in asset mapper.', $javaScriptImport->assetLogicalPath, $asset->logicalPath)); } $queue[] = $javaScriptAsset; } @@ -253,12 +253,12 @@ private function createMissingImportMapAssetException(ImportMapEntry $entry): \I { if ($entry->isRemotePackage()) { if (!is_file($entry->path)) { - throw new LogicException(sprintf('The "%s" vendor asset is missing. Try running the "importmap:install" command.', $entry->importName)); + throw new LogicException(\sprintf('The "%s" vendor asset is missing. Try running the "importmap:install" command.', $entry->importName)); } - throw new LogicException(sprintf('The "%s" vendor file exists locally (%s), but cannot be found in any asset map paths. Be sure the assets vendor directory is an asset mapper path.', $entry->importName, $entry->path)); + throw new LogicException(\sprintf('The "%s" vendor file exists locally (%s), but cannot be found in any asset map paths. Be sure the assets vendor directory is an asset mapper path.', $entry->importName, $entry->path)); } - throw new LogicException(sprintf('The asset "%s" cannot be found in any asset map paths.', $entry->path)); + throw new LogicException(\sprintf('The asset "%s" cannot be found in any asset map paths.', $entry->path)); } } diff --git a/ImportMap/ImportMapManager.php b/ImportMap/ImportMapManager.php index 7e352ce..4a12a6a 100644 --- a/ImportMap/ImportMapManager.php +++ b/ImportMap/ImportMapManager.php @@ -94,7 +94,7 @@ private function updateImportMapConfig(bool $update, array $packagesToRequire, a foreach ($packagesToRemove as $packageName) { if (!$currentEntries->has($packageName)) { - throw new \InvalidArgumentException(sprintf('Package "%s" listed for removal was not found in "importmap.php".', $packageName)); + throw new \InvalidArgumentException(\sprintf('Package "%s" listed for removal was not found in "importmap.php".', $packageName)); } $this->cleanupPackageFiles($currentEntries->get($packageName)); @@ -149,7 +149,7 @@ private function requirePackages(array $packagesToRequire, ImportMapEntries $imp $path = $requireOptions->path; if (!$asset = $this->findAsset($path)) { - throw new \LogicException(sprintf('The path "%s" of the package "%s" cannot be found: either pass the logical name of the asset or a relative path starting with "./".', $requireOptions->path, $requireOptions->importName)); + throw new \LogicException(\sprintf('The path "%s" of the package "%s" cannot be found: either pass the logical name of the asset or a relative path starting with "./".', $requireOptions->path, $requireOptions->importName)); } // convert to a relative path (or fallback to the logical path) diff --git a/ImportMap/ImportMapRenderer.php b/ImportMap/ImportMapRenderer.php index 65957f7..3e1cf8e 100644 --- a/ImportMap/ImportMapRenderer.php +++ b/ImportMap/ImportMapRenderer.php @@ -80,7 +80,7 @@ public function render(string|array $entryPoint, array $attributes = []): string // importmap entry is a noop $importMap[$importName] = 'data:application/javascript,'; } else { - $importMap[$importName] = 'data:application/javascript,'.rawurlencode(sprintf('document.head.appendChild(Object.assign(document.createElement("link"),{rel:"stylesheet",href:"%s"}))', addslashes($path))); + $importMap[$importName] = 'data:application/javascript,'.rawurlencode(\sprintf('document.head.appendChild(Object.assign(document.createElement("link"),{rel:"stylesheet",href:"%s"}))', addslashes($path))); } } @@ -106,7 +106,7 @@ public function render(string|array $entryPoint, array $attributes = []): string if (false !== $this->polyfillImportName && null === $polyfillPath) { if ('es-module-shims' !== $this->polyfillImportName) { - throw new \InvalidArgumentException(sprintf('The JavaScript module polyfill was not found in your import map. Either disable the polyfill or run "php bin/console importmap:require "%s"" to install it.', $this->polyfillImportName)); + throw new \InvalidArgumentException(\sprintf('The JavaScript module polyfill was not found in your import map. Either disable the polyfill or run "php bin/console importmap:require "%s"" to install it.', $this->polyfillImportName)); } // a fallback for the default polyfill in case it's not in the importmap @@ -162,7 +162,7 @@ private function createAttributesString(array $attributes): string $attributes += $this->scriptAttributes; if (isset($attributes['src']) || isset($attributes['type'])) { - throw new \InvalidArgumentException(sprintf('The "src" and "type" attributes are not allowed on the + HTML; } @@ -151,12 +156,14 @@ public function render(string|array $entryPoint, array $attributes = []): string return $output; } - private function escapeAttributeValue(string $value): string + private function escapeAttributeValue(string $value, int $flags = \ENT_COMPAT | \ENT_SUBSTITUTE): string { - return htmlspecialchars($value, \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset); + $value = htmlspecialchars($value, $flags, $this->charset); + + return \ENT_NOQUOTES & $flags ? addslashes($value) : $value; } - private function createAttributesString(array $attributes): string + private function createAttributesString(array $attributes, string $pattern = '%s="%s"', string $glue = ' ', int $flags = \ENT_COMPAT | \ENT_SUBSTITUTE): string { $attributeString = ''; @@ -166,15 +173,17 @@ private function createAttributesString(array $attributes): string } foreach ($attributes as $name => $value) { - $attributeString .= ' '; + if ('' !== $attributeString) { + $attributeString .= $glue; + } if (true === $value) { - $attributeString .= $name; - - continue; + $value = $name; } - $attributeString .= \sprintf('%s="%s"', $name, $this->escapeAttributeValue($value)); + $attributeString .= \sprintf($pattern, $this->escapeAttributeValue($name, $flags), $this->escapeAttributeValue($value, $flags)); } + $attributeString = preg_replace('/\b([^ =]++)="\1"/', '\1', $attributeString); + return $attributeString; } diff --git a/Tests/ImportMap/ImportMapRendererTest.php b/Tests/ImportMap/ImportMapRendererTest.php index 0ff4d40..a477063 100644 --- a/Tests/ImportMap/ImportMapRendererTest.php +++ b/Tests/ImportMap/ImportMapRendererTest.php @@ -77,7 +77,7 @@ public function testBasicRender() $this->assertStringContainsString('', $html); + $this->assertStringContainsString("script.src = 'https://ga.jspm.io/npm:es-module-shims';", $html); // and is hidden from the import map $this->assertStringNotContainsString('"es-module-shim"', $html); $this->assertStringContainsString('import \'app\';', $html); @@ -120,8 +120,8 @@ public function testDefaultPolyfillUsedIfNotInImportmap() polyfillImportName: 'es-module-shims', ); $html = $renderer->render(['app']); - $this->assertStringContainsString('', $html); + $this->assertStringContainsString('