github-action-readme-generator 1.9.2 → 1.10.0

package/dist/types/index.d.ts

@@ -136,6 +136,18 @@ declare module "src/constants" {
     /**
      * Enumerates the keys for the configuration options.
      */
+    /**
+     * Valid version source options for determining action version.
+     */
+    export const VERSION_SOURCES: readonly ["git-tag", "git-branch", "git-sha", "package-json", "explicit"];
+    /**
+     * Type for version source options.
+     */
+    export type VersionSource = (typeof VERSION_SOURCES)[number];
+    /**
+     * Checks if the given value is a valid version source.
+     */
+    export function isValidVersionSource(value: string): value is VersionSource;
     export enum ConfigKeys {
         Owner = "owner",
         Repo = "repo",
@@ -150,6 +162,7 @@ declare module "src/constants" {
         VersioningOverride = "versioning:override",
         VersioningPrefix = "versioning:prefix",
         VersioningBranch = "versioning:branch",
+        VersioningSource = "versioning:source",
         IncludeGithubVersionBadge = "versioning:badge",
         DebugNconf = "debug:nconf",
         DebugReadme = "debug:readme",
@@ -241,37 +254,37 @@ declare module "src/Action" {
      * Defines the runs property for container actions.
      */
     type RunsContainer = {
-        'using': ContainerAction;
-        'image': string;
-        'args'?: string[];
+        using: ContainerAction;
+        image: string;
+        args?: string[];
         'pre-entrypoint'?: string;
         'post-entrypoint'?: string;
-        'entrypoint'?: string;
+        entrypoint?: string;
     };
     /**
      * Defines the runs property for JavaScript actions.
      */
     type RunsJavascript = {
         /** The runner used to execute the action */
-        'using': JavascriptAction;
+        using: JavascriptAction;
         /** The entrypoint file for the action */
-        'main': string;
-        'pre'?: string;
+        main: string;
+        pre?: string;
         'pre-if'?: string;
         'post-if'?: string;
-        'post'?: string;
+        post?: string;
     };
     /**
      * Defines the steps property for composite actions.
      */
     type Steps = {
-        'shell'?: string;
-        'if'?: string;
-        'run'?: string;
-        'name'?: string;
-        'id'?: string;
+        shell?: string;
+        if?: string;
+        run?: string;
+        name?: string;
+        id?: string;
         'working-directory'?: string;
-        'env': {
+        env: {
             [key: string]: string;
         };
     };
@@ -311,7 +324,7 @@ declare module "src/Action" {
      * Parses and represents metadata from action.yml.
      */
     export default class Action implements ActionYaml {
-        static validate(obj: any): obj is ActionType;
+        static validate(obj: unknown): obj is ActionType;
         log: LogTask;
         /** Name of the action */
         name: string;
@@ -360,10 +373,7 @@ declare module "src/Action" {
         stringify(): string;
     }
 }
-declare module "__tests__/action.test" {
-    export const __filename: string;
-    export const __dirname: string;
-}
+declare module "__tests__/action.test" { }
 declare module "__tests__/constants.test" { }
 declare module "__tests__/env.test" { }
 declare module "src/prettier" {
@@ -440,20 +450,12 @@ declare module "src/readme-editor" {
 declare module "src/inputs" {
     import { Context } from '@actions/github/lib/context.js';
     import nconf from 'nconf';
-    import Action, { Input } from "src/Action";
-    import { ReadmeSection } from "src/constants";
+    import Action, { type Input } from "src/Action";
+    import { type ReadmeSection } from "src/constants";
     import LogTask from "src/logtask/index";
     import ReadmeEditor from "src/readme-editor";
     const Provider: typeof nconf.Provider;
     type IOptions = nconf.IOptions;
-    /**
-     * Get the filename from the import.meta.url
-     */
-    export const __filename: string;
-    /**
-     * Get the directory name from the filename
-     */
-    export const __dirname: string;
     /**
      * Change working directory to output of workingDirectory()
      */
@@ -477,7 +479,7 @@ declare module "src/inputs" {
      * Type alias for Provider instance
      */
     type ProviderInstance = InstanceType<typeof Provider>;
-    export function transformGitHubInputsToArgv(log: LogTask, config: ProviderInstance, obj: KVPairType): undefined | KVPairType;
+    export function transformGitHubInputsToArgv(log: LogTask, _config: ProviderInstance, obj: KVPairType): undefined | KVPairType;
     /**
      * Sets config value from action file default
      *
@@ -604,9 +606,7 @@ declare module "src/helpers" {
     import type { Context } from '@actions/github/lib/context.js';
     import type Inputs from "src/inputs";
     import LogTask from "src/logtask/index";
-    import { Nullable } from "src/util";
-    export const __filename: string;
-    export const __dirname: string;
+    import { type Nullable } from "src/util";
     /**
      * Returns the input value if it is not empty, otherwise returns undefined.
      * @param value - The input value to check.
@@ -661,9 +661,10 @@ declare module "src/helpers" {
      * Finds the repository information from the input, context, environment variables, or git configuration.
      * @param inputRepo - The input repository string.
      * @param context - The GitHub context object.
+     * @param baseDir - Optional base directory to look for .git/config (defaults to CWD).
      * @returns The repository information (owner and repo) or null if not found.
      */
-    export function repositoryFinder(inputRepo: Nullable<string>, context: Nullable<Context>): Repo | null;
+    export function repositoryFinder(inputRepo: Nullable<string>, context: Nullable<Context>, baseDir?: string): Repo | null;
     /**
      * Returns the default branch of the git repository.
      * @returns The default branch.
@@ -692,89 +693,17 @@ declare module "src/helpers" {
     export function getCurrentVersionString(inputs: Inputs): string;
     export function indexOfRegex(str: string, providedRegex: RegExp): number;
     export function lastIndexOfRegex(str: string, providedRegex: RegExp): number;
-    export function isObject(value: any): value is object;
-}
-declare module "__tests__/helpers.test" {
-    export const __filename: string;
-    export const __dirname: string;
-}
-declare module "__tests__/inputs.test" {
-    export const __filename: string;
-    export const __dirname: string;
-}
-declare module "__tests__/integration-issue-335.test" { }
-declare module "src/markdowner/index" {
-    /**
-     * Types representing a 2D array of strings for a Markdown table.
-     */
-    export type MarkdownArrayRowType = string[][];
-    export type MarkdownArrayItemType = string;
-    /**
-     * Fills a string to a desired width by padding with spaces.
-     *
-     * @param text - The text to pad.
-     * @param width - The desired total width.
-     * @param paddingStart - Number of spaces to pad at the start.
-     * @returns The padded string.
-     */
-    export function padString(text: string, width: number, paddingStart: number): string;
-    /**
-     * Escapes special Markdown characters in a string.
-     *
-     * @param text - The text to escape.
-     * @returns The escaped text.
-     */
-    export function markdownEscapeTableCell(text: string): string;
-    /**
-     * Escapes inline code blocks in a Markdown string.
-     *
-     * @param content - Markdown string.
-     * @returns String with escaped inline code blocks.
-     */
-    export function markdownEscapeInlineCode(content: string): string;
-    /**
-     * Clones a 2D array.
-     *
-     * @param arr - Array to clone.
-     * @returns Cloned array.
-     */
-    export function cloneArray(arr: MarkdownArrayRowType): MarkdownArrayRowType;
-    /**
-     * Gets max and min column counts from 2D array.
-     *
-     * @param data - 2D string array.
-     * @returns Object with max and min cols.
-     */
-    export function getColumnCounts(data: MarkdownArrayRowType): {
-        maxCols: number;
-        minCols: number;
-    };
-    /**
-     * Pads 2D array rows to equal length.
-     *
-     * @param data - 2D array to pad.
-     * @param maxCols - Number of columns to pad to.
-     * @returns Padded 2D array.
-     */
-    export function padArrayRows(data: MarkdownArrayRowType, maxCols: number): MarkdownArrayRowType;
-    /**
-     * Converts a 2D array of strings to a Markdown table.
-     *
-     * @param data - 2D string array.
-     * @returns Markdown table string.
-     */
-    export function ArrayOfArraysToMarkdownTable(providedTableContent: MarkdownArrayRowType): string;
-    export default ArrayOfArraysToMarkdownTable;
+    export function isObject(value: unknown): value is object;
 }
-declare module "__tests__/markdowner.test" { }
-declare module "__tests__/prettier.test" { }
+declare module "__tests__/helpers.test" { }
+declare module "__tests__/inputs.test" { }
 declare module "src/sections/update-badges" {
     /**
      * This TypeScript code imports necessary modules and defines a function named 'updateBadges' which takes a sectionToken (ReadmeSection) and an instance of the 'Inputs' class as its parameters.
      * The function is responsible for updating the badges section in the README.md file based on the provided inputs.
      * It utilizes the 'LogTask' class for logging purposes.
      */
-    import { ReadmeSection } from "src/constants";
+    import type { ReadmeSection } from "src/constants";
     import type Inputs from "src/inputs";
     /**
      * Interface for a badge.
@@ -804,7 +733,7 @@ declare module "src/svg-editor" {
         /**
          * Initializes the SVG window, document, and canvas if not already set up.
          */
-        initSVG(): Promise<void>;
+        initSVG(): void;
         /**
          * Generates a branded SVG image.
          * @param {string | undefined} svgPath - Path to write the generated SVG file to.
@@ -812,7 +741,7 @@ declare module "src/svg-editor" {
          * @param {Partial<BrandColors>} bgcolor - Background color for the image.
          * @returns {Promise<void>} A promise that resolves when the image is generated.
          */
-        generateSvgImage(svgPath: string | undefined, icon?: Partial<FeatherIconNames>, bgcolor?: Partial<BrandColors>): Promise<void>;
+        generateSvgImage(svgPath: string | undefined, icon?: Partial<FeatherIconNames>, bgcolor?: Partial<BrandColors>): void;
         /**
          * Writes the SVG xml to disk.
          * @param {string} svgPath - File path to save the SVG to.
@@ -832,7 +761,7 @@ declare module "src/svg-editor" {
 declare module "src/sections/update-branding" {
     import type { FeatherIconNames } from 'feather-icons';
     import type { BrandColors } from "src/constants";
-    import { ReadmeSection } from "src/constants";
+    import { type ReadmeSection } from "src/constants";
     import type Inputs from "src/inputs";
     export interface IBranding {
         alt: string;
@@ -893,7 +822,7 @@ declare module "src/sections/update-contents" {
      * @param {ReadmeSection} sectionToken - The sectionToken representing the section of the README to update.
      * @param {Inputs} inputs - The Inputs class instance.
      */
-    import { ReadmeSection } from "src/constants";
+    import type { ReadmeSection } from "src/constants";
     import type Inputs from "src/inputs";
     export default function updateContents(sectionToken: ReadmeSection, inputs: Inputs): Record<string, string>;
 }
@@ -905,10 +834,73 @@ declare module "src/sections/update-description" {
      * @param {ReadmeSection} sectionToken - The sectionToken representing the section of the README to update.
      * @param {Inputs} inputs - The Inputs class instance.
      */
-    import { ReadmeSection } from "src/constants";
+    import type { ReadmeSection } from "src/constants";
     import type Inputs from "src/inputs";
     export default function updateDescription(sectionToken: ReadmeSection, inputs: Inputs): Record<string, string>;
 }
+declare module "src/markdowner/index" {
+    /**
+     * Types representing a 2D array of strings for a Markdown table.
+     */
+    export type MarkdownArrayRowType = string[][];
+    export type MarkdownArrayItemType = string;
+    /**
+     * Fills a string to a desired width by padding with spaces.
+     *
+     * @param text - The text to pad.
+     * @param width - The desired total width.
+     * @param paddingStart - Number of spaces to pad at the start.
+     * @returns The padded string.
+     */
+    export function padString(text: string, width: number, paddingStart: number): string;
+    /**
+     * Escapes special Markdown characters in a string.
+     *
+     * @param text - The text to escape.
+     * @returns The escaped text.
+     */
+    export function markdownEscapeTableCell(text: string): string;
+    /**
+     * Escapes inline code blocks in a Markdown string.
+     *
+     * @param content - Markdown string.
+     * @returns String with escaped inline code blocks.
+     */
+    export function markdownEscapeInlineCode(content: string): string;
+    /**
+     * Clones a 2D array.
+     *
+     * @param arr - Array to clone.
+     * @returns Cloned array.
+     */
+    export function cloneArray(arr: MarkdownArrayRowType): MarkdownArrayRowType;
+    /**
+     * Gets max and min column counts from 2D array.
+     *
+     * @param data - 2D string array.
+     * @returns Object with max and min cols.
+     */
+    export function getColumnCounts(data: MarkdownArrayRowType): {
+        maxCols: number;
+        minCols: number;
+    };
+    /**
+     * Pads 2D array rows to equal length.
+     *
+     * @param data - 2D array to pad.
+     * @param maxCols - Number of columns to pad to.
+     * @returns Padded 2D array.
+     */
+    export function padArrayRows(data: MarkdownArrayRowType, maxCols: number): MarkdownArrayRowType;
+    /**
+     * Converts a 2D array of strings to a Markdown table.
+     *
+     * @param data - 2D string array.
+     * @returns Markdown table string.
+     */
+    export function ArrayOfArraysToMarkdownTable(providedTableContent: MarkdownArrayRowType): string;
+    export default ArrayOfArraysToMarkdownTable;
+}
 declare module "src/sections/update-inputs" {
     /**
      * This TypeScript code exports a function named 'updateInputs' which takes a sectionToken (ReadmeSection) and an instance of the 'Inputs' class as its parameters.
@@ -917,7 +909,7 @@ declare module "src/sections/update-inputs" {
      * @param {ReadmeSection} sectionToken - The sectionToken representing the section of the README to update.
      * @param {Inputs} inputs - The Inputs class instance.
      */
-    import { ReadmeSection } from "src/constants";
+    import type { ReadmeSection } from "src/constants";
     import type Inputs from "src/inputs";
     export default function updateInputs(sectionToken: ReadmeSection, inputs: Inputs): Record<string, string>;
 }
@@ -930,7 +922,7 @@ declare module "src/sections/update-outputs" {
      * @param {ReadmeSection} sectionToken - The sectionToken used for identifying the section.
      * @param {Inputs} inputs - The Inputs class instance.
      */
-    import { ReadmeSection } from "src/constants";
+    import type { ReadmeSection } from "src/constants";
     import type Inputs from "src/inputs";
     export default function updateOutputs(sectionToken: ReadmeSection, inputs: Inputs): Record<string, string>;
 }
@@ -942,12 +934,12 @@ declare module "src/sections/update-title" {
      * @param {ReadmeSection} sectionToken - The sectionToken representing the section of the README to update.
      * @param {Inputs} inputs - The Inputs class instance.
      */
-    import { ReadmeSection } from "src/constants";
+    import type { ReadmeSection } from "src/constants";
     import type Inputs from "src/inputs";
     export default function updateTitle(sectionToken: ReadmeSection, inputs: Inputs): Record<string, string>;
 }
 declare module "src/sections/update-usage" {
-    import { ReadmeSection } from "src/constants";
+    import type { ReadmeSection } from "src/constants";
     import type Inputs from "src/inputs";
     export default function updateUsage(sectionToken: ReadmeSection, inputs: Inputs): Promise<Record<string, string>>;
 }
@@ -960,14 +952,14 @@ declare module "src/sections/index" {
      * @param {Inputs} inputs - The Inputs class instance.
      * @returns {Promise<void>} A promise that resolves once the section is updated.
      */
-    import { ReadmeSection } from "src/constants";
+    import type { ReadmeSection } from "src/constants";
     import type Inputs from "src/inputs";
     export default function updateSection(section: ReadmeSection, inputs: Inputs): Promise<Record<string, string>>;
 }
 declare module "src/readme-generator" {
-    import { ReadmeSection } from "src/constants";
-    import Inputs from "src/inputs";
-    import LogTask from "src/logtask/index";
+    import type { ReadmeSection } from "src/constants";
+    import type Inputs from "src/inputs";
+    import type LogTask from "src/logtask/index";
     export type SectionKV = Record<string, string>;
     /**
      * Class for managing README generation.
@@ -1016,10 +1008,11 @@ declare module "src/readme-generator" {
         generate(providedSections?: ReadmeSection[]): Promise<void>;
     }
 }
-declare module "__tests__/readme-generator.test" {
-    export const __filename: string;
-    export const __dirname: string;
-}
+declare module "__tests__/integration-external-repo.test" { }
+declare module "__tests__/integration-issue-335.test" { }
+declare module "__tests__/markdowner.test" { }
+declare module "__tests__/prettier.test" { }
+declare module "__tests__/readme-generator.test" { }
 declare module "__tests__/update-contents.test" { }
 declare module "__tests__/logtask/index.test" { }
 declare module "src/config" {
@@ -1066,8 +1059,8 @@ declare module "src/config" {
     }
 }
 declare module "src/save" {
-    import Inputs from "src/inputs";
-    import LogTask from "src/logtask/index";
+    import type Inputs from "src/inputs";
+    import type LogTask from "src/logtask/index";
     /**
      * This script rebuilds the usage section in the README.md to be consistent with the action.yml
      * @param {Inputs} inputs - the inputs class

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "github-action-readme-generator",
   "displayName": "bitflight-devops/github-action-readme-generator",
-  "version": "1.9.2",
+  "version": "1.10.0",
   "description": "The docs generator for GitHub Actions. Auto-syncs action.yml to README.md with 8 sections: inputs, outputs, usage, badges, branding & more. Works as CLI or GitHub Action.",
   "keywords": [
     "github-actions",
@@ -58,14 +58,18 @@
     "commit": "git-cz",
     "corepack": "corepack enable",
     "current-version": "jq -r '.version' package.json",
-    "format": "prettier --write . --config .prettierrc.cjs --ignore-unknown",
+    "format": "biome format --write ./src ./__tests__",
+    "format:check": "biome format ./src ./__tests__",
+    "format:prettier": "prettier --write . --config .prettierrc.cjs --ignore-unknown",
     "generate-docs": "echo 'Generating docs';node dist/bin/index.js && git add README.md ./.github/ghadocs .ghadocs.json || true",
     "postinstall": "echo '✨ Successfully Installed'",
     "prelint": "npm run format && tsc --project tsconfig.json --noemit",
-    "lint": "npm run lint:eslint && npm run lint:markdown",
-    "lint:fix": "npm run lint:eslint:fix && npm run lint:markdown:fix",
-    "lint:eslint": "eslint --color ./src/ ./__tests__/",
-    "lint:eslint:fix": "eslint --color --fix ./src/ ./__tests__/",
+    "lint": "npm run lint:biome && npm run lint:markdown",
+    "lint:fix": "npm run lint:biome:fix && npm run lint:markdown:fix",
+    "lint:biome": "biome lint ./src/ ./__tests__/",
+    "lint:biome:fix": "biome lint --write ./src/ ./__tests__/",
+    "check": "biome check ./src/ ./__tests__/",
+    "check:fix": "biome check --write ./src/ ./__tests__/",
     "markdownlint": "markdownlint",
     "lint:markdown": "markdownlint \"**/*.md\" --config=.markdownlint.json --ignore-path=.markdownlintignore",
     "lint:markdown:fix": "npm run lint:markdown -- --fix",
@@ -100,11 +104,9 @@
     }
   },
   "lint-staged": {
-    "*.{md,json,yaml,yml,sh}": "prettier --write",
-    "{src,__tests__}/**/*.ts": "eslint --cache --fix",
-    "*.{yaml,yml}": [
-      "eslint --cache --fix"
-    ]
+    "*.{md,yaml,yml,sh}": "prettier --write",
+    "{src,__tests__}/**/*.ts": "biome check --write",
+    "*.json": "biome format --write"
   },
   "config": {
     "commitizen": {
@@ -156,25 +158,16 @@
     "yaml": "^2.8.2"
   },
   "devDependencies": {
-    "@babel/core": "^7.28.5",
-    "@babel/eslint-parser": "^7.28.5",
-    "@babel/plugin-proposal-decorators": "^7.28.0",
-    "@babel/preset-env": "^7.26.0",
+    "@biomejs/biome": "2.3.13",
     "@commitlint/cli": "^20.3.1",
     "@commitlint/config-conventional": "^20.3.1",
     "@commitlint/prompt": "^20.3.1",
-    "@eslint-community/eslint-plugin-eslint-comments": "^4.1.0",
     "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/exec": "^6.0.3",
+    "@semantic-release/exec": "^7.1.0",
     "@semantic-release/git": "^10.0.1",
     "@tsconfig/node20": "^20.1.2",
-    "@types/babel__preset-env": "^7",
-    "@types/esm": "^3",
     "@types/nconf": "^0.10.5",
     "@types/node": "^25.0.9",
-    "@types/node-emoji": "^2.1.0",
-    "@typescript-eslint/eslint-plugin": "^8.53.1",
-    "@typescript-eslint/parser": "^8.53.0",
     "@vitest/coverage-v8": "^4.0.18",
     "commitizen": "^4.3.1",
     "conventional-commits": "^1.6.0",
@@ -182,19 +175,6 @@
     "dotenv": "^16.3.1",
     "esbuild": "^0.27.2",
     "esbuild-node-externals": "^1.20.1",
-    "eslint": "^9.39.2",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-import-resolver-typescript": "^4.4.4",
-    "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-n": "^17.23.2",
-    "eslint-plugin-optimize-regex": "^1.2.1",
-    "eslint-plugin-prettier": "^5.5.5",
-    "eslint-plugin-promise": "^7.2.1",
-    "eslint-plugin-simple-import-sort": "^12.1.1",
-    "eslint-plugin-sonarjs": "^3.0.5",
-    "eslint-plugin-sort-class-members": "^1.21.0",
-    "eslint-plugin-unicorn": "^62.0.0",
-    "eslint-plugin-vitest": "^0.5.4",
     "husky": "^9.1.7",
     "is-ci": "^3.0.1",
     "lint-staged": "^16.2.7",
@@ -208,7 +188,7 @@
     "vitest": "^4.0.18"
   },
   "engines": {
-    "node": ">=20.0.0 <26.0.0",
+    "node": ">=20.11.0 <26.0.0",
     "npm": ">=10.0.0"
   },
   "os": [