Prompt file imported from Virinco/WATS-DevKit (
.github/prompts/new-converter.prompt.md). Copyright stays with the author.
You are my assistant for creating a new WATS converter project.
Goal
Run the tools/new-converter.ps1 script to create a new converter project from the template.
Steps
1. Run the Script
Execute the PowerShell script:
.\Tools\NewConverter.ps1
2. Follow Interactive Prompts
The script will ask:
- Project name - Your company/project name (e.g., "AcmeCorp")
- Converter class name - Optional, defaults to "{ProjectName}Converter"
- Target framework - Choose .NET 8.0 (recommended) or .NET Framework 4.8
3. Verify Creation
After completion:
- ✅ Project created in:
Converters/{AssemblyName}/ - ✅ Contains: Converter class, test suite, Data/ folder, README
4. Next Steps
Inform the user:
"✅ Converter project created successfully!"
Next steps:
-
Add test files to:
Converters/{AssemblyName}/tests/Data/- Include 10+ files with variety (PASS/FAIL, different SNs, etc.)
-
Run initial tests to verify setup:
cd Converters/{AssemblyName} dotnet testNote: Tests will fail initially - that's expected! The template doesn't know your file format yet.
-
Implement converter:
- Edit
src/{ConverterName}.cs - Follow the milestone approach in README.md
- Re-run
dotnet testafter each change
- Edit
-
Review documentation:
- See
docs/guides/QUICKSTART.mdfor detailed tutorial - ⚠️ CRITICAL: See
docs/api/UUT_REFERENCE.mdfor complete UUT Report API reference - For repair converters, see
docs/api/UUR_REFERENCE.md
- See
⚠️ IMPORTANT FOR AI AGENTS
When helping implement converters, YOU MUST REFERENCE:
📘 API Documentation:
docs/api/UUT_REFERENCE.md- UUT Report API (test results)docs/api/UUR_REFERENCE.md- UUR Report API (repairs)docs/api/CONVERTER_GUIDE.md- Complete converter development guide
This contains:
- ✅ Correct API initialization patterns (
api.InitializeAPI(true)) - ✅ Operation type handling (server-specific, NEVER hardcoded)
- ✅ All step types: NumericLimitStep, PassFailStep, StringValueStep, etc.
- ✅ UUT properties, timing, validation modes
- ✅ Best practices and common mistakes to avoid
DO NOT guess at API methods or properties. Always check the API reference first!
Ready to implement your converter! Add test files and start coding. 🚀