@flisk/analyze-tracking 0.5.2 → 0.7.0

package/README.md

@@ -6,9 +6,9 @@ Automatically document your analytics setup by analyzing tracking code and gener
 
 
 ## Why Use @flisk/analyze-tracking?
-📊 **Understand Your Tracking** – Effortlessly analyze your codebase for `track` calls so you can see all your analytics events, properties, and triggers in one place. No more guessing what’s being tracked!
+📊 **Understand Your Tracking** – Effortlessly analyze your codebase for `track` calls so you can see all your analytics events, properties, and triggers in one place. No more guessing what's being tracked!
 
-🔍 **Auto-Document Events** – Generates a complete YAML schema that captures all events and properties, including where they’re implemented in your codebase.
+🔍 **Auto-Document Events** – Generates a complete YAML schema that captures all events and properties, including where they're implemented in your codebase.
 
 🕵️‍♂️ **Track Changes Over Time** – Easily spot unintended changes or ensure your analytics setup remains consistent across updates.
 
@@ -38,17 +38,26 @@ npx @flisk/analyze-tracking /path/to/project [options]
   Use this if you have your own in-house tracker or a wrapper function that calls other tracking libraries.
 
   We currently only support functions that follow the following format:
+  
+  **JavaScript/TypeScript/Python/Ruby:**
   ```js
   yourCustomTrackFunctionName('<event_name>', {
     <event_parameters>
   });
   ```
+  
+  **Go:**
+  ```go
+  yourCustomTrackFunctionName("<event_name>", map[string]any{}{
+    "<property_name>": "<property_value>",
+  })
+  ```
 </details>
 
 
-## What’s Generated?
+## What's Generated?
 A clear YAML schema that shows where your events are tracked, their properties, and more.
-Here’s an example:
+Here's an example:
 
 ```yaml
 version: 1
@@ -71,21 +80,41 @@ events:
         type: <property_type>
 ```
 
-Use this to understand where your events live in the code and how they’re being tracked.
+Use this to understand where your events live in the code and how they're being tracked.
 
 Your LLM of choice is used for generating descriptions of events, properties, and implementations.
 
 See [schema.json](schema.json) for a JSON Schema of the output.
+ 
+
+## Supported tracking libraries & languages
+
+| Library | JavaScript/TypeScript | Python | Ruby | Go |
+|---------|:---------------------:|:------:|:----:|:--:|
+| Google Analytics  | ✅ | ❌ | ❌ | ❌ |
+| Segment           | ✅ | ✅ | ✅ | ✅ |
+| Mixpanel          | ✅ | ✅ | ✅ | ✅ |
+| Amplitude         | ✅ | ✅ | ❌ | ✅ |
+| Rudderstack       | ✅ | ✅ | ✳️ | ✳️ |
+| mParticle         | ✅ | ✅ | ❌ | ❌ |
+| PostHog           | ✅ | ✅ | ✅ | ✅ |
+| Pendo             | ✅ | ✅ | ❌ | ❌ |
+| Heap              | ✅ | ✅ | ❌ | ❌ |
+| Snowplow          | ✅ | ✅ | ✅ | ✅ |
+| Custom Function   | ✅ | ✅ | ✅ | ✅ |
 
+✳️ Rudderstack's SDKs often use the same format as Segment, so Rudderstack events may be detected as Segment events.
 
-## Supported tracking libraries
+
+## SDKs for supported libraries
 
 <details>
   <summary>Google Analytics</summary>
 
+  **JavaScript/TypeScript**
   ```js
   gtag('event', '<event_name>', {
-    <event_parameters>
+    '<property_name>': '<property_value>'
   });
   ```
 </details>
@@ -93,126 +122,323 @@ See [schema.json](schema.json) for a JSON Schema of the output.
 <details>
   <summary>Segment</summary>
 
+  **JavaScript/TypeScript**
   ```js
   analytics.track('<event_name>', {
-    <event_parameters>
+    '<property_name>': '<property_value>'
   });
   ```
