Navigator Prefabricating Marinates

    swdc-tracker
    TypeScript icon, indicating that this package has built-in type declarations

    1.5.3 • Public • Published

    swdc-tracker

    npm version main

    Sends data to snowplow. Use this to track events in plugins written in js.

    Install

    yarn add swdc-tracker
    

    Usage

    extension.ts

    import swdcTracker from 'swdc-tracker'
    
    // initialize it once with the backend api host, namespace and appId
    swdcTracker.initialize("https://api.software.com", "codetime-events", "codetime-vscode")

    ./Utils.ts

    import swdcTracker from 'swdc-tracker'
    
    export function openSomeFile() {
      swdcTracker.trackEditorAction({
        jwt: jwt,
        entity: "editor",
        type: "activate",
        tz_offset_minutes: 420,
        file_name: "your_file.js",
        file_path: "/path/to/your_file.js",
        file_syntax: "javascript",
        file_line_count: 10,
        file_character_count: 100,
        project_name: "your_project_name",
        project_directory: "/path/to/your/project",
        plugin_id: 1,
        plugin_version: "1.2.3"
      })
      ...
    }

    Test mode

    swdc-tracker has test mode on by default. In order to send events to snowplow, set env ENABLE_SWDC_TRACKER to "true"

    test mode will log the event's properties and contexts so you can easily debug payloads being sent to snowplow.

    Development

    Install Deps

    yarn
    

    Build

    yarn build
    

    Keywords

    none

    Install

    npm i swdc-tracker

    DownloadsWeekly Downloads

    65

    Version

    1.5.3

    License

    SEE LICENSE IN LICENSE

    Unpacked Size

    142 kB

    Total Files

    70

    Last publish

    Collaborators

    • software_ryan
    • daniel.alfaro
    • bo_j
    • brettmstevens7
    • xavierluiz
    • thegeoffstevens
    • masonmc