/sketch-wakatime

Sketch plugin for automatic time tracking and metrics generated from your Sketch usage.

Primary LanguageJavaScriptBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

sketch-wakatime

Coding time tracker

Time tracking and metrics automatically generated from your Sketch usage.

Installation

  1. Download the latest release.

  2. Unzip the file.

  3. Open the WakaTime.sketchplugin file to install the plugin.

  4. Use Sketch like you normally do and your time will automatically be tracked for you.

  5. Enter your api key if prompted.

  6. Visit https://wakatime.com to see your logged time.

Screen Shots

Project Overview

Configuring

To change your api key, copy it from your Settings page, then paste into Sketch Plugins → WakaTime.

Additional settings are in $HOME/.wakatime.cfg for wakatime cli.

Contributing

To run this plugin from a local clone of the repo:

  1. git clone git@github.com:wakatime/sketch-wakatime.git
  2. cd sketch-wakatime
  3. ln -s "$PWD/sketch-wakatime/WakaTime.sketchplugin" ~/Library/Application\ Support/com.bohemiancoding.sketch3/Plugins/WakaTime.sketchplugin
  4. npm run watch

To view the output from console.log, you have a few different options:

  • Use the sketch-dev-tools
  • Run skpm log in your Terminal, with the optional -f argument (skpm log -f) which causes skpm log to not stop when the end of logs is reached, but rather to wait for additional data to be appended to the input

Publishing

skpm publish <major|minor|patch>

(where bump can be patch, minor or major)

skpm publish will create a new release on your GitHub repository and create an appcast file in order for Sketch users to be notified of the update.

Troubleshooting

The Sketch plugin logs errors to Console.app and ~/.wakatime/wakatime.log.

For more info on debugging Sketch plugins see the official docs.

For more general troubleshooting information, see wakatime/wakatime#troubleshooting.