+
+  **Python**
+  ```python
+  analytics.track('<event_name>', {
+    '<property_name>': '<property_value>'
+  })
+  ```
+
+  **Ruby**
+  ```ruby
+  Analytics.track(
+    event: '<event_name>',
+    properties: {
+      '<property_name>': '<property_value>'
+    }
+  )
+  ```
+
+  **Go**
+  ```go
+  client.Enqueue(analytics.Track{
+    UserId: "user-id",
+    Event:  "<event_name>",
+    Properties: analytics.NewProperties().
+      Set("<property_name>", "<property_value>"),
+  })
+  ```
 </details>
 
 <details>
   <summary>Mixpanel</summary>
 
+  **JavaScript/TypeScript**
   ```js
   mixpanel.track('<event_name>', {
-    <event_parameters>
+    '<property_name>': '<property_value>'
   });
   ```
+
+  **Python**
+  ```python
+  mixpanel.track('<event_name>', {
+    '<property_name>': '<property_value>'
+  })
+  ```
+
+  **Ruby**
+  ```ruby
+  tracker.track('<distinct_id>', '<event_name>', {
+    '<property_name>': '<property_value>'
+  })
+  ```
+
+  **Go**
+  ```go
+  ctx := context.Background()
+  mp := mixpanel.NewApiClient("YOUR_PROJECT_TOKEN")
+  mp.Track(ctx, []*mixpanel.Event{
+    mp.NewEvent("<event_name>", "", map[string]any{}{
+      "<property_name>": "<property_value>",
+    }),
+  })
+  ```
 </details>
 
 <details>
   <summary>Amplitude</summary>
 
+  **JavaScript/TypeScript**
   ```js
   amplitude.logEvent('<event_name>', {
     <event_parameters>
   });
   ```
+
+  **Python**
+  ```python
+  amplitude.track('<event_name>', {
+    '<property_name>': '<property_value>'
+  })
+  ```
+
+  **Go**
+  ```go
+  client.Track(amplitude.Event{
+    UserID:    "<user_id>",
+    EventType: "<event_name>",
+    EventProperties: map[string]any{}{
+      "<property_name>": "<property_value>",
+    },
+  })
+  ```
 </details>
 
 <details>
   <summary>Rudderstack</summary>
 
+  **JavaScript/TypeScript**
   ```js
   rudderanalytics.track('<event_name>', {
     <event_parameters>
   });
   ```
+
+  **Python**
+  ```python
+  rudder_analytics.track('<event_name>', {
+    '<property_name>': '<property_value>'
+  })
+  ```
+
+  **Ruby**
+  ```ruby
+  analytics.track(
+    user_id: '<user_id>',
+    event: '<event_name>',
+    properties: {
+      '<property_name>': '<property_value>'
+    }
+  )
+  ```
+
+  **Go**
+  ```go
+  client.Enqueue(analytics.Track{
+    UserId: "<user_id>",
+    Event:  "<event_name>",
+    Properties: analytics.NewProperties().
+      Set("<property_name>", "<property_value>"),
+  })
+  ```
 </details>
 
 <details>
   <summary>mParticle</summary>
 
+  **JavaScript/TypeScript**
   ```js
   mParticle.logEvent('<event_name>', {
-    <event_parameters>
+    '<property_name>': '<property_value>'
   });
   ```
+
+  **Python**
+  ```python
+  mParticle.logEvent('<event_name>', {
+    '<property_name>': '<property_value>'
+  })
+  ```
+
+
 </details>
 
 <details>
   <summary>PostHog</summary>
 
+  **JavaScript/TypeScript**
   ```js
   posthog.capture('<event_name>', {
-    <event_parameters>
+    '<property_name>': '<property_value>'
   });
   ```
