github-action-readme-generator 1.6.0 → 1.7.1

package/dist/mjs/sections/update-usage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-usage.js","sourceRoot":"","sources":["../../../src/sections/update-usage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AAExD,OAAO,OAAO,MAAM,qBAAqB,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,KAAa,EAAE,MAAc;IAC/D,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;IAC/B,GAAG,CAAC,KAAK,EAAE,CAAC;IACZ,MAAM,UAAU,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAW,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;IAC1F,GAAG,CAAC,IAAI,CAAC,gBAAgB,UAAU,EAAE,CAAC,CAAC;IACvC,MAAM,aAAa,GAAW,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAE9D,GAAG,CAAC,IAAI,CAAC,mBAAmB,aAAa,EAAE,CAAC,CAAC;IAE7C,MAAM,eAAe,GAAG,GAAG,UAAU,IAAI,aAAa,EAAE,CAAC;IAEzD,IAAI,CAAC,eAAe,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;KAChE;IAED,uBAAuB;IACvB,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,8BAA8B;IAC9B,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,eAAe,EAAE,EAAE,SAAS,CAAC,CAAC;IAEjE,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;IACjC,IAAI,UAAU,GAAG,IAAI,CAAC;IACtB,IAAI,GAAG,EAAE;QACP,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YAClC,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,4BAA4B;gBAC5B,IAAI,CAAC,UAAU,EAAE;oBACf,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;iBAClB;gBAED,wDAAwD;gBACxD,eAAe,CAAC,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAEtD,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE;oBAC/B,kDAAkD;oBAClD,IAAI,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;wBACnD,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;qBACvB;oBAED,UAAU;oBACV,OAAO,CAAC,IAAI,CAAC,kBAAkB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;iBACjD;gBAED,aAAa;gBACb,OAAO,CAAC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC;gBAE/B,UAAU,GAAG,KAAK,CAAC;aACpB;SACF;KACF;IAED,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAEtB,MAAM,CAAC,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAClD,GAAG,CAAC,OAAO,EAAE,CAAC;AAChB,CAAC","sourcesContent":["import { getCurrentVersionString } from '../helpers.js';\nimport type Inputs from '../inputs.js';\nimport LogTask from '../logtask/index.js';\nimport { wrapDescription } from '../prettier.js';\n\nexport default function updateUsage(token: string, inputs: Inputs): void {\n  const log = new LogTask(token);\n  log.start();\n  const actionName = `${inputs.config.get('owner') as string}/${inputs.config.get('repo')}`;\n  log.info(`Action name: ${actionName}`);\n  const versionString: string = getCurrentVersionString(inputs);\n\n  log.info(`Version string: ${versionString}`);\n\n  const actionReference = `${actionName}@${versionString}`;\n\n  if (!actionReference) {\n    throw new Error('Parameter actionReference must not be empty');\n  }\n\n  // Build the new README\n  const content: string[] = [];\n  // Build the new usage section\n  content.push('```yaml', `- uses: ${actionReference}`, '  with:');\n\n  const inp = inputs.action.inputs;\n  let firstInput = true;\n  if (inp) {\n    for (const key of Object.keys(inp)) {\n      const input = inp[key];\n      if (input !== undefined) {\n        // Line break between inputs\n        if (!firstInput) {\n          content.push('');\n        }\n\n        // Constrain the width of the description, and append it\n        wrapDescription(input.description, content, '    # ');\n\n        if (input.default !== undefined) {\n          // Append blank line if description had paragraphs\n          if (input.description?.trimEnd().match(/\\n *\\r?\\n/)) {\n            content.push('    #');\n          }\n\n          // Default\n          content.push(`    # Default: ${input.default}`);\n        }\n\n        // Input name\n        content.push(`    ${key}: ''`);\n\n        firstInput = false;\n      }\n    }\n  }\n\n  content.push('```\\n');\n\n  inputs.readmeEditor.updateSection(token, content);\n  log.success();\n}\n"]}

package/dist/mjs/svg-editor.d.mts

@@ -0,0 +1,22 @@
+import type { Container } from '@svgdotjs/svg.js';
+import * as feather from 'feather-icons';
+import { SVGDocument, SVGWindow } from 'svgdom';
+import LogTask from './logtask/index.js';
+type conforms<T, V> = T extends V ? T : V;
+type FeatherIconKeysArray = keyof typeof feather.icons;
+type FeatherIconKeys<T extends string, R = FeatherIconKeysArray> = conforms<T, R>;
+export declare const GITHUB_ACTIONS_BRANDING_ICONS: Set<string>;
+export declare const GITHUB_ACTIONS_BRANDING_COLORS: string[];
+export default class SVGEditor {
+    log: LogTask;
+    window?: SVGWindow;
+    canvas?: Container;
+    document?: SVGDocument;
+    constructor();
+    init(): Promise<void>;
+    /**
+     * Generates a svg branding image.
+     */
+    generateSvgImage(svgPath: string | undefined, icon?: FeatherIconKeys<keyof typeof feather.icons>, bgcolor?: string): void;
+}
+export {};

package/dist/mjs/svg-editor.mjs

@@ -0,0 +1,138 @@
+/* eslint-disable import/no-extraneous-dependencies */
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import { registerWindow, SVG } from '@svgdotjs/svg.js';
+import * as feather from 'feather-icons';
+import { createSVGDocument, createSVGWindow } from 'svgdom'; /// main-module.js';
+import LogTask from './logtask/index.js';
+// function featherType<T extends FeatherIconKeysArray | string>(iconName: T): FeatherIconKeys<T> {
+//   return iconName as FeatherIconKeys<T>;
+// }
+const brandingSquareEdgeLengthInPixels = 50;
+// https://help.github.com/en/articles/metadata-syntax-for-github-actions#branding
+const GITHUB_ACTIONS_OMITTED_ICONS = new Set([
+    'coffee',
+    'columns',
+    'divide-circle',
+    'divide-square',
+    'divide',
+    'frown',
+    'hexagon',
+    'key',
+    'meh',
+    'mouse-pointer',
+    'smile',
+    'tool',
+    'x-octagon',
+]);
+export const GITHUB_ACTIONS_BRANDING_ICONS = new Set(Object.keys(feather.icons).filter((item) => !GITHUB_ACTIONS_OMITTED_ICONS.has(item)));
+export const GITHUB_ACTIONS_BRANDING_COLORS = [
+    'white',
+    'yellow',
+    'blue',
+    'green',
+    'orange',
+    'red',
+    'purple',
+    'gray-dark',
+];
+export default class SVGEditor {
+    log;
+    window;
+    canvas;
+    document;
+    constructor() {
+        this.log = new LogTask('SVGEditor');
+    }
+    async init() {
+        if (!this.window) {
+            // returns a window with a document and an svg root node
+            this.window = createSVGWindow();
+            const { document } = this.window;
+            // instanceof<typeof createSVGWindow>
+            // register window and document
+            registerWindow(this.window, document);
+            if (!this.canvas) {
+                // create canvas
+                this.canvas = SVG(document.documentElement);
+            }
+        }
+        if (!this.document) {
+            this.document = createSVGDocument();
+        }
+        if (!this.canvas) {
+            // create canvas
+            this.canvas = SVG(this.document.documentElement);
+        }
+    }
+    /**
+     * Generates a svg branding image.
+     */
+    generateSvgImage(svgPath, icon = 'book-open', bgcolor = 'blue') {
+        const { log } = this;
+        if (svgPath && svgPath.length > 0) {
+            fs.mkdirSync(path.dirname(svgPath), { recursive: true });
+            this.init()
+                .then(() => {
+                const { canvas } = this;
+                if (!GITHUB_ACTIONS_BRANDING_ICONS.has(icon)) {
+                    log.fail(`Invalid icon specified for branding: ${icon}`);
+                    return;
+                }
+                const color = GITHUB_ACTIONS_BRANDING_COLORS.includes(bgcolor.toLowerCase())
+                    ? bgcolor.toLowerCase()
+                    : 'blue';
+                const svgData = feather.icons[icon];
+                log.info(`SVG data generated for ${icon} at ${svgPath} with color ${color}.`);
+                log.debug(`SVG data to ingest: ${svgData.toSvg()}`);
+                if (canvas) {
+                    canvas.clear();
+                    const outerViewBox = 100;
+                    canvas
+                        .size(brandingSquareEdgeLengthInPixels, brandingSquareEdgeLengthInPixels)
+                        .viewbox(`0 0 ${outerViewBox} ${outerViewBox}`)
+                        .stroke(color.startsWith('white') ? 'white' : 'black')
+                        .fill('none');
+                    const circleSize = outerViewBox / 2;
+                    canvas
+                        .circle('50%')
+                        .fill(color)
+                        .radius(circleSize)
+                        .cx(circleSize)
+                        .cy(circleSize)
+                        .stroke({ width: 0 });
+                    const iconsvgOuter = canvas.nested();
+                    iconsvgOuter.attr('overflow', 'visible').height('50%').width('50%').x('25%').y('25%');
+                    const iconsvg = iconsvgOuter.nested();
+                    iconsvg.id('icon').svg(svgData.contents);
+                    for (const attr of Object.keys(svgData.attrs)) {
+                        iconsvg.attr(attr, svgData.attrs[attr]);
+                    }
+                    iconsvg.attr('overflow', 'visible');
+                    log.info(`SVG icon: rbox: ${iconsvg.rbox()}`);
+                    log.info(`SVG icon: bbox: ${iconsvg.bbox()}`);
+                    iconsvg.viewbox(iconsvg.bbox());
+                    iconsvg.height('auto').width('auto');
+                    const svgOut = [
+                        '<?xml version="1.0" encoding="UTF-8" standalone="no"?>',
+                        canvas.svg(),
+                        '\n',
+                    ].join('\n');
+                    log.debug(`SVG data to write: ${svgOut}`);
+                    fs.mkdirSync(path.dirname(svgPath), { recursive: true });
+                    fs.writeFileSync(svgPath, svgOut, { encoding: 'utf8' });
+                    log.debug(`SVG image generated: ${svgPath}`);
+                    return;
+                }
+                throw new Error('Canvas not initialized');
+            })
+                .catch((error) => {
+                log.fail(`Error generating svg image: ${svgPath}. Error: ${error}`);
+            });
+        }
+        else {
+            log.debug('svgPath is not provided');
+        }
+    }
+}
+//# sourceMappingURL=svg-editor.mjs.map

package/dist/mjs/svg-editor.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"svg-editor.mjs","sourceRoot":"","sources":["../../src/svg-editor.mts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAGlC,OAAO,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAA0B,MAAM,QAAQ,CAAC,CAAC,oBAAoB;AAEzG,OAAO,OAAO,MAAM,oBAAoB,CAAC;AAKzC,mGAAmG;AACnG,2CAA2C;AAC3C,IAAI;AACJ,MAAM,gCAAgC,GAAG,EAAE,CAAC;AAE5C,kFAAkF;AAClF,MAAM,4BAA4B,GAAG,IAAI,GAAG,CAAC;IAC3C,QAAQ;IACR,SAAS;IACT,eAAe;IACf,eAAe;IACf,QAAQ;IACR,OAAO;IACP,SAAS;IACT,KAAK;IACL,KAAK;IACL,eAAe;IACf,OAAO;IACP,MAAM;IACN,WAAW;CACZ,CAAC,CAAC;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,IAAI,GAAG,CAClD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,4BAA4B,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CACrF,CAAC;AACF,MAAM,CAAC,MAAM,8BAA8B,GAAG;IAC5C,OAAO;IACP,QAAQ;IACR,MAAM;IACN,OAAO;IACP,QAAQ;IACR,KAAK;IACL,QAAQ;IACR,WAAW;CACZ,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,GAAG,CAAU;IAEb,MAAM,CAAa;IAEnB,MAAM,CAAa;IAEnB,QAAQ,CAAe;IAEvB;QACE,IAAI,CAAC,GAAG,GAAG,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,wDAAwD;YACxD,IAAI,CAAC,MAAM,GAAG,eAAe,EAAE,CAAC;YAEhC,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;YACjC,qCAAqC;YACrC,+BAA+B;YAC/B,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YACtC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBAChB,gBAAgB;gBAChB,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,eAAe,CAAc,CAAC;aAC1D;SACF;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,IAAI,CAAC,QAAQ,GAAG,iBAAiB,EAAE,CAAC;SACrC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,gBAAgB;YAChB,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAc,CAAC;SAC/D;IACH,CAAC;IAED;;OAEG;IACH,gBAAgB,CACd,OAA2B,EAC3B,OAAoD,WAAW,EAC/D,OAAO,GAAG,MAAM;QAEhB,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QACrB,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACzD,IAAI,CAAC,IAAI,EAAE;iBACR,IAAI,CAAC,GAAG,EAAE;gBACT,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;gBACxB,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;oBAC5C,GAAG,CAAC,IAAI,CAAC,wCAAwC,IAAI,EAAE,CAAC,CAAC;oBACzD,OAAO;iBACR;gBACD,MAAM,KAAK,GAAG,8BAA8B,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;oBAC1E,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE;oBACvB,CAAC,CAAC,MAAM,CAAC;gBAEX,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACpC,GAAG,CAAC,IAAI,CAAC,0BAA0B,IAAI,OAAO,OAAO,eAAe,KAAK,GAAG,CAAC,CAAC;gBAC9E,GAAG,CAAC,KAAK,CAAC,uBAAuB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBACpD,IAAI,MAAM,EAAE;oBACV,MAAM,CAAC,KAAK,EAAE,CAAC;oBACf,MAAM,YAAY,GAAG,GAAG,CAAC;oBACzB,MAAM;yBACH,IAAI,CAAC,gCAAgC,EAAE,gCAAgC,CAAC;yBACxE,OAAO,CAAC,OAAO,YAAY,IAAI,YAAY,EAAE,CAAC;yBAC9C,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;yBACrD,IAAI,CAAC,MAAM,CAAC,CAAC;oBAChB,MAAM,UAAU,GAAG,YAAY,GAAG,CAAC,CAAC;oBACpC,MAAM;yBACH,MAAM,CAAC,KAAK,CAAC;yBACb,IAAI,CAAC,KAAK,CAAC;yBACX,MAAM,CAAC,UAAU,CAAC;yBAClB,EAAE,CAAC,UAAU,CAAC;yBACd,EAAE,CAAC,UAAU,CAAC;yBACd,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;oBAExB,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;oBACrC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;oBACtF,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;oBAEtC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;oBACzC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;wBAC7C,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;qBACzC;oBACD,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;oBACpC,GAAG,CAAC,IAAI,CAAC,mBAAmB,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;oBAC9C,GAAG,CAAC,IAAI,CAAC,mBAAmB,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;oBAC9C,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;oBAChC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;oBAErC,MAAM,MAAM,GAAG;wBACb,wDAAwD;wBACxD,MAAM,CAAC,GAAG,EAAE;wBACZ,IAAI;qBACL,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACb,GAAG,CAAC,KAAK,CAAC,sBAAsB,MAAM,EAAE,CAAC,CAAC;oBAC1C,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;oBACzD,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;oBACxD,GAAG,CAAC,KAAK,CAAC,wBAAwB,OAAO,EAAE,CAAC,CAAC;oBAC7C,OAAO;iBACR;gBAED,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;YAC5C,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACf,GAAG,CAAC,IAAI,CAAC,+BAA+B,OAAO,YAAY,KAAK,EAAE,CAAC,CAAC;YACtE,CAAC,CAAC,CAAC;SACN;aAAM;YACL,GAAG,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;SACtC;IACH,CAAC;CACF","sourcesContent":["/* eslint-disable import/no-extraneous-dependencies */\nimport * as fs from 'node:fs';\nimport * as path from 'node:path';\n\nimport type { Container } from '@svgdotjs/svg.js';\nimport { registerWindow, SVG } from '@svgdotjs/svg.js';\nimport * as feather from 'feather-icons';\nimport { createSVGDocument, createSVGWindow, SVGDocument, SVGWindow } from 'svgdom'; /// main-module.js';\n\nimport LogTask from './logtask/index.js';\n\ntype conforms<T, V> = T extends V ? T : V;\ntype FeatherIconKeysArray = keyof typeof feather.icons;\ntype FeatherIconKeys<T extends string, R = FeatherIconKeysArray> = conforms<T, R>;\n// function featherType<T extends FeatherIconKeysArray | string>(iconName: T): FeatherIconKeys<T> {\n//   return iconName as FeatherIconKeys<T>;\n// }\nconst brandingSquareEdgeLengthInPixels = 50;\n\n// https://help.github.com/en/articles/metadata-syntax-for-github-actions#branding\nconst GITHUB_ACTIONS_OMITTED_ICONS = new Set([\n  'coffee',\n  'columns',\n  'divide-circle',\n  'divide-square',\n  'divide',\n  'frown',\n  'hexagon',\n  'key',\n  'meh',\n  'mouse-pointer',\n  'smile',\n  'tool',\n  'x-octagon',\n]);\nexport const GITHUB_ACTIONS_BRANDING_ICONS = new Set(\n  Object.keys(feather.icons).filter((item) => !GITHUB_ACTIONS_OMITTED_ICONS.has(item))\n);\nexport const GITHUB_ACTIONS_BRANDING_COLORS = [\n  'white',\n  'yellow',\n  'blue',\n  'green',\n  'orange',\n  'red',\n  'purple',\n  'gray-dark',\n];\n\nexport default class SVGEditor {\n  log: LogTask;\n\n  window?: SVGWindow;\n\n  canvas?: Container;\n\n  document?: SVGDocument;\n\n  constructor() {\n    this.log = new LogTask('SVGEditor');\n  }\n\n  async init(): Promise<void> {\n    if (!this.window) {\n      // returns a window with a document and an svg root node\n      this.window = createSVGWindow();\n\n      const { document } = this.window;\n      // instanceof<typeof createSVGWindow>\n      // register window and document\n      registerWindow(this.window, document);\n      if (!this.canvas) {\n        // create canvas\n        this.canvas = SVG(document.documentElement) as Container;\n      }\n    }\n\n    if (!this.document) {\n      this.document = createSVGDocument();\n    }\n\n    if (!this.canvas) {\n      // create canvas\n      this.canvas = SVG(this.document.documentElement) as Container;\n    }\n  }\n\n  /**\n   * Generates a svg branding image.\n   */\n  generateSvgImage(\n    svgPath: string | undefined,\n    icon: FeatherIconKeys<keyof typeof feather.icons> = 'book-open',\n    bgcolor = 'blue'\n  ): void {\n    const { log } = this;\n    if (svgPath && svgPath.length > 0) {\n      fs.mkdirSync(path.dirname(svgPath), { recursive: true });\n      this.init()\n        .then(() => {\n          const { canvas } = this;\n          if (!GITHUB_ACTIONS_BRANDING_ICONS.has(icon)) {\n            log.fail(`Invalid icon specified for branding: ${icon}`);\n            return;\n          }\n          const color = GITHUB_ACTIONS_BRANDING_COLORS.includes(bgcolor.toLowerCase())\n            ? bgcolor.toLowerCase()\n            : 'blue';\n\n          const svgData = feather.icons[icon];\n          log.info(`SVG data generated for ${icon} at ${svgPath} with color ${color}.`);\n          log.debug(`SVG data to ingest: ${svgData.toSvg()}`);\n          if (canvas) {\n            canvas.clear();\n            const outerViewBox = 100;\n            canvas\n              .size(brandingSquareEdgeLengthInPixels, brandingSquareEdgeLengthInPixels)\n              .viewbox(`0 0 ${outerViewBox} ${outerViewBox}`)\n              .stroke(color.startsWith('white') ? 'white' : 'black')\n              .fill('none');\n            const circleSize = outerViewBox / 2;\n            canvas\n              .circle('50%')\n              .fill(color)\n              .radius(circleSize)\n              .cx(circleSize)\n              .cy(circleSize)\n              .stroke({ width: 0 });\n\n            const iconsvgOuter = canvas.nested();\n            iconsvgOuter.attr('overflow', 'visible').height('50%').width('50%').x('25%').y('25%');\n            const iconsvg = iconsvgOuter.nested();\n\n            iconsvg.id('icon').svg(svgData.contents);\n            for (const attr of Object.keys(svgData.attrs)) {\n              iconsvg.attr(attr, svgData.attrs[attr]);\n            }\n            iconsvg.attr('overflow', 'visible');\n            log.info(`SVG icon: rbox: ${iconsvg.rbox()}`);\n            log.info(`SVG icon: bbox: ${iconsvg.bbox()}`);\n            iconsvg.viewbox(iconsvg.bbox());\n            iconsvg.height('auto').width('auto');\n\n            const svgOut = [\n              '<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>',\n              canvas.svg(),\n              '\\n',\n            ].join('\\n');\n            log.debug(`SVG data to write: ${svgOut}`);\n            fs.mkdirSync(path.dirname(svgPath), { recursive: true });\n            fs.writeFileSync(svgPath, svgOut, { encoding: 'utf8' });\n            log.debug(`SVG image generated: ${svgPath}`);\n            return;\n          }\n\n          throw new Error('Canvas not initialized');\n        })\n        .catch((error) => {\n          log.fail(`Error generating svg image: ${svgPath}. Error: ${error}`);\n        });\n    } else {\n      log.debug('svgPath is not provided');\n    }\n  }\n}\n"]}

package/dist/mjs/working-directory.d.ts

@@ -0,0 +1,2 @@
+export declare function workingDirectory(): string;
+export default workingDirectory;

package/dist/mjs/working-directory.js

@@ -0,0 +1,5 @@
+export function workingDirectory() {
+    return process.env.GITHUB_WORKSPACE ?? process.env.INIT_CWD ?? process.cwd();
+}
+export default workingDirectory;
+//# sourceMappingURL=working-directory.js.map

package/dist/mjs/working-directory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"working-directory.js","sourceRoot":"","sources":["../../src/working-directory.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,gBAAgB;IAC9B,OAAO,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;AAC/E,CAAC;AACD,eAAe,gBAAgB,CAAC","sourcesContent":["export function workingDirectory(): string {\n  return process.env.GITHUB_WORKSPACE ?? process.env.INIT_CWD ?? process.cwd();\n}\nexport default workingDirectory;\n"]}

package/dist/{index.d.ts → types/index.d.ts}

@@ -4,9 +4,8 @@ declare module "jest.config" {
     const config: Config.InitialOptions;
     export default config;
 }
-declare module "__tests__/index.test" { }
 declare module "src/logtask/index" {
-    class LogTask {
+    export default class LogTask {
         static ingroup_setting: {
             [key: string]: boolean;
         };
@@ -26,7 +25,6 @@ declare module "src/logtask/index" {
         error(description?: string): void;
         title(description?: string): void;
     }
-    export default LogTask;
 }
 declare module "src/Action" {
     export interface InputType {
@@ -59,11 +57,12 @@ declare module "src/Action" {
         outputs: OutputsType;
         runs: Runs;
         constructor(actionPath: string);
+        inputDefault(inputName: string): string | undefined;
         stringify(): string;
     }
 }
 declare module "src/helpers" {
-    import type { Context } from '@actions/github/lib/context';
+    import type { Context } from '@actions/github/lib/context.js';
     import type Inputs from "src/inputs";
     export function undefinedOnEmpty(value: string | undefined): string | undefined;
     export function basename(path: string): string | undefined;
@@ -93,7 +92,8 @@ declare module "src/readme-editor" {
         private readonly filePath;
         private fileContent;
         constructor(filePath: string);
-        updateSection(name: string, providedContent: string | string[]): void;
+        getTokenIndexes(token: string): number[];
+        updateSection(name: string, providedContent: string | string[], addNewlines?: boolean): void;
         dumpToFile(): Promise<void>;
     }
 }
@@ -102,19 +102,21 @@ declare module "src/working-directory" {
     export default workingDirectory;
 }
 declare module "src/inputs" {
-    import * as nconf from 'nconf';
+    import { Provider } from 'nconf';
     import Action from "src/Action";
     import ReadmeEditor from "src/readme-editor";
     export const configFileName = ".ghadocs.json";
     export const configKeys: string[];
+    type ProviderInstance = InstanceType<typeof Provider>;
     export default class Inputs {
-        config: nconf.Provider;
+        config: ProviderInstance;
         sections: string[];
         readmePath: string;
         configPath: string;
         action: Action;
         readmeEditor: ReadmeEditor;
         constructor();
+        setConfigValueFromActionFileDefault(actionInstance: Action, inputName: string, providedConfigName?: string): void;
         stringify(): string;
     }
 }
@@ -136,7 +138,7 @@ declare module "src/config" {
         title_prefix?: string;
         title?: string;
         paths?: Paths;
-        show_logo?: boolean;
+        branding_svg_path?: string;
         versioning?: Versioning;
         readmePath?: string;
         outpath?: string;
@@ -163,6 +165,38 @@ declare module "src/sections/update-badges" {
     }
     export default function updateBadges(token: string, inputs: Inputs): void;
 }
+declare module "src/svg-editor" {
+    import type { Container } from '@svgdotjs/svg.js';
+    import * as feather from 'feather-icons';
+    import { SVGDocument, SVGWindow } from 'svgdom';
+    import LogTask from "src/logtask/index";
+    type conforms<T, V> = T extends V ? T : V;
+    type FeatherIconKeysArray = keyof typeof feather.icons;
+    type FeatherIconKeys<T extends string, R = FeatherIconKeysArray> = conforms<T, R>;
+    export const GITHUB_ACTIONS_BRANDING_ICONS: Set<string>;
+    export const GITHUB_ACTIONS_BRANDING_COLORS: string[];
+    export default class SVGEditor {
+        log: LogTask;
+        window?: SVGWindow;
+        canvas?: Container;
+        document?: SVGDocument;
+        constructor();
+        init(): Promise<void>;
+        /**
+         * Generates a svg branding image.
+         */
+        generateSvgImage(svgPath: string | undefined, icon?: FeatherIconKeys<keyof typeof feather.icons>, bgcolor?: string): void;
+    }
+}
+declare module "src/sections/update-branding" {
+    import type Inputs from "src/inputs";
+    export interface IBranding {
+        alt: string;
+        img: string;
+        url?: string;
+    }
+    export default function updateBranding(token: string, inputs: Inputs): void;
+}
 declare module "src/sections/update-description" {
     import type Inputs from "src/inputs";
     export default function updateDescription(token: string, inputs: Inputs): void;
@@ -209,9 +243,9 @@ declare module "src/sections/index" {
 declare module "src/generate-docs" {
     import Inputs from "src/inputs";
     export const inputs: Inputs;
-    export default function generateDocs(): void;
+    export function generateDocs(): void;
 }
 declare module "src/index" { }
-declare module "src/testInputs" {
+declare module "src/inputs.test" {
     export default function main(): void;
 }