Beartest Test Explorer for VSCode

VSCode extension that integrates beartest with the VSCode Test Explorer.

Features

• Automatic Test Discovery: Discovers test files matching configurable glob patterns
• File/Folder Hierarchy: Shows tests organized by your project structure
• Run Tests: Execute individual tests, test suites, or entire files
• Debug Tests: Debug your tests with breakpoints using VSCode's debugger
• Real-time Results: See test results as they run with duration tracking
• Error Reporting: View detailed error messages and stack traces

Requirements

• VSCode 1.59.0 or higher
• beartest-js installed in your workspace

Installation

For Development

1. Clone this repository
2. Run npm install in the extension directory
3. Run npm run compile to build the extension
4. Press F5 to open a new VSCode window with the extension loaded

From VSIX

1. Download the .vsix file
2. In VSCode, go to Extensions view
3. Click "..." menu and select "Install from VSIX..."
4. Select the downloaded file

Usage

1. Install beartest in your project:

   npm install beartest
   

2. Create test files with the .test.js, .test.ts, or similar extension

3. The Test Explorer will automatically discover your test files

4. Click the beaker icon in the Activity Bar to open the Test Explorer

5. Run tests by clicking the play button next to any test, suite, or file

6. Debug tests by right-clicking and selecting "Debug Test"

Configuration

Configure the extension in your VSCode settings:

{
  "beartest.testFilePattern": ["**/*.test.*", "**/*.spec.*"]
}

Available Settings

• beartest.testFilePattern: Array of glob patterns for discovering test files (default: ["**/*.test.*"])
• beartest.command: Command to execute tests (default: "node")
• beartest.runtimeArgs: Additional arguments passed to the runtime (default: [])
• beartest.configurations: Array of pattern-based configurations for different test environments (default: [])

Monorepo Configuration

For monorepos or projects where different test files need different runtime configurations, use beartest.configurations. This allows you to specify different commands and runtime arguments based on file path patterns.

Example: Running frontend tests with Bun and backend tests with Node:

{
  "beartest.configurations": [
    {
      "pattern": "packages/frontend/**",
      "command": "bun",
      "runtimeArgs": ["--preload", "./setup.ts"]
    },
    {
      "pattern": "packages/backend/**",
      "command": "node",
      "runtimeArgs": ["--require", "./test-setup.js"]
    },
    {
      "pattern": "packages/legacy/**",
      "command": "node",
      "runtimeArgs": ["--experimental-modules"],
      "cwd": "packages/legacy"
    }
  ]
}

How it works:

• Each test file is matched against patterns in order
• The first matching pattern's configuration is used
• Tests with different configurations run in separate processes automatically
• If no pattern matches, an error is shown

Configuration options:

• pattern (required): Glob pattern to match test file paths (e.g., "packages/frontend/**")
• command (required): Runtime command (e.g., "node", "bun", "tsx")
• runtimeArgs (required): Array of arguments passed to the runtime
• cwd (optional): Working directory relative to workspace root

Multi-root workspaces:

For multi-root workspaces, patterns are matched relative to each workspace folder:

{
  "folders": [
    { "path": "frontend" },
    { "path": "backend" }
  ],
  "settings": {
    "beartest.configurations": [
      {
        "pattern": "**/*.test.ts",
        "command": "tsx",
        "runtimeArgs": []
      }
    ]
  }
}

How It Works

1. Discovery: The extension scans your workspace for files matching the test pattern and builds a file/folder hierarchy in the Test Explorer

2. Dynamic Test Discovery: When you run tests for the first time, the extension executes beartest and listens to test:start events to build the test structure inside each file

3. Execution: Uses beartest's event stream (test:start, test:pass, test:fail) to report test results in real-time

4. Debugging: Launches Node.js with the debugger attached, allowing you to set breakpoints in your test code

Limitations

• Tests inside a file are only discovered after the first run (lazy discovery)
• When debugging, you can only debug entire files (not individual tests within a file)
• Beartest must be installed in your workspace's node_modules or in a beartest-js directory

Development

Building

npm run compile

Watching for changes

npm run watch

Testing the extension

Press F5 in VSCode to open the Extension Development Host with the extension loaded.

License

MIT

Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.