AnyTest
Run any test from Sublime Text
Details
Installs
- Total 251
- Win 134
- Mac 80
- Linux 37
Oct 12 | Oct 11 | Oct 10 | Oct 9 | Oct 8 | Oct 7 | Oct 6 | Oct 5 | Oct 4 | Oct 3 | Oct 2 | Oct 1 | Sep 30 | Sep 29 | Sep 28 | Sep 27 | Sep 26 | Sep 25 | Sep 24 | Sep 23 | Sep 22 | Sep 21 | Sep 20 | Sep 19 | Sep 18 | Sep 17 | Sep 16 | Sep 15 | Sep 14 | Sep 13 | Sep 12 | Sep 11 | Sep 10 | Sep 9 | Sep 8 | Sep 7 | Sep 6 | Sep 5 | Sep 4 | Sep 3 | Sep 2 | Sep 1 | Aug 31 | Aug 30 | Aug 29 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 2 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Mac | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Linux | 0 | 0 | 0 | 0 | 0 | 2 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Readme
- Source
- raw.githubusercontent.com
AnyTest
Run any test from Sublime Text
A Sublime Text ¾ package whose main idea is to automatically detect a test framework for the given file and run it. It is a Sublime Text interpretation of the awesome vim-test plugin.
Currently, the following test frameworks are supported (more test frameworks are coming soon):
Language | Test framework | Identifiers |
---|---|---|
Elixir | ESpec, ExUnit | espec , exunit |
Go | Delve, Ginkgo, Gotest | delve , ginkgo , gotest |
Java | JUnit (with Maven or Gradle) | junit |
JavaScript | Jest, Mocha, Vitest | jest , mocha , vitest |
Python | Behave, Django(including Nose), Mamba, Nose, Nose2, PyTest, PyUnit | behave , django , mamba , nose , nose2 , pytest , pyunit |
Ruby | Cucumber, M, Minitest, Rails, RSpec, Test Bench | cucumber , m ,minitest , rails , rspec , test_bench |
Rust | Cargo | cargotest |
Switft | XCTest | xctest |
Zig | Zigtest | zigtest |
Feel free to open an issue with a test framework request as those test frameworks will be added first.
Installation
- Install the Sublime Text Package Control package if you don't have it already.
- Open the command palette and start typing
Package Control: Install Package
. - Enter
AnyTest
.
Usage
The main command that the package exposes is any_test_run
. It supports 4 scopes:
• suite scope
{ "command": "any_test_run", "args": { "scope": "suite" } }
or AnyTest: Test suite
in the command palette.
Runs the whole test suite (based on the current file)
• file scope
{ "command": "any_test_run", "args": { "scope": "file" } }
or AnyTest: Test file
in the command palette.
Runs all tests in the current file
• line scope
{ "command": "any_test_run", "args": { "scope": "line" } }
or AnyTest: Test line
in the command palette.
Runs the test nearest to the current line(cursor)
• last scope
{ "command": "any_test_run", "args": { "scope": "last" } }
or AnyTest: Test last
in the command palette.
Runs the last test
The package tries to detect a test framework based on the current file.
When the framework is detected the package generates a command and runs it using the selected runner.
When the edit
flag is passed to true
then the command can be edited before running.
And finally, if the select
flag is passed to true
then the auto-detection feature is bypassed
and the quick panel with all available test frameworks is shown allowing to select a test framework manually.
The package keeps the 10 last test commands in history that can be accessed with the AnyTest: Show history
command.
The history can be cleared with the AnyTest: Clear history
command.
The package comes with polyfills for test frameworks that don't have built-in support for running tests for the current line.
All the polyfills have been borrowed from the vim-test
plugin and adapted for Sublime Text.
All the package commands can be found in Default.sublime-commands
By default the package doesn't define any key bindings, run Preferences: AnyTest Key Bindings
to define your own bindings.
Configuration
The package can be configured either globally or at the project level. Settings defined at the project level override settings defined globally.
To configure the package at the project level all settings must be added under the AnyTest
namespace:
{
"folders": [
{
"path": ".",
}
],
"settings": {
"AnyTest": {
"test_frameworks": {
"python": "pyunit"
},
"python.pyunit.runner": "unittesting"
}
}
}
The package provides schemas for its settings so it is recommended to install LSP-json to have settings autocomplete.
To see all available settings please check AnyTest.sublime-settings
By default, the package iterates through all available test frameworks to detect the one to use.
This can be changed with the test_frameworks
setting:
"test_frameworks": {
"python": "pyunit"
}
or
"test_frameworks": {
"python": ["pyunit", "pytest"]
}
this way all other test frameworks will be ignored.
Also, some languages support specifying test frameworks, for example
"python.test_framework": "pytest"
This won't change the detection process, but if there are multiple candidates the specified one will be used.
Project folders and subprojects
The package supports multiple project folders. It can be very useful when there is a nested folder that contains a separate project. The package can detect this situation and calculate the root path correctly.
Another way to handle nested projects is to use the subprojects
settings (usually in the project config)
{
"folders": [
{
"path": ".",
}
],
"settings": {
"AnyTest": {
"subprojects": [
"subfolder1/subfolder1_1",
["subfolder2", "subfolder2_1"]
]
}
}
}
A subproject can be either a string or an array of strings(the path separator will be added automatically).
Runners
The package comes with 3 runners:
command
terminus
console
The default runner is the command
. It uses the built-in Sublime exec
command(the command can be configured) to run the test command.
The command
runner is a bit limited so it is recommended to install Terminus package and use the terminus
runner instead.
The console
runner is mostly used for testing/debugging as its main purpose is to output the test command and metadata to the console.
Runners can be activated globally, per language or framework:
"runner": "terminus",
"python.runner": "command",
"python.pyunit.runner": "unittesting"
Please consult with AnyTest.sublime-settings to check all available settings.
There is also the unittesting
runner and it should be used to test sublime packages with UnitTesting.
Unfortunately, due to UnitTesting
limitations, there is no way to run tests for the current line.
Using unittesting
only makes sense with PyUnit test framework, so it is usually activated as:
"python.pyunit.runner": "unittesting"
Roadmap
- Add more test frameworks (the end goal is to at least support all the test frameworks that
vim-test
supports) - Run tests from the Side Bar (including testing folders)
- Potentially integrate the package with Sublime Debugger
Contribution
The easiest way to add a new test framework is to find it in the vim-test
repository and try to adapt it.
It is also required to cover the test frameworks with tests. Tests and fixtures can be also found in the vim-test
repository
The package uses black
, flake8
and isort
for linting.
Credits
AnyTest
is heavily inspired by the vim-test plugin so all credits go to the authors and maintainers of this awesome Vim plugin.