guilhermec-costa / Tracker.nvim

Data analityics and dashboards about your perfomance inside neovim? yeah πŸ“Š

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

tracker.nvim

Lua

Stay in the flow, let Tracker handle the stats πŸ“ˆ


Tracker is currently in development and unstable ⚠️

What is Tracker?

tracker.nvim is a feature-rich plugin for Neovim aimed at providing comprehensive tracking and analysis of developer activities within Neovim.

  • Detailed Tracking: Watches a variety of events. Check Tracker events
  • Data Analysis: Uses the data collected via the events to make valuable analysis of your perfomance
  • Flexible Customization: Customize settings to fit your workflow and individual preferences.

Installation

Using packer.nvim

use {
  'GuiC0506/Tracker.nvim',
}

Using lazy.nvim

-- init.lua:
{
    'GuiC0506/Tracker.nvim',
    requires = {
        {'nvim-telescope/telescope.nvim'}
    }
}

-- plugins/telescope.lua:
return {
    'GuiC0506/Tracker.nvim',
        dependencies = { 'nvim-telescope/telescope.nvim' }
    }

Tracker setup

require('tracker').setup {
    
    -- the location where Tracker will store the session data and logs
    persistence_location = "foo/bar/eg"

    -- if Tracker should store logs about the tracking process
    logs_permission = true,

    -- the frequency, in seconds, which the session data will be saved in the current session
    save_session_data_frequency = 20

    -- time, in seconds, between each timer increment
    timer_delay = 3000,
    
    -- if Tracker should delete all session files on the end of a vim session
    cleanup_session_files_on_session_end = false,

    -- if Tracker should delete all log files on the end of a vim session
    cleanup_log_files_on_session_end = true 

    -- the frequency, in days, which the session data files will be deleted
    -- the files would be deleted the next time you enter vim, and 'x' days have passed
    cleanup_session_files_frequency = 7

    -- the frequency, in days, which the log files will be deleted
    -- the files would be deleted the next time you enter vim, and 'x' days have passed
    cleanup_log_files_frequency = 7
}

Commands

Tracker.nvim provides several commands to interact with the plugin. Here is the list of available commands along with their descriptions:

Tracker commands:

Command Description
TrackerPauseTimer Pauses the Tracker timer
TrackerResumeTimer Resumes the Tracker timer
TrackerResetTimer Resets the Tracker timer
TrackerGetActiveEvents List the events that Tracker watches
TrackerSaveSession Save data from the current session
TrackerClearSessionFiles Clear all session files from the persistence location
TrackerClearLogFiles Clear all the log files within the persistence location
TrackerFilepathOverview List buffers overview
TrackerFiletypeOverview List filetype overview
TrackerProjectOverview List project overview

Telescope integration

Tracker.nvim provides some built

" Show all Tracker available commands

:Telescope tracker commands

" Show all Tracker available commands
:Telescope tracker days

" Will trigger a vim date input (YYYY_MM_DD)
:Telescope tracker sessions

About

Data analityics and dashboards about your perfomance inside neovim? yeah πŸ“Š

License:MIT License


Languages

Language:Lua 100.0%