A vim profiling tool

vim-profiler 🕒

vim-profiler is a wrapper around the (n)vim --startuptime command, written in Rust. The binary is called vp and has only been tested on a Unix based system.

Demo

Here is a quick demo showcasing the main functionality of the program.

Installation

You can install vim-profiler with the rust package manager Cargo:

$ cargo install vim-profiler

Usage

vim-profiler 0.0.1
A vim profiling tool.

USAGE:
    vp [FLAGS] [OPTIONS]

FLAGS:
    -e, --export     Export the results to a CSV file
    -h, --help       Prints help information
    -p, --plot       Plot the data and save it to a SVG file
    -r, --reverse    Display the plugin times in reverse order (fastest first)
    -s, --sys        Show system plugins in the output
    -V, --version    Prints version information
    -v, --verbose    Add informative messages during program execution

OPTIONS:
    -c, --command <command>        The command to run, e.g vim or neovim [default: vim]
    -n, --count <count>            The number of plugins to list in the output
    -i, --iter <iter>              The number of iterations
    -x, --precision <precision>    Precision in the output

Exporting results

This utility allows for exporting results to either in a .svg file in the form of a plot or in a .csv file, where extra statistics are written.

Plot

The plot visualizes the start times of each plugin in your plugin directory. If you invoke vp with the --plot flag, you will receive a plot in the form of an SVG file called plugins.svg in the current working directory that looks something like:

CSV

The CSV file contains various other useful statistics such as:

• The average start time across all iterations
• The median start time across all iterations
• The standard deviation from the mean

If you invoke vp with the --export flag you will receive a CSV file with the additional statistics called plugins.csv in the current working directory that looks something like:

Prior Art

The API is heavily inspired by the Python script that goes by the same name vim-profiler.

A few other notable vim profiling tools include:

• hyiltiz/vim-plugins-profile
• dstein64/vim-startuptime