idleberg/vite-manifest

A parser for Vite manifest files

v1.2.0 2024-10-20 23:11 UTC

Requires

• php: >=8.1
• league/uri: ^7.4.1

Requires (Dev)

• brainmaestro/composer-git-hooks: ^3.0.0
• 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
• shipmonk/composer-dependency-analyser: ^1.6

MIT

• Jan T. Sott

• vite
• vitejs
• vite manifest

README

A parser for Vite manifest files.

Table of contents

• Installation
• Usage
• Methods
  • getManifest()
  • getEntrypoint()
  • getEntrypoints()
  • getImports()
  • getStyles()
• License

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");

Parameters

$manifestPath

Type: string

Specifies the path to the manifest.

$baseUri

Type: string

Specifies the base URI for the assets in the manifest.

$algorithm

Type: "sha256" |"sha384" |"sha512" | ":manifest:"
Default: "sha256"

Specifies the algorithm used for hashing the assets. This will be used can be used for subsource integrity when printing script or style tags. You can use ":manifest:" in conjunction with vite-plugin-manifest-sri, a plug-in that calculates the hashes at build-time and adds them to the manifest.

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;
}

getEntrypoints()

Usage: getEntrypoints()

Returns all entrypoints 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.