@jmlweb/vitest-config 1.0.0

package/README.md

@@ -0,0 +1,232 @@
+# @jmlweb/vitest-config
+
+[![npm version](https://img.shields.io/npm/v/@jmlweb/vitest-config)](https://www.npmjs.com/package/@jmlweb/vitest-config)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Node.js](https://img.shields.io/badge/Node.js-%3E%3D18.0.0-339933.svg)](https://nodejs.org/)
+[![Vitest](https://img.shields.io/badge/Vitest-1.0%2B-6E9F18.svg)](https://vitest.dev/)
+
+> Base Vitest configuration for jmlweb projects. TypeScript support, coverage settings, and sensible defaults out of the box.
+
+## ✨ Features
+
+- 🔧 **TypeScript Support**: Configured for TypeScript projects with type checking enabled
+- 📊 **Coverage Configuration**: Pre-configured with v8 provider and 80% coverage thresholds
+- 🎯 **Sensible Defaults**: Node.js environment, globals enabled, standard reporters
+- 🚀 **Easy Extension**: Flat config format for easy customization
+- 📦 **Zero Config**: Works out of the box with minimal setup
+
+## 📦 Installation
+
+```bash
+npm install --save-dev @jmlweb/vitest-config vitest
+```
+
+## 🚀 Quick Start
+
+Create a `vitest.config.ts` file in your project root:
+
+```typescript
+import { defineConfig } from 'vitest/config';
+import baseConfig from '@jmlweb/vitest-config';
+
+export default defineConfig({
+  ...baseConfig,
+  // Add your project-specific overrides here
+});
+```
+
+## 💡 Examples
+
+### Basic Setup
+
+```typescript
+// vitest.config.ts
+import { defineConfig } from 'vitest/config';
+import baseConfig from '@jmlweb/vitest-config';
+
+export default defineConfig({
+  ...baseConfig,
+});
+```
+
+### With Project-Specific Overrides
+
+```typescript
+// vitest.config.ts
+import { defineConfig } from 'vitest/config';
+import baseConfig from '@jmlweb/vitest-config';
+
+export default defineConfig({
+  ...baseConfig,
+  test: {
+    ...baseConfig.test,
+    // Override environment for browser testing
+    environment: 'jsdom',
+    // Custom test timeout
+    testTimeout: 10000,
+    // Custom coverage thresholds
+    coverage: {
+      ...baseConfig.test?.coverage,
+      thresholds: {
+        lines: 90,
+        functions: 90,
+        branches: 85,
+        statements: 90,
+      },
+    },
+  },
+});
+```
+
+### React/JSX Project Example
+
+```typescript
+// vitest.config.ts
+import { defineConfig } from 'vitest/config';
+import baseConfig from '@jmlweb/vitest-config';
+
+export default defineConfig({
+  ...baseConfig,
+  test: {
+    ...baseConfig.test,
+    environment: 'jsdom', // Use jsdom for React component testing
+    setupFiles: ['./src/test/setup.ts'], // Optional setup file
+  },
+});
+```
+
+### Lower Coverage Thresholds
+
+```typescript
+// vitest.config.ts
+import { defineConfig } from 'vitest/config';
+import baseConfig from '@jmlweb/vitest-config';
+
+export default defineConfig({
+  ...baseConfig,
+  test: {
+    ...baseConfig.test,
+    coverage: {
+      ...baseConfig.test?.coverage,
+      thresholds: {
+        lines: 60,
+        functions: 60,
+        branches: 60,
+        statements: 60,
+      },
+    },
+  },
+});
+```
+
+## 📋 Configuration Details
+
+### 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                      |
+
+### Coverage Exclusions
+
+The following patterns are excluded from coverage by default:
+
+- `**/*.d.ts` - TypeScript declaration files
+- `**/*.config.{ts,js}` - Configuration files
+- `**/dist/**` - Build output
+- `**/build/**` - Build directories
+- `**/node_modules/**` - Dependencies
+- `**/coverage/**` - Coverage reports
+- `**/*.test.{ts,tsx,js,jsx}` - Test files
+- `**/*.spec.{ts,tsx,js,jsx}` - Spec files
+
+### Test File Patterns
+
+Tests are automatically discovered from:
+
+- `**/*.test.{ts,tsx,js,jsx}`
+- `**/*.spec.{ts,tsx,js,jsx}`
+
+### Reporters
+
+Default reporters include:
+
+- `verbose` - Detailed test output
+- `json` - JSON format for CI/CD
+- `html` - HTML coverage report
+
+## 🎯 When to Use
+
+Use this configuration when you want:
+
+- ✅ Consistent testing setup across projects
+- ✅ TypeScript support out of the box
+- ✅ Coverage thresholds enforced
+- ✅ Sensible defaults for Node.js projects
+- ✅ Easy customization and extension
+
+## 🔧 Extending the Configuration
+
+You can extend or override the configuration for your specific needs:
+
+```typescript
+import { defineConfig } from 'vitest/config';
+import baseConfig from '@jmlweb/vitest-config';
+
+export default defineConfig({
+  ...baseConfig,
+  test: {
+    ...baseConfig.test,
+    // Add custom setup files
+    setupFiles: ['./src/test/setup.ts'],
+    // Custom test patterns
+    include: ['**/*.test.ts', '**/__tests__/**/*.ts'],
+    // Custom environment
+    environment: 'jsdom',
+  },
+});
+```
+
+## 📝 Usage with Scripts
+
+Add test scripts to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "test": "vitest",
+    "test:run": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:ui": "vitest --ui"
+  }
+}
+```
+
+## 📋 Requirements
+
+- **Node.js** >= 18.0.0
+- **Vitest** >= 1.0.0
+- **TypeScript** project (recommended, but not required)
+
+## 📦 Peer Dependencies
+
+This package requires the following peer dependency:
+
+- `vitest` (^1.0.0)
+
+## 🔗 Related Packages
+
+- [`@jmlweb/eslint-config-base`](../eslint-config-base) - ESLint config for TypeScript projects
+- [`@jmlweb/prettier-config-base`](../prettier-config-base) - Prettier config for consistent formatting
+- [`@jmlweb/tsconfig-base`](../tsconfig-base) - TypeScript configuration
+
+## 📄 License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,77 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var config = {
+  test: {
+    // Enable globals for cleaner test syntax (e.g., describe, it, expect without imports)
+    globals: true,
+    // Use Node.js environment by default
+    environment: "node",
+    // Coverage configuration
+    coverage: {
+      // Use v8 provider for coverage (default, but explicit for clarity)
+      provider: "v8",
+      // Coverage thresholds - enforce 80% coverage
+      thresholds: {
+        lines: 80,
+        functions: 80,
+        branches: 80,
+        statements: 80
+      },
+      // Files to include in coverage
+      include: ["src/**/*.{ts,tsx,js,jsx}"],
+      // Files to exclude from coverage
+      exclude: [
+        "**/*.d.ts",
+        "**/*.config.{ts,js}",
+        "**/dist/**",
+        "**/build/**",
+        "**/node_modules/**",
+        "**/coverage/**",
+        "**/*.test.{ts,tsx,js,jsx}",
+        "**/*.spec.{ts,tsx,js,jsx}"
+      ],
+      // Coverage reporters
+      reporter: ["text", "json", "html"]
+    },
+    // Test file patterns
+    include: ["**/*.{test,spec}.{ts,tsx,js,jsx}"],
+    // Files to exclude from test runs
+    exclude: [
+      "**/node_modules/**",
+      "**/dist/**",
+      "**/build/**",
+      "**/.{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
+    }
+  }
+};
+var index_default = config;

package/dist/index.d.cts

@@ -0,0 +1,28 @@
+import { UserConfig } from 'vitest/config';
+
+/**
+ * Base Vitest configuration with TypeScript support, coverage settings, and sensible defaults.
+ * This configuration provides a solid foundation for testing TypeScript projects.
+ *
+ * Features:
+ * - TypeScript support out of the box
+ * - Coverage configuration with v8 provider
+ * - Standard coverage thresholds (80% for lines, functions, branches, statements)
+ * - Node.js environment by default
+ * - Globals enabled for cleaner test syntax
+ * - Standard reporter configuration
+ *
+ * @example
+ * ```ts
+ * import { defineConfig } from 'vitest/config';
+ * import baseConfig from '@jmlweb/vitest-config';
+ *
+ * export default defineConfig({
+ *   ...baseConfig,
+ *   // Add your project-specific overrides here
+ * });
+ * ```
+ */
+declare const config: UserConfig;
+
+export { config as default };

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+import { UserConfig } from 'vitest/config';
+
+/**
+ * Base Vitest configuration with TypeScript support, coverage settings, and sensible defaults.
+ * This configuration provides a solid foundation for testing TypeScript projects.
+ *
+ * Features:
+ * - TypeScript support out of the box
+ * - Coverage configuration with v8 provider
+ * - Standard coverage thresholds (80% for lines, functions, branches, statements)
+ * - Node.js environment by default
+ * - Globals enabled for cleaner test syntax
+ * - Standard reporter configuration
+ *
+ * @example
+ * ```ts
+ * import { defineConfig } from 'vitest/config';
+ * import baseConfig from '@jmlweb/vitest-config';
+ *
+ * export default defineConfig({
+ *   ...baseConfig,
+ *   // Add your project-specific overrides here
+ * });
+ * ```
+ */
+declare const config: UserConfig;
+
+export { config as default };

package/dist/index.js

@@ -0,0 +1,56 @@
+// src/index.ts
+var config = {
+  test: {
+    // Enable globals for cleaner test syntax (e.g., describe, it, expect without imports)
+    globals: true,
+    // Use Node.js environment by default
+    environment: "node",
+    // Coverage configuration
+    coverage: {
+      // Use v8 provider for coverage (default, but explicit for clarity)
+      provider: "v8",
+      // Coverage thresholds - enforce 80% coverage
+      thresholds: {
+        lines: 80,
+        functions: 80,
+        branches: 80,
+        statements: 80
+      },
+      // Files to include in coverage
+      include: ["src/**/*.{ts,tsx,js,jsx}"],
+      // Files to exclude from coverage
+      exclude: [
+        "**/*.d.ts",
+        "**/*.config.{ts,js}",
+        "**/dist/**",
+        "**/build/**",
+        "**/node_modules/**",
+        "**/coverage/**",
+        "**/*.test.{ts,tsx,js,jsx}",
+        "**/*.spec.{ts,tsx,js,jsx}"
+      ],
+      // Coverage reporters
+      reporter: ["text", "json", "html"]
+    },
+    // Test file patterns
+    include: ["**/*.{test,spec}.{ts,tsx,js,jsx}"],
+    // Files to exclude from test runs
+    exclude: [
+      "**/node_modules/**",
+      "**/dist/**",
+      "**/build/**",
+      "**/.{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
+    }
+  }
+};
+var index_default = config;
+export {
+  index_default as default
+};

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@jmlweb/vitest-config",
+  "version": "1.0.0",
+  "description": "Base Vitest configuration for jmlweb projects with TypeScript support and coverage settings",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "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"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "pnpm build"
+  },
+  "keywords": [
+    "vitest",
+    "vitest-config",
+    "testing",
+    "test-config",
+    "coverage"
+  ],
+  "author": "jmlweb",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jmlweb/tooling.git"
+  },
+  "bugs": {
+    "url": "https://github.com/jmlweb/tooling/issues"
+  },
+  "homepage": "https://github.com/jmlweb/tooling/tree/main/packages/vitest-config#readme",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "vitest": "^1.0.0"
+  },
+  "devDependencies": {
+    "@jmlweb/tsconfig-internal": "workspace:*",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^2.1.8"
+  }
+}