@promoboxx/react-scripts-vite 0.1.17 → 0.1.21

package/README.md

@@ -0,0 +1,65 @@
+# react-scripts-vite
+
+An almost drop-in replacement for react-scripts, but based on Vite.
+
+## Features
+
+- svgr
+- TypeScript `paths`
+- TypeScript type checking
+- ESLint linting
+- `process.env`
+- Vitest
+
+## Getting Started
+
+Install `@promoboxx/react-scripts-vite`:
+
+```shell
+npm install --save-dev @promoboxx/react-scripts-vite
+```
+
+Edit your `vite.config.ts`:
+
+```typescript
+import { viteConfig } from '@promoboxx/react-scripts-vite'
+
+export default viteConfig
+```
+
+If you're using TypeScript, you'll want to load the client types. This will clear up any errors when accessing `import.meta.hot`, or when importing an image.
+
+Put this in `src/react-scripts-vite.d.ts`:
+
+```typescript
+/// <reference types="@promoboxx/react-scripts-vite/dist/client" />
+```
+
+## Migrating from react-scripts
+
+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](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,2 +1,3 @@
 /// <reference types="vite/client" />
 /// <reference types="vite-plugin-svgr/client" />
+/// <reference types="vitest/globals" />

package/dist/viteConfig.js

@@ -11,7 +11,7 @@ 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: [

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@promoboxx/react-scripts-vite",
-  "version": "0.1.17",
+  "version": "0.1.21",
   "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"