@stencil/vitest 1.7.2 → 1.8.0

package/README.md

@@ -357,6 +357,38 @@ The `stencil-test` CLI supports most of Stencil's CLI options and all of Vitest
 - For full Stencil CLI options, see [Stencil CLI docs](https://stenciljs.com/docs/cli).
 - For full Vitest CLI options, see [Vitest CLI docs](https://vitest.dev/guide/cli.html).
 
+### Global Variables
+
+The `stencil-test` CLI exposes global variables that can be accessed in your tests to check which CLI flags were used:
+
+| Global              | Type      | Description                            |
+| ------------------- | --------- | -------------------------------------- |
+| `__STENCIL_PROD__`  | `boolean` | `true` when `--prod` flag is passed    |
+| `__STENCIL_SERVE__` | `boolean` | `true` when `--serve` flag is passed   |
+| `__STENCIL_PORT__`  | `string`  | Port number when `--port` is specified |
+
+```tsx
+if (__STENCIL_PROD__) {
+  console.log('Running tests against production build');
+}
+
+if (__STENCIL_SERVE__) {
+  const baseUrl = `http://localhost:${__STENCIL_PORT__ || '3333'}`;
+}
+```
+
+#### TypeScript Support
+
+Add to your `tsconfig.json` for type definitions:
+
+```json
+{
+  "compilerOptions": {
+    "types": ["@stencil/vitest/globals"]
+  }
+}
+```
+
 ## License
 
 MIT

package/dist/bin/stencil-test.js

@@ -207,6 +207,10 @@ function runTests() {
         env: {
             ...process.env,
             NODE_ENV: 'test',
+            // Expose CLI flags to tests via environment variables
+            STENCIL_PROD: args.prod ? 'true' : '',
+            STENCIL_SERVE: args.serve ? 'true' : '',
+            STENCIL_PORT: args.port || '',
         },
     });
     vitestProcess.on('exit', (code) => {

package/dist/config.js

@@ -124,6 +124,23 @@ function generateCoverageExcludes(testIncludes, srcDir) {
 function applyStencilDefaults(config, stencilConfig) {
     // Start with the user's config
     const result = { ...config };
+    // Expose STENCIL_* env vars to all test environments
+    // These are set by the stencil-test CLI when spawning vitest
+    const stencilEnvDefines = {
+        __STENCIL_PROD__: JSON.stringify(process.env.STENCIL_PROD === 'true'),
+        __STENCIL_SERVE__: JSON.stringify(process.env.STENCIL_SERVE === 'true'),
+        __STENCIL_PORT__: JSON.stringify(process.env.STENCIL_PORT || ''),
+    };
+    if (!result.define) {
+        result.define = stencilEnvDefines;
+    }
+    else {
+        // Merge with existing defines, user's defines take precedence
+        result.define = {
+            ...stencilEnvDefines,
+            ...result.define,
+        };
+    }
     // Add esbuild JSX config if not present
     if (!result.esbuild) {
         result.esbuild = {
@@ -307,6 +324,22 @@ function enhanceTestConfig(testConfig, stencilConfig) {
  */
 function enhanceProject(project, stencilConfig) {
     const enhanced = { ...project };
+    // Expose STENCIL_* env vars at the project level for browser tests
+    // This ensures the defines are available in all project types
+    const stencilEnvDefines = {
+        __STENCIL_PROD__: JSON.stringify(process.env.STENCIL_PROD === 'true'),
+        __STENCIL_SERVE__: JSON.stringify(process.env.STENCIL_SERVE === 'true'),
+        __STENCIL_PORT__: JSON.stringify(process.env.STENCIL_PORT || ''),
+    };
+    if (!enhanced.define) {
+        enhanced.define = stencilEnvDefines;
+    }
+    else {
+        enhanced.define = {
+            ...stencilEnvDefines,
+            ...enhanced.define,
+        };
+    }
     // Get output directories from Stencil config
     const outputDirs = getStencilOutputDirs(stencilConfig);
     const defaultExcludes = ['**/node_modules/**', ...outputDirs.map((dir) => `**/${dir}/**`)];

package/dist/globals.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Global variables injected by stencil-test CLI via Vite's define config.
+ *
+ * Usage in tests:
+ * ```typescript
+ * if (__STENCIL_PROD__) {
+ *   // Running with --prod flag
+ * }
+ * ```
+ *
+ * To get TypeScript support, add to your tsconfig.json:
+ * ```json
+ * {
+ *   "compilerOptions": {
+ *     "types": ["@stencil/vitest/globals"]
+ *   }
+ * }
+ * ```
+ */
+
+declare const __STENCIL_PROD__: boolean;
+declare const __STENCIL_SERVE__: boolean;
+declare const __STENCIL_PORT__: string;

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/stenciljs/vitest"
   },
-  "version": "1.7.2",
+  "version": "1.8.0",
   "description": "First-class testing utilities for Stencil design systems with Vitest",
   "license": "MIT",
   "type": "module",
@@ -43,6 +43,9 @@
     "./environments/stencil": {
       "types": "./dist/environments/stencil.d.ts",
       "import": "./dist/environments/stencil.js"
+    },
+    "./globals": {
+      "types": "./dist/globals.d.ts"
     }
   },
   "files": [
@@ -97,7 +100,7 @@
   "dependencies": {
     "jiti": "^2.6.1",
     "local-pkg": "^1.1.2",
-    "vitest-environment-stencil": "1.7.2"
+    "vitest-environment-stencil": "1.8.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.39.2",
@@ -122,7 +125,7 @@
     "node": "^20.0.0 || ^22.0.0 || >=24.0.0"
   },
   "scripts": {
-    "build": "tsc && tsc -p tsconfig.bin.json",
+    "build": "tsc && tsc -p tsconfig.bin.json && cp src/globals.d.ts dist/globals.d.ts",
     "dev": "tsc --watch",
     "test:e2e": "pnpm --filter test-project test",
     "test:unit": "vitest run",