github-action-readme-generator/dist/mjs/constants.d.ts

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.

/**
 * Represents the Feather icon names.
 */
import type { FeatherIconNames } from 'feather-icons';
/**
 * Represents the sections of the README.
 */
export declare const README_SECTIONS: readonly ["title", "branding", "description", "usage", "inputs", "outputs", "contents", "badges"];
/**
 * Represents a single section of the README.
 */
export type ReadmeSection = (typeof README_SECTIONS)[number];
/**
 * Represents the file name for the configuration file.
 */
export declare const configFileName = ".ghadocs.json";
/**
 * Enumerates the keys for the configuration options.
 */
/**
 * Valid version source options for determining action version.
 */
export declare 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 declare function isValidVersionSource(value: string): value is VersionSource;
export declare enum ConfigKeys {
    Owner = "owner",
    Repo = "repo",
    TitlePrefix = "title_prefix",
    Prettier = "prettier",
    Save = "save",
    pathsAction = "paths:action",
    pathsReadme = "paths:readme",
    BrandingSvgPath = "branding_svg_path",
    BrandingAsTitlePrefix = "branding_as_title_prefix",
    VersioningEnabled = "versioning:enabled",
    VersioningOverride = "versioning:override",
    VersioningPrefix = "versioning:prefix",
    VersioningBranch = "versioning:branch",
    VersioningSource = "versioning:source",
    IncludeGithubVersionBadge = "versioning:badge",
    DebugNconf = "debug:nconf",
    DebugReadme = "debug:readme",
    DebugConfig = "debug:config",
    DebugAction = "debug:action",
    DebugGithub = "debug:github"
}
/**
 * Represents the edge length (in pixels) for the branding square.
 */
export declare const brandingSquareEdgeLengthInPixels = 50;
/**
 * Represents the default brand color.
 */
export declare const DEFAULT_BRAND_COLOR = "blue";
/**
 * Represents the default brand icon.
 */
export declare const DEFAULT_BRAND_ICON = "activity";
/**
 * Represents the markup for center alignment.
 */
export declare const ALIGNMENT_MARKUP = "<div align=\"center\">";
/**
 * Represents the set of icons that are omitted in GitHub Actions branding.
 */
export declare const GITHUB_ACTIONS_OMITTED_ICONS: Set<string>;
/**
 * Represents the set of icons available for GitHub Actions branding.
 */
export declare const GITHUB_ACTIONS_BRANDING_ICONS: Set<string>;
/**
 * Represents the available colors for GitHub Actions branding.
 */
export declare const GITHUB_ACTIONS_BRANDING_COLORS: readonly ["white", "yellow", "blue", "green", "orange", "red", "purple", "gray-dark"];
/**
 * Represents the available brand colors.
 */
export type BrandColors = (typeof GITHUB_ACTIONS_BRANDING_COLORS)[number];
/**
 * Checks if the given icon is valid for GitHub Actions branding.
 * @param {Partial<FeatherIconNames>} icon - The icon to validate.
 * @returns A boolean indicating if the icon is valid.
 */
export declare function isValidIcon(icon: Partial<FeatherIconNames>): icon is FeatherIconNames;
/**
 * Checks if the given color is valid for GitHub Actions branding.
 * @param {Partial<BrandColors>} color - The color to validate.
 * @returns A boolean indicating if the color is valid.
 */
export declare function isValidColor(color: Partial<BrandColors>): color is BrandColors;
/**
 * Represents the branding information for the action.
 */
export interface Branding {
    /** Color for the action branding */
    color: Partial<BrandColors>;
    icon: Partial<FeatherIconNames>;
}