[AssetMapper] Adding debug:assetmap command + normalize paths #50219
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\AssetMapper\Command; | ||
|
|
||
| use Symfony\Component\AssetMapper\AssetMapperInterface; | ||
| use Symfony\Component\AssetMapper\AssetMapperRepository; | ||
| use Symfony\Component\Console\Attribute\AsCommand; | ||
| use Symfony\Component\Console\Command\Command; | ||
| use Symfony\Component\Console\Input\InputInterface; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
| use Symfony\Component\Console\Style\SymfonyStyle; | ||
|
|
||
| /** | ||
| * Outputs all the assets in the asset mapper. | ||
| * | ||
| * @experimental | ||
| * | ||
| * @author Ryan Weaver <ryan@symfonycasts.com> | ||
| */ | ||
| #[AsCommand(name: 'debug:asset-map', description: 'Outputs all mapped assets.')] | ||
| final class DebugAssetMapperCommand extends Command | ||
| { | ||
| private bool $didShortenPaths = false; | ||
|
|
||
| public function __construct( | ||
| private readonly AssetMapperInterface $assetMapper, | ||
| private readonly AssetMapperRepository $assetMapperRepository, | ||
| private readonly string $projectDir, | ||
| ) { | ||
| parent::__construct(); | ||
| } | ||
|
|
||
| protected function configure(): void | ||
| { | ||
| $this | ||
| ->addOption('full', null, null, 'Whether to show the full paths') | ||
| ->setHelp(<<<'EOT' | ||
| The <info>%command.name%</info> command outputs all of the assets in | ||
| asset mapper for debugging purposes. | ||
| EOT | ||
| ); | ||
| } | ||
|
|
||
| protected function execute(InputInterface $input, OutputInterface $output): int | ||
| { | ||
| $io = new SymfonyStyle($input, $output); | ||
|
|
||
| $allAssets = $this->assetMapper->allAssets(); | ||
|
|
||
| $pathRows = []; | ||
| foreach ($this->assetMapperRepository->allDirectories() as $path => $namespace) { | ||
weaverryan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| $path = $this->relativizePath($path); | ||
|
There was a problem hiding this comment. We could make There was a problem hiding this comment. That's true - we already have the projectRootDir there. I don't feel too strongly either way :) There was a problem hiding this comment. if only the debug command needs that, I would keep it in the bug command for now |
||
| if (!$input->getOption('full')) { | ||
| $path = $this->shortenPath($path); | ||
| } | ||
|
|
||
| $pathRows[] = [$path, $namespace]; | ||
| } | ||
| $io->section('Asset Mapper Paths'); | ||
| $io->table(['Path', 'Namespace prefix'], $pathRows); | ||
|
|
||
| $rows = []; | ||
| foreach ($allAssets as $asset) { | ||
| $logicalPath = $asset->logicalPath; | ||
| $sourcePath = $this->relativizePath($asset->getSourcePath()); | ||
|
|
||
| if (!$input->getOption('full')) { | ||
| $logicalPath = $this->shortenPath($logicalPath); | ||
| $sourcePath = $this->shortenPath($sourcePath); | ||
| } | ||
|
|
||
| $rows[] = [ | ||
| $logicalPath, | ||
| $sourcePath, | ||
| ]; | ||
| } | ||
| $io->section('Mapped Assets'); | ||
| $io->table(['Logical Path', 'Filesystem Path'], $rows); | ||
|
|
||
| if ($this->didShortenPaths) { | ||
| $io->note('To see the full paths, re-run with the --full option.'); | ||
| } | ||
|
|
||
| return 0; | ||
| } | ||
|
|
||
| private function relativizePath(string $path): string | ||
| { | ||
| return str_replace($this->projectDir.'/', '', $path); | ||
| } | ||
|
|
||
| private function shortenPath($path): string | ||
| { | ||
| $limit = 50; | ||
|
|
||
| if (\strlen($path) <= $limit) { | ||
| return $path; | ||
| } | ||
|
|
||
| $this->didShortenPaths = true; | ||
| $limit = floor(($limit - 3) / 2); | ||
|
|
||
| return substr($path, 0, $limit).'...'.substr($path, -$limit); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using
realpatheverywhere now in this file so that all paths use the "real" path. That's just "nice" because you'll get back full paths - instead of potentially getting back file paths like/var/something/else/../other-path/app.js- and is important especially forfindLogicalPath()where we pass in a$filesystemPathand then do some matching by the filesystem path.