https://github.com/madneal/pwa-manifest-generator

A webpack plugin for generating progressive web application manifest.json file.
https://github.com/madneal/pwa-manifest-generator

pwa webpack webpack-plugin

Last synced: about 1 month ago
JSON representation

A webpack plugin for generating progressive web application manifest.json file.

• Host: GitHub
• URL: https://github.com/madneal/pwa-manifest-generator
• Owner: madneal
• License: mit
• Created: 2017-05-13T03:25:47.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-05-16T06:41:17.000Z (over 7 years ago)
• Last Synced: 2024-12-13T02:54:18.148Z (2 months ago)
• Topics: pwa, webpack, webpack-plugin
• Language: JavaScript
• Size: 75.2 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pwa-manifest-generator [![Build Status](https://travis-ci.org/neal1991/pwa-manifest-generator.svg?branch=master)](https://travis-ci.org/neal1991/pwa-manifest-generator)

This is utilized to generated `manifest.json` file for a progressive web application. And this is inspired by [pwa-manifest-webpack-plugin](https://github.com/easthing/pwa-manifest-webpack-plugin).

## Install

`npm install -g pwa-manifest-generator`

## Config 

```javascript

const pluginPwa = require('pwa-manifest-generator')

module.exports = {

  entry: path.resolve(__dirname, './main.js'),

  output: {

    path: path.resolve(__dirname, 'dist'),

    filename: 'bundle.js'

  },

  plugins: [

    new pluginPwa({

      name: 'test',

      description: 'test the plugin',

      icon: {

          src: path.resolve('example/icon.jpg'),

          sizes: [144, 192]

      }

    })

  ]

}

```

This will generate the `manifest.json` file:

```json

{

  "name": "pwa-manifest-generator",

  "version": "0.1.3",

  "description": "A webpack plugin to generate manifest.json file for a progressive web application.",

  "main": "index.js",

  "directories": {

    "example": "example"

  },

  "scripts": {

    "test": "webpack --config ./example/webpack.config.js"

  },

  "repository": {

    "type": "git",

    "url": "git+https://github.com/neal1991/pwa-manifest-generator.git"

  },

  "keywords": [

    "pwa",

    "webpack",

    "plugin"

  ],

  "author": "neal1991",

  "license": "MIT",

  "bugs": {

    "url": "https://github.com/neal1991/pwa-manifest-generator/issues"

  },

  "homepage": "https://github.com/neal1991/pwa-manifest-generator#readme",

  "dependencies": {

    "mime": "^1.3.6",

    "webpack": "^2.5.1",

    "jimp": "^0.2.27

  }

}

```

You can access the example folder for an example. In the example folder, there is a `webpack.config.js`，you can run `npm run test` to generate the `manifest.json` file.

## LICENSE

[MIT](https://github.com/neal1991/pwa-manifest-generator/blob/master/LICENSE)