Skip to content

Latest commit

 

History

History
76 lines (47 loc) · 2.58 KB

README.md

File metadata and controls

76 lines (47 loc) · 2.58 KB
Raw

TestEZ Companion

License Visual Studio Marketplace

TestEZ Companion is a Visual Studio Code extension that enables Roblox developers to preview their 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.

  • 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, and is then bundled with webpack.

  • 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.