github-action-readme-generator 1.6.0 → 1.7.0

package/dist/mjs/inputs.js

@@ -0,0 +1,252 @@
+/* eslint-disable import/no-extraneous-dependencies */
+/* eslint-disable sonarjs/no-duplicate-string */
+/* eslint-disable @typescript-eslint/explicit-member-accessibility */
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import YAML from 'yaml';
+import Action from './Action.js';
+import { repositoryFinder } from './helpers.js';
+import LogTask from './logtask/index.js';
+import { Provider } from './nconf/nconf.cjs';
+import ReadmeEditor from './readme-editor.js';
+import { workingDirectory } from './working-directory.js';
+const log = new LogTask('inputs');
+process.chdir(workingDirectory());
+const githubEventPath = process.env.GITHUB_EVENT_PATH ?? '';
+let githubEvent = null;
+try {
+    githubEvent = JSON.parse(fs.readFileSync(githubEventPath, 'utf8'));
+}
+catch {
+    // File not there
+    log.debug(`GITHUB_EVENT_PATH not found: ${githubEventPath}`);
+}
+export const configFileName = '.ghadocs.json';
+const pathsAction = 'paths:action';
+const pathsReadme = 'paths:readme';
+export const configKeys = [
+    'save',
+    pathsAction,
+    pathsReadme,
+    'branding_svg_path',
+    'versioning:enabled',
+    'versioning:override',
+    'versioning:prefix',
+    'versioning:branch',
+    'owner',
+    'repo',
+    'title_prefix',
+    'pretty',
+    'include_github_version_badge',
+];
+export default class Inputs {
+    config;
+    sections;
+    readmePath;
+    configPath;
+    action;
+    readmeEditor;
+    constructor() {
+        this.configPath = path.resolve(configFileName);
+        this.config = new Provider();
+        const repositoryDetail = repositoryFinder(null, githubEvent);
+        if (process.env.GITHUB_ACTION) {
+            log.info('running in GitHub action');
+        }
+        if (fs.existsSync(this.configPath)) {
+            log.info(`config file found: ${this.configPath}`);
+        }
+        else {
+            log.error(`config file not found: ${this.configPath}`);
+        }
+        this.config
+            .env({
+            lowerCase: true,
+            parseValues: true,
+            match: /^INPUT_/,
+            transform: (obj) => {
+                if (obj.key.startsWith('input_')) {
+                    const newObj = {
+                        key: obj.key,
+                        value: obj.value,
+                    };
+                    const keyParsed = obj.key.replace(/^(INPUT|input)_/, '');
+                    switch (keyParsed) {
+                        case 'readme': {
+                            newObj.key = pathsReadme;
+                            break;
+                        }
+                        case 'action': {
+                            newObj.key = pathsAction;
+                            break;
+                        }
+                        case 'versioning_enabled': {
+                            newObj.key = 'versioning:enabled';
+                            break;
+                        }
+                        case 'version_prefix': {
+                            newObj.key = 'versioning:prefix';
+                            break;
+                        }
+                        case 'versioning_default_branch': {
+                            newObj.key = 'versioning:branch';
+                            break;
+                        }
+                        case 'version_override': {
+                            newObj.key = 'versioning:override';
+                            break;
+                        }
+                        case 'include_github_version_badge': {
+                            newObj.key = 'versioning:badge';
+                            break;
+                        }
+                        default: {
+                            newObj.key = keyParsed;
+                            break;
+                        }
+                    }
+                    if (newObj.value) {
+                        this.config.set(newObj.key, newObj.value);
+                    }
+                    return newObj;
+                }
+                return undefined;
+            },
+        })
+            .argv({
+            'save': {
+                alias: 'save',
+                describe: `Save this config to ${configFileName}`,
+                parseValues: true,
+                type: 'boolean',
+            },
+            'paths:action': {
+                alias: ['pathsAction', 'action'],
+                type: 'string',
+                describe: 'Path to the action.yml',
+            },
+            'paths:readme': {
+                alias: ['pathsReadme', 'readme'],
+                type: 'string',
+                describe: 'Path to the README file',
+            },
+            'branding_svg_path': {
+                alias: 'svg',
+                type: 'string',
+                describe: 'Save and load the branding svg image in the README from this path',
+            },
+            'owner': {
+                alias: 'owner',
+                describe: 'The GitHub Action repository owner. i.e: `bitflight-devops`',
+            },
+            'repo': {
+                alias: 'repo',
+                describe: 'The GitHub Action repository name. i.e: `github-action-readme-generator`',
+            },
+            'prettier': {
+                alias: 'pretty',
+                describe: 'Format the markdown using prettier formatter',
+                parseValues: true,
+                type: 'boolean',
+            },
+            'versioning:enabled': {
+                alias: ['versioning', 'versioning_enabled'],
+                describe: 'Enable the update of the usage version to match the latest version in the package.json file',
+                parseValues: true,
+                type: 'boolean',
+            },
+            'versioning:override': {
+                alias: ['setversion', 'versioning_override', 'version_override'],
+                describe: 'Set a specific version to display in the README.md',
+                parseValues: true,
+            },
+            'versioning:prefix': {
+                alias: ['vp', 'version_prefix'],
+                describe: "Prefix the version with this value (if it isn't already prefixed)",
+                parseValues: true,
+            },
+            'versioning:branch': {
+                alias: ['branch', 'versioning_default_branch'],
+                describe: 'If versioning is disabled show this branch instead',
+                parseValues: true,
+            },
+            'versioning:badge': {
+                alias: ['version-badge', 'versioning_badge'],
+                describe: 'Display the current version as a badge',
+                parseValues: true,
+                type: 'boolean',
+            },
+            'title_prefix': {
+                alias: ['prefix', 'title_prefix'],
+                describe: 'Add a prefix to the README title',
+                parseValues: true,
+            },
+        })
+            .file(this.configPath)
+            .defaults({
+            owner: repositoryDetail?.owner,
+            repo: repositoryDetail?.repo,
+            sections: [
+                'title',
+                'branding',
+                'description',
+                'usage',
+                'inputs',
+                'outputs',
+                'contents',
+                'badges',
+            ],
+        })
+            .required(['owner', 'repo']);
+        this.sections = this.config.get('sections');
+        const actionPath = path.resolve(this.config.get(pathsAction));
+        this.action = new Action(actionPath);
+        this.readmePath = path.resolve(this.config.get(pathsReadme));
+        try {
+            const thisActionPath = path.join(__dirname, '../../action.yml');
+            const thisAction = new Action(thisActionPath);
+            this.setConfigValueFromActionFileDefault(thisAction, 'readme', pathsReadme);
+            this.setConfigValueFromActionFileDefault(thisAction, 'title_prefix');
+            this.setConfigValueFromActionFileDefault(thisAction, 'save');
+            this.setConfigValueFromActionFileDefault(thisAction, 'pretty');
+            this.setConfigValueFromActionFileDefault(thisAction, 'versioning_enabled', 'versioning:enabled');
+            this.setConfigValueFromActionFileDefault(thisAction, 'versioning_default_branch', 'versioning:branch');
+            this.setConfigValueFromActionFileDefault(thisAction, 'version_override', 'versioning:override');
+            this.setConfigValueFromActionFileDefault(thisAction, 'version_prefix', 'versioning:prefix');
+            this.setConfigValueFromActionFileDefault(thisAction, 'include_github_version_badge', 'versioning:badges');
+            this.setConfigValueFromActionFileDefault(thisAction, 'branding_svg_path');
+        }
+        catch (error) {
+            log.info(`failed to load defaults from action's action.yml: ${error}`);
+        }
+        this.readmeEditor = new ReadmeEditor(this.readmePath);
+        if (LogTask.isDebug()) {
+            try {
+                log.debug('resolved inputs:');
+                log.debug(this.stringify());
+                log.debug('resolved action:');
+                log.debug(this.action.stringify());
+            }
+            catch (error) {
+                if (typeof error === 'string') {
+                    log.debug(error);
+                }
+            }
+        }
+    }
+    setConfigValueFromActionFileDefault(actionInstance, inputName, providedConfigName) {
+        const configName = providedConfigName ?? inputName;
+        this.config.set(configName, this.config.get(configName) ?? actionInstance.inputDefault(inputName));
+    }
+    stringify() {
+        if (this) {
+            const output = [];
+            for (const k of configKeys) {
+                output.push(`${k}: ${this.config.get(k)}`);
+            }
+            return YAML.stringify(output);
+        }
+        return '';
+    }
+}
+//# sourceMappingURL=inputs.js.map

