@herodevs/cli 0.2.0 → 0.2.1-rc2

package/README.md

@@ -33,10 +33,3 @@ Get a list of committers within a git repository
 ```
 hd report committers
 ```
-
-Track a project's progress via lines of code
-
-```
-hd tracker init
-hd tracker run
-```

package/dist/commands/report/committers.d.ts

@@ -1,4 +1,4 @@
-import { BaseCommand, Flags as flagType } from '../../shared';
+import { BaseCommand } from '../../shared';
 export declare class ReportCommitters extends BaseCommand<typeof ReportCommitters> {
     static summary: string;
     static usage: string;
@@ -7,10 +7,13 @@ export declare class ReportCommitters extends BaseCommand<typeof ReportCommitter
         startDate: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         endDate: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
         exclude: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        monthly: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
     private _parseDateFlags;
     private _parseGitLogEntries;
     private _collapseAndSortCommitterInfo;
-    private _printOutput;
-    run(): Promise<flagType<typeof ReportCommitters>>;
+    private parseMonthly;
+    private printCommitters;
+    private printMonthly;
+    run(): Promise<any>;
 }

package/dist/commands/report/committers.js

@@ -31,11 +31,44 @@ class ReportCommitters extends shared_1.BaseCommand {
         Object.keys(hash).forEach((name) => {
             sortable.push({ name, commits: hash[name] });
         });
-        return sortable.sort((a, b) => {
+        const committers = sortable.sort((a, b) => {
             return b.commits.length - a.commits.length;
         });
+        const monthly = this.parseMonthly(entries);
+        return { committers, monthly };
     }
-    _printOutput(committers) {
+    parseMonthly(entries) {
+        const monthly = [];
+        const dates = [new Date(this.flags.startDate), new Date(this.flags.endDate)];
+        const ival = {
+            start: (0, date_fns_1.min)(dates),
+            end: (0, date_fns_1.max)(dates)
+        };
+        const range = (0, date_fns_1.eachMonthOfInterval)(ival);
+        for (const idxr in range) {
+            const idx = parseInt(idxr);
+            if (idx + 1 >= range.length) {
+                continue;
+            }
+            const [start, end] = [range[idx], range[idx + 1]];
+            const month = {
+                name: (0, date_fns_1.format)(start, 'LLLL yyyy'),
+                start, end,
+                committers: {}
+            };
+            for (const rec of entries) {
+                if ((0, date_fns_1.isWithinInterval)(new Date(rec.date), { start, end })) {
+                    month.committers[rec.committer] = month.committers[rec.committer] || [];
+                    month.committers[rec.committer].push({ hash: rec.commitHash, date: rec.date });
+                }
+            }
+            if (Object.keys(month.committers).length > 0) {
+                monthly.push(month);
+            }
+        }
+        return monthly;
+    }
+    printCommitters(committers) {
         if (!Object.keys(committers).length) {
             this.log('NO COMMITTERS IN PERIOD');
         }
@@ -49,15 +82,79 @@ class ReportCommitters extends shared_1.BaseCommand {
         });
         this.log('---------------------------------------------------\n');
     }
+    printMonthly(md) {
+        if (!Object.keys(md).length) {
+            this.log('NO COMMITTERS IN PERIOD');
+            return;
+        }
+        const rows = md
+            .flatMap(r => {
+            return Object
+                .entries(r.committers)
+                .flatMap(([committer, commits]) => commits.flatMap(commit => ({ month: r.name, committer, commit })));
+        }).map(r => ({ ...r, flags: { newMonth: true, newCommitter: true } }));
+        // ugly flag hack for now
+        rows.forEach((r, idx) => {
+            let newMonth = true;
+            let newCommitter = true;
+            if (idx == 0 || r.month !== rows[idx - 1].month) {
+                // first row / new month? always show both
+            }
+            else if (r.committer !== rows[idx - 1].committer) {
+                // month's same but new committer
+                newMonth = false;
+            }
+            else {
+                // show both
+                newMonth = false;
+                newCommitter = false;
+            }
+            r.flags = { newMonth, newCommitter };
+        });
+        const distinctCommitters = rows.reduce((arr, row) => arr.includes(row.committer) ? arr : [...arr, row.committer], []);
+        this.log('\n');
+        core_1.ux.table(rows, {
+            month: {
+                header: 'Month',
+                minWidth: 20,
+                get: row => row.flags.newMonth ? row.month : ''
+            },
+            committer: {
+                header: 'Contributor',
+                minWidth: 25,
+                get: row => row.flags.newCommitter ? row.committer : ''
+            },
+            commit: {
+                header: 'Commit SHA',
+                get: row => row.commit.hash,
+                minWidth: 15,
+            },
+            date: {
+                header: 'Commit Date',
+                get: row => row.commit.date,
+                minWidth: 20
+            },
+            // flags: {}
+        });
+        const unique = distinctCommitters.sort();
+        this.log(`\n\n\nThere were ${unique.length} contributors reported: ${unique.join(', ')}\n`);
+    }
+    // public async run(): Promise<flagType<typeof ReportCommitters>> {
     async run() {
-        const { flags } = (await this.parse(ReportCommitters));
+        const { flags } = this;
         const dates = this._parseDateFlags(flags.startDate, flags.endDate);
         const ignores = flags.exclude && flags.exclude.length ? `-- . "!(${flags.exclude.join('|')})"` : '';
         const gitCommand = `git log --since "${dates[0]}" --until "${dates[1]}" --pretty=format:${gitOutputFormat} ${ignores}`;
         const result = await (0, shared_1.run)(gitCommand);
-        const committers = this._collapseAndSortCommitterInfo(result.split('\n'));
-        this._printOutput(committers);
-        return Promise.resolve();
+        const { committers, monthly } = this._collapseAndSortCommitterInfo(result.split('\n'));
+        if (flags.monthly) {
+            this.printMonthly(monthly);
+            return monthly;
+        }
+        else {
+            this.printCommitters(committers);
+            return committers;
+        }
     }
 }
 exports.ReportCommitters = ReportCommitters;
@@ -84,4 +181,10 @@ ReportCommitters.flags = {
         required: false,
         // default: () => "" as any
     }),
