swdc-tracker

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

Install

yarn add swdc-tracker

Usage

extension.ts

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

./Utils.ts

importswdcTrackerfrom'swdc-tracker'exportfunctionopenSomeFile(){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