+
+  **Python**
+  ```python
+  posthog.capture(
+    'distinct_id',
+    '<event_name>',
+    {
+      '<property_name>': '<property_value>'
+    }
+  )
+  # Or
+  posthog.capture(
+    'distinct_id',
+    event='<event_name>',
+    properties={
+      '<property_name>': '<property_value>'
+    }
+  )
+  ```
+
+  **Ruby**
+  ```ruby
+  posthog.capture({
+    distinct_id: '<distinct_id>',
+    event: '<event_name>',
+    properties: {
+      '<property_name>': '<property_value>'
+    }
+  })
+  ```
+
+  **Go**
+  ```go
+  client.Enqueue(posthog.Capture{
+    DistinctId: "<distinct_id>",
+    Event:      "<event_name>",
+    Properties: posthog.NewProperties().
+      Set("<property_name>", "<property_value>"),
+  })
+  ```
 </details>
 
 <details>
   <summary>Pendo</summary>
 
+  **JavaScript/TypeScript**
   ```js
   pendo.track('<event_name>', {
     <event_parameters>
   });
   ```
+
+  **Python**
+  ```python
+  pendo.track('<event_name>', {
+    '<property_name>': '<property_value>'
+  })
+  ```
+
+
 </details>
 
 <details>
   <summary>Heap</summary>
 
+  **JavaScript/TypeScript**
   ```js
   heap.track('<event_name>', {
     <event_parameters>
   });
   ```
+
+  **Python**
+  ```python
+  heap.track('<event_name>', {
+    '<property_name>': '<property_value>'
+  })
+  ```
+
+
 </details>
 
 <details>
-  <summary>Snowplow (struct events)</summary>
+  <summary>Snowplow (Structured Events)</summary>
 
+  **JavaScript/TypeScript**
   ```js
   snowplow('trackStructEvent', {
     category: '<category>',
     action: '<action>',
     label: '<label>',
     property: '<property>',
-    value: '<value> '
+    value: '<value>'
   });
   ```
 
-  ```js
+  **Python**
+  ```python
+  # Direct tracking
   trackStructEvent({
-    category: '<category>',
-    action: '<action>',
-    label: '<label>',
-    property: '<property>',
-    value: '<value>'
-  });
+    'category': '<category>',
+    'action': '<action>',
+    'label': '<label>',
+    'property': '<property>',
+    'value': '<value>'
+  })
+  
+  # Builder pattern
+  buildStructEvent({
+    'category': '<category>',
+    'action': '<action>',
+    'label': '<label>',
+    'property': '<property>',
+    'value': '<value>'
+  })
+  
+  # Function call pattern
+  snowplow('trackStructEvent', {
+    'category': '<category>',
+    'action': '<action>',
+    'label': '<label>',
+    'property': '<property>',
+    'value': '<value>'
+  })
   ```
 
-  ```js
-  buildStructEvent({
+  **Ruby**
+  ```ruby
+  tracker.track_struct_event(
     category: '<category>',
     action: '<action>',
     label: '<label>',
     property: '<property>',
     value: '<value>'
-  });
+  )
   ```
 
-  _Note: Snowplow Self Describing Events are coming soon!_
+  **Go**
+  ```go
+  tracker.TrackStructEvent(sp.StructuredEvent{
+		Category: sp.NewString("<category>"),
+		Action:   sp.NewString("<action>"),
+		Label:    sp.NewString("<label>"),
+		Property: sp.NewString("<property>"),
+		Value:    sp.NewFloat64(<value>),
+	})
+  ```
 </details>
 
 
-## Supported languages
-
-- JavaScript
-- TypeScript
-- Ruby (Experimental - only supports Segment for now)
-
-
 ## Contribute
-We’re actively improving this package. Found a bug? Want to request a feature? Open an issue or contribute directly!
+We're actively improving this package. Found a bug? Want to request a feature? Open an issue or contribute directly!

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flisk/analyze-tracking",
-  "version": "0.5.2",
+  "version": "0.7.0",
   "description": "Analyzes tracking code in a project and generates data schemas",
   "main": "src/index.js",
   "bin": {
@@ -33,6 +33,7 @@
     "command-line-usage": "^7.0.3",
     "isomorphic-git": "^1.27.1",
     "js-yaml": "^4.1.0",
+    "pyodide": "^0.27.6",
     "typescript": "^5.5.4",
     "zod": "^3.24.4"
   },