@codedrifters/configulator 0.0.120 → 0.0.122

package/README.md

@@ -36,7 +36,7 @@ Projen is a project generator and configuration management tool that:
 
 ### Key Concepts
 
-**Components:** Individual pieces of configuration (e.g., Jest, Prettier, TypeScript). Each component configures specific files and settings. When you add or remove a component, all its associated files and configurations are automatically managed.
+**Components:** Individual pieces of configuration (e.g., Jest, Vitest, Prettier, TypeScript). Each component configures specific files and settings. When you add or remove a component, all its associated files and configurations are automatically managed.
 
 **Project Types:** Base-level configurations for different kinds of projects (e.g., TypeScript app, monorepo, React project).
 
@@ -204,9 +204,8 @@ Use `TypeScriptProject` for:
 #### Key Features
 
 - **Automatic PNPM Version Inheritance**: Inherits PNPM version from parent `MonorepoProject` when used as a sub-project
-- **SWC for Testing**: Uses `@swc/jest` instead of `ts-jest` for faster test execution
+- **Configurable Test Runner**: Choose Jest (default) or Vitest via the `testRunner` option. Jest uses `@swc/jest` for fast execution; Vitest uses a generated `vitest.config.ts` with coverage and watch tasks.
 - **Prettier Integration**: Automatic Prettier configuration
-- **Jest Configuration**: External Jest config file (not in package.json) with sensible defaults
 - **Automatic Turborepo Integration**: Automatically configures Turborepo tasks when parent has TurboRepo enabled
 - **Catalog Dependency Support**: Can use catalog dependencies defined in parent workspace
 - **Release Support**: Built-in support for NPM releases with continuous deployment triggers
@@ -297,12 +296,12 @@ The `TypeScriptProject` accepts all options from Projen's `TypeScriptProjectOpti
 | `sampleCode` | `boolean` | `false` | Generate sample code |
 | `release` | `boolean` | `false` | Enable NPM releases |
 | `licensed` | `boolean` | `false` | Include license (unless `license` option provided) |
+| `testRunner` | `TestRunner` | `TestRunner.JEST` | Test runner: `TestRunner.JEST` or `TestRunner.VITEST` |
+| `vitestOptions` | `VitestOptions` | `undefined` | Options for Vitest (only used when `testRunner` is `TestRunner.VITEST`) |
 
-**Jest Configuration:**
-- Uses external `jest.config.json` file
-- Configured to use `@swc/jest` for faster compilation
-- Test files in `src/` directory
-- ESLint rule `import/no-extraneous-dependencies` disabled for test files
+**Test runner (Jest or Vitest):**
+- **Jest (default):** External `jest.config.json`, `@swc/jest` for fast compilation, test files in `src/`. Use when you want to keep existing Jest-based workflows.
+- **Vitest:** Set `testRunner: TestRunner.VITEST` to use Vitest. The project gets a generated `vitest.config.ts`, `vitest` (and optionally `@vitest/coverage-v8`) as devDeps, and tasks: `test` (runs `vitest run`), `test:watch`. Snapshots are updated automatically on each test run to match the project's previous Jest behavior (no separate snapshot-update step). Coverage directory is added to `.gitignore` and `.npmignore`. Jest is disabled (`jest: false`) when Vitest is selected; the two cannot be used together.
 
 **NPM Ignore:**
 - Automatically ignores `*.spec.*`, `*.test.*`, and `__fixtures__` patterns

package/lib/index.d.mts

