@herodevs/cli 0.2.2 → 0.2.3-rc1

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.js

@@ -1,156 +0,0 @@
-// import { join } from 'path';
-// import { AggregateResult } from './models/aggregate-result';
-// import { ChartConfig } from './models/chart-config';
-// import { ProcessResult } from './models/process-result';
-// import { VizDataset } from './models/viz-dataset';
-// import { VizLabelsDatasets } from './models/viz-labels-datasets';
-// import { existsSync, rmSync, writeFileSync } from 'fs';
-// import { format, parse } from 'date-fns';
-// import { ChartJSNodeCanvas } from 'chartjs-node-canvas';
-// import * as ChartDataLabels from 'chartjs-plugin-datalabels';
-// import * as autocolors from 'chartjs-plugin-autocolors';
-// import { ChartConfiguration } from 'chart.js';
-// export class TrackerChart {
-//   constructor(private _config: ChartConfig, private _allProcessResults: ProcessResult[], private _dateFormat: string) { }
-//   private getDataAndLabels(allJsonData, propName: string): VizLabelsDatasets {
-//     if (this._config.perCategoryTotals) {
-//       return this.getTotalsPerCategory(allJsonData, propName);
-//     }
-//     if (this._config.perCategoryAndFileType) {
-//       return this.getTotalsPerFileTypePerCategory(allJsonData, propName);
-//     }
-//     return this.getTotalsPerCategory(allJsonData, propName);
-//   }
-//   private getTotalsPerFileTypePerCategory(allJsonData, propName: string): VizLabelsDatasets {
-//     const runs = { };
-//     const allTypes = { };
-//     allJsonData.forEach((jsonData: ProcessResult, 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) as string[];
-//     const datasets = Object.values(allTypes).map((t: VizDataset) => {
-//       return {
-//         ...t,
-//         fill: false,
-//         tension: .1
-//       }
-//     }) as VizDataset[];
-//     return {
-//       labels,
-//       datasets,
-//     };
-//   }
-//   private getTotalsPerCategory(allJsonData, propName: string): VizLabelsDatasets {
-//     const runs = { };
-//     const allTypes = { };
-//     allJsonData.forEach((jsonData: ProcessResult, 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) as string[];
-//     const datasets = Object.values(allTypes).map((t: VizDataset) => {
-//       return {
-//         ...t,
-//         fill: false,
-//         tension: .1
-//       }
-//     }) as VizDataset[];
-//     return {
-//       labels,
-//       datasets,
-//     };
-//   }
-//   private async generateGraphImageFile(parentDirectory: string, vizData: VizLabelsDatasets): Promise<void> {
-//     const outFile = join(parentDirectory, this._config.outFile);
-//     if (this._config.overwrite && existsSync(outFile)) { 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 format(
-//                     parse(this.getLabelForValue(val), dateFmt, new Date()),
-//                     'yyyy-MM-dd'
-//                   );
-//                 }
-//               }
-//             },
-//             y: {
-//               title: {
-//                 display: true,
-//                 text: this._config.yAxisLabel
-//               }
-//             }
-//           }
-//         }
-//       },
-//     };
-//     try {
-//       const pieChart = new ChartJSNodeCanvas({
-//         width: this._config.width,
-//         height: this._config.height,
-//         backgroundColour: this._config.bg,
-//         plugins: {
-//           modern: [ChartDataLabels, autocolors],
-//         }
-//       });
-//       const result = await pieChart.renderToBuffer(configuration as ChartConfiguration);
-//       writeFileSync(outFile, result);
-//     } catch (exc) {
-//       console.error(exc);
-//     }
-//   }
-//   writeTo(parentDirectory: string, graphablePropertyName: keyof AggregateResult = 'total'): Promise<void> {
-//     const vizData = this.getDataAndLabels(this._allProcessResults, graphablePropertyName);
-//     return this.generateGraphImageFile(parentDirectory, vizData);
-//   }
-// }

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

@@ -1,17 +0,0 @@
-import { Config } from './models/config';
-import { ProcessResult } from './models/process-result';
-/**
- *
- *
- *
- * exported alphabetized util functions ->
- *
- */
-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,98 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.saveResults = exports.readConfig = exports.getTheRootDirectory = exports.getGitCommit = exports.getData = 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");
-// import { AggregateResult } from './models/aggregate-result';
-// import { TrackerChart } from './tracker-chart';
-// import { ChartConfig } from './models/chart-config';
-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 ->
- *
- */
-// export async function createDataVizIn(
-//   chartConfig: ChartConfig,
-//   parentDirectory: string,
-//   allJsonData: ProcessResult[],
-//   graphablePropertyName: keyof AggregateResult = 'total'
-// ): Promise<void> {
-//   const chart = new TrackerChart(chartConfig, allJsonData, DATE_FORMAT);
-//   return chart.writeTo(parentDirectory, graphablePropertyName);
-// }
-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;

package/dist/shared/types/flags.type.d.ts

@@ -1,4 +0,0 @@
-import { Command, Interfaces } from "@oclif/core";
-import { BaseCommand } from "../command";
-export type Flags<T extends typeof Command> = Interfaces.InferredFlags<typeof BaseCommand['baseFlags'] & T['flags']>;
-export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;

package/dist/shared/types/flags.type.js

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

package/dist/shared/types/index.d.ts

@@ -1 +0,0 @@
-export * from './flags.type';

package/dist/shared/types/index.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./flags.type"), exports);

package/oclif.manifest.json

@@ -1,118 +0,0 @@
-{
-  "version": "0.2.2",
-  "commands": {
-    "report:committers": {
-      "id": "report:committers",
-      "summary": "Get Committers Between Two Dates",
-      "strict": true,
-      "usage": "<%= command.id %> [flags [-s][-e][-x]]",
-      "pluginName": "@herodevs/cli",
-      "pluginAlias": "@herodevs/cli",
-      "pluginType": "core",
-      "aliases": [],
-      "examples": [
-        "<%= config.bin %> <%= command.id %>"
-      ],
-      "flags": {
-        "json": {
-          "name": "json",
-          "type": "boolean",
-          "description": "Format output as json.",
-          "helpGroup": "GLOBAL",
-          "allowNo": false
-        },
-        "log-level": {
-          "name": "log-level",
-          "type": "option",
-          "summary": "Specify level for logging.",
-          "helpGroup": "GLOBAL",
-          "multiple": false,
-          "options": [
-            "debug",
-            "info",
-            "warn",
-            "error"
-          ]
-        },
-        "startDate": {
-          "name": "startDate",
-          "type": "option",
-          "char": "s",
-          "summary": "Start Date (format: yyyy-MM-dd)",
-          "required": false,
-          "multiple": false,
-          "default": "2024-03-06"
-        },
-        "endDate": {
-          "name": "endDate",
-          "type": "option",
-          "char": "e",
-          "summary": "End Date (format: yyyy-MM-dd)",
-          "required": false,
-          "multiple": false,
-          "default": "2023-03-06"
-        },
-        "exclude": {
-          "name": "exclude",
-          "type": "option",
-          "char": "x",
-          "summary": "Path Exclusions (eg -x=\"./src/bin\" -x=\"./dist\")",
-          "required": false,
-          "multiple": true
-        },
-        "monthly": {
-          "name": "monthly",
-          "type": "boolean",
-          "char": "m",
-          "summary": "Break down by calendar month, rather than by committer.  (eg -m)",
-          "required": false,
-          "allowNo": false
-        }
-      },
-      "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
-        }
-      },
-      "args": {}
-    }
-  }
-}