Setup

Installation

npm install voltage-schema
npm install --save-dev voltage-autodoc

Quick Start

1. Initialize your analytics schema:

npm voltage init

2. Configure your analytics codegen in voltage.config.js:

export default {
  generates: [
    {
      events: './analytics/events/events.volt.yaml',
      output: '/__analytics_generated__/analytics.ts'
    }
  ]
}

3. Define your events in events.volt.yaml:

events:
  page_view:
    name: Page View
    description: Triggered when a user views a page.
    properties:
      - name: Page Name
        description: The name of the page that was viewed.
        type: string

4. Generate your types:

npm voltage generate

5. Use the tracker:

import { createAnalyticsTracker } from 'voltage-schema';
import { AnalyticsSchema, trackingConfig } from './__analytics_generated__/analytics';

const tracker = createAnalyticsTracker<AnalyticsSchema>(trackingConfig, {
  onEventTracked: (eventName, { properties, groups, meta }) => {
    // Send to your analytics service
  }
});

tracker.track('page_view', {
  "Page Name": 'Home'
});

Auto-Documentation

Voltage Schema can automatically generate documentation for your analytics taxonomy:

npm voltage-autodoc

This generates an HTML page that documents all your events, properties, and dimensions. You can view a sample autodoc to see what this looks like.

The autodoc is always up-to-date with your schema, eliminating the need for manually maintained documentation that quickly becomes stale.