@herodevs/cli 0.1.16 → 0.2.0

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

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

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

@@ -0,0 +1,19 @@
+"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

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

package/dist/shared/tracker/initialize.js

@@ -0,0 +1,15 @@
+"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

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

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

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

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

@@ -0,0 +1,7 @@
+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

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

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

@@ -0,0 +1,9 @@
+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

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

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

@@ -0,0 +1,24 @@
+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

@@ -0,0 +1,81 @@
+"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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,11 @@
+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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,155 @@
+"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

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,16 @@
+"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

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,158 @@
+"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

@@ -0,0 +1,20 @@
+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;