validate

opentp validate

Validates all events in your tracking plan against the configuration.

Usage

opentp validate [options]

Options

Option	Description
--root <path>	Project root directory
--verbose	Show detailed output
--json	Output results as JSON
--external-rules <path>	Load custom validation checks
--external-transforms <path>	Load custom transforms

Examples

Basic validation

opentp validate

Output:

✓ All events are valid count=42

With custom project root

opentp validate --root ./my-tracking-plan

With verbose output

opentp validate --verbose

Shows detailed information about each validated event.

With custom checks

opentp validate --external-rules ./my-rules

Loads additional validation checks from the specified directory.

Validation Checks

The validator performs these checks:

1. Key validation — event.key is required; optional constraints via spec.events.key; optional expected-key check if spec.events.x-opentp.keygen is configured
2. Uniqueness — event keys must be unique across the plan
3. Taxonomy validation — required fields + dict/enum + JSON-Schema-like constraints + x-opentp.checks
4. Payload validation — target selector resolution + versioning (aliases, $ref) + merge semantics + constraints + x-opentp.checks + PII
5. Path extraction — taxonomy variables extracted from file paths (based on spec.paths.events.template)

Error Output

When validation fails, errors are displayed with:

• File path
• Error type
• Error message
• Suggested fix (when available)

✗ events/auth/login.yaml
  Key mismatch: expected "auth::login", got "auth::login_click"

✗ events/dashboard/view.yaml
  Missing required field: taxonomy.action

Found 2 errors in 42 events