Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tacheometry/testez-companion
Run TestEZ tests and view their results right from VS Code
https://github.com/tacheometry/testez-companion
roblox roblox-studio tests vscode-extension
Last synced: 2 months ago
JSON representation
Run TestEZ tests and view their results right from VS Code
- Host: GitHub
- URL: https://github.com/tacheometry/testez-companion
- Owner: tacheometry
- License: gpl-3.0
- Created: 2021-04-23T13:09:29.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-21T22:11:51.000Z (10 months ago)
- Last Synced: 2024-04-22T02:15:11.234Z (10 months ago)
- Topics: roblox, roblox-studio, tests, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=tacheometrist.testez-companion
- Size: 577 KB
- Stars: 20
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[marketplace-shield]: https://img.shields.io/visual-studio-marketplace/d/tacheometrist.testez-companion
[marketplace-url]: https://marketplace.visualstudio.com/items?itemName=tacheometrist.testez-companion
[license-shield]: https://img.shields.io/github/license/tacheometry/testez-companion
[license-url]: https://github.com/tacheometry/testez-companion/blob/master/LICENSE.md
# TestEZ Companion
[![License][license-shield]][license-url]
[![Visual Studio Marketplace][marketplace-shield]][marketplace-url]
TestEZ Companion is a Visual Studio Code extension that enables Roblox developers to preview their [TestEZ](https://roblox.github.io/testez/) test results inside VS Code.
## CLI
A community made project for CLI usage is available: https://github.com/jackTabsCode/testez-companion-cli
# Contributing
## VS Code extension
### Set up
After getting the repository, run `npm i` to install all dependencies.
### Running tests
Before compiling, running tests is highly encouraged. This is done through [Jasmine](https://jasmine.github.io).
- To run tests once, run: `npm test`
- To run tests in watch mode, run: `npm run test:watch`
### Compiling
The VS Code extension uses [TypeScript](https://www.typescriptlang.org), and is then bundled with [webpack](https://webpack.js.org).
- To compile once (in production mode), run: `npm run build`
- To compile in watch mode, run `npm run watch`
## Roblox Studio plugin
Make sure to first initialize git submodules:
```
git submodule init
git submodule update
```
### Installing the plugin
These commands are to be run inside the `plugin` directory of the repository.
#### By building it with Rojo
1. Run `rojo build`, and move the output file to your Studio plugins directory.
```
rojo build -o "TestEZ Companion.rbxmx"
```
On Windows, the location of Studio plugins is `%LOCALAPPDATA%\Roblox\Plugins`.
On macOS, the location of Studio plugins is `~/Documents/Roblox/Plugins`.
#### By copying from Studio
1. Serve the `testing.project.json` file:
```
rojo serve testing.project.json
```
2. Under `ReplicatedStorage`, right click the `TestEZ Companion` folder, and select `Save as Local Plugin...`. Selecting `Save to File...`, and saving the `rbxm*` model in your plugin directory also works.
## Test place
A basic place to test the functionality of spec files is https://github.com/tacheometry/testez-basic-place.