@promoboxx/react-scripts-vite 0.1.18 → 0.1.22

package/README.md

@@ -8,6 +8,7 @@ An almost drop-in replacement for react-scripts, but based on Vite.
 - TypeScript `paths`
 - TypeScript type checking
 - ESLint linting
+- PWA support
 - `process.env`
 - Vitest
 
@@ -39,10 +40,27 @@ Put this in `src/react-scripts-vite.d.ts`:
 
 Should be very straightforward. For application code, everything should be supported out of the box.
 
+### index.html
+
+Vite expects your `index.html` to live at the root directory, not in `public/`
+
+```shell
+mv public/index.html ./
+```
+
+Remove any references to `%PUBLIC_URL%`. Passing `--base /some/sub/dir/` to `build` will get you the same result.
+
 ### Sass
 
 Sass isn't included [as per Vite's recommendation](https://vitejs.dev/guide/features.html#css-pre-processors). You can add pre-processors to your projects if you wish.
 
 ### Tests
 
-react-scripts-vite uses Vitest instead of Jest. Vitest has a jest-compatible interface, accessible via `vi`.
+react-scripts-vite uses [Vitest](https://vitest.dev) instead of Jest. Vitest has a jest-compatible interface, accessible via `vi`.
+
+The path to the test setup file has changed:
+
+```shell
+mkdir -p src/tests/
+mv src/setupTests.ts src/test/setup.ts
+```

package/dist/client.d.ts

@@ -1,3 +1,38 @@
 /// <reference types="vite/client" />
 /// <reference types="vite-plugin-svgr/client" />
 /// <reference types="vitest/globals" />
+
+// https://github.com/antfu/vite-plugin-pwa/blob/951311fa811b8cee98ea5530522961f64645cd75/client.d.ts
+declare module 'virtual:pwa-register' {
+  export type RegisterSWOptions = {
+    immediate?: boolean
+    onNeedRefresh?: () => void
+    onOfflineReady?: () => void
+    onRegistered?: (registration: ServiceWorkerRegistration | undefined) => void
+    onRegisterError?: (error: any) => void
+  }
+
+  export function registerSW(
+    options?: RegisterSWOptions,
+  ): (reloadPage?: boolean) => Promise<void>
+}
+
+// https://github.com/antfu/vite-plugin-pwa/blob/951311fa811b8cee98ea5530522961f64645cd75/client.d.ts
+declare module 'virtual:pwa-register/react' {
+  // @ts-ignore ignore when react is not installed
+  import { Dispatch, SetStateAction } from 'react'
+
+  export type RegisterSWOptions = {
+    immediate?: boolean
+    onNeedRefresh?: () => void
+    onOfflineReady?: () => void
+    onRegistered?: (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>
+  }
+}

package/dist/viteConfig.js

@@ -6,12 +6,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var plugin_react_1 = __importDefault(require("@vitejs/plugin-react"));
 var vite_plugin_checker_1 = __importDefault(require("vite-plugin-checker"));
 var vite_plugin_env_compatible_1 = __importDefault(require("vite-plugin-env-compatible"));
+var vite_plugin_pwa_1 = require("vite-plugin-pwa");
 var vite_plugin_svgr_1 = __importDefault(require("vite-plugin-svgr"));
 var vite_tsconfig_paths_1 = __importDefault(require("vite-tsconfig-paths"));
 var config_1 = require("vitest/config");
 exports.default = (0, config_1.defineConfig)({
     build: {
-        outDir: 'dist',
+        outDir: 'build',
         sourcemap: true,
     },
     plugins: [
@@ -22,6 +23,8 @@ exports.default = (0, config_1.defineConfig)({
         (0, vite_plugin_env_compatible_1.default)(),
         // Support TypeScript paths.
         (0, vite_tsconfig_paths_1.default)(),
+        // PWA.
+        (0, vite_plugin_pwa_1.VitePWA)(),
         // Check for issues.
         process.env.NODE_ENV !== 'test' &&
             (0, vite_plugin_checker_1.default)({

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@promoboxx/react-scripts-vite",
-  "version": "0.1.18",
+  "version": "0.1.22",
   "description": "",
   "main": "dist/index.js",
   "keywords": [],
+  "repository": {
+    "url": "https://github.com/promoboxx/react-scripts-vite"
+  },
   "bin": {
     "react-scripts": "./dist/cli.js",
     "react-scripts-vite": "./dist/cli.js"
@@ -22,6 +25,7 @@
     "vite": "^2.8.4",
     "vite-plugin-checker": "^0.4.2",
     "vite-plugin-env-compatible": "^1.1.1",
+    "vite-plugin-pwa": "^0.11.13",
     "vite-plugin-svgr": "^1.0.1",
     "vite-tsconfig-paths": "^3.4.1",
     "vitest": "^0.5.5"