azerella / rollup-plugin-manifest-json

Rollup plugin to generate a manifest.json file used to tell the browser about your web app.

rollup-plugin-manifest-json

Rollup plugin that generates a web application manifest file. This file contains the startup parameters and application defaults when a web application is launched.

Install

# NPM
npm i --save-dev rollup-plugin-manifest-json

# Yarn
yarn add -D rollup-plugin-manifest-json

Usage

import manifestJSON from "rollup-plugin-manifest-json";

export default {
    input: "main.js",
    plugins: [
        ...
        manifestJSON({
            input: "public/manifest.json", // Required
            // minify: true
            // output: "public/manifest.webmanifest"
            manifest: {
                short_name: "different-short-name"
            }
        })
    ]
}

Options

input

Required

Type: string

Default: ""

The web application manifest file location that will be either cloned or modified and moved into the Rollup build directory.

minify

Optional

Type: boolean

Default: true

Whether or not to mangle the output file, it's recommended to minify the file as it will reduce the file size.

manifest

Optional

Type: object

Default: {}

The key values you wish to add or modify given the existing web application manifest file. For a full list of key values to use see here.

output

Optional

Type: string

Default: public/manifest.json

Output directory to write the manifest file to, useful for building your app outside of the root rollup folder.

Contributors

Don't be scared to raise an issue or a pull request!

Any contributions, no matter how big or small will land your picture here and be greatly appreciated ❤️