@jmlweb/vitest-config 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# @jmlweb/vitest-config
+
+## 1.0.1
+
+### Patch Changes
+
+- d75c258: fix: update vitest peer dependency to support newer versions
+
+  Updated the vitest peer dependency from `^1.0.0` to `>=1.0.0` to support vitest 2.x, 3.x, and 4.x versions, resolving peer dependency warnings in modern projects.

package/README.md

@@ -9,9 +9,10 @@
 
 ## ✨ Features
 
-- 🔧 **TypeScript Support**: Configured for TypeScript projects with type checking enabled
+- 🔧 **TypeScript Support**: Configured for TypeScript projects (type checking via CLI)
 - 📊 **Coverage Configuration**: Pre-configured with v8 provider and 80% coverage thresholds
-- 🎯 **Sensible Defaults**: Node.js environment, globals enabled, standard reporters
+- 🎯 **Sensible Defaults**: Node.js environment, globals enabled, optimized test execution
+- ⚡ **Performance Optimized**: Thread pool configuration for efficient parallel test execution
 - 🚀 **Easy Extension**: Flat config format for easy customization
 - 📦 **Zero Config**: Works out of the box with minimal setup
 
@@ -123,16 +124,18 @@ export default defineConfig({
 
 ### Default Settings
 
-| Setting                          | Value  | Description                                          |
-| -------------------------------- | ------ | ---------------------------------------------------- |
-| `globals`                        | `true` | Enables global test functions (describe, it, expect) |
-| `environment`                    | `node` | Node.js environment by default                       |
-| `coverage.provider`              | `v8`   | Coverage provider                                    |
-| `coverage.thresholds.lines`      | `80`   | Minimum line coverage                                |
-| `coverage.thresholds.functions`  | `80`   | Minimum function coverage                            |
-| `coverage.thresholds.branches`   | `80`   | Minimum branch coverage                              |
-| `coverage.thresholds.statements` | `80`   | Minimum statement coverage                           |
-| `typecheck.enabled`              | `true` | Enable TypeScript type checking                      |
+| Setting                          | Value     | Description                                          |
+| -------------------------------- | --------- | ---------------------------------------------------- |
+| `globals`                        | `true`    | Enables global test functions (describe, it, expect) |
+| `environment`                    | `node`    | Node.js environment by default                       |
+| `testTimeout`                    | `5000`    | Test timeout in milliseconds (5 seconds)             |
+| `hookTimeout`                    | `10000`   | Hook timeout in milliseconds (10 seconds)            |
+| `pool`                           | `threads` | Use thread pool for parallel test execution          |
+| `coverage.provider`              | `v8`      | Coverage provider                                    |
+| `coverage.thresholds.lines`      | `80`      | Minimum line coverage                                |
+| `coverage.thresholds.functions`  | `80`      | Minimum function coverage                            |
+| `coverage.thresholds.branches`   | `80`      | Minimum branch coverage                              |
+| `coverage.thresholds.statements` | `80`      | Minimum statement coverage                           |
 
 ### Coverage Exclusions
 
@@ -156,11 +159,15 @@ Tests are automatically discovered from:
 
 ### Reporters
 
-Default reporters include:
+**Test Reporters:**
 
-- `verbose` - Detailed test output
-- `json` - JSON format for CI/CD
-- `html` - HTML coverage report
+- `verbose` - Detailed test output with full test names and results
+
+**Coverage Reporters:**
+
+- `text` - Text summary in terminal
+- `json` - JSON format for CI/CD integration
+- `html` - HTML coverage report (generated in `coverage/` directory)
 
 ## 🎯 When to Use
 
@@ -169,6 +176,7 @@ Use this configuration when you want:
 - ✅ Consistent testing setup across projects
 - ✅ TypeScript support out of the box
 - ✅ Coverage thresholds enforced
+- ✅ Optimized test execution with thread pool
 - ✅ Sensible defaults for Node.js projects
 - ✅ Easy customization and extension
 
@@ -204,11 +212,34 @@ Add test scripts to your `package.json`:
     "test": "vitest",
     "test:run": "vitest run",
     "test:coverage": "vitest run --coverage",
-    "test:ui": "vitest --ui"
+    "test:ui": "vitest --ui",
+    "test:typecheck": "vitest typecheck"
   }
 }
 ```
 
+Then run:
+
+```bash
+npm run test           # Run tests in watch mode
+npm run test:run       # Run tests once
+npm run test:coverage # Run tests with coverage
+npm run test:ui       # Open Vitest UI
+npm run test:typecheck # Run TypeScript type checking
+```
+
+### TypeScript Type Checking
+
+Type checking is performed separately using the `vitest typecheck` command for better performance. This allows you to run type checking independently of your test suite:
+
+```bash
+# Run type checking only
+npm run test:typecheck
+
+# Or run tests and type checking together
+npm run test && npm run test:typecheck
+```
+
 ## 📋 Requirements
 
 - **Node.js** >= 18.0.0
@@ -221,6 +252,13 @@ This package requires the following peer dependency:
 
 - `vitest` (^1.0.0)
 
+## 📚 Examples
+
+See real-world usage examples:
+
+- [`example-nodejs-typescript-api`](../../apps/example-nodejs-typescript-api) - Node.js TypeScript API with testing
+- [`example-react-typescript-app`](../../apps/example-react-typescript-app) - React TypeScript app with component testing
+
 ## 🔗 Related Packages
 
 - [`@jmlweb/eslint-config-base`](../eslint-config-base) - ESLint config for TypeScript projects

package/dist/index.cjs

@@ -23,12 +23,17 @@ __export(index_exports, {
   default: () => index_default
 });
 module.exports = __toCommonJS(index_exports);
-var config = {
+var import_config = require("vitest/config");
+var config = (0, import_config.defineConfig)({
   test: {
     // Enable globals for cleaner test syntax (e.g., describe, it, expect without imports)
     globals: true,
     // Use Node.js environment by default
     environment: "node",
+    // Test timeout (5 seconds default, can be overridden)
+    testTimeout: 5e3,
+    // Hook timeout (10 seconds for setup/teardown)
+    hookTimeout: 1e4,
     // Coverage configuration
     coverage: {
       // Use v8 provider for coverage (default, but explicit for clarity)
@@ -53,7 +58,7 @@ var config = {
         "**/*.test.{ts,tsx,js,jsx}",
         "**/*.spec.{ts,tsx,js,jsx}"
       ],
-      // Coverage reporters
+      // Coverage reporters (HTML is valid here for coverage reports)
       reporter: ["text", "json", "html"]
     },
     // Test file patterns
@@ -66,12 +71,23 @@ var config = {
       "**/.{idea,git,cache,output,temp}/**",
       "**/{karma,rollup,webpack,vite,vitest,jest,ava,babel,nyc,cypress,tsup,build,eslint,prettier}.config.*"
     ],
-    // Reporter configuration
-    reporters: ["verbose", "json", "html"],
-    // TypeScript configuration
-    typecheck: {
-      enabled: true
+    // Test reporter configuration (HTML is only for coverage, not test reporters)
+    // Use 'verbose' for detailed output, 'basic' for minimal, 'dot' for dots, 'json' for CI/CD
+    reporters: ["verbose"],
+    // Pool configuration for test execution
+    // threads: faster but may have issues with shared state
+    // forks: more isolated but slower
+    // Use threads by default for better performance
+    pool: "threads",
+    // Pool options for better performance
+    poolOptions: {
+      threads: {
+        // Use all available CPUs minus 1 to leave one for the system
+        minThreads: 1,
+        maxThreads: void 0
+        // Let Vitest decide based on available CPUs
+      }
     }
   }
-};
+});
 var index_default = config;

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { UserConfig } from 'vitest/config';
+import * as vite from 'vite';
 
 /**
  * Base Vitest configuration with TypeScript support, coverage settings, and sensible defaults.
@@ -11,6 +11,10 @@ import { UserConfig } from 'vitest/config';
  * - Node.js environment by default
  * - Globals enabled for cleaner test syntax
  * - Standard reporter configuration
+ * - Optimized test execution settings
+ *
+ * Note: Type checking should be run separately using `vitest typecheck` command
+ * for better performance, rather than enabling it in the test configuration.
  *
  * @example
  * ```ts