@@ -394,11 +394,15 @@ declare const VERSION: {
     /**
      * Version of Projen to use.
      */
-    readonly PROJEN_VERSION: "0.99.17";
+    readonly PROJEN_VERSION: "0.99.18";
     /**
      * What version of the turborepo library should we use?
      */
     readonly TURBO_VERSION: "2.8.13";
+    /**
+     * What version of Vitest to use when testRunner is 'vitest'.
+     */
+    readonly VITEST_VERSION: "4.0.18";
 };
 
 /**
@@ -1265,10 +1269,124 @@ declare class MonorepoProject extends TypeScriptAppProject {
     postSynthesize(): void;
 }
 
+/**
+ * Options for the Vitest config (test block in vitest.config).
+ *
+ * @see https://vitest.dev/config/
+ */
+interface VitestConfigOptions {
+    /**
+     * Glob patterns for test files.
+     *
+     * @default ["**\/*.{test,spec}.?(c|m)[jt]s?(x)"]
+     */
+    readonly include?: string[];
+    /**
+     * Glob patterns to exclude from test files.
+     *
+     * @default ["**\/node_modules\/**", "**\/dist\/**", "**\/lib\/**", "**\/.?\*"]
+     */
+    readonly exclude?: string[];
+    /**
+     * Test environment.
+     *
+     * @default "node"
+     */
+    readonly environment?: "node" | "jsdom" | "happy-dom" | "edge-runtime";
+    /**
+     * Do not fail when no tests are found.
+     *
+     * @default true
+     */
+    readonly passWithNoTests?: boolean;
+    /**
+     * Enable coverage collection.
+     *
+     * @default true
+     */
+    readonly coverageEnabled?: boolean;
+    /**
+     * Coverage reports directory.
+     *
+     * @default "coverage"
+     */
+    readonly coverageDirectory?: string;
+    /**
+     * Coverage reporters.
+     *
+     * @default ["text", "lcov"]
+     */
+    readonly coverageReporters?: string[];
+}
+/**
+ * Options for the Vitest component.
+ */
+interface VitestOptions {
+    /**
+     * Config file path.
+     *
+     * @default "vitest.config.ts"
+     */
+    readonly configFilePath?: string;
+    /**
+     * Vitest config (test block).
+     */
+    readonly config?: VitestConfigOptions;
+    /**
+     * Vitest version (overrides VERSION.VITEST_VERSION).
+     */
+    readonly vitestVersion?: string;
+}
+/**
+ * Vitest component for Node/TypeScript projects.
+ *
+ * Adds Vitest as the test runner: devDeps, vitest.config.ts, and test/watch tasks.
+ * Incompatible with Jest; use jest: false when constructing the project.
+ */
+declare class Vitest extends Component {
+    readonly project: NodeProject;
+    /**
+     * Find the Vitest component on a project.
+     */
+    static of(project: NodeProject): Vitest | undefined;
+    private readonly configFilePath;
+    private readonly include;
+    private readonly exclude;
+    private readonly environment;
+    private readonly passWithNoTests;
+    private readonly coverageEnabled;
+    private readonly coverageDirectory;
+    private readonly coverageReporters;
+    private readonly version;
+    constructor(project: NodeProject, options?: VitestOptions);
+    preSynthesize(): void;
+    private addTestTasks;
+    private synthesizeConfig;
+    private renderConfig;
+}
+
+/**
+ * Test runner for TypeScript projects.
+ */
+declare const TestRunner: {
+    readonly JEST: "jest";
+    readonly VITEST: "vitest";
+};
+type TestRunner = (typeof TestRunner)[keyof typeof TestRunner];
 /**
  * Configuration options for TypeScriptProject.
  */
 interface TypeScriptProjectOptions extends Omit<typescript.TypeScriptProjectOptions, "defaultReleaseBranch"> {
+    /**
+     * Test runner to use.
+     *
+     * @default TestRunner.JEST
+     */
+    readonly testRunner?: TestRunner;
+    /**
+     * Options for Vitest (only used when testRunner is 'vitest').
+     */
+    readonly vitestOptions?: VitestOptions;
     /**
      * Enable the reset task that deletes all build artifacts.
      *
@@ -1386,4 +1504,4 @@ declare class AwsDeployWorkflow extends Component {
     preSynthesize(): void;
 }
 
-export { type AwsAccount, AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, type AwsDeploymentTargetOptions, type AwsLocalDeploymentConfig, type AwsOrganization, type AwsRegion, type CiDeploymentConfig, type ClassTypeOptions, type DeployWorkflowOptions, type GitBranch, type IDependencyResolver, JsiiFaker, MIMIMUM_RELEASE_AGE, MonorepoProject, type MonorepoProjectOptions, PROD_DEPLOY_NAME, PnpmWorkspace, type PnpmWorkspaceOptions, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, type RemoteCacheOptions, ResetTask, type ResetTaskOptions, TurboRepo, type TurboRepoOptions, TurboRepoTask, type TurboRepoTaskOptions, TypeScriptConfig, TypeScriptProject, type TypeScriptProjectOptions, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, type VersionKey, getLatestEligibleVersion };
+export { type AwsAccount, AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, type AwsDeploymentTargetOptions, type AwsLocalDeploymentConfig, type AwsOrganization, type AwsRegion, type CiDeploymentConfig, type ClassTypeOptions, type DeployWorkflowOptions, type GitBranch, type IDependencyResolver, JsiiFaker, MIMIMUM_RELEASE_AGE, MonorepoProject, type MonorepoProjectOptions, PROD_DEPLOY_NAME, PnpmWorkspace, type PnpmWorkspaceOptions, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, type RemoteCacheOptions, ResetTask, type ResetTaskOptions, TestRunner, TurboRepo, type TurboRepoOptions, TurboRepoTask, type TurboRepoTaskOptions, TypeScriptConfig, TypeScriptProject, type TypeScriptProjectOptions, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, type VersionKey, Vitest, type VitestConfigOptions, type VitestOptions, getLatestEligibleVersion };

package/lib/index.d.ts

@@ -443,11 +443,15 @@ declare const VERSION: {
     /**
      * Version of Projen to use.
      */
-    readonly PROJEN_VERSION: "0.99.17";
+    readonly PROJEN_VERSION: "0.99.18";
     /**
      * What version of the turborepo library should we use?
      */
     readonly TURBO_VERSION: "2.8.13";
+    /**
+     * What version of Vitest to use when testRunner is 'vitest'.
+     */
+    readonly VITEST_VERSION: "4.0.18";
 };
 
 /**
@@ -1314,10 +1318,124 @@ declare class MonorepoProject extends TypeScriptAppProject {
     postSynthesize(): void;
 }
 
+/**
+ * Options for the Vitest config (test block in vitest.config).
+ *
+ * @see https://vitest.dev/config/
+ */
+interface VitestConfigOptions {
+    /**
+     * Glob patterns for test files.
+     *
+     * @default ["**\/*.{test,spec}.?(c|m)[jt]s?(x)"]
+     */
+    readonly include?: string[];
+    /**
+     * Glob patterns to exclude from test files.
+     *
+     * @default ["**\/node_modules\/**", "**\/dist\/**", "**\/lib\/**", "**\/.?\*"]
+     */
+    readonly exclude?: string[];
+    /**
+     * Test environment.
+     *
+     * @default "node"
+     */
+    readonly environment?: "node" | "jsdom" | "happy-dom" | "edge-runtime";
+    /**
+     * Do not fail when no tests are found.
+     *
+     * @default true
+     */
+    readonly passWithNoTests?: boolean;
+    /**
+     * Enable coverage collection.
+     *
+     * @default true
+     */
+    readonly coverageEnabled?: boolean;
+    /**
+     * Coverage reports directory.
+     *
+     * @default "coverage"
+     */
+    readonly coverageDirectory?: string;
+    /**
+     * Coverage reporters.
+     *
+     * @default ["text", "lcov"]
+     */
+    readonly coverageReporters?: string[];
+}
+/**
+ * Options for the Vitest component.
+ */
+interface VitestOptions {
+    /**
+     * Config file path.
+     *
+     * @default "vitest.config.ts"
+     */
+    readonly configFilePath?: string;
+    /**
+     * Vitest config (test block).
+     */
+    readonly config?: VitestConfigOptions;
+    /**
+     * Vitest version (overrides VERSION.VITEST_VERSION).
+     */
+    readonly vitestVersion?: string;
+}
+/**
+ * Vitest component for Node/TypeScript projects.
+ *
+ * Adds Vitest as the test runner: devDeps, vitest.config.ts, and test/watch tasks.
+ * Incompatible with Jest; use jest: false when constructing the project.
+ */
+declare class Vitest extends Component {
+    readonly project: NodeProject;
+    /**
+     * Find the Vitest component on a project.
+     */
+    static of(project: NodeProject): Vitest | undefined;
+    private readonly configFilePath;
+    private readonly include;
+    private readonly exclude;
+    private readonly environment;
+    private readonly passWithNoTests;
+    private readonly coverageEnabled;
+    private readonly coverageDirectory;
+    private readonly coverageReporters;
+    private readonly version;
+    constructor(project: NodeProject, options?: VitestOptions);
+    preSynthesize(): void;
+    private addTestTasks;
+    private synthesizeConfig;
+    private renderConfig;
+}
+
+/**
+ * Test runner for TypeScript projects.
+ */
+declare const TestRunner: {
+    readonly JEST: "jest";
+    readonly VITEST: "vitest";
+};
+type TestRunner = (typeof TestRunner)[keyof typeof TestRunner];
 /**
  * Configuration options for TypeScriptProject.
  */
 interface TypeScriptProjectOptions extends Omit<typescript.TypeScriptProjectOptions, "defaultReleaseBranch"> {
+    /**
+     * Test runner to use.
+     *
+     * @default TestRunner.JEST
+     */
+    readonly testRunner?: TestRunner;
+    /**
+     * Options for Vitest (only used when testRunner is 'vitest').
+     */
+    readonly vitestOptions?: VitestOptions;
     /**
      * Enable the reset task that deletes all build artifacts.
      *
@@ -1435,5 +1553,5 @@ declare class AwsDeployWorkflow extends Component {
     preSynthesize(): void;
 }
 
-export { AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, JsiiFaker, MIMIMUM_RELEASE_AGE, MonorepoProject, PROD_DEPLOY_NAME, PnpmWorkspace, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, ResetTask, TurboRepo, TurboRepoTask, TypeScriptConfig, TypeScriptProject, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, getLatestEligibleVersion };
-export type { AwsAccount, AwsDeploymentTargetOptions, AwsLocalDeploymentConfig, AwsOrganization, AwsRegion, CiDeploymentConfig, ClassTypeOptions, DeployWorkflowOptions, GitBranch, IDependencyResolver, MonorepoProjectOptions, PnpmWorkspaceOptions, RemoteCacheOptions, ResetTaskOptions, TurboRepoOptions, TurboRepoTaskOptions, TypeScriptProjectOptions, VersionKey };
+export { AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, JsiiFaker, MIMIMUM_RELEASE_AGE, MonorepoProject, PROD_DEPLOY_NAME, PnpmWorkspace, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, ResetTask, TestRunner, TurboRepo, TurboRepoTask, TypeScriptConfig, TypeScriptProject, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, Vitest, getLatestEligibleVersion };
+export type { AwsAccount, AwsDeploymentTargetOptions, AwsLocalDeploymentConfig, AwsOrganization, AwsRegion, CiDeploymentConfig, ClassTypeOptions, DeployWorkflowOptions, GitBranch, IDependencyResolver, MonorepoProjectOptions, PnpmWorkspaceOptions, RemoteCacheOptions, ResetTaskOptions, TurboRepoOptions, TurboRepoTaskOptions, TypeScriptProjectOptions, VersionKey, VitestConfigOptions, VitestOptions };