@appland/appmap 3.99.3 → 3.100.0

package/built/cmds/inventory-report/MarkdownReport.js

@@ -0,0 +1,124 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportTemplate = exports.WelcomeReport = exports.DefaultReport = void 0;
+const handlebars_1 = __importDefault(require("handlebars"));
+const path_1 = require("path");
+const promises_1 = require("fs/promises");
+const assert_1 = __importDefault(require("assert"));
+const fs_1 = require("fs");
+const TemplateDirectory = [
+    '../../../resources/inventory-report',
+    '../../../../resources/inventory-report', // In development
+]
+    .map((dirName) => (0, path_1.join)(__dirname, dirName))
+    .find((dirName) => (0, fs_1.existsSync)(dirName));
+(0, assert_1.default)(TemplateDirectory, "Report template directory 'inventory-report' not found");
+var TemplateName;
+(function (TemplateName) {
+    TemplateName["Default"] = "default";
+    TemplateName["Welcome"] = "welcome";
+})(TemplateName || (TemplateName = {}));
+async function generateReport(templateName, report) {
+    let reportTemplate;
+    switch (templateName) {
+        case TemplateName.Default:
+            reportTemplate = new DefaultReport();
+            break;
+        case TemplateName.Welcome:
+            reportTemplate = new WelcomeReport();
+            break;
+    }
+    return reportTemplate.generateReport(report);
+}
+exports.default = generateReport;
+class DefaultReport {
+    async generateReport(reportData) {
+        (0, assert_1.default)(TemplateDirectory);
+        const templateFile = (0, path_1.join)(TemplateDirectory, 'default', 'inventory.hbs');
+        const template = await ReportTemplate.build(templateFile);
+        return template.generateMarkdown(reportData);
+    }
+}
+exports.DefaultReport = DefaultReport;
+class WelcomeReport {
+    async generateReport(reportData) {
+        (0, assert_1.default)(TemplateDirectory);
+        const templateFile = (0, path_1.join)(TemplateDirectory, 'welcome', 'welcome.hbs');
+        const template = await ReportTemplate.build(templateFile);
+        return template.generateMarkdown(reportData);
+    }
+}
+exports.WelcomeReport = WelcomeReport;
+class ReportTemplate {
+    constructor(template) {
+        this.template = template;
+    }
+    generateMarkdown(report) {
+        return this.template(report, {
+            helpers: ReportTemplate.helpers(),
+            allowProtoPropertiesByDefault: true,
+        });
+    }
+    static helpers() {
+        const inspect = (value) => {
+            return new handlebars_1.default.SafeString(JSON.stringify(value, null, 2));
+        };
+        const length = (...list) => {
+            const _fn = list.pop();
+            let result = 0;
+            for (const item of list) {
+                if (Array.isArray(item)) {
+                    result += item.length;
+                }
+                else if (item.constructor === Map) {
+                    result += item.size;
+                }
+                else if (typeof item === 'object') {
+                    result += Object.keys(item).length;
+                }
+            }
+            return result;
+        };
+        const coalesce = (...list) => {
+            const _fn = list.pop();
+            return list.find((item) => item !== undefined && item !== '');
+        };
+        const select_values_by_key_range = (data, keyMin, keyMax) => {
+            if (typeof keyMax === 'object')
+                keyMax = undefined;
+            const result = Object.keys(data)
+                .map((k) => parseInt(k, 10))
+                .filter((k) => k >= keyMin && (keyMax === undefined || k < keyMax))
+                .map((k) => data[k]);
+            return result;
+        };
+        const extractArrayValue = (args) => (Array.isArray(args[0]) ? args[0] : args);
+        const sum_values_by_key_range = (data, keyMin, keyMax) => {
+            const values = select_values_by_key_range(data, keyMin, keyMax);
+            return values.reduce((a, b) => a + (b || 0), 0);
+        };
+        const sum = () => {
+            const args = [...arguments];
+            const _fn = args.pop();
+            const values = extractArrayValue(args);
+            return values.reduce((a, b) => a + (b || 0), 0);
+        };
+        return {
+            coalesce,
+            inspect,
+            length,
+            select_values_by_key_range,
+            sum,
+            sum_values_by_key_range,
+        };
+    }
+    static async build(templateFile) {
+        const template = handlebars_1.default.compile(await (0, promises_1.readFile)(templateFile, 'utf8'));
+        return new ReportTemplate(template);
+    }
+}
+exports.ReportTemplate = ReportTemplate;
+//# sourceMappingURL=MarkdownReport.js.map

