@herodevs/cli 0.1.16 → 0.2.0

package/dist/shared/tracker/util.js

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

package/oclif.manifest.json

@@ -1,8 +1,8 @@
 {
-  "version": "0.1.16",
+  "version": "0.2.0",
   "commands": {
-    "committer:get-all": {
-      "id": "committer:get-all",
+    "report:committers": {
+      "id": "report:committers",
       "summary": "Get Committers Between Two Dates",
       "strict": true,
       "usage": "<%= command.id %> [flags [-s][-e][-x]]",
@@ -41,7 +41,7 @@
           "summary": "Start Date (format: yyyy-MM-dd)",
           "required": false,
           "multiple": false,
-          "default": "2023-09-01"
+          "default": "2024-02-27"
         },
         "endDate": {
           "name": "endDate",
@@ -50,7 +50,7 @@
           "summary": "End Date (format: yyyy-MM-dd)",
           "required": false,
           "multiple": false,
-          "default": "2022-09-01"
+          "default": "2023-02-27"
         },
         "exclude": {
           "name": "exclude",
@@ -63,44 +63,54 @@
       },
       "args": {}
     },
-    "committer": {
-      "id": "committer",
-      "description": "Gets committer info",
+    "tracker:init": {
+      "id": "tracker:init",
+      "description": "Initialize the tracker configuration",
       "strict": true,
       "pluginName": "@herodevs/cli",
       "pluginAlias": "@herodevs/cli",
       "pluginType": "core",
       "aliases": [],
       "examples": [
-        "$ @herodevs/cli committer"
+        "<%= 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": {
-        "json": {
-          "name": "json",
-          "type": "boolean",
-          "description": "Format output as json.",
-          "helpGroup": "GLOBAL",
-          "allowNo": false
+        "root": {
+          "name": "root",
+          "type": "option",
+          "char": "r",
+          "description": "root dir of the project",
+          "multiple": false
         },
-        "log-level": {
-          "name": "log-level",
+        "config": {
+          "name": "config",
           "type": "option",
-          "summary": "Specify level for logging.",
-          "helpGroup": "GLOBAL",
-          "multiple": false,
-          "options": [
-            "debug",
-            "info",
-            "warn",
-            "error"
-          ]
+          "char": "c",
+          "description": "path to config file",
+          "multiple": false
+        },
+        "chart": {
+          "name": "chart",
+          "type": "option",
+          "description": "chart configuration",
+          "multiple": false
         }
       },
-      "args": {
-        "get-all": {
-          "name": "get-all"
-        }
-      }
+      "args": {}
     }
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@herodevs/cli",
-  "version": "0.1.16",
-  "description": "HeroDevs NES Developer Kit",
+  "version": "0.2.0",
+  "description": "HeroDevs CLI",
   "author": "@herodevs",
   "bin": {
     "@herodevs/cli": "./bin/run",
@@ -19,13 +19,20 @@
     "package.json"
   ],
   "dependencies": {
-    "@badisi/latest-version": "^6.1.10",
     "@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"
+    "shelljs": "^0.8.5",
+    "sloc": "^0.2.1"
   },
   "devDependencies": {
     "@oclif/test": "^2.4.4",
@@ -48,13 +55,15 @@
     "dirname": "@herodevs/cli",
     "commands": "./dist/commands",
     "plugins": [
-      "@oclif/plugin-help",
-      "@oclif/plugin-plugins"
+      "@oclif/plugin-help"
     ],
     "topicSeparator": " ",
     "topics": {
-      "committer": {
-        "description": "Committer actions"
+      "report": {
+        "description": "Run reports for the current project (commands: committers)"
+      },
+      "tracker": {
+        "description": "Track project progress based upon lines of code (commands: init, run)"
       }
     }
   },
@@ -68,7 +77,7 @@
     "build": "shx rm -rf dist && tsc -b && shx cp package.json dist/package.json",
     "lint": "eslint . --ext .ts --config .eslintrc",
     "postpack": "shx rm -f oclif.manifest.json",
-    "posttest": "npm run lint",
+    "posttestXXX": "npm run lint",
     "prepack": "npm run build && oclif manifest && oclif readme",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
     "version": "oclif readme && git add README.md",
@@ -106,5 +115,11 @@
   "keywords": [
     "oclif"
   ],
-  "types": "dist/index.d.ts"
+  "types": "dist/index.d.ts",
+  "prettier": {
+    "singleQuote": true,
+    "trailingComma": "es5",
+    "bracketSpacing": true,
+    "printWidth": 100
+  }
 }

package/dist/commands/committer/index.d.ts

@@ -1,9 +0,0 @@
-import { CommitterGetAll } from "./get-all";
-import { BaseCommand } from "../../shared";
-export default class Committer extends BaseCommand<typeof CommitterGetAll> {
-    static description: string;
-    static examples: string[];
-    static flags: {};
-    static args: any;
-    run(): Promise<void>;
-}

package/dist/commands/committer/index.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const get_all_1 = require("./get-all");
-const shared_1 = require("../../shared");
-class Committer extends shared_1.BaseCommand {
-    async run() {
-    }
-}
-exports.default = Committer;
-Committer.description = "Gets committer info";
-Committer.examples = [`$ @herodevs/cli committer`];
-Committer.flags = {};
-Committer.args = {
-    'get-all': get_all_1.CommitterGetAll.args
-};