@@ -23,6 +27,6 @@ import { UserConfig } from 'vitest/config';
  * });
  * ```
  */
-declare const config: UserConfig;
+declare const config: vite.UserConfig;
 
 export { config as default };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { UserConfig } from 'vitest/config';
+import * as vite from 'vite';
 
 /**
  * Base Vitest configuration with TypeScript support, coverage settings, and sensible defaults.
@@ -11,6 +11,10 @@ import { UserConfig } from 'vitest/config';
  * - Node.js environment by default
  * - Globals enabled for cleaner test syntax
  * - Standard reporter configuration
+ * - Optimized test execution settings
+ *
+ * Note: Type checking should be run separately using `vitest typecheck` command
+ * for better performance, rather than enabling it in the test configuration.
  *
  * @example
  * ```ts
@@ -23,6 +27,6 @@ import { UserConfig } from 'vitest/config';
  * });
  * ```
  */
-declare const config: UserConfig;
+declare const config: vite.UserConfig;
 
 export { config as default };

package/dist/index.js

@@ -1,10 +1,15 @@
 // src/index.ts
-var config = {
+import { defineConfig } from "vitest/config";
+var config = defineConfig({
   test: {
     // Enable globals for cleaner test syntax (e.g., describe, it, expect without imports)
     globals: true,
     // Use Node.js environment by default
     environment: "node",
+    // Test timeout (5 seconds default, can be overridden)
+    testTimeout: 5e3,
+    // Hook timeout (10 seconds for setup/teardown)
+    hookTimeout: 1e4,
     // Coverage configuration
     coverage: {
       // Use v8 provider for coverage (default, but explicit for clarity)
@@ -29,7 +34,7 @@ var config = {
         "**/*.test.{ts,tsx,js,jsx}",
         "**/*.spec.{ts,tsx,js,jsx}"
       ],
-      // Coverage reporters
+      // Coverage reporters (HTML is valid here for coverage reports)
       reporter: ["text", "json", "html"]
     },
     // Test file patterns
@@ -42,14 +47,25 @@ var config = {
       "**/.{idea,git,cache,output,temp}/**",
       "**/{karma,rollup,webpack,vite,vitest,jest,ava,babel,nyc,cypress,tsup,build,eslint,prettier}.config.*"
     ],
-    // Reporter configuration
-    reporters: ["verbose", "json", "html"],
-    // TypeScript configuration
-    typecheck: {
-      enabled: true
+    // Test reporter configuration (HTML is only for coverage, not test reporters)
+    // Use 'verbose' for detailed output, 'basic' for minimal, 'dot' for dots, 'json' for CI/CD
+    reporters: ["verbose"],
+    // Pool configuration for test execution
+    // threads: faster but may have issues with shared state
+    // forks: more isolated but slower
+    // Use threads by default for better performance
+    pool: "threads",
+    // Pool options for better performance
+    poolOptions: {
+      threads: {
+        // Use all available CPUs minus 1 to leave one for the system
+        minThreads: 1,
+        maxThreads: void 0
+        // Let Vitest decide based on available CPUs
+      }
     }
   }
-};
+});
 var index_default = config;
 export {
   index_default as default

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jmlweb/vitest-config",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Base Vitest configuration for jmlweb projects with TypeScript support and coverage settings",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -8,41 +8,32 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      },
       "import": {
         "types": "./dist/index.d.ts",
         "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
       }
     }
   },
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "CHANGELOG.md"
   ],
-  "scripts": {
-    "build": "tsup",
-    "clean": "rm -rf dist",
-    "prepublishOnly": "pnpm build"
-  },
   "keywords": [
-    "vitest",
-    "vitest-config",
-    "testing",
+    "coverage",
     "test-config",
-    "coverage"
+    "testing",
+    "vitest",
+    "vitest-config"
   ],
   "author": "jmlweb",
   "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/jmlweb/tooling.git"
-  },
-  "bugs": {
-    "url": "https://github.com/jmlweb/tooling/issues"
-  },
+  "repository": "jmlweb/tooling.git",
+  "bugs": "https://github.com/jmlweb/tooling/issues",
   "homepage": "https://github.com/jmlweb/tooling/tree/main/packages/vitest-config#readme",
   "engines": {
     "node": ">=18.0.0"
@@ -51,12 +42,16 @@
     "access": "public"
   },
   "peerDependencies": {
-    "vitest": "^1.0.0"
+    "vitest": ">=1.0.0"
   },
   "devDependencies": {
-    "@jmlweb/tsconfig-internal": "workspace:*",
     "tsup": "^8.5.1",
     "typescript": "^5.9.3",
-    "vitest": "^2.1.8"
+    "vitest": "^2.1.8",
+    "@jmlweb/tsconfig-internal": "0.0.1"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "rm -rf dist"
   }
-}
+}