Skip to content

Scrum/webpack-extension-manifest-plugin

Repository files navigation

webpack-extension-manifest-plugin

Creates manifest json file based on you config

Actions Statusnodenpm versionXO code styleCoveralls status

npm downloadsnpm

Why ?

Simplifies the development of cross-platform browser extension

  • Firefox
  • Chrome
  • EDGE
  • Safari

Install

npm i -D webpack-extension-manifest-plugin

Note: This project is compatible with node v10+

Usage

baseManifest.js

export default {
  name: 'my manifest'
};

webpack.config.js

import WebpackExtensionManifestPlugin from 'webpack-extension-manifest-plugin';

module.exports = {
  plugins: [
    new WebpackExtensionManifestPlugin({
      config: {
        base: './baseManifest.js',
        extend: {description: 'my description'}
      },
      pkgJsonProps: [
        'version'
      ]
    })
  ]
};

Create manifest.json with extend configs {name: 'my manifest', description: 'my description', version: '0.0.0'}

Options

config

Type: Object
Default: {}
Description: Can take a ready-made configuration or filename (to fetch from) for the manifest file, or a set of parameters base, extend (both of which can be a filename or an object)

minify

Type: Boolean
Default: false
Description: Controls if the output should be minified

pkgJsonProps

Type: Array of strings
Description: Adds specified properties from your package.json file into the manifest