This repository contains tools for researchers and experiment designers to create, validate, and manage experiments for the Deliberation Lab. The main functionality includes a Visual Studio Code (VS Code) extension for syntax highlighting, validation, and YAML schema validation of experiment configuration files (.treatments.yaml + elements built in markdown).
This VS Code extension enhances experiment design workflows by:
1. Providing syntax highlighting for .treatments.yaml files and elements built in markdown.
2. Using Zod schemas to validate experiment configurations.
3. Diagnosing errors with detailed, line-specific feedback.
4. Allowing structured YAML configuration for treatments, sequences, elements, and other experiment components.
5. Displaying useful, context-aware validation and error messages for experiment designers.
- Prompt file validation
- Timeline visualization for experiment component display
- Participant preview
- Find our extension here: https://marketplace.visualstudio.com/items?itemName=deliberation-lab.deliberation-lab-tools
In a working directory:
# clone the repository from github
git clone [email protected]:Watts-Lab/deliberation-lab-tools.git
# generate .vsix file, need @vscode/vsce installed if not already
vsce package
# install generated package in vscode
code --install-extension [.vsix file generated above]
Tests are located in the following files, separated by their functionality:
src/test/suite/detection.test.ts
src/test/suite/diagnostics.test.ts
The file src/runExtensionTests.js runs a test script that calls the file src/test/suite/index.ts to execute these tests. All tests can be run at once with npm test (if this command is not working, make sure you run npm install first).
If you want to test only one or a few test files, then run npm test --TEST_FILES {test_file_name} {test_file_name} ..., making sure to separate specific test file names by spaces. For example, npm test --TEST_FILES detection.test.js runs only detection algorithm tests, and npm test --TEST_FILES diagnostics.test.js runs only diagnostic tests. npm test --TEST_FILES detection.test.js diagnostics.test.js runs both files in the specified order.
- Access our Azure DevOps organization -- permission required
- Create a PAT following VSCode guidelines
- Provide custom defined scope to
Marketplacescope withManageaccess level - Make sure the
Organizationis set toAll accessible organizations(NOT just for our org)
- Provide custom defined scope to
- Update GitHub repository with newly generated PAT