.eslintrc.json

@@ -1,5 +1,5 @@
 {
-  "extends": "@antfu",
+  "extends": ["@antfu"],
   "overrides": [
     {
       "files": [

.gitignore

@@ -6,3 +6,6 @@ dev-dist
 .idea/
 # routify
 .routify/
+examples/*/test-results/
+examples/*/playwright-report/
+examples/*/playwright/.cache/

.npmrc

@@ -0,0 +1,5 @@
+ignore-workspace-root-check=true
+shamefully-hoist=true
+strict-peer-dependencies=false
+auto-install-peers=true
+shell-emulator=true

CONTRIBUTING.md

@@ -11,9 +11,9 @@ To develop and test the `vite-plugin-pwa` package:
 
 1. Fork the `vite-plugin-pwa` repository to your own GitHub account and then clone it to your local device.
 
-2. Ensure using the latest Node.js (16.x)
+2. Ensure using the latest Node.js (16.x), from version 0.16.0 `vite-plugin-pwa` requires Node.js 16.x.
 
-3. `vite-plugin-pwa` uses pnpm v7. If you are working on multiple projects with different versions of pnpm, it's recommend to enable [Corepack](https://github.com/nodejs/corepack) by running `corepack enable`.
+3. `vite-plugin-pwa` uses pnpm v8. If you are working on multiple projects with different versions of pnpm, it's recommend to enable [Corepack](https://github.com/nodejs/corepack) by running `corepack enable`.
 
 4. Check out a branch where you can work and commit your changes:
 ```shell
@@ -38,10 +38,12 @@ The `vite-plugin-pwa` repo includes a set of examples where you can test the cha
 
 > If your changes are specific to some behavior, just use the corresponding option on the `cli`.
 
-## Testing website docs changes
+## Running tests
+
+Before running tests, you'll need to install [Playwright](https://playwright.dev/) Chromium browser: `pnpm playwright install chromium`.
 
-`vite-plugin-pwa` uses `Vitepress` for the website docs, if your changes are about the documentation, you can find the website on the `docs` folder. 
+Run `pnpm run test` in root folder or inside each examples folder after build `vite-plugin-pwa`.
 
-Once you made the changes to the documentation, you can test them running `pnpm run docs` from the root folder.
+## Testing website docs changes
 
-To check the website build, just run `pnpm run docs:serve` from the root folder.
+`vite-plugin-pwa` docs website has been moved to [docs repository](https://github.com/vite-pwa/docs).

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Anthony Fu<https://github.com/antfu>
+Copyright (c) 2020-PRESENT Anthony Fu <https://github.com/antfu>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,5 +1,5 @@
 <p align='center'>
-<img src='https://vite-plugin-pwa.netlify.app/banner_light.svg' alt="vite-plugin-pwa - Zero-config PWA for Vite"><br>
+<img src='https://vite-pwa-org.netlify.app/banner_light.svg' alt="vite-plugin-pwa - Zero-config PWA for Vite"><br>
 Zero-config PWA Framework-agnostic Plugin for Vite
 </p>
 
@@ -10,7 +10,7 @@ Zero-config PWA Framework-agnostic Plugin for Vite
 <a href="https://www.npmjs.com/package/vite-plugin-pwa" target="__blank">
     <img alt="NPM Downloads" src="https://img.shields.io/npm/dm/vite-plugin-pwa?color=476582&label=">
 </a>
-<a href="https://vite-plugin-pwa.netlify.app/" target="__blank">
+<a href="https://vite-pwa-org.netlify.app/" target="__blank">
     <img src="https://img.shields.io/static/v1?label=&message=docs%20%26%20guides&color=2e859c" alt="Docs & Guides">
 </a>
 <br>
@@ -30,7 +30,7 @@ Zero-config PWA Framework-agnostic Plugin for Vite
 
 ## 🚀 Features
 
-- 📖 [**Documentation & guides**](https://vite-plugin-pwa.netlify.app/)
+- 📖 [**Documentation & guides**](https://vite-pwa-org.netlify.app/)
 - 👌 **Zero-Config**: sensible built-in default configs for common use cases
 - 🔩 **Extensible**: expose the full ability to customize the behavior of the plugin
 - 🦾 **Type Strong**: written in [TypeScript](https://www.typescriptlang.org/)
@@ -40,9 +40,14 @@ Zero-config PWA Framework-agnostic Plugin for Vite
 - ⚙️ **Stale-while-revalidate**: automatic reload when new content is available
 - ✨ **Static assets handling**: configure static assets for offline support
 - 🐞 **Development Support**: debug your custom service worker logic as you develop your application
+- 🛠️ **Versatile**: integration with meta frameworks:  [îles](https://github.com/ElMassimo/iles), [SvelteKit](https://github.com/sveltejs/kit), [VitePress](https://github.com/vuejs/vitepress), [Astro](https://github.com/withastro/astro), and [Nuxt 3](https://github.com/nuxt/nuxt)
 
 ## 📦 Install
 
+> From v0.13, `vite-plugin-pwa` requires **Vite 3.1 or above**.
+
+> From v0.16 `vite-plugin-pwa` requires **Node 16 or above**: `workbox v7` requires **Node 16 or above**.
+
 ```bash
 npm i vite-plugin-pwa -D 
 
@@ -68,7 +73,7 @@ export default {
 }
 ```
 
-Read the [📖 documentation](https://vite-plugin-pwa.netlify.app/guide/) for a complete guide on how to configure and use 
+Read the [📖 documentation](https://vite-pwa-org.netlify.app/guide/) for a complete guide on how to configure and use 
 this plugin.
 
 Check out the client type declarations [client.d.ts](./client.d.ts) for built-in frameworks support.
@@ -83,4 +88,4 @@ Check out the type declaration [src/types.ts](./src/types.ts) and the following
 
 ## 📄 License
 
-MIT License © 2020-PRESENT [Anthony Fu](https://github.com/antfu)
+[MIT](./LICENSE) License &copy; 2020-PRESENT [Anthony Fu](https://github.com/antfu)

client.d.ts

@@ -1,189 +1,6 @@
-declare module 'virtual:pwa-register' {
-  export interface RegisterSWOptions {
-    immediate?: boolean
-    onNeedRefresh?: () => void
-    onOfflineReady?: () => void
-    /**
-     * Called only if `onRegisteredSW` is not provided.
-     *
-     * @deprecated Use `onRegisteredSW` instead.
-     * @param registration The service worker registration if available.
-     */
-    onRegistered?: (registration: ServiceWorkerRegistration | undefined) => void
-    /**
-     * Called once the service worker is registered (requires version `0.12.8+`).
-     *
-     * @param swScriptUrl The service worker script url.
-     * @param registration The service worker registration if available.
-     */
-    onRegisteredSW?: (swScriptUrl: string, registration: ServiceWorkerRegistration | undefined) => void
-    onRegisterError?: (error: any) => void
-  }
-
-  export function registerSW(options?: RegisterSWOptions): (reloadPage?: boolean) => Promise<void>
-}
-
-declare module 'virtual:pwa-register/vue' {
-  // eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error
-  // @ts-ignore ignore when vue is not installed
-  import type { Ref } from 'vue'
-
-  export interface RegisterSWOptions {
-    immediate?: boolean
-    onNeedRefresh?: () => void
-    onOfflineReady?: () => void
-    /**
-     * Called only if `onRegisteredSW` is not provided.
-     *
-     * @deprecated Use `onRegisteredSW` instead.
-     * @param registration The service worker registration if available.
-     */
-    onRegistered?: (registration: ServiceWorkerRegistration | undefined) => void
-    /**
-     * Called once the service worker is registered (requires version `0.12.8+`).
-     *
-     * @param swScriptUrl The service worker script url.
-     * @param registration The service worker registration if available.
-     */
-    onRegisteredSW?: (swScriptUrl: string, registration: ServiceWorkerRegistration | undefined) => void
-    onRegisterError?: (error: any) => void
-  }
-
-  export function useRegisterSW(options?: RegisterSWOptions): {
-    needRefresh: Ref<boolean>
-    offlineReady: Ref<boolean>
-    updateServiceWorker: (reloadPage?: boolean) => Promise<void>
-  }
-}
-
-declare module 'virtual:pwa-register/svelte' {
-  // eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error
-  // @ts-ignore ignore when svelte is not installed
-  import type { Writable } from 'svelte/store'
-
-  export interface RegisterSWOptions {
-    immediate?: boolean
-    onNeedRefresh?: () => void
-    onOfflineReady?: () => void
-    /**
-     * Called only if `onRegisteredSW` is not provided.
-     *
-     * @deprecated Use `onRegisteredSW` instead.
-     * @param registration The service worker registration if available.
-     */
-    onRegistered?: (registration: ServiceWorkerRegistration | undefined) => void
-    /**
-     * Called once the service worker is registered (requires version `0.12.8+`).
-     *
-     * @param swScriptUrl The service worker script url.
-     * @param registration The service worker registration if available.
-     */
-    onRegisteredSW?: (swScriptUrl: string, registration: ServiceWorkerRegistration | undefined) => void
-    onRegisterError?: (error: any) => void
-  }
-
-  export function useRegisterSW(options?: RegisterSWOptions): {
-    needRefresh: Writable<boolean>
-    offlineReady: Writable<boolean>
-    updateServiceWorker: (reloadPage?: boolean) => Promise<void>
-  }
-}
-
-declare module 'virtual:pwa-register/react' {
-  // eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error
-  // @ts-ignore ignore when react is not installed
-  import type { Dispatch, SetStateAction } from 'react'
-
-  export interface RegisterSWOptions {
-    immediate?: boolean
-    onNeedRefresh?: () => void
-    onOfflineReady?: () => void
-    /**
-     * Called only if `onRegisteredSW` is not provided.
-     *
-     * @deprecated Use `onRegisteredSW` instead.
-     * @param registration The service worker registration if available.
-     */
-    onRegistered?: (registration: ServiceWorkerRegistration | undefined) => void
-    /**
-     * Called once the service worker is registered (requires version `0.12.8+`).
-     *
-     * @param swScriptUrl The service worker script url.
-     * @param registration The service worker registration if available.
-     */
-    onRegisteredSW?: (swScriptUrl: string, registration: ServiceWorkerRegistration | undefined) => void
-    onRegisterError?: (error: any) => void
-  }
-
-  export function useRegisterSW(options?: RegisterSWOptions): {
-    needRefresh: [boolean, Dispatch<SetStateAction<boolean>>]
-    offlineReady: [boolean, Dispatch<SetStateAction<boolean>>]
-    updateServiceWorker: (reloadPage?: boolean) => Promise<void>
-  }
-}
-
-declare module 'virtual:pwa-register/solid' {
-  // eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error
-  // @ts-ignore ignore when solid-js is not installed
-  import type { Accessor, Setter } from 'solid-js'
-
-  export interface RegisterSWOptions {
-    immediate?: boolean
-    onNeedRefresh?: () => void
-    onOfflineReady?: () => void
-    /**
-     * Called only if `onRegisteredSW` is not provided.
-     *
-     * @deprecated Use `onRegisteredSW` instead.
-     * @param registration The service worker registration if available.
-     */
-    onRegistered?: (registration: ServiceWorkerRegistration | undefined) => void
-    /**
-     * Called once the service worker is registered (requires version `0.12.8+`).
-     *
-     * @param swScriptUrl The service worker script url.
-     * @param registration The service worker registration if available.
-     */
-    onRegisteredSW?: (swScriptUrl: string, registration: ServiceWorkerRegistration | undefined) => void
-    onRegisterError?: (error: any) => void
-  }
-
-  export function useRegisterSW(options?: RegisterSWOptions): {
-    needRefresh: [Accessor<boolean>, Setter<boolean>]
-    offlineReady: [Accessor<boolean>, Setter<boolean>]
-    updateServiceWorker: (reloadPage?: boolean) => Promise<void>
-  }
-}
-
-declare module 'virtual:pwa-register/preact' {
-  // eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error
-  // @ts-ignore ignore when preact/hooks is not installed
-  import type { StateUpdater } from 'preact/hooks'
-
-  export interface RegisterSWOptions {
-    immediate?: boolean
-    onNeedRefresh?: () => void
-    onOfflineReady?: () => void
-    /**
-     * Called only if `onRegisteredSW` is not provided.
-     *
-     * @deprecated Use `onRegisteredSW` instead.
-     * @param registration The service worker registration if available.
-     */
-    onRegistered?: (registration: ServiceWorkerRegistration | undefined) => void
-    /**
-     * Called once the service worker is registered (requires version `0.12.8+`).
-     *
-     * @param swScriptUrl The service worker script url.
-     * @param registration The service worker registration if available.
-     */
-    onRegisteredSW?: (swScriptUrl: string, registration: ServiceWorkerRegistration | undefined) => void
-    onRegisterError?: (error: any) => void
-  }
-
-  export function useRegisterSW(options?: RegisterSWOptions): {
-    needRefresh: [boolean, StateUpdater<boolean>]
-    offlineReady: [boolean, StateUpdater<boolean>]
-    updateServiceWorker: (reloadPage?: boolean) => Promise<void>
-  }
-}
+import './vue'
+import './preact'
+import './react'
+import './svelte'
+import './solid'
+import './vanillajs'

docs/.vitepress/components.d.ts

@@ -3,6 +3,8 @@
 // Read more: https://github.com/vuejs/core/pull/3399
 import '@vue/runtime-core'
 
+export {}
+
 declare module '@vue/runtime-core' {
   export interface GlobalComponents {
     CleanupOutdatedCaches: typeof import('./theme/components/CleanupOutdatedCaches.md')['default']
@@ -11,7 +13,6 @@ declare module '@vue/runtime-core' {
     ExamplesInjectManifest: typeof import('./theme/components/ExamplesInjectManifest.md')['default']
     GenerateSWCleanupOutdatedCaches: typeof import('./theme/components/GenerateSWCleanupOutdatedCaches.md')['default']
     GenerateSWSourceMap: typeof import('./theme/components/GenerateSWSourceMap.md')['default']
-    HeuristicWorkboxWindow: typeof import('./theme/components/HeuristicWorkboxWindow.md')['default']
     HomePage: typeof import('./theme/components/HomePage.vue')['default']
     InjectManifestCleanupOutdatedCaches: typeof import('./theme/components/InjectManifestCleanupOutdatedCaches.md')['default']
     InjectManifestSourceMap: typeof import('./theme/components/InjectManifestSourceMap.md')['default']
@@ -24,5 +25,3 @@ declare module '@vue/runtime-core' {
     TypeScriptError2307: typeof import('./theme/components/TypeScriptError2307.md')['default']
   }
 }
-
-export {}

docs/.vitepress/config.ts

@@ -1,5 +1,7 @@
 import { defineConfig } from 'vitepress'
 import { version } from '../../package.json'
+import { pwa } from '../scripts/pwa'
+import { buildEnd } from '../scripts/build'
 
 const Guide = [
   {
@@ -224,8 +226,8 @@ function prepareSidebar(idx: number) {
   })
 }
 
-const ogUrl = 'https://vite-plugin-pwa.netlify.app/'
-const ogImage = 'https://vite-plugin-pwa.netlify.app/og-image.png'
+const ogUrl = 'https://vite-pwa-org.netlify.app/'
+const ogImage = 'https://vite-pwa-org.netlify.app/og-image.png'
 
 export default defineConfig({
   lang: 'en-US',
@@ -328,4 +330,10 @@ export default defineConfig({
       '/workbox/': prepareSidebar(4),
     },
   },
+  vite: {
+    plugins: [
+      pwa(),
+    ],
+  },
+  buildEnd,
 })