+    monthly: core_1.Flags.boolean({
+        char: 'm',
+        summary: 'Break down by calendar month, rather than by committer.  (eg -m)',
+        required: false,
+        default: false
+    }),
 };

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@herodevs/cli",
-  "version": "0.2.0",
+  "version": "0.2.1-rc2",
   "description": "HeroDevs CLI",
   "author": "@herodevs",
   "bin": {
@@ -22,17 +22,12 @@
     "@oclif/core": "^2",
     "@oclif/plugin-help": "^5",
     "@oclif/plugin-plugins": "^3.2.0",
-    "chart.js": "^3.9.1",
-    "chart.js-image": "^6.1.3",
-    "chartjs-node-canvas": "^4.1.6",
-    "chartjs-plugin-autocolors": "^0.2.2",
-    "chartjs-plugin-datalabels": "^2.2.0",
     "date-fns": "^2.30.0",
     "get-json": "^1.0.1",
     "git-last-commit": "^1.0.1",
     "module-alias": "^2.2.3",
     "shelljs": "^0.8.5",
-    "sloc": "^0.2.1"
+    "sloc": "^0.3.2"
   },
   "devDependencies": {
     "@oclif/test": "^2.4.4",
@@ -61,9 +56,6 @@
     "topics": {
       "report": {
         "description": "Run reports for the current project (commands: committers)"
-      },
-      "tracker": {
-        "description": "Track project progress based upon lines of code (commands: init, run)"
       }
     }
   },

package/dist/shared/lib/version-update.js

