idleberg / vite-manifest
A parser for Vite v2 manifest files
Installs: 19 495
Dependents: 1
Suggesters: 0
Security: 0
Stars: 6
Watchers: 3
Forks: 2
Open Issues: 1
Requires
- php: >=8.1
- league/uri: ^6.0
Requires (Dev)
- brainmaestro/composer-git-hooks: ^3.0@alpha
- codeception/codeception: ^5.0.4
- codeception/module-asserts: ^3.0.0
- friendsofphp/php-cs-fixer: ^3.8
- icanhazstring/composer-unused: ^0.8.10
- phpstan/phpstan: ^1.9
README
A parser for Vite v2 manifest files
Table of contents
Installation
composer require idleberg/vite-manifest
Usage
To get you going, first instantiate the class exposed by this library
new Manifest(string $manifestPath, string $baseUri, string $algorithm = "sha256");
Example
use Idleberg\ViteManifest\Manifest; $baseUrl = "https://idleberg.github.io"; $manifest = "path/to/manifest.json"; $vm = new Manifest($manifest, $baseUrl);
Methods
getManifest()
Usage: getManifest()
Returns the contents of the manifest file as a PHP array
getEntrypoint()
Usage: getEntrypoint(string $entrypoint, bool $hash = true)
Example
$entrypoint = $vm->getEntrypoint("index.ts"); if ($entrypoint) { ["url" => $url, "hash" => $hash] = $entrypoint; echo "<script type='module' src='$url' crossorigin integrity='$hash'></script>" . PHP_EOL; }
Returns the entrypoint from the manifest
getImports()
Usage: getImports(string $entrypoint, bool $hash = true)
Returns imports for a file listed in the manifest
Example
foreach ($vm->getImports("index.ts", false) as $import) { ["url" => $url] = $import; echo "<link rel='modulepreload' href='$url' />" . PHP_EOL; }
getStyles()
Usage: getStyles(string $entrypoint, bool $hash = true)
Returns stylesheets for a file listed in the manifest
Example
foreach ($vm->getStyles("index.ts") as $style) { ["url" => $url, "hash" => $hash] = $style; echo "<link rel='stylesheet' href='$url' crossorigin integrity='$hash' />" . PHP_EOL; }
License
This work is licensed under The MIT License