Home

Tutorial

write-vscodestat makes it easy to collect, filter and save vscode statistics to csv files.

Visit our documentation site for code reference.

Initilaize a new WriteVscodeStat class

In these examples we initilaize a WriteVscodeStat class in order to collect statistics about gitlens vscode extension.

Parameters:

• extensionName: name of the target vscode extension
• outDir: path of the directory where the gathered data will be saved into csv files

Example - Initilaize without outDir

Because outDir is null the gathered statistics will be only printed to the console.

const WriteVscodeStat = require("write-vscodestat").default;

const targetExtension = "gitlens";
const writevscodestat = new WriteVscodeStat(targetExtension);

Example - Initilaize with outDir

Because outDir is not null the gathered statistics will be saved into csv files too.

const WriteVscodeStat = require("write-vscodestat").default;

const targetExtension = "gitlens";
const csvDir = "stats/gitlens";
const writevscodestat = new WriteVscodeStat(targetExtension, csvDir);

Properties of the WriteVscodeStat class

Properties:

• outDir: path of the directory where the gathered data will be saved into csv files
• datePeriod: grouping of the statistics
• writeExtensionName: flag used to write the name of the extension into a csv column
• mergeStoredData: flag used to merge actual day's vscode statistics with previously stored

Example - Change outDir

outDir can be changed or set at anytime.

const WriteVscodeStat = require("write-vscodestat").default;

const targetExtension = "gitlens";
const writevscodestat = new WriteVscodeStat(targetExtension);

writevscodestat.outDir = "stats/gitlens";

Example - Change datePeriod

const WriteVscodeStat = require("write-vscodestat").default;

const targetExtension = "gitlens";
const writevscodestat = new WriteVscodeStat(targetExtension);

writevscodestat.datePeriod = "month";

Example - Change writeExtensionName

const WriteVscodeStat = require("write-vscodestat").default;

const targetExtension = "gitlens";
const writevscodestat = new WriteVscodeStat(targetExtension);

writevscodestat.writeExtensionName = true;

Example - Change mergeStoredData

const WriteVscodeStat = require("write-vscodestat").default;

const targetExtension = "gitlens";
const writevscodestat = new WriteVscodeStat(targetExtension);

writevscodestat.mergeStoredData = false;

Methods of the WriteVscodeStat class

getVscodeStat

Example - Get actual day's vscode statistics

const WriteVscodeStat = require("write-vscodestat").default;

const targetExtension = "gitlens";
const writevscodestat = new WriteVscodeStat(targetExtension);

writevscodestat.getVscodeStat().then(stats => {
    console.log(stats);
});

writeVscodeStat

Parameters:

• postfix: postfix of the csv file

Example - Write actual day's vscode statistics, grouped by month

const WriteVscodeStat = require("write-vscodestat").default;

const targetExtension = "gitlens";
const csvDir = "stats/gitlens";
const writevscodestat = new WriteVscodeStat(targetExtension, csvDir);

writevscodestat.mergeStoredData = true;
writevscodestat.datePeriod = "month";
writevscodestat.writeVscodeStat();