🔑  Important: If you are using generateDescription, you must set the appropriate credentials for the LLM provider you are using as an environment variable. OpenAI uses OPENAI_API_KEY and Google Vertex AI uses GOOGLE_APPLICATION_CREDENTIALS.

$3

If you have your own in-house tracker or a wrapper function that calls other tracking libraries, you can specify the function signature with the -c or --customFunction option.

#### Standard Custom Function Format

Your function signature should be in the following format:
`js
yourCustomTrackFunctionName(EVENT_NAME, PROPERTIES, customFieldOne, customFieldTwo)
`

- EVENT_NAME is the name of the event you are tracking. It should be a string or a pointer to a string. This is required.
- PROPERTIES is an object of properties for that event. It should be an object / dictionary. This is optional.
- Any additional parameters are other fields you are tracking. They can be of any type. The names you provide for these parameters will be used as the property names in the output.


For example, if your function has a userId parameter at the beginning, followed by the event name and properties, you would pass in the following:

`js
yourCustomTrackFunctionName(userId, EVENT_NAME, PROPERTIES)
`

If your function follows the standard format yourCustomTrackFunctionName(EVENT_NAME, PROPERTIES), you can simply pass in yourCustomTrackFunctionName to --customFunction as a shorthand.

#### Method-Name-as-Event Format

For tracking patterns where the method name itself is the event name (e.g., yourClass.yourEventName({...})), use the special EVENT_NAME placeholder in the method position:

`js
yourClass.EVENT_NAME(PROPERTIES)
`

This pattern tells the analyzer that:
- yourClass is the object name to match
- The method name after the dot (e.g., viewItemList, addToCart) is the event name
- PROPERTIES is the properties object (defaults to the first argument if not specified)

Example:
`typescript
// Code in your project:
yourClass.viewItemList({ items: [...] });
yourClass.addToCart({ item: {...}, value: 100 });
yourClass.purchase({ userId: '123', value: 100 });

// Command:
npx @flisk/analyze-tracking /path/to/project --customFunction "yourClass.EVENT_NAME(PROPERTIES)"
`

This will detect:
- Event: viewItemList with properties from the first argument
- Event: addToCart with properties from the first argument
- Event: purchase with properties from the first argument

_Note: This pattern is currently only supported for JavaScript and TypeScript code._

#### Multiple Custom Functions

You can also pass in multiple custom function signatures by passing in the --customFunction option multiple times or by passing in a space-separated list of function signatures.

`sh
npx @flisk/analyze-tracking /path/to/project --customFunction "yourFunc1" --customFunction "yourFunc2(userId, EVENT_NAME, PROPERTIES)"
npx @flisk/analyze-tracking /path/to/project -c "yourFunc1" "yourFunc2(userId, EVENT_NAME, PROPERTIES)"
npx @flisk/analyze-tracking /path/to/project -c "yourClass.EVENT_NAME(PROPERTIES)" "customTrack(EVENT_NAME, PROPERTIES)"
`

What's Generated?

`yaml
version: 1
source:
repository:
commit:
timestamp:
events:
:
description:
implementations:
- description:
path:
line:
function:
destination:
properties:
:
description:
type:
`

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 for a JSON Schema of the output.

Supported tracking libraries & languages

| Library | JavaScript/TypeScript | Python | Ruby | Go | Swift |
|---------|:---------------------:|:------:|:----:|:--:|:--:|
| Google Analytics | ✅ | ❌ | ❌ | ❌ | ✅ |
| Google Tag Manager | ✅ | ❌ | ❌ | ❌ | ✅ |
| Segment | ✅ | ✅ | ✅ | ✅ | ✅ |
| Mixpanel | ✅ | ✅ | ✅ | ✅ | ✅ |
| Amplitude | ✅ | ✅ | ❌ | ✅ | ✅ |
| Rudderstack | ✅ | ✅ | ✳️ | ✳️ | ✅ |
| mParticle | ✅ | ❌ | ❌ | ❌ | ✅ |
| PostHog | ✅ | ✅ | ✅ | ✅ | ✅ |
| Pendo | ✅ | ❌ | ❌ | ❌ | ✅ |
| Heap | ✅ | ❌ | ❌ | ❌ | ✅ |
| Snowplow | ✅ | ✅ | ✅ | ✅ | ❌ |
| Datadog RUM | ✅ | ❌ | ❌ | ❌ | ❌ |
| Custom Function | ✅ | ✅ | ✅ | ✅ | ✅ |

✳️ Rudderstack's SDKs often use the same format as Segment, so Rudderstack events may be detected as Segment events.

SDKs for supported libraries

Contribute