Merge pull request #678 from nextcloud-libraries/feat/migrate-vite

feat: Migrate to Vite for building and Vitest for testing
nextcloud-libraries · Apr 22, 2024 · 8504f30 · 8504f30
2 parents 9999cad + 2392809
commit 8504f30
Show file tree

Hide file tree

Showing 9 changed files with 3,594 additions and 776 deletions.
diff --git a/.travis.yml b/.travis.yml
diff --git a/jest.config.ts b/jest.config.ts
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -22,35 +22,30 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.es.mjs",
+      "import": "./dist/index.mjs",
       "require": "./dist/index.cjs"
     }
   },
   "scripts": {
-    "build": "rollup --config rollup.config.js",
+    "build": "vite --mode production build",
     "build:doc": "typedoc --out dist/doc lib/index.ts && touch dist/doc/.nojekyll",
-    "check-types": "tsc --noEmit",
-    "dev": "rollup --config rollup.config.js --watch",
+    "dev": "vite --mode development build --watch",
     "lint": "eslint lib test *.ts",
     "lint:fix": "eslint --fix lib test *.ts",
-    "test": "jest",
-    "test:coverage": "jest --coverage",
-    "test:watch": "jest --watchAll"
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest watch"
   },
   "devDependencies": {
-    "@jest/globals": "^29.7.0",
     "@nextcloud/eslint-config": "^8.3.0",
-    "@rollup/plugin-typescript": "^11.1.6",
+    "@nextcloud/vite-config": "^1.2.2",
     "@types/node": "^20.12.7",
+    "@vitest/coverage-v8": "^1.5.0",
     "eslint": "^8.57.0",
-    "jest": "^29.7.0",
-    "jest-environment-jsdom": "^29.7.0",
-    "rollup": "^4.16.0",
-    "ts-jest": "^29.1.2",
-    "ts-node": "^10.9.2",
-    "tslib": "^2.6.2",
     "typedoc": "^0.25.13",
-    "typescript": "^5.4.5"
+    "typescript": "^5.4.5",
+    "vite": "^5.2.10",
+    "vitest": "^1.5.0"
   },
   "engines": {
     "node": "^20.0.0",

diff --git a/rollup.config.js b/rollup.config.js
diff --git a/test/index.test.ts b/test/index.test.ts
@@ -1,5 +1,5 @@
+import { expect, test } from 'vitest'
 import { loadState } from '../lib'
-import { expect, test } from '@jest/globals'
 
 test('throw if nothing found', () => {
 	expect(() => loadState('test', 'key')).toThrow(new Error('Could not find initial state key of test'))

diff --git a/tsconfig.json b/tsconfig.json
@@ -1,12 +1,12 @@
 {
     "include": [
-        "./lib/**/*.ts"
+        "./lib/**.ts"
     ],
     "compilerOptions": {
         "allowSyntheticDefaultImports": true,
-        "moduleResolution": "node",
+        "moduleResolution": "Bundler",
         "target": "ESNext",
-        "module": "esnext",
+        "module": "ESNext",
         "declaration": true,
         "strict": true,
         "noImplicitAny": false,

diff --git a/vite.config.ts b/vite.config.ts
@@ -0,0 +1,10 @@
+import { createLibConfig } from '@nextcloud/vite-config'
+
+export default createLibConfig(
+	{
+		index: `${__dirname}/lib/index.ts`,
+	},
+	{
+		libraryFormats: ['es', 'cjs'],
+	},
+)
diff --git a/vitest.config.ts b/vitest.config.ts
@@ -0,0 +1,18 @@
+import type { UserConfig } from 'vite'
+import viteConfig from './vite.config'
+
+export default async (env) => {
+	const config = typeof viteConfig === 'function' ? await viteConfig(env) : viteConfig
+	// node-externals conflicts with vitest
+	config.plugins = config.plugins!.filter((plugin) => plugin && (!('name' in plugin) || plugin?.name !== 'node-externals'))
+
+	return {
+		...config,
+		test: {
+			environment: 'jsdom',
+			coverage: {
+				reporter: ['text', 'lcov'],
+			},
+		},
+	} as UserConfig
+}