package/built/cmds/inventory-report/MarkdownReport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MarkdownReport.js","sourceRoot":"","sources":["../../../src/cmds/inventory-report/MarkdownReport.ts"],"names":[],"mappings":";;;;;;AAAA,4DAAoC;AAEpC,+BAA4B;AAC5B,0CAAuC;AACvC,oDAA4B;AAC5B,2BAAgC;AAEhC,MAAM,iBAAiB,GAAG;IACxB,qCAAqC;IACrC,wCAAwC,EAAE,iBAAiB;CAC5D;KACE,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAA,WAAI,EAAC,SAAS,EAAE,OAAO,CAAC,CAAC;KAC1C,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAA,eAAU,EAAC,OAAO,CAAC,CAAC,CAAC;AAC1C,IAAA,gBAAM,EAAC,iBAAiB,EAAE,wDAAwD,CAAC,CAAC;AAEpF,IAAK,YAGJ;AAHD,WAAK,YAAY;IACf,mCAAmB,CAAA;IACnB,mCAAmB,CAAA;AACrB,CAAC,EAHI,YAAY,KAAZ,YAAY,QAGhB;AAEc,KAAK,UAAU,cAAc,CAC1C,YAA0B,EAC1B,MAAc;IAEd,IAAI,cAA8B,CAAC;IACnC,QAAQ,YAAY,EAAE;QACpB,KAAK,YAAY,CAAC,OAAO;YACvB,cAAc,GAAG,IAAI,aAAa,EAAE,CAAC;YACrC,MAAM;QACR,KAAK,YAAY,CAAC,OAAO;YACvB,cAAc,GAAG,IAAI,aAAa,EAAE,CAAC;YACrC,MAAM;KACT;IACD,OAAO,cAAc,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;AAC/C,CAAC;AAdD,iCAcC;AAMD,MAAa,aAAa;IACxB,KAAK,CAAC,cAAc,CAAC,UAAkB;QACrC,IAAA,gBAAM,EAAC,iBAAiB,CAAC,CAAC;QAC1B,MAAM,YAAY,GAAG,IAAA,WAAI,EAAC,iBAAiB,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;QACzE,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC1D,OAAO,QAAQ,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IAC/C,CAAC;CACF;AAPD,sCAOC;AAED,MAAa,aAAa;IACxB,KAAK,CAAC,cAAc,CAAC,UAAkB;QACrC,IAAA,gBAAM,EAAC,iBAAiB,CAAC,CAAC;QAC1B,MAAM,YAAY,GAAG,IAAA,WAAI,EAAC,iBAAiB,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QACvE,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC1D,OAAO,QAAQ,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IAC/C,CAAC;CACF;AAPD,sCAOC;AAED,MAAa,cAAc;IACzB,YAAmB,QAAoC;QAApC,aAAQ,GAAR,QAAQ,CAA4B;IAAG,CAAC;IAE3D,gBAAgB,CAAC,MAAc;QAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YAC3B,OAAO,EAAE,cAAc,CAAC,OAAO,EAAE;YACjC,6BAA6B,EAAE,IAAI;SACpC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,OAAO;QACZ,MAAM,OAAO,GAAG,CAAC,KAAU,EAAE,EAAE;YAC7B,OAAO,IAAI,oBAAU,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACnE,CAAC,CAAC;QAEF,MAAM,MAAM,GAAG,CAAC,GAAG,IAAW,EAAU,EAAE;YACxC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACvB,IAAI,MAAM,GAAG,CAAC,CAAC;YACf,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE;gBACvB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;oBACvB,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC;iBACvB;qBAAM,IAAI,IAAI,CAAC,WAAW,KAAK,GAAG,EAAE;oBACnC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC;iBACrB;qBAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;oBACnC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;iBACpC;aACF;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QAEF,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAW,EAAU,EAAE;YAC1C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC;QAChE,CAAC,CAAC;QAEF,MAAM,0BAA0B,GAAG,CACjC,IAA4B,EAC5B,MAAc,EACd,MAAe,EACL,EAAE;YACZ,IAAI,OAAO,MAAM,KAAK,QAAQ;gBAAE,MAAM,GAAG,SAAS,CAAC;YACnD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;iBAC7B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;iBAC3B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,MAAM,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;iBAClE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YACvB,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QACF,MAAM,iBAAiB,GAAG,CAAC,IAAW,EAAS,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAE5F,MAAM,uBAAuB,GAAG,CAC9B,IAA4B,EAC5B,MAAc,EACd,MAAe,EACP,EAAE;YACV,MAAM,MAAM,GAAG,0BAA0B,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;YAChE,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAClD,CAAC,CAAC;QAEF,MAAM,GAAG,GAAG,GAAG,EAAE;YACf,MAAM,IAAI,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC;YAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACvB,MAAM,MAAM,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;YACvC,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAClD,CAAC,CAAC;QAEF,OAAO;YACL,QAAQ;YACR,OAAO;YACP,MAAM;YACN,0BAA0B;YAC1B,GAAG;YACH,uBAAuB;SACxB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,YAAoB;QACrC,MAAM,QAAQ,GAAG,oBAAU,CAAC,OAAO,CAAC,MAAM,IAAA,mBAAQ,EAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;QAC1E,OAAO,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;CACF;AA/ED,wCA+EC"}