package/dist/mjs/inputs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inputs.js","sourceRoot":"","sources":["../../src/inputs.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,gDAAgD;AAChD,qEAAqE;AAErE,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAGlC,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,OAAO,MAAM,oBAAoB,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;AAElC,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC,CAAC;AAClC,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAC;AAC5D,IAAI,WAAW,GAAmB,IAAI,CAAC;AACvC,IAAI;IACF,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,CAAC,CAAY,CAAC;CAC/E;AAAC,MAAM;IACN,iBAAiB;IACjB,GAAG,CAAC,KAAK,CAAC,gCAAgC,eAAe,EAAE,CAAC,CAAC;CAC9D;AACD,MAAM,CAAC,MAAM,cAAc,GAAG,eAAe,CAAC;AAC9C,MAAM,WAAW,GAAG,cAAc,CAAC;AACnC,MAAM,WAAW,GAAG,cAAc,CAAC;AACnC,MAAM,CAAC,MAAM,UAAU,GAAa;IAClC,MAAM;IACN,WAAW;IACX,WAAW;IACX,mBAAmB;IACnB,oBAAoB;IACpB,qBAAqB;IACrB,mBAAmB;IACnB,mBAAmB;IACnB,OAAO;IACP,MAAM;IACN,cAAc;IACd,QAAQ;IACR,8BAA8B;CAC/B,CAAC;AAMF,MAAM,CAAC,OAAO,OAAO,MAAM;IAClB,MAAM,CAAmB;IAEzB,QAAQ,CAAW;IAEnB,UAAU,CAAS;IAEnB,UAAU,CAAS;IAEnB,MAAM,CAAS;IAEf,YAAY,CAAe;IAElC;QACE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC7B,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC7D,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE;YAC7B,GAAG,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;SACtC;QACD,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YAClC,GAAG,CAAC,IAAI,CAAC,sBAAsB,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;SACnD;aAAM;YACL,GAAG,CAAC,KAAK,CAAC,0BAA0B,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;SACxD;QACD,IAAI,CAAC,MAAM;aACR,GAAG,CAAC;YACH,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI;YACjB,KAAK,EAAE,SAAS;YAChB,SAAS,EAAE,CAAC,GAAe,EAA0B,EAAE;gBACrD,IAAI,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;oBAChC,MAAM,MAAM,GAAe;wBACzB,GAAG,EAAE,GAAG,CAAC,GAAG;wBACZ,KAAK,EAAE,GAAG,CAAC,KAAK;qBACjB,CAAC;oBACF,MAAM,SAAS,GAAG,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;oBACzD,QAAQ,SAAS,EAAE;wBACjB,KAAK,QAAQ,CAAC,CAAC;4BACb,MAAM,CAAC,GAAG,GAAG,WAAW,CAAC;4BACzB,MAAM;yBACP;wBACD,KAAK,QAAQ,CAAC,CAAC;4BACb,MAAM,CAAC,GAAG,GAAG,WAAW,CAAC;4BACzB,MAAM;yBACP;wBACD,KAAK,oBAAoB,CAAC,CAAC;4BACzB,MAAM,CAAC,GAAG,GAAG,oBAAoB,CAAC;4BAClC,MAAM;yBACP;wBACD,KAAK,gBAAgB,CAAC,CAAC;4BACrB,MAAM,CAAC,GAAG,GAAG,mBAAmB,CAAC;4BACjC,MAAM;yBACP;wBACD,KAAK,2BAA2B,CAAC,CAAC;4BAChC,MAAM,CAAC,GAAG,GAAG,mBAAmB,CAAC;4BACjC,MAAM;yBACP;wBACD,KAAK,kBAAkB,CAAC,CAAC;4BACvB,MAAM,CAAC,GAAG,GAAG,qBAAqB,CAAC;4BACnC,MAAM;yBACP;wBACD,KAAK,8BAA8B,CAAC,CAAC;4BACnC,MAAM,CAAC,GAAG,GAAG,kBAAkB,CAAC;4BAChC,MAAM;yBACP;wBACD,OAAO,CAAC,CAAC;4BACP,MAAM,CAAC,GAAG,GAAG,SAAS,CAAC;4BACvB,MAAM;yBACP;qBACF;oBACD,IAAI,MAAM,CAAC,KAAK,EAAE;wBAChB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;qBAC3C;oBACD,OAAO,MAAM,CAAC;iBACf;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC;SACF,CAAC;aACD,IAAI,CAAC;YACJ,MAAM,EAAE;gBACN,KAAK,EAAE,MAAM;gBACb,QAAQ,EAAE,uBAAuB,cAAc,EAAE;gBACjD,WAAW,EAAE,IAAI;gBACjB,IAAI,EAAE,SAAS;aAChB;YACD,cAAc,EAAE;gBACd,KAAK,EAAE,CAAC,aAAa,EAAE,QAAQ,CAAC;gBAChC,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,wBAAwB;aACnC;YACD,cAAc,EAAE;gBACd,KAAK,EAAE,CAAC,aAAa,EAAE,QAAQ,CAAC;gBAChC,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,yBAAyB;aACpC;YACD,mBAAmB,EAAE;gBACnB,KAAK,EAAE,KAAK;gBACZ,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,mEAAmE;aAC9E;YACD,OAAO,EAAE;gBACP,KAAK,EAAE,OAAO;gBACd,QAAQ,EAAE,6DAA6D;aACxE;YACD,MAAM,EAAE;gBACN,KAAK,EAAE,MAAM;gBACb,QAAQ,EAAE,0EAA0E;aACrF;YACD,UAAU,EAAE;gBACV,KAAK,EAAE,QAAQ;gBACf,QAAQ,EAAE,8CAA8C;gBACxD,WAAW,EAAE,IAAI;gBACjB,IAAI,EAAE,SAAS;aAChB;YACD,oBAAoB,EAAE;gBACpB,KAAK,EAAE,CAAC,YAAY,EAAE,oBAAoB,CAAC;gBAC3C,QAAQ,EACN,6FAA6F;gBAC/F,WAAW,EAAE,IAAI;gBACjB,IAAI,EAAE,SAAS;aAChB;YACD,qBAAqB,EAAE;gBACrB,KAAK,EAAE,CAAC,YAAY,EAAE,qBAAqB,EAAE,kBAAkB,CAAC;gBAChE,QAAQ,EAAE,oDAAoD;gBAC9D,WAAW,EAAE,IAAI;aAClB;YACD,mBAAmB,EAAE;gBACnB,KAAK,EAAE,CAAC,IAAI,EAAE,gBAAgB,CAAC;gBAC/B,QAAQ,EAAE,mEAAmE;gBAC7E,WAAW,EAAE,IAAI;aAClB;YACD,mBAAmB,EAAE;gBACnB,KAAK,EAAE,CAAC,QAAQ,EAAE,2BAA2B,CAAC;gBAC9C,QAAQ,EAAE,oDAAoD;gBAC9D,WAAW,EAAE,IAAI;aAClB;YACD,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,eAAe,EAAE,kBAAkB,CAAC;gBAC5C,QAAQ,EAAE,wCAAwC;gBAClD,WAAW,EAAE,IAAI;gBACjB,IAAI,EAAE,SAAS;aAChB;YACD,cAAc,EAAE;gBACd,KAAK,EAAE,CAAC,QAAQ,EAAE,cAAc,CAAC;gBACjC,QAAQ,EAAE,kCAAkC;gBAC5C,WAAW,EAAE,IAAI;aAClB;SACF,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;aACrB,QAAQ,CAAC;YACR,KAAK,EAAE,gBAAgB,EAAE,KAAK;YAC9B,IAAI,EAAE,gBAAgB,EAAE,IAAI;YAC5B,QAAQ,EAAE;gBACR,OAAO;gBACP,UAAU;gBACV,aAAa;gBACb,OAAO;gBACP,QAAQ;gBACR,SAAS;gBACT,UAAU;gBACV,QAAQ;aACT;SACF,CAAC;aACD,QAAQ,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;QAE/B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAa,CAAC;QAExD,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAW,CAAC,CAAC;QACxE,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,UAAU,CAAC,CAAC;QACrC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,CAAW,CAAC,CAAC;QACvE,IAAI;YACF,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;YAChE,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,cAAc,CAAC,CAAC;YAC9C,IAAI,CAAC,mCAAmC,CAAC,UAAU,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;YAC5E,IAAI,CAAC,mCAAmC,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;YACrE,IAAI,CAAC,mCAAmC,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAC7D,IAAI,CAAC,mCAAmC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAC/D,IAAI,CAAC,mCAAmC,CACtC,UAAU,EACV,oBAAoB,EACpB,oBAAoB,CACrB,CAAC;YACF,IAAI,CAAC,mCAAmC,CACtC,UAAU,EACV,2BAA2B,EAC3B,mBAAmB,CACpB,CAAC;YACF,IAAI,CAAC,mCAAmC,CACtC,UAAU,EACV,kBAAkB,EAClB,qBAAqB,CACtB,CAAC;YACF,IAAI,CAAC,mCAAmC,CAAC,UAAU,EAAE,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;YAC5F,IAAI,CAAC,mCAAmC,CACtC,UAAU,EACV,8BAA8B,EAC9B,mBAAmB,CACpB,CAAC;YACF,IAAI,CAAC,mCAAmC,CAAC,UAAU,EAAE,mBAAmB,CAAC,CAAC;SAC3E;QAAC,OAAO,KAAK,EAAE;YACd,GAAG,CAAC,IAAI,CAAC,qDAAqD,KAAK,EAAE,CAAC,CAAC;SACxE;QAED,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtD,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE;YACrB,IAAI;gBACF,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;gBAC9B,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;gBAC5B,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;gBAC9B,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;aACpC;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;oBAC7B,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;iBAClB;aACF;SACF;IACH,CAAC;IAED,mCAAmC,CACjC,cAAsB,EACtB,SAAiB,EACjB,kBAA2B;QAE3B,MAAM,UAAU,GAAG,kBAAkB,IAAI,SAAS,CAAC;QACnD,IAAI,CAAC,MAAM,CAAC,GAAG,CACb,UAAU,EACV,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,cAAc,CAAC,YAAY,CAAC,SAAS,CAAC,CACtE,CAAC;IACJ,CAAC;IAED,SAAS;QACP,IAAI,IAAI,EAAE;YACR,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE;gBAC1B,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;aAC5C;YACD,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;SAC/B;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;CACF","sourcesContent":["/* eslint-disable import/no-extraneous-dependencies */\n/* eslint-disable sonarjs/no-duplicate-string */\n/* eslint-disable @typescript-eslint/explicit-member-accessibility */\n\nimport * as fs from 'node:fs';\nimport * as path from 'node:path';\n\nimport type { Context } from '@actions/github/lib/context.js';\nimport YAML from 'yaml';\n\nimport Action from './Action.js';\nimport { repositoryFinder } from './helpers.js';\nimport LogTask from './logtask/index.js';\nimport { Provider } from './nconf/nconf.cjs';\nimport ReadmeEditor from './readme-editor.js';\nimport { workingDirectory } from './working-directory.js';\n\nconst log = new LogTask('inputs');\n\nprocess.chdir(workingDirectory());\nconst githubEventPath = process.env.GITHUB_EVENT_PATH ?? '';\nlet githubEvent: Context | null = null;\ntry {\n  githubEvent = JSON.parse(fs.readFileSync(githubEventPath, 'utf8')) as Context;\n} catch {\n  // File not there\n  log.debug(`GITHUB_EVENT_PATH not found: ${githubEventPath}`);\n}\nexport const configFileName = '.ghadocs.json';\nconst pathsAction = 'paths:action';\nconst pathsReadme = 'paths:readme';\nexport const configKeys: string[] = [\n  'save',\n  pathsAction,\n  pathsReadme,\n  'branding_svg_path',\n  'versioning:enabled',\n  'versioning:override',\n  'versioning:prefix',\n  'versioning:branch',\n  'owner',\n  'repo',\n  'title_prefix',\n  'pretty',\n  'include_github_version_badge',\n];\ninterface KVPairType {\n  key: string;\n  value: string | undefined;\n}\ntype ProviderInstance = InstanceType<typeof Provider>;\nexport default class Inputs {\n  public config: ProviderInstance;\n\n  public sections: string[];\n\n  public readmePath: string;\n\n  public configPath: string;\n\n  public action: Action;\n\n  public readmeEditor: ReadmeEditor;\n\n  constructor() {\n    this.configPath = path.resolve(configFileName);\n    this.config = new Provider();\n    const repositoryDetail = repositoryFinder(null, githubEvent);\n    if (process.env.GITHUB_ACTION) {\n      log.info('running in GitHub action');\n    }\n    if (fs.existsSync(this.configPath)) {\n      log.info(`config file found: ${this.configPath}`);\n    } else {\n      log.error(`config file not found: ${this.configPath}`);\n    }\n    this.config\n      .env({\n        lowerCase: true,\n        parseValues: true,\n        match: /^INPUT_/,\n        transform: (obj: KVPairType): undefined | KVPairType => {\n          if (obj.key.startsWith('input_')) {\n            const newObj: KVPairType = {\n              key: obj.key,\n              value: obj.value,\n            };\n            const keyParsed = obj.key.replace(/^(INPUT|input)_/, '');\n            switch (keyParsed) {\n              case 'readme': {\n                newObj.key = pathsReadme;\n                break;\n              }\n              case 'action': {\n                newObj.key = pathsAction;\n                break;\n              }\n              case 'versioning_enabled': {\n                newObj.key = 'versioning:enabled';\n                break;\n              }\n              case 'version_prefix': {\n                newObj.key = 'versioning:prefix';\n                break;\n              }\n              case 'versioning_default_branch': {\n                newObj.key = 'versioning:branch';\n                break;\n              }\n              case 'version_override': {\n                newObj.key = 'versioning:override';\n                break;\n              }\n              case 'include_github_version_badge': {\n                newObj.key = 'versioning:badge';\n                break;\n              }\n              default: {\n                newObj.key = keyParsed;\n                break;\n              }\n            }\n            if (newObj.value) {\n              this.config.set(newObj.key, newObj.value);\n            }\n            return newObj;\n          }\n          return undefined;\n        },\n      })\n      .argv({\n        'save': {\n          alias: 'save',\n          describe: `Save this config to ${configFileName}`,\n          parseValues: true,\n          type: 'boolean',\n        },\n        'paths:action': {\n          alias: ['pathsAction', 'action'],\n          type: 'string',\n          describe: 'Path to the action.yml',\n        },\n        'paths:readme': {\n          alias: ['pathsReadme', 'readme'],\n          type: 'string',\n          describe: 'Path to the README file',\n        },\n        'branding_svg_path': {\n          alias: 'svg',\n          type: 'string',\n          describe: 'Save and load the branding svg image in the README from this path',\n        },\n        'owner': {\n          alias: 'owner',\n          describe: 'The GitHub Action repository owner. i.e: `bitflight-devops`',\n        },\n        'repo': {\n          alias: 'repo',\n          describe: 'The GitHub Action repository name. i.e: `github-action-readme-generator`',\n        },\n        'prettier': {\n          alias: 'pretty',\n          describe: 'Format the markdown using prettier formatter',\n          parseValues: true,\n          type: 'boolean',\n        },\n        'versioning:enabled': {\n          alias: ['versioning', 'versioning_enabled'],\n          describe:\n            'Enable the update of the usage version to match the latest version in the package.json file',\n          parseValues: true,\n          type: 'boolean',\n        },\n        'versioning:override': {\n          alias: ['setversion', 'versioning_override', 'version_override'],\n          describe: 'Set a specific version to display in the README.md',\n          parseValues: true,\n        },\n        'versioning:prefix': {\n          alias: ['vp', 'version_prefix'],\n          describe: \"Prefix the version with this value (if it isn't already prefixed)\",\n          parseValues: true,\n        },\n        'versioning:branch': {\n          alias: ['branch', 'versioning_default_branch'],\n          describe: 'If versioning is disabled show this branch instead',\n          parseValues: true,\n        },\n        'versioning:badge': {\n          alias: ['version-badge', 'versioning_badge'],\n          describe: 'Display the current version as a badge',\n          parseValues: true,\n          type: 'boolean',\n        },\n        'title_prefix': {\n          alias: ['prefix', 'title_prefix'],\n          describe: 'Add a prefix to the README title',\n          parseValues: true,\n        },\n      })\n      .file(this.configPath)\n      .defaults({\n        owner: repositoryDetail?.owner,\n        repo: repositoryDetail?.repo,\n        sections: [\n          'title',\n          'branding',\n          'description',\n          'usage',\n          'inputs',\n          'outputs',\n          'contents',\n          'badges',\n        ],\n      })\n      .required(['owner', 'repo']);\n\n    this.sections = this.config.get('sections') as string[];\n\n    const actionPath = path.resolve(this.config.get(pathsAction) as string);\n    this.action = new Action(actionPath);\n    this.readmePath = path.resolve(this.config.get(pathsReadme) as string);\n    try {\n      const thisActionPath = path.join(__dirname, '../../action.yml');\n      const thisAction = new Action(thisActionPath);\n      this.setConfigValueFromActionFileDefault(thisAction, 'readme', pathsReadme);\n      this.setConfigValueFromActionFileDefault(thisAction, 'title_prefix');\n      this.setConfigValueFromActionFileDefault(thisAction, 'save');\n      this.setConfigValueFromActionFileDefault(thisAction, 'pretty');\n      this.setConfigValueFromActionFileDefault(\n        thisAction,\n        'versioning_enabled',\n        'versioning:enabled',\n      );\n      this.setConfigValueFromActionFileDefault(\n        thisAction,\n        'versioning_default_branch',\n        'versioning:branch',\n      );\n      this.setConfigValueFromActionFileDefault(\n        thisAction,\n        'version_override',\n        'versioning:override',\n      );\n      this.setConfigValueFromActionFileDefault(thisAction, 'version_prefix', 'versioning:prefix');\n      this.setConfigValueFromActionFileDefault(\n        thisAction,\n        'include_github_version_badge',\n        'versioning:badges',\n      );\n      this.setConfigValueFromActionFileDefault(thisAction, 'branding_svg_path');\n    } catch (error) {\n      log.info(`failed to load defaults from action's action.yml: ${error}`);\n    }\n\n    this.readmeEditor = new ReadmeEditor(this.readmePath);\n    if (LogTask.isDebug()) {\n      try {\n        log.debug('resolved inputs:');\n        log.debug(this.stringify());\n        log.debug('resolved action:');\n        log.debug(this.action.stringify());\n      } catch (error) {\n        if (typeof error === 'string') {\n          log.debug(error);\n        }\n      }\n    }\n  }\n\n  setConfigValueFromActionFileDefault(\n    actionInstance: Action,\n    inputName: string,\n    providedConfigName?: string,\n  ): void {\n    const configName = providedConfigName ?? inputName;\n    this.config.set(\n      configName,\n      this.config.get(configName) ?? actionInstance.inputDefault(inputName),\n    );\n  }\n\n  stringify(): string {\n    if (this) {\n      const output: string[] = [];\n      for (const k of configKeys) {\n        output.push(`${k}: ${this.config.get(k)}`);\n      }\n      return YAML.stringify(output);\n    }\n    return '';\n  }\n}\n"]}

package/dist/mjs/inputs.test.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export default function main(): void;

package/dist/mjs/inputs.test.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+import Inputs from './inputs.js';
+export default function main() {
+    const inputs = new Inputs();
+    console.log('Input values:', inputs);
+}
+main();
+//# sourceMappingURL=inputs.test.js.map

package/dist/mjs/inputs.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inputs.test.js","sourceRoot":"","sources":["../../src/inputs.test.ts"],"names":[],"mappings":";AACA,OAAO,MAAM,MAAM,aAAa,CAAC;AAEjC,MAAM,CAAC,OAAO,UAAU,IAAI;IAC1B,MAAM,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;IAC5B,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;AACvC,CAAC;AAED,IAAI,EAAE,CAAC","sourcesContent":["#!/usr/bin/env node\nimport Inputs from './inputs.js';\n\nexport default function main(): void {\n  const inputs = new Inputs();\n  console.log('Input values:', inputs);\n}\n\nmain();\n"]}

package/dist/mjs/logtask/index.d.ts

@@ -0,0 +1,20 @@
+export default class LogTask {
+    static ingroup_setting: {
+        [key: string]: boolean;
+    };
+    static indentWidth: number;
+    static isDebug(): boolean;
+    name: string;
+    constructor(name: string);
+    get ingroup(): boolean;
+    set ingroup(value: boolean);
+    logStep(emojiStr: string, step: string, description: string, startGroup?: number): Promise<void>;
+    debug(description?: string): void;
+    start(description?: string): void;
+    info(description?: string): void;
+    warn(description?: string): void;
+    success(description?: string, ingroup?: boolean): void;
+    fail(description?: string, ingroup?: boolean): void;
+    error(description?: string): void;
+    title(description?: string): void;
+}

package/dist/mjs/logtask/index.js

@@ -0,0 +1,181 @@
+import * as core from '@actions/core';
+import chalkPkg from 'chalk';
+import * as emoji from 'node-emoji';
+const { bgRedBright, cyan, green, greenBright, red, redBright, white, whiteBright, yellow, yellowBright, } = chalkPkg;
+const NO_GROUP = 0;
+const START_GROUP = 1;
+const END_GROUP = 2;
+const IS_ERROR = 3;
+const IS_FAILED = 5;
+const IS_TITLE = 6;
+export default class LogTask {
+    static ingroup_setting = {};
+    static indentWidth = 5;
+    static isDebug() {
+        return core.isDebug() || !!process.env.DEBUG;
+    }
+    name;
+    constructor(name) {
+        this.name = name?.trim();
+        this.ingroup = false;
+    }
+    get ingroup() {
+        return LogTask.ingroup_setting[this.name] ?? false;
+    }
+    set ingroup(value) {
+        LogTask.ingroup_setting[this.name] = value;
+    }
+    async logStep(emojiStr, step, description, startGroup = NO_GROUP) {
+        if (step.length > LogTask.indentWidth) {
+            LogTask.indentWidth = step.length;
+        }
+        let failed = false;
+        let desc;
+        switch (step) {
+            case 'START': {
+                desc = yellowBright(`${description}`);
+                break;
+            }
+            case 'INFO': {
+                desc = green(`${description}`);
+                break;
+            }
+            case 'WARN': {
+                desc = yellow(`${description}`);
+                break;
+            }
+            case 'SUCCESS': {
+                desc = greenBright(`${description}`);
+                break;
+            }
+            case 'FAILURE': {
+                desc = redBright(`${description}`);
+                failed = true;
+                break;
+            }
+            case 'ERROR': {
+                desc = redBright(`${description}`);
+                break;
+            }
+            case '#####': {
+                desc = cyan(`${description}`);
+                break;
+            }
+            default: {
+                desc = white(`${description}`);
+                break;
+            }
+        }
+        let msg;
+        if (this.ingroup && !process.env.GITHUB_ACTIONS) {
+            const indentStr = [...Array.from({ length: LogTask.indentWidth }).fill(' ')].join('');
+            msg = `${indentStr}   ${emojiStr}: ${this.name} > ${desc}`;
+        }
+        else {
+            const stepStr = [
+                step,
+                ...Array.from({ length: LogTask.indentWidth - step.length }).fill(' '),
+            ].join('');
+            msg = `[${stepStr}] ${emojiStr}: ${desc}`;
+        }
+        switch (step) {
+            case 'START': {
+                msg = yellowBright(`${msg}`);
+                break;
+            }
+            case 'SUCCESS': {
+                msg = whiteBright(`${msg}`);
+                break;
+            }
+            case 'FAILURE': {
+                msg = red(`${msg}`);
+                break;
+            }
+            case 'ERROR': {
+                msg = red(`${msg}`);
+                break;
+            }
+            default: {
+                break;
+            }
+        }
+        const isErroring = startGroup === IS_ERROR || startGroup === IS_FAILED;
+        if (process.env.GITHUB_ACTIONS) {
+            switch (startGroup) {
+                case START_GROUP: {
+                    core.startGroup(msg);
+                    break;
+                }
+                case END_GROUP: {
+                    core.endGroup();
+                    break;
+                }
+                case IS_ERROR: {
+                    core.error(bgRedBright(msg));
+                    break;
+                }
+                case IS_FAILED: {
+                    core.setFailed(bgRedBright(msg));
+                    break;
+                }
+                default: {
+                    core.info(msg);
+                }
+            }
+        }
+        else if (isErroring) {
+            if (failed) {
+                core.setFailed(msg);
+            }
+            else {
+                core.error(msg);
+            }
+        }
+        else {
+            core.info(msg);
+        }
+    }
+    debug(description = '') {
+        if (LogTask.isDebug() && description !== '') {
+            this.logStep('👁️‍🗨️', 'DEBUG', description);
+        }
+    }
+    start(description = '') {
+        const desc = description === '' ? `Starting ${this.name}...` : description;
+        this.logStep(emoji.get('rocket') ?? '', 'START', desc, START_GROUP);
+    }
+    info(description = '') {
+        this.logStep(emoji.get('sparkles') ?? '', 'INFO', description);
+    }
+    warn(description = '') {
+        this.logStep(emoji.get('anger') ?? '', 'WARN', description);
+    }
+    success(description = '', ingroup = true) {
+        const desc = description === '' ? `Completed ${this.name}.` : description;
+        if (ingroup) {
+            this.ingroup = false;
+            if (process.env.GITHUB_ACTIONS) {
+                core.endGroup();
+            }
+        }
+        this.logStep(emoji.get('white_check_mark') ?? '', 'SUCCESS', desc);
+    }
+    fail(description = '', ingroup = true) {
+        const desc = description === '' ? `Failed ${this.name}.` : description;
+        if (ingroup) {
+            this.ingroup = false;
+            if (process.env.GITHUB_ACTIONS) {
+                core.endGroup();
+            }
+        }
+        const msgtype = process.env.GITHUB_ACTIONS ? IS_FAILED : IS_ERROR;
+        this.logStep(emoji.get('x') ?? '', 'FAILURE', desc, msgtype);
+    }
+    error(description = '') {
+        this.logStep(emoji.get('x') ?? '', 'ERROR', description, IS_ERROR);
+    }
+    title(description = '') {
+        this.logStep('📓', '#####', description, IS_TITLE);
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/mjs/logtask/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/logtask/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,QAAQ,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AAEpC,MAAM,EACJ,WAAW,EACX,IAAI,EACJ,KAAK,EACL,WAAW,EACX,GAAG,EACH,SAAS,EACT,KAAK,EACL,WAAW,EACX,MAAM,EACN,YAAY,GACb,GAAG,QAAQ,CAAC;AACb,MAAM,QAAQ,GAAG,CAAC,CAAC;AACnB,MAAM,WAAW,GAAG,CAAC,CAAC;AACtB,MAAM,SAAS,GAAG,CAAC,CAAC;AACpB,MAAM,QAAQ,GAAG,CAAC,CAAC;AACnB,MAAM,SAAS,GAAG,CAAC,CAAC;AACpB,MAAM,QAAQ,GAAG,CAAC,CAAC;AAEnB,MAAM,CAAC,OAAO,OAAO,OAAO;IAC1B,MAAM,CAAC,eAAe,GAA+B,EAAE,CAAC;IAExD,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC;IAEvB,MAAM,CAAC,OAAO;QACZ,OAAO,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;IAC/C,CAAC;IAED,IAAI,CAAS;IAEb,YAAY,IAAY;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,EAAE,IAAI,EAAE,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IAED,IAAI,OAAO;QACT,OAAO,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC;IACrD,CAAC;IAED,IAAI,OAAO,CAAC,KAAc;QACxB,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,OAAO,CACX,QAAgB,EAChB,IAAY,EACZ,WAAmB,EACnB,UAAU,GAAG,QAAQ;QAErB,IAAI,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE;YACrC,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC;SACnC;QACD,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,IAAI,IAAY,CAAC;QACjB,QAAQ,IAAI,EAAE;YACZ,KAAK,OAAO,CAAC,CAAC;gBACZ,IAAI,GAAG,YAAY,CAAC,GAAG,WAAW,EAAE,CAAC,CAAC;gBACtC,MAAM;aACP;YACD,KAAK,MAAM,CAAC,CAAC;gBACX,IAAI,GAAG,KAAK,CAAC,GAAG,WAAW,EAAE,CAAC,CAAC;gBAC/B,MAAM;aACP;YACD,KAAK,MAAM,CAAC,CAAC;gBACX,IAAI,GAAG,MAAM,CAAC,GAAG,WAAW,EAAE,CAAC,CAAC;gBAChC,MAAM;aACP;YACD,KAAK,SAAS,CAAC,CAAC;gBACd,IAAI,GAAG,WAAW,CAAC,GAAG,WAAW,EAAE,CAAC,CAAC;gBACrC,MAAM;aACP;YACD,KAAK,SAAS,CAAC,CAAC;gBACd,IAAI,GAAG,SAAS,CAAC,GAAG,WAAW,EAAE,CAAC,CAAC;gBACnC,MAAM,GAAG,IAAI,CAAC;gBACd,MAAM;aACP;YACD,KAAK,OAAO,CAAC,CAAC;gBACZ,IAAI,GAAG,SAAS,CAAC,GAAG,WAAW,EAAE,CAAC,CAAC;gBACnC,MAAM;aACP;YACD,KAAK,OAAO,CAAC,CAAC;gBACZ,IAAI,GAAG,IAAI,CAAC,GAAG,WAAW,EAAE,CAAC,CAAC;gBAC9B,MAAM;aACP;YACD,OAAO,CAAC,CAAC;gBACP,IAAI,GAAG,KAAK,CAAC,GAAG,WAAW,EAAE,CAAC,CAAC;gBAC/B,MAAM;aACP;SACF;QAED,IAAI,GAAW,CAAC;QAChB,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;YAC/C,MAAM,SAAS,GAAG,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACtF,GAAG,GAAG,GAAG,SAAS,MAAM,QAAQ,KAAK,IAAI,CAAC,IAAI,MAAM,IAAI,EAAE,CAAC;SAC5D;aAAM;YACL,MAAM,OAAO,GAAG;gBACd,IAAI;gBACJ,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;aACvE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAEX,GAAG,GAAG,IAAI,OAAO,KAAK,QAAQ,KAAK,IAAI,EAAE,CAAC;SAC3C;QACD,QAAQ,IAAI,EAAE;YACZ,KAAK,OAAO,CAAC,CAAC;gBACZ,GAAG,GAAG,YAAY,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;gBAC7B,MAAM;aACP;YACD,KAAK,SAAS,CAAC,CAAC;gBACd,GAAG,GAAG,WAAW,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;gBAC5B,MAAM;aACP;YACD,KAAK,SAAS,CAAC,CAAC;gBACd,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;gBACpB,MAAM;aACP;YACD,KAAK,OAAO,CAAC,CAAC;gBACZ,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;gBACpB,MAAM;aACP;YACD,OAAO,CAAC,CAAC;gBACP,MAAM;aACP;SACF;QACD,MAAM,UAAU,GAAG,UAAU,KAAK,QAAQ,IAAI,UAAU,KAAK,SAAS,CAAC;QAEvE,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;YAC9B,QAAQ,UAAU,EAAE;gBAClB,KAAK,WAAW,CAAC,CAAC;oBAChB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;oBAErB,MAAM;iBACP;gBACD,KAAK,SAAS,CAAC,CAAC;oBACd,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAEhB,MAAM;iBACP;gBACD,KAAK,QAAQ,CAAC,CAAC;oBACb,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;oBAE7B,MAAM;iBACP;gBACD,KAAK,SAAS,CAAC,CAAC;oBACd,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;oBAEjC,MAAM;iBACP;gBACD,OAAO,CAAC,CAAC;oBACP,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;iBAChB;aACF;SACF;aAAM,IAAI,UAAU,EAAE;YACrB,IAAI,MAAM,EAAE;gBACV,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;aACrB;iBAAM;gBACL,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;aACjB;SACF;aAAM;YACL,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAChB;IACH,CAAC;IAED,KAAK,CAAC,WAAW,GAAG,EAAE;QACpB,IAAI,OAAO,CAAC,OAAO,EAAE,IAAI,WAAW,KAAK,EAAE,EAAE;YAC3C,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;SAC/C;IACH,CAAC;IAED,KAAK,CAAC,WAAW,GAAG,EAAE;QACpB,MAAM,IAAI,GAAG,WAAW,KAAK,EAAE,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC;QAE3E,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;IACtE,CAAC;IAED,IAAI,CAAC,WAAW,GAAG,EAAE;QACnB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IACjE,CAAC;IAED,IAAI,CAAC,WAAW,GAAG,EAAE;QACnB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO,CAAC,WAAW,GAAG,EAAE,EAAE,OAAO,GAAG,IAAI;QACtC,MAAM,IAAI,GAAG,WAAW,KAAK,EAAE,CAAC,CAAC,CAAC,aAAa,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC;QAC1E,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;YACrB,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;gBAC9B,IAAI,CAAC,QAAQ,EAAE,CAAC;aACjB;SACF;QACD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IACrE,CAAC;IAED,IAAI,CAAC,WAAW,GAAG,EAAE,EAAE,OAAO,GAAG,IAAI;QACnC,MAAM,IAAI,GAAG,WAAW,KAAK,EAAE,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC;QACvE,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;YACrB,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE;gBAC9B,IAAI,CAAC,QAAQ,EAAE,CAAC;aACjB;SACF;QACD,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC;QAClE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED,KAAK,CAAC,WAAW,GAAG,EAAE;QACpB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,CAAC,WAAW,GAAG,EAAE;QACpB,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC","sourcesContent":["import * as core from '@actions/core';\nimport chalkPkg from 'chalk';\nimport * as emoji from 'node-emoji';\n\nconst {\n  bgRedBright,\n  cyan,\n  green,\n  greenBright,\n  red,\n  redBright,\n  white,\n  whiteBright,\n  yellow,\n  yellowBright,\n} = chalkPkg;\nconst NO_GROUP = 0;\nconst START_GROUP = 1;\nconst END_GROUP = 2;\nconst IS_ERROR = 3;\nconst IS_FAILED = 5;\nconst IS_TITLE = 6;\n\nexport default class LogTask {\n  static ingroup_setting: { [key: string]: boolean } = {};\n\n  static indentWidth = 5;\n\n  static isDebug(): boolean {\n    return core.isDebug() || !!process.env.DEBUG;\n  }\n\n  name: string;\n\n  constructor(name: string) {\n    this.name = name?.trim();\n    this.ingroup = false;\n  }\n\n  get ingroup(): boolean {\n    return LogTask.ingroup_setting[this.name] ?? false;\n  }\n\n  set ingroup(value: boolean) {\n    LogTask.ingroup_setting[this.name] = value;\n  }\n\n  async logStep(\n    emojiStr: string,\n    step: string,\n    description: string,\n    startGroup = NO_GROUP,\n  ): Promise<void> {\n    if (step.length > LogTask.indentWidth) {\n      LogTask.indentWidth = step.length;\n    }\n    let failed = false;\n    let desc: string;\n    switch (step) {\n      case 'START': {\n        desc = yellowBright(`${description}`);\n        break;\n      }\n      case 'INFO': {\n        desc = green(`${description}`);\n        break;\n      }\n      case 'WARN': {\n        desc = yellow(`${description}`);\n        break;\n      }\n      case 'SUCCESS': {\n        desc = greenBright(`${description}`);\n        break;\n      }\n      case 'FAILURE': {\n        desc = redBright(`${description}`);\n        failed = true;\n        break;\n      }\n      case 'ERROR': {\n        desc = redBright(`${description}`);\n        break;\n      }\n      case '#####': {\n        desc = cyan(`${description}`);\n        break;\n      }\n      default: {\n        desc = white(`${description}`);\n        break;\n      }\n    }\n\n    let msg: string;\n    if (this.ingroup && !process.env.GITHUB_ACTIONS) {\n      const indentStr = [...Array.from({ length: LogTask.indentWidth }).fill(' ')].join('');\n      msg = `${indentStr}   ${emojiStr}: ${this.name} > ${desc}`;\n    } else {\n      const stepStr = [\n        step,\n        ...Array.from({ length: LogTask.indentWidth - step.length }).fill(' '),\n      ].join('');\n\n      msg = `[${stepStr}] ${emojiStr}: ${desc}`;\n    }\n    switch (step) {\n      case 'START': {\n        msg = yellowBright(`${msg}`);\n        break;\n      }\n      case 'SUCCESS': {\n        msg = whiteBright(`${msg}`);\n        break;\n      }\n      case 'FAILURE': {\n        msg = red(`${msg}`);\n        break;\n      }\n      case 'ERROR': {\n        msg = red(`${msg}`);\n        break;\n      }\n      default: {\n        break;\n      }\n    }\n    const isErroring = startGroup === IS_ERROR || startGroup === IS_FAILED;\n\n    if (process.env.GITHUB_ACTIONS) {\n      switch (startGroup) {\n        case START_GROUP: {\n          core.startGroup(msg);\n\n          break;\n        }\n        case END_GROUP: {\n          core.endGroup();\n\n          break;\n        }\n        case IS_ERROR: {\n          core.error(bgRedBright(msg));\n\n          break;\n        }\n        case IS_FAILED: {\n          core.setFailed(bgRedBright(msg));\n\n          break;\n        }\n        default: {\n          core.info(msg);\n        }\n      }\n    } else if (isErroring) {\n      if (failed) {\n        core.setFailed(msg);\n      } else {\n        core.error(msg);\n      }\n    } else {\n      core.info(msg);\n    }\n  }\n\n  debug(description = ''): void {\n    if (LogTask.isDebug() && description !== '') {\n      this.logStep('👁️‍🗨️', 'DEBUG', description);\n    }\n  }\n\n  start(description = ''): void {\n    const desc = description === '' ? `Starting ${this.name}...` : description;\n\n    this.logStep(emoji.get('rocket') ?? '', 'START', desc, START_GROUP);\n  }\n\n  info(description = ''): void {\n    this.logStep(emoji.get('sparkles') ?? '', 'INFO', description);\n  }\n\n  warn(description = ''): void {\n    this.logStep(emoji.get('anger') ?? '', 'WARN', description);\n  }\n\n  success(description = '', ingroup = true): void {\n    const desc = description === '' ? `Completed ${this.name}.` : description;\n    if (ingroup) {\n      this.ingroup = false;\n      if (process.env.GITHUB_ACTIONS) {\n        core.endGroup();\n      }\n    }\n    this.logStep(emoji.get('white_check_mark') ?? '', 'SUCCESS', desc);\n  }\n\n  fail(description = '', ingroup = true): void {\n    const desc = description === '' ? `Failed ${this.name}.` : description;\n    if (ingroup) {\n      this.ingroup = false;\n      if (process.env.GITHUB_ACTIONS) {\n        core.endGroup();\n      }\n    }\n    const msgtype = process.env.GITHUB_ACTIONS ? IS_FAILED : IS_ERROR;\n    this.logStep(emoji.get('x') ?? '', 'FAILURE', desc, msgtype);\n  }\n\n  error(description = ''): void {\n    this.logStep(emoji.get('x') ?? '', 'ERROR', description, IS_ERROR);\n  }\n\n  title(description = ''): void {\n    this.logStep('📓', '#####', description, IS_TITLE);\n  }\n}\n"]}

package/dist/mjs/markdowner/index.d.ts

@@ -0,0 +1,17 @@
+export type MarkdownArrayRowType = string[][];
+export type MarkdownArrayItemType = string;
+/**
+ * Fills the width of the cell.
+ * @param text
+ * @param width
+ * @param paddingStart
+ */
+export declare function fillWidth(text: string, width: number, paddingStart: number): string;
+/**
+ * Escape a text so it can be used in a markdown table
+ * @param text
+ */
+export declare function markdownEscapeTableCell(text: string): string;
+export declare function markdownEscapeInlineCode(content: string): string;
+export declare function ArrayOfArraysToMarkdownTable(providedTableContent: MarkdownArrayRowType): string;
+export default ArrayOfArraysToMarkdownTable;

package/dist/mjs/markdowner/index.js

@@ -0,0 +1,104 @@
+/**
+ * Fills the width of the cell.
+ * @param text
+ * @param width
+ * @param paddingStart
+ */
+export function fillWidth(text, width, paddingStart) {
+    return (' '.repeat(paddingStart) + text + ' '.repeat(Math.max(1, width - text.length - paddingStart)));
+}
+/**
+ * Escape a text so it can be used in a markdown table
+ * @param text
+ */
+export function markdownEscapeTableCell(text) {
+    return text.replaceAll('\n', '<br />').replaceAll('|', '\\|');
+}
+export function markdownEscapeInlineCode(content) {
+    // replace grave accents with <code> HTML element to resolve unicode character in markdown
+    // let isClosingTag = false;
+    if (content.includes('|')) {
+        return content.replaceAll(/([\s*_]|^)`([^`]+)`([\s*_]|$)/g, '$1<code>$2</code>$3');
+    }
+    return content;
+    // ?.forEach((match) => {
+    //   if (!isClosingTag) {
+    //     content = content.replace(match, '<code>');
+    //   } else {
+    //     content = content.replace(match, '</code>');
+    //   }
+    //   isClosingTag = !isClosingTag;
+    // });
+    // return content
+}
+export function ArrayOfArraysToMarkdownTable(providedTableContent) {
+    const tableContent = [];
+    const outputStrings = [];
+    // Clone the arrays so we don't modify the original
+    for (const rowA of providedTableContent) {
+        tableContent.push([...rowA]);
+    }
+    const maxRows = tableContent.length;
+    let maxCols = 0;
+    let minCols = 0;
+    // Find the max and min columns so we can pad the rows
+    // for (const [i, e] of tableContent.entries()) {
+    let tblIdx = 0;
+    for (const e of tableContent) {
+        if (tableContent[tblIdx] !== undefined) {
+            const numCols = e.length;
+            if (numCols > maxCols) {
+                maxCols = numCols;
+            }
+            if (numCols < minCols || minCols === 0) {
+                minCols = numCols;
+            }
+        }
+        tblIdx += 1;
+    }
+    if (maxCols !== minCols) {
+        let cntIdx = 0;
+        for (const e of tableContent) {
+            if (tableContent[cntIdx] === undefined) {
+                tableContent[cntIdx] = Array.from({ length: maxCols }).fill('');
+            }
+            else if (e.length < maxCols) {
+                tableContent[cntIdx] = [
+                    ...e,
+                    ...Array.from({ length: maxCols - e.length }).fill('undefined'),
+                ];
+            }
+            cntIdx += 1;
+        }
+    }
+    const markdownArrayRowsLength = maxRows + 1;
+    const markdownArrayEntriesLength = maxCols * 2 + 1;
+    const markdownArrays = Array.from({ length: markdownArrayRowsLength }).fill(Array.from({ length: markdownArrayEntriesLength }).fill('|'));
+    let i = 0;
+    for (const row of markdownArrays) {
+        let col = 0;
+        const idx = i > 1 ? i - 1 : 0;
+        const dataRow = tableContent[idx];
+        for (let j = 0; j < row.length; j++) {
+            let content = markdownEscapeTableCell(dataRow[col] ?? '');
+            content = markdownEscapeInlineCode(content);
+            if (j % 2 === 1) {
+                if (i === 0) {
+                    markdownArrays[i][j] = ` **${content.trim()}** `;
+                }
+                else if (i === 1) {
+                    markdownArrays[i][j] = '---';
+                }
+                else {
+                    markdownArrays[i][j] = ` ${content.trim()} `;
+                }
+                col += 1;
+            }
+        }
+        outputStrings.push(`${markdownArrays[i].join('')}\n`);
+        i += 1;
+    }
+    return outputStrings.join('');
+}
+export default ArrayOfArraysToMarkdownTable;
+//# sourceMappingURL=index.js.map