vim-test/vim-test
Vim Test
vim-test is a Vim extension and multi-language test orchestrator that automatically detects and executes test suites directly from the editor. It functions as a configurable framework for triggering CLI-based testing across diverse programming languages, mapping source files to their corresponding tests and running them via language-specific tools.
The system distinguishes itself through a customizable runner framework that allows for the definition of custom execution logic and flags. It utilizes a pluggable architecture to support various testing frameworks and languages by mapping identifiers to specific executable logic and command templates.
The plugin covers a broad range of automation capabilities, including automated test discovery, cursor-based single test execution, and the ability to trigger tests automatically upon saving files. It manages execution environments by supporting internal terminals, external shells, and background processes, while allowing for the configuration of CLI options and environment variables.
Features
- Editor-Integrated Test Execution - Provides a Vim-integrated environment to execute and monitor test suites, files, and individual tests across multiple languages.
- Test Runner Integrations - Integrates test suite and individual test execution directly within the Vim editor.
- Vim Plugins - Extends the Vim editor to automatically detect and execute test suites for multiple languages.
- Source-to-Test Mappings - Automatically links source files to corresponding test files using predefined naming transformations.
- Multi-Language Test Frameworks - Provides a unified command interface in Vim to manage various testing frameworks across polyglot projects.
- Runner Configurations - Allows defining specific shell commands and environment variables to trigger external testing tools.
- Runner Definitions - Enables users to specify new languages and executable logic to support non-builtin testing frameworks.
- Runner Templates - Provides a pluggable architecture to support new languages via custom executable logic and command templates.
- Test Runner Frameworks - Offers a configurable framework for defining custom execution logic and flags for various testing tools.
- Test Discovery Mechanisms - Automates the identification and queuing of test files based on the currently open buffer.
- Test Execution Filtering - Executes specific tests nearest to the cursor by filtering the test runner based on the identified location.
- Cross-File Test Linking - Identifies and runs tests for the corresponding test file while editing an application implementation file.
- Test Orchestrators - Orchestrates multi-language testing by mapping source files to tests and executing them via CLI tools.
- Test Runner Discovery - Locates the correct test runner by scanning the project directory for specific configuration files and conventions.
- Test Suite Execution - Executes the entire project test suite directly from the editor without requiring external scripts.
- Customizable Execution Flags - Allows users to append custom flags, formatting options, and environment variables to the test execution command.
- Automated Test Execution - Triggers test suites automatically upon saving or editing files to verify software functionality during development.
- Execution Environment Selection - Allows users to choose between internal terminals, external shells, or background processes for test execution.
- Command Construction - Dynamically constructs shell commands by combining runner paths with flags and cursor-based filters.
- Command Wrapping - Modifies final command strings to wrap executions in remote sessions or specific environment shells.
- Executable Detection - Automatically locates the correct test runner by scanning the project for specific configuration files.
- Test-Driven Development Workflow - Supports an iterative development cycle by executing tests automatically upon saving files.
- Asynchronous Test Execution - Enables running test suites in the background to ensure the editor interface remains responsive during execution.
- Test Identification - Uses regular expressions to identify the specific test case nearest to the cursor for targeted execution.
- Custom Argument Passing - Enables passing custom flags and specific parameters to the test runner to modify execution behavior.