package/built/cmds/inventory-report/inventoryReport.js

@@ -0,0 +1,58 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = exports.builder = exports.describe = exports.command = void 0;
+const utils_1 = require("../../utils");
+const handleWorkingDirectory_1 = require("../../lib/handleWorkingDirectory");
+const promises_1 = require("fs/promises");
+const MarkdownReport_1 = __importDefault(require("./MarkdownReport"));
+const console_1 = require("console");
+const process_1 = require("process");
+const path_1 = require("path");
+exports.command = 'inventory-report <report-json-file> [output-file]';
+exports.describe = 'Generate a report document describing the current state of a repository.';
+const builder = (args) => {
+    args.positional('report-json-file', {
+        type: 'string',
+        describe: `JSON report file to read. This file is generated by the 'inventory' command.`,
+        demandOption: true,
+    });
+    args.positional('template-name', {
+        type: 'string',
+        describe: `Template name.`,
+        default: 'default',
+        choices: ['default', 'welcome'],
+        alias: 't',
+    });
+    args.positional('output-file', {
+        type: 'string',
+        describe: `Markdown output file. If not specified, the report is written to stdout.`,
+        demandOption: true,
+    });
+    args.option('directory', {
+        describe: 'program working directory',
+        type: 'string',
+        alias: 'd',
+    });
+    return args.strict();
+};
+exports.builder = builder;
+const handler = async (argv) => {
+    (0, utils_1.verbose)(argv.verbose);
+    const { directory } = argv;
+    (0, handleWorkingDirectory_1.handleWorkingDirectory)(directory);
+    const { reportJsonFile, outputFile, templateName } = argv;
+    const report = JSON.parse(await (0, promises_1.readFile)(reportJsonFile, 'utf-8'));
+    const reportMD = await (0, MarkdownReport_1.default)(templateName, report);
+    if (outputFile) {
+        await (0, promises_1.writeFile)(outputFile, reportMD);
+        (0, console_1.warn)(`Report written to ${(0, path_1.join)((0, process_1.cwd)(), outputFile)}`);
+    }
+    else {
+        console.log(reportMD);
+    }
+};
+exports.handler = handler;
+//# sourceMappingURL=inventoryReport.js.map

package/built/cmds/inventory-report/inventoryReport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inventoryReport.js","sourceRoot":"","sources":["../../../src/cmds/inventory-report/inventoryReport.ts"],"names":[],"mappings":";;;;;;AACA,uCAAsC;AACtC,6EAA0E;AAC1E,0CAAkD;AAClD,sEAA8C;AAC9C,qCAA+B;AAC/B,qCAA8B;AAC9B,+BAA4B;AAEf,QAAA,OAAO,GAAG,mDAAmD,CAAC;AAC9D,QAAA,QAAQ,GAAG,0EAA0E,CAAC;AAE5F,MAAM,OAAO,GAAG,CAAC,IAAgB,EAAE,EAAE;IAC1C,IAAI,CAAC,UAAU,CAAC,kBAAkB,EAAE;QAClC,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,8EAA8E;QACxF,YAAY,EAAE,IAAI;KACnB,CAAC,CAAC;IAEH,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE;QAC/B,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,gBAAgB;QAC1B,OAAO,EAAE,SAAS;QAClB,OAAO,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;QAC/B,KAAK,EAAE,GAAG;KACX,CAAC,CAAC;IAEH,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE;QAC7B,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,0EAA0E;QACpF,YAAY,EAAE,IAAI;KACnB,CAAC,CAAC;IAEH,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;QACvB,QAAQ,EAAE,2BAA2B;QACrC,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,GAAG;KACX,CAAC,CAAC;IAEH,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;AACvB,CAAC,CAAC;AA5BW,QAAA,OAAO,WA4BlB;AAEK,MAAM,OAAO,GAAG,KAAK,EAAE,IAAS,EAAE,EAAE;IACzC,IAAA,eAAO,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACtB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;IAC3B,IAAA,+CAAsB,EAAC,SAAS,CAAC,CAAC;IAElC,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;IAE1D,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,IAAA,mBAAQ,EAAC,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC;IAEnE,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAc,EAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAC5D,IAAI,UAAU,EAAE;QACd,MAAM,IAAA,oBAAS,EAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACtC,IAAA,cAAI,EAAC,qBAAqB,IAAA,WAAI,EAAC,IAAA,aAAG,GAAE,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC;KACtD;SAAM;QACL,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;KACvB;AACH,CAAC,CAAC;AAhBW,QAAA,OAAO,WAgBlB"}