@@ -19,6 +19,9 @@ async function getLatestVersion(pkgName) {
     });
 }
 async function isVersionUpToDate(command, quietIfSuccessful = false) {
+    if (config_1.env.packageVersion === '0.0.0') {
+        return true;
+    }
     const latestVersion = await getLatestVersion(config_1.env.packageName);
     if (latestVersion === config_1.env.packageVersion) {
         if (!quietIfSuccessful) {

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.2.0",
+  "version": "0.2.1-rc2",
   "commands": {
     "report:committers": {
       "id": "report:committers",
@@ -41,7 +41,7 @@
           "summary": "Start Date (format: yyyy-MM-dd)",
           "required": false,
           "multiple": false,
-          "default": "2024-02-27"
+          "default": "2024-03-01"
         },
         "endDate": {
           "name": "endDate",
@@ -50,7 +50,7 @@
           "summary": "End Date (format: yyyy-MM-dd)",
           "required": false,
           "multiple": false,
-          "default": "2023-02-27"
+          "default": "2023-03-01"
         },
         "exclude": {
           "name": "exclude",
@@ -59,55 +59,14 @@
           "summary": "Path Exclusions (eg -x=\"./src/bin\" -x=\"./dist\")",
           "required": false,
           "multiple": true
-        }
-      },
-      "args": {}
-    },
-    "tracker:init": {
-      "id": "tracker:init",
-      "description": "Initialize the tracker configuration",
-      "strict": true,
-      "pluginName": "@herodevs/cli",
-      "pluginAlias": "@herodevs/cli",
-      "pluginType": "core",
-      "aliases": [],
-      "examples": [
-        "<%= config.bin %> <%= command.id %>"
-      ],
-      "flags": {},
-      "args": {}
-    },
-    "tracker:run": {
-      "id": "tracker:run",
-      "description": "Run the tracker",
-      "strict": true,
-      "pluginName": "@herodevs/cli",
-      "pluginAlias": "@herodevs/cli",
-      "pluginType": "core",
-      "aliases": [],
-      "examples": [
-        "<%= config.bin %> <%= command.id %>"
-      ],
-      "flags": {
-        "root": {
-          "name": "root",
-          "type": "option",
-          "char": "r",
-          "description": "root dir of the project",
-          "multiple": false
-        },
-        "config": {
-          "name": "config",
-          "type": "option",
-          "char": "c",
-          "description": "path to config file",
-          "multiple": false
         },
-        "chart": {
-          "name": "chart",
-          "type": "option",
-          "description": "chart configuration",
-          "multiple": false
+        "monthly": {
+          "name": "monthly",
+          "type": "boolean",
+          "char": "m",
+          "summary": "Break down by calendar month, rather than by committer.  (eg -m)",
+          "required": false,
+          "allowNo": false
         }
       },
       "args": {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@herodevs/cli",
-  "version": "0.2.0",
+  "version": "0.2.1-rc2",
   "description": "HeroDevs CLI",
   "author": "@herodevs",
   "bin": {
@@ -22,17 +22,12 @@
     "@oclif/core": "^2",
     "@oclif/plugin-help": "^5",
     "@oclif/plugin-plugins": "^3.2.0",
-    "chart.js": "^3.9.1",
-    "chart.js-image": "^6.1.3",
-    "chartjs-node-canvas": "^4.1.6",
-    "chartjs-plugin-autocolors": "^0.2.2",
-    "chartjs-plugin-datalabels": "^2.2.0",
     "date-fns": "^2.30.0",
     "get-json": "^1.0.1",
     "git-last-commit": "^1.0.1",
     "module-alias": "^2.2.3",
     "shelljs": "^0.8.5",
-    "sloc": "^0.2.1"
+    "sloc": "^0.3.2"
   },
   "devDependencies": {
     "@oclif/test": "^2.4.4",
@@ -61,9 +56,6 @@
     "topics": {
       "report": {
         "description": "Run reports for the current project (commands: committers)"
-      },
-      "tracker": {
-        "description": "Track project progress based upon lines of code (commands: init, run)"
       }
     }
   },

package/dist/commands/tracker/init.d.ts

@@ -1,8 +0,0 @@
-import { Command } from '@oclif/core';
-export declare class TrackerInit extends Command {
-    static description: string;
-    static examples: string[];
-    static flags: {};
-    static args: {};
-    run(): Promise<void>;
-}

package/dist/commands/tracker/init.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TrackerInit = void 0;
-const core_1 = require("@oclif/core");
-const initialize_1 = require("../../shared/tracker/initialize");
-const util_1 = require("../../shared/tracker/util");
-class TrackerInit extends core_1.Command {
-    async run() {
-        (0, initialize_1.initialize)((0, util_1.getTheRootDirectory)(global.process.cwd()));
-    }
-}
-exports.TrackerInit = TrackerInit;
-TrackerInit.description = 'Initialize the tracker configuration';
-TrackerInit.examples = ['<%= config.bin %> <%= command.id %>'];
-TrackerInit.flags = {};
-TrackerInit.args = {};

package/dist/commands/tracker/run.d.ts

@@ -1,13 +0,0 @@
-import { Command } from '@oclif/core';
-import { ChartConfig } from '../../shared/tracker/models/chart-config';
-export declare class TrackerRun extends Command {
-    static description: string;
-    static examples: string[];
-    static flags: {
-        root: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        config: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        chart: import("@oclif/core/lib/interfaces").OptionFlag<ChartConfig, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-    };
-    static args: {};
-    run(): Promise<void>;
-}

package/dist/commands/tracker/run.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TrackerRun = void 0;
-const core_1 = require("@oclif/core");
-const path_1 = require("path");
-const util_1 = require("../../shared/tracker/util");
-const process_config_1 = require("../../shared/tracker/process-config");
-const chart_config_1 = require("../../shared/tracker/models/chart-config");
-class TrackerRun extends core_1.Command {
-    async run() {
-        const { flags } = await this.parse(TrackerRun);
-        const localRootDir = (0, util_1.getTheRootDirectory)(global.process.cwd());
-        const rootDirectory = flags.root ? (0, path_1.resolve)(flags.root) : localRootDir;
-        const config = (0, util_1.readConfig)(localRootDir, flags.config);
-        const results = await (0, process_config_1.processConfig)(config, rootDirectory);
-        (0, util_1.saveResults)(localRootDir, config.outputDir, results);
-        const allData = (0, util_1.getData)(localRootDir, config.outputDir);
-        const parentDir = (0, path_1.resolve)(localRootDir, config.outputDir);
-        const chartConfig = new chart_config_1.ChartConfig(flags.chart);
-        try {
-            await (0, util_1.createDataVizIn)(chartConfig, parentDir, allData);
-        }
-        catch (error) {
-            console.log('Error creating visualization');
-        }
-    }
-}
-exports.TrackerRun = TrackerRun;
-TrackerRun.description = 'Run the tracker';
-TrackerRun.examples = ['<%= config.bin %> <%= command.id %>'];
-TrackerRun.flags = {
-    root: core_1.Flags.string({ char: 'r', description: 'root dir of the project' }),
-    config: core_1.Flags.string({ char: 'c', description: 'path to config file' }),
-    chart: core_1.Flags.custom({
-        description: 'chart configuration',
-    })(),
-};
-TrackerRun.args = {};

package/dist/shared/tracker/default-config.d.ts

@@ -1,3 +0,0 @@
-import { Config } from './models/config';
-declare const defaultConfig: Config;
-export default defaultConfig;

package/dist/shared/tracker/default-config.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const defaultConfig = {
-    categories: {
-        legacy: {
-            fileTypes: ['js', 'ts', 'html', 'css', 'scss', 'less'],
-            includes: ['./legacy'],
-            jsTsPairs: 'js',
-        },
-        modern: {
-            fileTypes: ['ts', 'html', 'css', 'scss', 'less'],
-            includes: ['./modern'],
-            jsTsPairs: 'ts',
-        },
-    },
-    ignorePatterns: ['node_modules'],
-    outputDir: 'hd-tracker',
-};
-exports.default = defaultConfig;

package/dist/shared/tracker/initialize.d.ts

@@ -1 +0,0 @@
-export declare function initialize(rootDir: string): void;

package/dist/shared/tracker/initialize.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.initialize = void 0;
-const path_1 = require("path");
-const fs_1 = require("fs");
-const default_config_1 = require("./default-config");
-function initialize(rootDir) {
-    const output = JSON.stringify(default_config_1.default, null, 2);
-    const dir = (0, path_1.join)(rootDir, "hd-tracker");
-    if (!(0, fs_1.existsSync)(dir)) {
-        (0, fs_1.mkdirSync)(dir);
-    }
-    (0, fs_1.writeFileSync)((0, path_1.join)(dir, "config.json"), output);
-}
-exports.initialize = initialize;

package/dist/shared/tracker/models/aggregate-result.d.ts

@@ -1,4 +0,0 @@
-import { TotalResult } from './total-result';
-export interface AggregateResult extends TotalResult {
-    fileType: string;
-}

package/dist/shared/tracker/models/aggregate-result.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/shared/tracker/models/category-result.d.ts

@@ -1,7 +0,0 @@
-import { AggregateResult } from './aggregate-result';
-import { TotalResult } from './total-result';
-export interface CategoryResult {
-    name: string;
-    totals: TotalResult;
-    fileTypes: AggregateResult[];
-}

package/dist/shared/tracker/models/category-result.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/shared/tracker/models/category.d.ts

@@ -1,9 +0,0 @@
-export interface Category extends CategoryDefinition {
-    name: string;
-}
-export interface CategoryDefinition {
-    fileTypes: string[];
-    includes: string[];
-    excludes?: string[];
-    jsTsPairs?: 'js' | 'ts' | 'ignore';
-}

package/dist/shared/tracker/models/category.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/shared/tracker/models/chart-config.d.ts

@@ -1,24 +0,0 @@
-export declare class ChartConfig {
-    private _cliOptions;
-    private _perCategoryAndFileType;
-    private _perCategoryTotals;
-    private _width;
-    private _height;
-    private _bg;
-    private _title;
-    private _xAxisLabel;
-    private _yAxisLabel;
-    private _overwrite;
-    private _outFile;
-    get perCategoryAndFileType(): boolean;
-    get perCategoryTotals(): boolean;
-    get width(): number;
-    get height(): number;
-    get bg(): string;
-    get title(): string;
-    get xAxisLabel(): string;
-    get yAxisLabel(): string;
-    get overwrite(): boolean;
-    get outFile(): string;
-    constructor(_cliOptions?: ChartConfig);
-}

package/dist/shared/tracker/models/chart-config.js

@@ -1,81 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChartConfig = void 0;
-class ChartConfig {
-    get perCategoryAndFileType() {
-        // if false, use false; false !== undefined
-        return this._cliOptions.perCategoryAndFileType !== undefined ?
-            this._cliOptions.perCategoryAndFileType :
-            this._perCategoryAndFileType;
-    }
-    get perCategoryTotals() {
-        // if false, use false; false !== undefined
-        return this._cliOptions.perCategoryTotals !== undefined ?
-            this._cliOptions.perCategoryTotals :
-            this._perCategoryTotals;
-    }
-    get width() {
-        // if set and non-numeric
-        if (this._cliOptions.width !== undefined && isNaN(Number(this._cliOptions.width))) {
-            throw Error('--chart.width must be a number');
-        }
-        // if unset or numeric
-        return this._cliOptions.width !== undefined ?
-            this._cliOptions.width :
-            this._width;
-    }
-    get height() {
-        // if set and non-numeric
-        if (this._cliOptions.height !== undefined && isNaN(Number(this._cliOptions.height))) {
-            throw Error('--chart.height must be a number');
-        }
-        // if unset or numeric
-        return this._cliOptions.height !== undefined ?
-            this._cliOptions.height :
-            this._height;
-    }
-    get bg() {
-        return this._cliOptions.bg ?
-            this._cliOptions.bg :
-            this._bg;
-    }
-    get title() {
-        return this._cliOptions.title ?
-            this._cliOptions.title :
-            this._title;
-    }
-    get xAxisLabel() {
-        return this._cliOptions.xAxisLabel ?
-            this._cliOptions.xAxisLabel :
-            this._xAxisLabel;
-    }
-    get yAxisLabel() {
-        return this._cliOptions.yAxisLabel ?
-            this._cliOptions.yAxisLabel :
-            this._yAxisLabel;
-    }
-    get overwrite() {
-        return this._cliOptions.overwrite !== undefined ?
-            this._cliOptions.overwrite :
-            this._overwrite;
-    }
-    get outFile() {
-        return this._cliOptions.outFile ?
-            this._cliOptions.outFile :
-            this._outFile;
-    }
-    constructor(_cliOptions = {}) {
-        this._cliOptions = _cliOptions;
-        this._perCategoryAndFileType = false;
-        this._perCategoryTotals = true;
-        this._width = 1200;
-        this._height = 800;
-        this._bg = 'white';
-        this._title = 'Migration Progress LOC';
-        this._xAxisLabel = 'Date';
-        this._yAxisLabel = 'Totals';
-        this._overwrite = true;
-        this._outFile = 'viz.png';
-    }
-}
-exports.ChartConfig = ChartConfig;

package/dist/shared/tracker/models/config.d.ts

@@ -1,8 +0,0 @@
-import { CategoryDefinition } from './category';
-export interface Config {
-    categories: {
-        [key: string]: CategoryDefinition;
-    };
-    ignorePatterns?: string[];
-    outputDir: string;
-}

package/dist/shared/tracker/models/config.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/shared/tracker/models/file-result.d.ts

@@ -1,5 +0,0 @@
-import { Result } from './result';
-export interface FileResult extends Result {
-    fileType: string;
-    path: string;
-}

package/dist/shared/tracker/models/file-result.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/shared/tracker/models/process-result.d.ts

@@ -1,6 +0,0 @@
-import { CategoryResult } from './category-result';
-export interface ProcessResult {
-    timestamp: string;
-    hash: string;
-    categories: CategoryResult[];
-}

package/dist/shared/tracker/models/process-result.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/shared/tracker/models/result.d.ts

@@ -1,11 +0,0 @@
-export interface Result {
-    total: number;
-    source: number;
-    comment: number;
-    single: number;
-    block: number;
-    mixed: number;
-    empty: number;
-    todo: number;
-    blockEmpty: number;
-}

package/dist/shared/tracker/models/result.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/shared/tracker/models/total-result.d.ts

@@ -1,4 +0,0 @@
-import { Result } from './result';
-export interface TotalResult extends Result {
-    fileCount: number;
-}

package/dist/shared/tracker/models/total-result.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/shared/tracker/models/viz-dataset.d.ts

@@ -1,4 +0,0 @@
-export type VizDataset = {
-    label: string;
-    data: number[];
-};

package/dist/shared/tracker/models/viz-dataset.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/shared/tracker/models/viz-labels-datasets.d.ts

@@ -1,5 +0,0 @@
-import { VizDataset } from './viz-dataset';
-export type VizLabelsDatasets = {
-    labels: string[];
-    datasets: VizDataset[];
-};

package/dist/shared/tracker/models/viz-labels-datasets.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/shared/tracker/process-category.d.ts

@@ -1,3 +0,0 @@
-import { Category } from './models/category';
-import { CategoryResult } from './models/category-result';
-export declare function processCategory(rootDirectory: string, category: Category, ignorePatterns: string[]): CategoryResult;

package/dist/shared/tracker/process-category.js

@@ -1,155 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.processCategory = void 0;
-const sloc = require("sloc");
-const fs_1 = require("fs");
-const path_1 = require("path");
-function processCategory(rootDirectory, category, ignorePatterns) {
-    console.log(`Processing "${category.name}"...`);
-    const allFiles = category.includes.reduce((acc, include) => {
-        return [...acc, ...findAllFilesInDirectory((0, path_1.join)(rootDirectory, include))];
-    }, []);
-    const includedFiles = findIncludedFiles(category, ignorePatterns, allFiles);
-    console.log(`     ${includedFiles.length} files...`);
-    const results = includedFiles.map(getFileStats);
-    const resultMap = aggregateResults(results);
-    const aggregatedResults = Object.values(resultMap).map((val) => val);
-    const totals = aggregatedResults.reduce((totals, curr) => ({
-        fileCount: totals.fileCount + curr.fileCount,
-        total: totals.total + curr.total,
-        source: totals.source + curr.source,
-        comment: totals.comment + curr.comment,
-        single: totals.single + curr.single,
-        block: totals.block + curr.block,
-        mixed: totals.mixed + curr.mixed,
-        empty: totals.empty + curr.empty,
-        todo: totals.todo + curr.todo,
-        blockEmpty: totals.blockEmpty + curr.blockEmpty,
-    }), {
-        fileCount: 0,
-        total: 0,
-        source: 0,
-        comment: 0,
-        single: 0,
-        block: 0,
-        mixed: 0,
-        empty: 0,
-        todo: 0,
-        blockEmpty: 0,
-    });
-    const final = {
-        name: category.name,
-        totals: totals,
-        fileTypes: aggregatedResults,
-    };
-    console.log(`     ${final.totals.total} total lines`);
-    return final;
-}
-exports.processCategory = processCategory;
-function aggregateResults(results) {
-    return results.reduce((acc, result) => {
-        const fileTypeResults = acc[result.fileType];
-        if (!fileTypeResults) {
-            acc[result.fileType] = {
-                fileType: result.fileType,
-                fileCount: 1,
-                total: result.total,
-                source: result.source,
-                comment: result.comment,
-                single: result.single,
-                block: result.block,
-                mixed: result.mixed,
-                empty: result.empty,
-                todo: result.todo,
-                blockEmpty: result.blockEmpty,
-            };
-        }
-        else {
-            acc[result.fileType] = {
-                fileType: result.fileType,
-                fileCount: fileTypeResults.fileCount + 1,
-                total: fileTypeResults.total + result.total,
-                source: fileTypeResults.source + result.source,
-                comment: fileTypeResults.comment + result.comment,
-                single: fileTypeResults.single + result.single,
-                block: fileTypeResults.block + result.block,
-                mixed: fileTypeResults.mixed + result.mixed,
-                empty: fileTypeResults.empty + result.empty,
-                todo: fileTypeResults.todo + result.todo,
-                blockEmpty: fileTypeResults.blockEmpty + result.blockEmpty,
-            };
-        }
-        return acc;
-    }, {});
-}
-function getFileStats(file) {
-    const contents = (0, fs_1.readFileSync)(file).toString('utf-8');
-    const fileType = getFileExt(file);
-    const stats = sloc(contents, fileType);
-    return {
-        path: file,
-        fileType: fileType,
-        ...stats,
-    };
-}
-function findIncludedFiles(category, ignorePatterns, allFiles) {
-    return allFiles
-        .filter((file) => {
-        var _a;
-        const ext = getFileExt(file);
-        let shouldBeIncluded = !!category.fileTypes.find((fileType) => fileType === ext);
-        if (shouldBeIncluded) {
-            ignorePatterns === null || ignorePatterns === void 0 ? void 0 : ignorePatterns.forEach((ignorePattern) => {
-                if (file.indexOf(ignorePattern) !== -1) {
-                    shouldBeIncluded = false;
-                }
-            });
-        }
-        if (shouldBeIncluded) {
-            (_a = category.excludes) === null || _a === void 0 ? void 0 : _a.forEach((exclude) => {
-                if (file.indexOf(exclude) !== -1) {
-                    shouldBeIncluded = false;
-                }
-            });
-        }
-        return shouldBeIncluded;
-    })
-        .filter((file, _index, files) => {
-        if (category.jsTsPairs === 'ignore' || category.jsTsPairs === undefined) {
-            return true;
-        }
-        const fileExtToKeep = category.jsTsPairs;
-        const ext = getFileExt(file);
-        const fileExtToDiscard = fileExtToKeep === 'js' ? 'ts' : 'js';
-        // if it is the extension to keep
-        // or if it is not the one to discard, we keep those files
-        if (fileExtToKeep === ext || fileExtToDiscard !== ext) {
-            return true;
-        }
-        // get the counterpart's extension
-        const counterpartExt = ext === 'js' ? 'ts' : 'js';
-        const parts = file.split('.');
-        parts[parts.length - 1] = counterpartExt;
-        const counterpartExists = files.filter((f) => f === parts.join('.')).length !== 0;
-        if (counterpartExists) {
-            return false;
-        }
-        return true;
-    });
-}
-function findAllFilesInDirectory(directory) {
-    const results = (0, fs_1.readdirSync)(directory);
-    const subfiles = results
-        .filter((result) => (0, fs_1.lstatSync)((0, path_1.join)(directory, result)).isDirectory())
-        .reduce((acc, subdir) => {
-        const files = findAllFilesInDirectory((0, path_1.join)(directory, subdir));
-        return [...acc, ...files];
-    }, []);
-    const files = results
-        .filter((result) => (0, fs_1.lstatSync)((0, path_1.join)(directory, result)).isFile())
-        .map((fileName) => (0, path_1.join)(directory, fileName));
-    return [...files, ...subfiles];
-}
-function getFileExt(file) {
-    return (0, path_1.extname)(file).replace(/\./g, '');
-}

package/dist/shared/tracker/process-config.d.ts

@@ -1,3 +0,0 @@
-import { Config } from './models/config';
-import { ProcessResult } from './models/process-result';
-export declare function processConfig(config: Config, rootDirectory: string): Promise<ProcessResult>;

package/dist/shared/tracker/process-config.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.processConfig = void 0;
-const process_category_1 = require("./process-category");
-const util_1 = require("./util");
-async function processConfig(config, rootDirectory) {
-    console.log(`Starting...`);
-    const categoryResults = Object.entries(config.categories).map(([name, category]) => (0, process_category_1.processCategory)(rootDirectory, { ...category, name }, config.ignorePatterns || []));
-    const commit = await (0, util_1.getGitCommit)();
-    return {
-        timestamp: commit.timestamp,
-        hash: commit.hash,
-        categories: categoryResults,
-    };
-}
-exports.processConfig = processConfig;

package/dist/shared/tracker/tracker-chart.d.ts

@@ -1,14 +0,0 @@
-import { AggregateResult } from './models/aggregate-result';
-import { ChartConfig } from './models/chart-config';
-import { ProcessResult } from './models/process-result';
-export declare class TrackerChart {
-    private _config;
-    private _allProcessResults;
-    private _dateFormat;
-    constructor(_config: ChartConfig, _allProcessResults: ProcessResult[], _dateFormat: string);
-    private getDataAndLabels;
-    private getTotalsPerFileTypePerCategory;
-    private getTotalsPerCategory;
-    private generateGraphImageFile;
-    writeTo(parentDirectory: string, graphablePropertyName?: keyof AggregateResult): Promise<void>;
-}

package/dist/shared/tracker/tracker-chart.js

@@ -1,158 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TrackerChart = void 0;
-const path_1 = require("path");
-const fs_1 = require("fs");
-const date_fns_1 = require("date-fns");
-const chartjs_node_canvas_1 = require("chartjs-node-canvas");
-const ChartDataLabels = require("chartjs-plugin-datalabels");
-const autocolors = require("chartjs-plugin-autocolors");
-class TrackerChart {
-    constructor(_config, _allProcessResults, _dateFormat) {
-        this._config = _config;
-        this._allProcessResults = _allProcessResults;
-        this._dateFormat = _dateFormat;
-    }
-    getDataAndLabels(allJsonData, propName) {
-        if (this._config.perCategoryTotals) {
-            return this.getTotalsPerCategory(allJsonData, propName);
-        }
-        if (this._config.perCategoryAndFileType) {
-            return this.getTotalsPerFileTypePerCategory(allJsonData, propName);
-        }
-        return this.getTotalsPerCategory(allJsonData, propName);
-    }
-    getTotalsPerFileTypePerCategory(allJsonData, propName) {
-        const runs = {};
-        const allTypes = {};
-        allJsonData.forEach((jsonData, i) => {
-            runs[jsonData.hash] = jsonData.timestamp;
-            jsonData.categories.forEach((category) => {
-                category.fileTypes.forEach((t) => {
-                    const label = `${category.name}: ${t.fileType}`;
-                    if (!allTypes[label]) {
-                        allTypes[label] = {
-                            label,
-                            data: []
-                        };
-                    }
-                    allTypes[label].data[i] = t[propName];
-                });
-            });
-        });
-        const labels = Object.values(runs);
-        const datasets = Object.values(allTypes).map((t) => {
-            return {
-                ...t,
-                fill: false,
-                tension: .1
-            };
-        });
-        return {
-            labels,
-            datasets,
-        };
-    }
-    getTotalsPerCategory(allJsonData, propName) {
-        const runs = {};
-        const allTypes = {};
-        allJsonData.forEach((jsonData, i) => {
-            runs[jsonData.hash] = jsonData.timestamp;
-            jsonData.categories.forEach((category) => {
-                const label = category.name;
-                if (!allTypes[label]) {
-                    allTypes[label] = {
-                        label,
-                        data: []
-                    };
-                }
-                allTypes[label].data[i] = category.totals[propName];
-            });
-        });
-        const labels = Object.values(runs);
-        const datasets = Object.values(allTypes).map((t) => {
-            return {
-                ...t,
-                fill: false,
-                tension: .1
-            };
-        });
-        return {
-            labels,
-            datasets,
-        };
-    }
-    async generateGraphImageFile(parentDirectory, vizData) {
-        const outFile = (0, path_1.join)(parentDirectory, this._config.outFile);
-        if (this._config.overwrite && (0, fs_1.existsSync)(outFile)) {
-            (0, fs_1.rmSync)(outFile);
-        }
-        const dateFmt = this._dateFormat;
-        const configuration = {
-            type: 'line',
-            data: vizData,
-            options: {
-                elements: {
-                    point: {
-                        radius: 0
-                    }
-                },
-                plugins: {
-                    title: {
-                        display: true,
-                        text: this._config.title
-                    },
-                    autocolors: {
-                        enabled: true,
-                        mode: 'data',
-                    },
-                    scales: {
-                        x: {
-                            type: 'timeseries',
-                            time: {
-                                minUnit: 'week',
-                            },
-                            parsing: false,
-                            title: {
-                                display: true,
-                                text: this._config.xAxisLabel
-                            },
-                            ticks: {
-                                source: 'data',
-                                callback: function (val) {
-                                    return (0, date_fns_1.format)((0, date_fns_1.parse)(this.getLabelForValue(val), dateFmt, new Date()), 'yyyy-MM-dd');
-                                }
-                            }
-                        },
-                        y: {
-                            title: {
-                                display: true,
-                                text: this._config.yAxisLabel
-                            }
-                        }
-                    }
-                }
-            },
-        };
-        try {
-            const pieChart = new chartjs_node_canvas_1.ChartJSNodeCanvas({
-                width: this._config.width,
-                height: this._config.height,
-                backgroundColour: this._config.bg,
-                plugins: {
-                    modern: [ChartDataLabels, autocolors],
-                }
-            });
-            const result = await pieChart.renderToBuffer(configuration);
-            (0, fs_1.writeFileSync)(outFile, result);
-        }
-        catch (exc) {
-            console.error(exc);
-        }
-    }
-    writeTo(parentDirectory, graphablePropertyName = 'total') {
-        const vizData = this.getDataAndLabels(this._allProcessResults, graphablePropertyName);
-        return this.generateGraphImageFile(parentDirectory, vizData);
-    }
-}
-exports.TrackerChart = TrackerChart;

package/dist/shared/tracker/util.d.ts

@@ -1,20 +0,0 @@
-import { Config } from './models/config';
-import { ProcessResult } from './models/process-result';
-import { AggregateResult } from './models/aggregate-result';
-import { ChartConfig } from './models/chart-config';
-/**
- *
- *
- *
- * exported alphabetized util functions ->
- *
- */
-export declare function createDataVizIn(chartConfig: ChartConfig, parentDirectory: string, allJsonData: ProcessResult[], graphablePropertyName?: keyof AggregateResult): Promise<void>;
-export declare function getData(localRootDir: string, outputDir: string): any;
-export declare function getGitCommit(): Promise<{
-    hash: string;
-    timestamp: string;
-}>;
-export declare function getTheRootDirectory(directory: string): string;
-export declare function readConfig(rootDirectory: string, optionsPath?: string): Config;
-export declare function saveResults(localRootDir: string, outputDir: string, results: ProcessResult): void;

package/dist/shared/tracker/util.js

@@ -1,92 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.saveResults = exports.readConfig = exports.getTheRootDirectory = exports.getGitCommit = exports.getData = exports.createDataVizIn = void 0;
-const path_1 = require("path");
-const fs_1 = require("fs");
-const date_fns_1 = require("date-fns");
-const git_last_commit_1 = require("git-last-commit");
-const tracker_chart_1 = require("./tracker-chart");
-const DATE_FORMAT = 'yyyy-MM-dd-HH-mm-ss-SSS';
-/**
- *
- *
- *
- * internal alphabetized helper functions ->
- *
- */
-function formatDate(date) {
-    return (0, date_fns_1.format)(date, DATE_FORMAT);
-}
-function getDataFilePath(localRootDir, outputDir) {
-    return (0, path_1.resolve)((0, path_1.join)(localRootDir, outputDir, 'data.json'));
-}
-function getGitDate(date) {
-    return new Date(+date * 1000);
-}
-function getLastCommitAsPromise() {
-    return new Promise((resolve, reject) => {
-        (0, git_last_commit_1.getLastCommit)((err, commit) => {
-            if (err) {
-                reject(err);
-            }
-            resolve(commit);
-        });
-    });
-}
-/**
- *
- *
- *
- * exported alphabetized util functions ->
- *
- */
-async function createDataVizIn(chartConfig, parentDirectory, allJsonData, graphablePropertyName = 'total') {
-    const chart = new tracker_chart_1.TrackerChart(chartConfig, allJsonData, DATE_FORMAT);
-    return chart.writeTo(parentDirectory, graphablePropertyName);
-}
-exports.createDataVizIn = createDataVizIn;
-function getData(localRootDir, outputDir) {
-    const outputPath = getDataFilePath(localRootDir, outputDir);
-    let contents = '';
-    if ((0, fs_1.existsSync)(outputPath)) {
-        contents = (0, fs_1.readFileSync)(outputPath).toString('utf-8');
-    }
-    return contents === '' ? [] : JSON.parse(contents);
-}
-exports.getData = getData;
-async function getGitCommit() {
-    const commit = await getLastCommitAsPromise();
-    return {
-        hash: commit.hash,
-        timestamp: formatDate(getGitDate(commit.committedOn)),
-    };
-}
-exports.getGitCommit = getGitCommit;
-function getTheRootDirectory(directory) {
-    if ((0, fs_1.existsSync)((0, path_1.join)(directory, 'package.json'))) {
-        return directory;
-    }
-    return getTheRootDirectory((0, path_1.resolve)((0, path_1.join)(directory, '..')));
-}
-exports.getTheRootDirectory = getTheRootDirectory;
-function readConfig(rootDirectory, optionsPath) {
-    const path = optionsPath && (0, fs_1.existsSync)((0, path_1.join)(rootDirectory, optionsPath))
-        ? (0, path_1.join)(rootDirectory, optionsPath)
-        : (0, path_1.join)(rootDirectory, 'hd-tracker', 'config.json');
-    const contents = (0, fs_1.readFileSync)(path).toString('utf-8');
-    return JSON.parse(contents);
-}
-exports.readConfig = readConfig;
-function saveResults(localRootDir, outputDir, results) {
-    console.log('Outputting file');
-    const output = getData(localRootDir, outputDir);
-    if (!Array.isArray(output)) {
-        console.error('Invalid output file format');
-    }
-    output.push(results);
-    const outputPath = getDataFilePath(localRootDir, outputDir);
-    const outputText = JSON.stringify(output, null, 2);
-    (0, fs_1.writeFileSync)(outputPath, outputText);
-    console.log(`Output written to: ${outputPath}`);
-}
-exports.saveResults = saveResults;