Leverages on favicons to automatically generate your progressive web app for you.
Originally forked from jantimon/favicons-webpack-plugin
What's new?
Installation
Install the plugin with npm:
$ npm install --save-dev webapp-webpack-pluginBasic Usage
Add the plugin to your webpack config as follows:
const WebappWebpackPlugin = ... plugins: '/path/to/logo.png' // svg works too!The default configuration will automatically generate webapp manifest files along with
44 different icon formats
as appropriate for iOS devices, Android devices, Windows Phone and various desktop browsers out of your single logo.png.
Tip: You might want to fine tune what vendors to support.
A Note on Path Resolution
Under the hood, Webpack resolves the path to logo according to the following rules:
-
If
/path/to/logois absolute, there is nothing to resolve and the path specified is used as is. -
If
./path/to/logois relative, it's resolved with respect to Webpack'scontext, which defaults toprocess.cwd(). -
If
path/to/logois neither explicitly relative nor absolute, Webpack attempts to resolve it according toresolve.modules, which defaults tomodules: ["node_modules"].
HTML Injection
In combination with html-webpack-plugin it will also inject the necessary html for you:
Note:
html-webpack-pluginmust come beforewebapp-webpack-pluginin the plugins array.
https://github.com/brunocodutra/webapp-webpack-plugin/blob/master/test/fixtures/expected/html
Advanced Usage
plugins: // Your source logo (required) logo: '/path/to/logo.png' // Enable caching and optionally specify the path to store cached data // Note: disabling caching may increase build times considerably cache: true // Override the publicPath option usually read from webpack configuration publicPath: '/static' // The directory to output the assets relative to the webpack output dir. // Relative string paths are allowed here ie '../public/static'. If this // option is not set, `prefix` is used. outputPath: '/public/static' // Prefix path for generated assets prefix: 'assets/' // Inject html links/metadata (requires html-webpack-plugin). // This option accepts arguments of different types: // * boolean // `false`: disables injection // `true`: enables injection if that is not disabled in html-webpack-plugin // * string // `'force'`: enables injection even if that is disabled in html-webpack-plugin // * function // any predicate that takes an instance of html-webpack-plugin and returns either // `true` or `false` to control the injection of html metadata for the html files // generated by this instance. inject: true // Favicons configuration options (see below) favicons: ... To fine tune what icons/metadata is generated, refer to favicons' documentation.
The options specified under favicons: are handed over as is to favicons,
except that if appName, appDescription, version, developerName or
developerURL are left undefined, they will be automatically inferred
respectively from name, description, version, author.name and
author.url as defined in the nearest package.json if available.
To disable automatically retrieving metadata from package.json, simply set
to null the properties you want to omit.
Examples
Basic
const WebappWebpackPlugin = ... plugins: logo: '/path/to/logo.png' // svg works too! favicons: appName: 'my-app' appDescription: 'My awesome App' developerName: 'Me' developerURL: null // prevent retrieving from the nearest package.json background: '#ddd' theme_color: '#333' icons: coast: false yandex: false Handling Multiple HTML Files
const WebappWebpackPlugin = const HtmlWebpackPlugin = const basename = ... plugins: template: 'a.html.tmpl' filename: 'a.html' template: 'b.html.tmpl' filename: 'b.html' logo: 'logo.svg' === 'a.html' Hooks
To allow other plugins to intercept and customise assets before they are emitted, the following hooks may be tapped
webappWebpackPluginBeforeEmit
AsyncSeriesWaterfallHook
Example implementation:
{ compilerhooksmake } Rule
A Webpack loader rule is also provided to make the generated HTML tags available to your JS app.
const plugin = logo: '/path/to/logo.png' ; ... plugins: pluginmodule: rules: plugin // now inside Webpack bundle// you can require logo path// and get an array of strings with html tagsconst favicons = ;Note:
logomust be an absolute path forruleto work.
Contribution
You're very welcome to contribute to this project by opening issues and/or pull requests.
Please keep in mind that every change and new feature should be covered by tests.
License
This project is licensed under MIT.