Skip to content

feat: pwa, generate manifest.json (#2981) #3711

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion packages/@vue/cli-plugin-pwa/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ file, or the `"vue"` field in `package.json`.
- Default: `'default'`

- **pwa.assetsVersion**

- Default: `''`

This option is used if you need to add a version to your icons and manifest, against browser’s cache. This will append `?v=<pwa.assetsVersion>` to the URLs of the icons and manifest.
Expand All @@ -65,6 +65,35 @@ file, or the `"vue"` field in `package.json`.

The path of app’s manifest.

- **pwa.manifestOptions**

- Default: `{}`

The object will be used to generate the `manifest.json`

If the following attributes are not defined in the object, the options of `pwa` or default options will be used instead.
- name: `pwa.name`
- short_name: `pwa.name`
- icons:
```js
[
{
src: './img/icons/android-chrome-192x192.png',
sizes: '192x192',
type: 'image/png'
},
{
src: './img/icons/android-chrome-512x512.png',
sizes: '512x512',
type: 'image/png'
}
]
```
- start_url: `'./index.html'`
- display: `'standalone'`
- background_color: `'#000000'`
- theme_color: `pwa.themeColor`

- **pwa.iconPaths**

- Defaults:
Expand Down
22 changes: 22 additions & 0 deletions packages/@vue/cli-plugin-pwa/__tests__/pwaPlugin.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,28 @@ test('pwa', async () => {
expect(project.has('dist/manifest.json')).toBe(true)
expect(project.has('dist/img/icons/android-chrome-512x512.png')).toBe(true)

const manifest = await project.read('dist/manifest.json')
expect(JSON.parse(manifest)).toEqual({
name: 'pwa-build',
short_name: 'pwa-build',
theme_color: '#4DBA87',
icons: [
{
src: './img/icons/android-chrome-192x192.png',
sizes: '192x192',
type: 'image/png'
},
{
src: './img/icons/android-chrome-512x512.png',
sizes: '512x512',
type: 'image/png'
}
],
start_url: './index.html',
display: 'standalone',
background_color: '#000000'
})

// Make sure the base preload/prefetch are not affected
const index = await project.read('dist/index.html')

Expand Down

This file was deleted.

4 changes: 3 additions & 1 deletion packages/@vue/cli-plugin-pwa/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,16 @@ module.exports = (api, options) => {
}

const name = api.service.pkg.name
const assetsPublic = api.resolve('public')
const userOptions = options.pwa || {}

// the pwa plugin hooks on to html-webpack-plugin
// and injects icons, manifest links & other PWA related tags into <head>
webpackConfig
.plugin('pwa')
.use(require('./lib/HtmlPwaPlugin'), [Object.assign({
name
name,
assetsPublic
}, userOptions)])
.after('html')

Expand Down
77 changes: 76 additions & 1 deletion packages/@vue/cli-plugin-pwa/lib/HtmlPwaPlugin.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,26 @@ const defaults = {
appleMobileWebAppCapable: 'no',
appleMobileWebAppStatusBarStyle: 'default',
assetsVersion: '',
manifestPath: 'manifest.json'
manifestPath: 'manifest.json',
manifestOptions: {}
}

const defaultManifest = {
icons: [
{
"src": "./img/icons/android-chrome-192x192.png",
"sizes": "192x192",
"type": "image/png"
},
{
"src": "./img/icons/android-chrome-512x512.png",
"sizes": "512x512",
"type": "image/png"
}
],
start_url: './index.html',
display: 'standalone',
background_color: "#000000"
}

const defaultIconPaths = {
Expand Down Expand Up @@ -109,6 +128,62 @@ module.exports = class HtmlPwaPlugin {

cb(null, data)
})


})

// generated manifest.json
compiler.hooks.emit.tapAsync(ID, (data, cb) => {
const {
name,
assetsPublic,
themeColor,
manifestPath,
manifestOptions
} = this.options

const publicOptions = {
name,
short_name: name,
theme_color: themeColor
}

const manifestFilePath = path.resolve(assetsPublic, manifestPath)
let fileManifest
try {
fileManifest = JSON.parse(
fs.readFileSync(manifestFilePath).toString()
)

// Check the generated manifest.json (without file) is identical to the existing one
const nofileManifest = Object.assign(publicOptions, defaultManifest, manifestOptions)
const isIdentical = !Object.keys(fileManifest).find((key) => {
return (
JSON.stringify(fileManifest[key]) !==
JSON.stringify(nofileManifest[key])
)
})

// Throw info or warn
setTimeout(() => {
if (isIdentical) {
info(`You can safely delete the manifest.json redundant file.\nFile Path: ${manifestFilePath}`)
} else {
warn(`Recommend: Use pwa.manifestOptions instead of ${manifestFilePath}`)
}
}, 1000)
} catch (err) {
fileManifest = {}
}

const outputManifest = JSON.stringify(
Object.assign(publicOptions, defaultManifest, fileManifest, manifestOptions)
)
data.assets[manifestPath] = {
source: () => outputManifest,
size: () => outputManifest.length
}
cb(null, data)
})
}
}
Expand Down