Features

• Converts manifest.json to a PHP file.
• Supports filtering and grouping of manifest items/chunks.
• Allows customization of PHP file formatting (line breaks, indentation, short array syntax).

Installation

Install it via npm:

1npm install vite-php-manifest --save-dev

Or with yarn:

1yarn add -D vite-php-manifest

Usage

Add the plugin to your vite.config.js file:

1import { defineConfig } from 'vite';
2import { VitePhpManifest } from 'vite-php-manifest';
3
4export default defineConfig({
5  plugins: [VitePhpManifest()],
6});

or with plugin options (optional)

1import { defineConfig } from 'vite';
2import { VitePhpManifest } from 'vite-php-manifest';
3
4export default defineConfig({
5  plugins: [
6    VitePhpManifest({
7      filter: (originalFileName, manifestChunk) => {
8        manifestChunk.myCustomKey = 'my-custom-value';
9        return manifestChunk;
10      },
11      group: {
12        js: ['js', 'jsx'],
13        css: ['css'],
14        images: ['png', 'jpg', 'jpeg', 'gif'],
15        svg: ['svg'],
16      },
17      linebreak: '\n',
18      indent: '    ',
19      shortArraySyntax: true,
20      unlinkOriginManifest: false,
21      manifestFile: 'vite/manifest.php',
22    }),
23  ],
24});

Options

filter (default: false)

Type: false | (originalFileName: string, manifestChunk: ManifestChunk) => ManifestChunk | null

A function to filter chunks in the manifest. If false, no filtering is applied.

Example:

1filter: (originalFileName, manifestChunk) => {
2  if (manifestChunk.isEntry) {
3    manifestChunk.customEntryKey = 'custom-value';
4  }
5  return manifestChunk;
6};

group (default: false)

Type: false | Record<string, string[]> | (originalFileName: string, manifestChunk: ManifestChunk) => string

A function to group chunks in the PHP manifest. Can be an object mapping group names to file extensions or a callback function.

Example (Object Mapping):

1 group: {
2    js: ['js', 'jsx'],
3    css: ['css'],
4    images: ['png', 'jpg', 'jpeg', 'gif'],
5    svg: ['svg']
6},

Example (Callback Function):

1group: (originalFileName, manifestChunk) => {
2  return originalFileName.endsWith('.css') ? 'styles' : 'scripts';
3},

defaultGroup (default: 'other')

Type: string

The default group name for chunks that do not match any group when using object mapping.

unlinkOriginManifest (default: true)

Type: boolean

If true, deletes the original manifest.json after generating the PHP file.

manifestFile (default: 'manifest.php')

Type: string

The output path for the generated PHP manifest file relative to the outDir.

linebreak (default: '\n')

Type: string

The line break character(s) to use in the PHP manifest file.

indent (default: ' ')

Type: string

The indentation character(s) to use in the PHP manifest file.

shortArraySyntax (default: false)

Type: boolean

Whether to use PHP's short array syntax ([]).

Example Output

Given the following manifest.json:

1{
2  "main.js": {
3    "file": "assets/main-1234.js",
4    "isEntry": true
5  },
6  "styles.css": {
7    "file": "assets/styles-5678.css",
8    "isEntry": false
9  }
10}

The plugin generates the following manifest.php:

1<?php
2  return array(
3    'main.js' => array(
4      'file' => 'assets/main-1234.js',
5      'isEntry' => true,
6    ),
7    'styles.css' => array(
8      'file' => 'assets/styles-5678.css',
9      'isEntry' => false,
10    ),
11  );