@tobi-or-not/docpress 0.8.2 → 0.9.0

package/types/src/lib/prepare.d.ts

@@ -1,214 +0,0 @@
-import type { defineConfig } from 'vitepress';
-import type { PrepareOpts } from '../schemas/prepare.js';
-import type { GlobalOpts } from '../schemas/global.js';
-import { getUserInfos } from '../utils/functions.js';
-import type { EnhancedRepository } from './fetch.js';
-import type { getInfos } from './git.js';
-/**
- * Represents a navigation page item with text and link
- */
-export interface Page {
-    text: string;
-    link: string;
-}
-/**
- * Represents a sidebar project with nested items
- */
-export interface SidebarProject {
-    text: string;
-    collapsed: boolean;
-    items: (Page | SidebarProject)[];
-}
-/**
- * Represents a feature to display on the index page
- */
-export interface Feature {
-    title: string;
-    details: string;
-    link: string;
-}
-/**
- * Represents the structure of the VitePress index page
- */
-export interface Index {
-    layout: string;
-    hero: {
-        name: string;
-        tagline?: string;
-    };
-    /** List of features to display */
-    features: Feature[];
-}
-/**
- * Prepares the documentation structure for a user's repositories
- *
- * @param options - Options for documentation preparation
- * @param options.extraHeaderPages - Array of paths to additional header pages
- * @param options.extraPublicContent - Array of paths to additional public content
- * @param options.extraTheme - Array of paths to additional theme files
- * @param options.vitepressConfig - Path to the VitePress configuration file
- * @param options.forks - Flag to include forked repositories
- * @param options.token - GitHub token for API access
- * @param options.username - GitHub username to fetch repositories for
- * @param options.websiteTitle - Custom title for the documentation website
- * @param options.websiteTagline - Custom tagline for the documentation website
- */
-export declare function prepareDoc({ extraHeaderPages, extraPublicContent, extraTheme, vitepressConfig, forks, token, username, websiteTitle, websiteTagline }: Omit<PrepareOpts, 'usernames' | 'branch' | 'gitProvider' | 'reposFilter'> & {
-    username: PrepareOpts['usernames'][number];
-}): Promise<void>;
-/**
- * Adds a source reference section to a markdown file
- *
- * @param repoUrl - URL of the GitHub repository
- * @param outputPath - Path to the markdown file where sources will be added
- */
-export declare function addSources(repoUrl: string, outputPath: string): void;
-/**
- * Information about website title and tagline
- */
-export interface WebsiteInfos {
-    title?: string;
-    tagline?: string;
-}
-/**
- * Generates the index page content for the documentation site
- *
- * @param features - Array of features to display on the homepage
- * @param user - User information retrieved from GitHub
- * @param websiteInfos - Custom title and tagline information
- * @returns An object with index page configuration
- */
-export declare function generateIndex(features: Feature[], user: ReturnType<typeof getUserInfos>, websiteInfos: WebsiteInfos): {
-    layout: string;
-    hero: {
-        name: string;
-        tagline: string | undefined;
-    };
-    features: Feature[];
-};
-/**
- * Generates feature cards for the homepage
- *
- * @param repoName - Name of the repository
- * @param description - Description of the repository
- * @param features - Optional existing features to append to
- * @returns Array of feature objects for the homepage
- */
-export declare function generateFeatures(repoName: string, description: string, features?: Feature[]): Feature[];
-/**
- * Generates a sidebar project entry for the documentation navigation
- *
- * @param repoName - Name of the repository
- * @param sidebarPages - Array of sidebar pages to include in this project
- * @returns A sidebar project configuration object
- */
-export declare function generateSidebarProject(repoName: string, sidebarPages: (SidebarProject | Page)[]): {
-    text: string;
-    collapsed: boolean;
-    items: (SidebarProject | Page)[];
-};
-/**
- * Generates sidebar page entries for the documentation navigation
- *
- * @param repoName - Name of the repository
- * @param fileName - Name of the file
- * @param sidebarPages - Optional existing sidebar pages to append to
- * @returns Array of page objects for the sidebar
- */
-export declare function generateSidebarPages(repoName: string, fileName: string, sidebarPages?: Page[]): Page[];
-/**
- * Generates sidebar items from a repository's file structure
- *
- * @param repository - Repository information
- * @param obj - Object representing the file tree structure
- * @returns Array of sidebar items (projects and pages)
- */
-export declare function generateSidebarItems(repository: EnhancedRepository, obj: any): (SidebarProject | Page)[];
-/**
- * Builds a tree structure from an array of file paths
- *
- * @param files - Array of file paths to be organized into a tree
- * @returns A nested object representing the directory structure
- */
-export declare function buildTree(files: string[]): any;
-/**
- * Flattens a nested tree structure into an array of file paths
- *
- * @param subtree - The tree object to flatten
- * @param prefix - Optional path prefix to prepend to each result
- * @returns An array of file paths
- */
-export declare function flattenTree(subtree: any, prefix?: string): string[];
-/**
- * Transforms repository data into documentation structure
- *
- * @param repositories - Array of enhanced repositories
- * @param user - User information retrieved from GitHub
- * @param websiteInfos - Custom title and tagline information
- * @returns Object containing sidebar and index page configurations
- */
-export declare function transformDoc(repositories: EnhancedRepository[], user: ReturnType<typeof getUserInfos>, websiteInfos: WebsiteInfos): {
-    sidebar: SidebarProject[];
-    index: {
-        layout: string;
-        hero: {
-            name: string;
-            tagline: string | undefined;
-        };
-        features: Feature[];
-    };
-};
-/**
- * Adds extra pages to the documentation from specified paths
- *
- * @param paths - Array of paths to markdown files
- * @returns Array of navigation page objects
- */
-export declare function addExtraPages(paths: string[]): Page[];
-/**
- * Adds content from specified paths to a target directory
- *
- * @param paths - String or array of paths to content
- * @param dir - Target directory to copy content to
- * @param fn - Optional callback function to execute for each file
- */
-export declare function addContent(paths: string | string[], dir: string, fn?: () => void): void;
-/**
- * Creates a fork page to display external contributions
- *
- * @param forks - Array of repositories and contribution counts
- */
-export declare function addForkPage(forks: {
-    repository: Awaited<ReturnType<typeof getInfos>>['repos'][number];
-    contributions: number;
-}[]): void;
-/**
- * Processes forked repositories to generate contribution information
- *
- * @param repositories - Array of enhanced repositories
- * @param username - GitHub username
- * @param token - Optional GitHub API token
- */
-export declare function processForks(repositories: EnhancedRepository[], username: GlobalOpts['usernames'][number], token?: GlobalOpts['token']): Promise<void>;
-/**
- * Parses a VitePress configuration file
- *
- * @param path - Path to the VitePress config file
- * @returns The parsed configuration object
- */
-export declare function parseVitepressConfig(path: string): Promise<Partial<ReturnType<typeof defineConfig>>>;
-/**
- * Parses a VitePress index file
- *
- * @param path - Path to the index file
- * @returns The parsed index object
- */
-export declare function parseVitepressIndex(path: string): Promise<Index>;
-/**
- * Generates VitePress configuration and index files
- *
- * @param vitepressConfig - VitePress configuration object
- * @param index - Index page configuration
- * @returns The list of theme files that were generated
- */
-export declare function generateVitepressFiles(vitepressConfig: Partial<ReturnType<typeof defineConfig>>, index: Index): void;

package/types/src/lib/vitepress.d.ts

@@ -1,11 +0,0 @@
-import type { defineConfig } from 'vitepress';
-import type { Page, SidebarProject } from './prepare.js';
-/**
- * Generates VitePress configuration by merging default and custom configs
- *
- * @param sidebar - Sidebar configuration
- * @param nav - Navigation configuration
- * @param vitepressConfig - Optional custom VitePress configuration
- * @returns Merged VitePress configuration
- */
-export declare function getVitepressConfig(sidebar: SidebarProject[], nav: Page[], vitepressConfig?: ReturnType<typeof defineConfig>): Partial<ReturnType<typeof defineConfig>>;

package/types/src/schemas/build.d.ts

@@ -1,7 +0,0 @@
-import type { z } from 'zod';
-/**
- * Schema for build command options
- * Currently empty as build doesn't require specific options
- */
-export declare const buildOptsSchema: z.ZodObject<{}, z.core.$strip>;
-export type BuildOpts = z.infer<typeof buildOptsSchema>;

package/types/src/schemas/fetch.d.ts

@@ -1,25 +0,0 @@
-import type { GlobalOpts } from './global.js';
-/**
- * Schema for fetch command options
- * Includes options related to Git repository fetching
- */
-export declare const fetchOptsSchema: import("zod").ZodObject<{
-    usernames: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
-    branch: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodString>>;
-    gitProvider: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<{
-        github: "github";
-    }>>>;
-    reposFilter: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
-    config: import("zod").ZodOptional<import("zod").ZodString>;
-    token: import("zod").ZodOptional<import("zod").ZodString>;
-}, import("zod/v4/core").$strip>;
-/**
- * Type for fetch options
- */
-export type FetchOpts = GlobalOpts;
-/**
- * Type for fetch options with username instead of usernames array
- */
-export type FetchOptsUser = Omit<FetchOpts, 'usernames'> & {
-    username: FetchOpts['usernames'][number];
-};

package/types/src/schemas/global.d.ts

@@ -1,100 +0,0 @@
-import { z } from 'zod';
-/**
- * Schema for the DocPress configuration file
- * Defines the structure and validation rules for the configuration
- */
-export declare const configSchema: z.ZodObject<{
-    usernames: z.ZodArray<z.ZodString>;
-    branch: z.ZodDefault<z.ZodString>;
-    gitProvider: z.ZodDefault<z.ZodEnum<{
-        github: "github";
-    }>>;
-    reposFilter: z.ZodArray<z.ZodString>;
-    extraHeaderPages: z.ZodArray<z.ZodString>;
-    extraPublicContent: z.ZodArray<z.ZodString>;
-    extraTheme: z.ZodArray<z.ZodString>;
-    forks: z.ZodDefault<z.ZodBoolean>;
-    vitepressConfig: z.ZodAny;
-    websiteTitle: z.ZodString;
-    websiteTagline: z.ZodString;
-}, z.core.$strip>;
-export type Config = z.infer<typeof configSchema>;
-/**
- * Base CLI schema for parsing command line arguments
- * All fields are optional in this schema
- */
-export declare const baseCliSchema: z.ZodObject<{
-    branch: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-    gitProvider: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
-        github: "github";
-    }>>>;
-    forks: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-    websiteTitle: z.ZodOptional<z.ZodString>;
-    websiteTagline: z.ZodOptional<z.ZodString>;
-    config: z.ZodOptional<z.ZodString>;
-    token: z.ZodOptional<z.ZodString>;
-    usernames: z.ZodOptional<z.ZodString>;
-    reposFilter: z.ZodOptional<z.ZodString>;
-    extraHeaderPages: z.ZodOptional<z.ZodString>;
-    extraPublicContent: z.ZodOptional<z.ZodString>;
-    extraTheme: z.ZodOptional<z.ZodString>;
-    vitepressConfig: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-export type RawCli = z.infer<typeof baseCliSchema>;
-/**
- * CLI schema with transformations applied to handle string-to-array conversions
- */
-export declare const cliSchema: z.ZodObject<{
-    branch: z.ZodOptional<z.ZodDefault<z.ZodString>>;
-    gitProvider: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
-        github: "github";
-    }>>>;
-    forks: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
-    websiteTitle: z.ZodOptional<z.ZodString>;
-    websiteTagline: z.ZodOptional<z.ZodString>;
-    config: z.ZodOptional<z.ZodString>;
-    token: z.ZodOptional<z.ZodString>;
-    usernames: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>;
-    reposFilter: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>;
-    extraHeaderPages: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>;
-    extraPublicContent: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>;
-    extraTheme: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>;
-    vitepressConfig: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-export type Cli = z.infer<typeof cliSchema>;
-/**
- * Schema for global options that combines CLI arguments and configuration files
- * Applies transformations to merge different config sources and validate the result
- */
-export declare const globalOptsSchema: z.ZodPipe<z.ZodObject<{
-    branch: z.ZodOptional<z.ZodOptional<z.ZodDefault<z.ZodString>>>;
-    gitProvider: z.ZodOptional<z.ZodOptional<z.ZodDefault<z.ZodEnum<{
-        github: "github";
-    }>>>>;
-    forks: z.ZodOptional<z.ZodOptional<z.ZodDefault<z.ZodBoolean>>>;
-    websiteTitle: z.ZodOptional<z.ZodOptional<z.ZodString>>;
-    websiteTagline: z.ZodOptional<z.ZodOptional<z.ZodString>>;
-    config: z.ZodOptional<z.ZodOptional<z.ZodString>>;
-    token: z.ZodOptional<z.ZodOptional<z.ZodString>>;
-    usernames: z.ZodOptional<z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>>;
-    reposFilter: z.ZodOptional<z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>>;
-    extraHeaderPages: z.ZodOptional<z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>>;
-    extraPublicContent: z.ZodOptional<z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>>;
-    extraTheme: z.ZodOptional<z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string[], string>>>>;
-    vitepressConfig: z.ZodOptional<z.ZodOptional<z.ZodString>>;
-}, z.core.$strip>, z.ZodTransform<any, {
-    branch?: string | undefined;
-    gitProvider?: "github" | undefined;
-    forks?: boolean | undefined;
-    websiteTitle?: string | undefined;
-    websiteTagline?: string | undefined;
-    config?: string | undefined;
-    token?: string | undefined;
-    usernames?: string[] | undefined;
-    reposFilter?: string[] | undefined;
-    extraHeaderPages?: string[] | undefined;
-    extraPublicContent?: string[] | undefined;
-    extraTheme?: string[] | undefined;
-    vitepressConfig?: string | undefined;
-}>>;
-export type GlobalOpts = Required<Pick<z.infer<typeof globalOptsSchema>, 'branch' | 'gitProvider'>> & Omit<z.infer<typeof globalOptsSchema>, 'branch' | 'gitProvider'>;

package/types/src/schemas/prepare.d.ts

@@ -1,22 +0,0 @@
-import type { GlobalOpts } from './global.js';
-/**
- * Schema for prepare command options
- * Includes options related to documentation preparation and customization
- */
-export declare const prepareOptsSchema: import("zod").ZodObject<{
-    usernames: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
-    gitProvider: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<{
-        github: "github";
-    }>>>;
-    reposFilter: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
-    extraHeaderPages: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
-    extraPublicContent: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
-    extraTheme: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
-    vitepressConfig: import("zod").ZodOptional<import("zod").ZodString>;
-    config: import("zod").ZodOptional<import("zod").ZodString>;
-    token: import("zod").ZodOptional<import("zod").ZodString>;
-}, import("zod/v4/core").$strip>;
-/**
- * Type for prepare options
- */
-export type PrepareOpts = GlobalOpts;

package/types/src/templates/index.d.ts

@@ -1 +0,0 @@
-export declare function generateFile(src: string, dest: string): void;

package/types/src/templates/theme/index.d.ts

@@ -1,8 +0,0 @@
-declare const _default: {
-    enhanceApp({ app }: import("vitepress").EnhanceAppContext): void;
-    extends: {
-        Layout: import("@vue/runtime-core").DefineComponent;
-        enhanceApp: (ctx: import("vitepress").EnhanceAppContext) => void;
-    };
-};
-export default _default;

package/types/src/utils/commands.d.ts

@@ -1,95 +0,0 @@
-import type { Command, Option } from 'commander';
-import type { GlobalOpts } from '../schemas/global.js';
-import type { BuildOpts } from '../schemas/build.js';
-import type { FetchOpts } from '../schemas/fetch.js';
-import type { PrepareOpts } from '../schemas/prepare.js';
-/**
- * Type definition for command names
- */
-type Cmd = 'fetch' | 'build' | 'prepare' | 'global';
-/**
- * Interface mapping command names to their option types
- */
-interface Options {
-    build: BuildOpts;
-    fetch: FetchOpts;
-    prepare: PrepareOpts;
-    global: GlobalOpts;
-}
-/**
- * Mapping of command names to their schema validators
- */
-export declare const options: {
-    build: import("zod").ZodObject<{}, import("zod/v4/core").$strip>;
-    fetch: import("zod").ZodObject<{
-        usernames: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
-        branch: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodString>>;
-        gitProvider: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<{
-            github: "github";
-        }>>>;
-        reposFilter: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
-        config: import("zod").ZodOptional<import("zod").ZodString>;
-        token: import("zod").ZodOptional<import("zod").ZodString>;
-    }, import("zod/v4/core").$strip>;
-    prepare: import("zod").ZodObject<{
-        usernames: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
-        gitProvider: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<{
-            github: "github";
-        }>>>;
-        reposFilter: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
-        extraHeaderPages: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
-        extraPublicContent: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
-        extraTheme: import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>;
-        vitepressConfig: import("zod").ZodOptional<import("zod").ZodString>;
-        config: import("zod").ZodOptional<import("zod").ZodString>;
-        token: import("zod").ZodOptional<import("zod").ZodString>;
-    }, import("zod/v4/core").$strip>;
-    global: import("zod").ZodPipe<import("zod").ZodObject<{
-        branch: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodString>>>;
-        gitProvider: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<{
-            github: "github";
-        }>>>>;
-        forks: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodBoolean>>>;
-        websiteTitle: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodString>>;
-        websiteTagline: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodString>>;
-        config: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodString>>;
-        token: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodString>>;
-        usernames: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>>;
-        reposFilter: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>>;
-        extraHeaderPages: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>>;
-        extraPublicContent: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>>;
-        extraTheme: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<string[], string>>>>;
-        vitepressConfig: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodString>>;
-    }, import("zod/v4/core").$strip>, import("zod").ZodTransform<any, {
-        branch?: string | undefined;
-        gitProvider?: "github" | undefined;
-        forks?: boolean | undefined;
-        websiteTitle?: string | undefined;
-        websiteTagline?: string | undefined;
-        config?: string | undefined;
-        token?: string | undefined;
-        usernames?: string[] | undefined;
-        reposFilter?: string[] | undefined;
-        extraHeaderPages?: string[] | undefined;
-        extraPublicContent?: string[] | undefined;
-        extraTheme?: string[] | undefined;
-        vitepressConfig?: string | undefined;
-    }>>;
-};
-/**
- * Parses and validates command options based on the command type
- *
- * @param cmd - The command name ('fetch', 'build', 'prepare', or 'global')
- * @param opts - Raw options from the command line
- * @returns Validated and processed options for the specified command
- */
-export declare function parseOptions<T extends Cmd>(cmd: T, opts: Record<string, unknown>): Options[T];
-/**
- * Adds option definitions to a Command instance
- *
- * @param cmd - The Commander Command instance
- * @param opts - Array of option definitions to add
- * @returns The Command instance with options added
- */
-export declare function addOptions(cmd: Command, opts: Option[]): Command;
-export {};

package/types/src/utils/const.d.ts

@@ -1,40 +0,0 @@
-/**
- * Main directory for DocPress files
- */
-export declare const DOCPRESS_DIR: string;
-/**
- * Path to repositories information JSON file
- */
-export declare const USER_REPOS_INFOS: string;
-/**
- * Path to user information JSON file
- */
-export declare const USER_INFOS: string;
-/**
- * Directory for documentation files
- */
-export declare const DOCS_DIR: string;
-/**
- * Path to the main index file
- */
-export declare const INDEX_FILE: string;
-/**
- * Path to the forks documentation file
- */
-export declare const FORKS_FILE: string;
-/**
- * Path to VitePress configuration file
- */
-export declare const VITEPRESS_CONFIG: string;
-/**
- * Directory for VitePress theme
- */
-export declare const VITEPRESS_THEME: string;
-/**
- * Directory for user custom theme files
- */
-export declare const VITEPRESS_USER_THEME: string;
-/**
- * Path to template theme files
- */
-export declare const TEMPLATE_THEME: string;

package/types/src/utils/functions.d.ts

@@ -1,130 +0,0 @@
-import type { GlobalOpts } from '../schemas/global.js';
-import type { EnhancedRepository } from '../lib/fetch.js';
-import type { getInfos } from '../lib/git.js';
-/**
- * Checks the HTTP status code of a URL
- *
- * @param url - URL to check
- * @returns HTTP status code (404 if not found, 500 for errors)
- */
-export declare function checkHttpStatus(url: string): Promise<number>;
-/**
- * Options for prettifying strings
- */
-interface PrettifyOpts {
-    mode?: 'capitalize' | 'uppercase' | 'lowercase';
-    replaceDash?: boolean;
-    removeIdx?: boolean;
-    removeDot?: boolean;
-    removeExt?: boolean;
-}
-/**
- * Formats a string based on specified options
- *
- * @param s - Input string to format
- * @param opts - Formatting options
- * @returns Formatted string
- */
-export declare function prettify(s: string, opts: PrettifyOpts): string;
-/**
- * Creates a directory, optionally cleaning it first
- *
- * @param directory - Path to the directory to create
- * @param options - Options object
- * @param options.clean - Whether to clean the directory before creating it
- */
-export declare function createDir(directory: string, { clean }?: {
-    clean?: boolean;
-}): void;
-/**
- * Checks if a path is a directory
- *
- * @param path - Path to check
- * @returns True if path is a directory, false otherwise
- */
-export declare function isDir(path: string): boolean;
-/**
- * Checks if a path is a file
- *
- * @param path - Path to check
- * @returns True if path is a file, false otherwise
- */
-export declare function isFile(path: string): boolean;
-/**
- * Extracts a list of file paths from directories and files
- *
- * @param paths - Path or array of paths to extract files from
- * @returns Array of file paths
- */
-export declare function extractFiles(paths: string[] | string): string[];
-/**
- * Gets all markdown files from specified paths
- *
- * @param path - Array of paths to search for markdown files
- * @returns Array of markdown file paths
- */
-export declare function getMdFiles(path: string[]): string[];
-/**
- * Formats an array of strings into a readable comma-separated list
- *
- * @param arr - Array of strings to format
- * @returns Formatted string (e.g., "a", "b" or "c")
- */
-export declare function prettifyEnum(arr: readonly string[]): string;
-/**
- * Gets user information from cached JSON file
- *
- * @param username - GitHub username
- * @returns User information object
- */
-export declare function getUserInfos(username: GlobalOpts['usernames'][number]): Awaited<ReturnType<typeof getInfos>>["user"];
-/**
- * Gets repository information from cached JSON file
- *
- * @param username - GitHub username
- * @returns Array of enhanced repository objects
- */
-export declare function getUserRepos(username: GlobalOpts['usernames'][number]): EnhancedRepository[];
-/**
- * Deep merges multiple objects
- *
- * @param objects - Objects to merge
- * @returns Merged object
- */
-export declare function deepMerge<T extends Record<string, any> | null>(...objects: T[]): T;
-/**
- * Checks if a value is an object (not an array or null)
- *
- * @param val - Value to check
- * @returns True if value is an object, false otherwise
- */
-export declare function isObject(val: any): val is object;
-/**
- * Loads and parses a JSON configuration file
- *
- * @param configPath - Path to the configuration file
- * @returns Parsed configuration object or empty object if file doesn't exist
- */
-export declare function loadConfigFile(configPath?: string): any;
-/**
- * Splits a comma-separated string into an array of strings
- *
- * @param s - Comma-separated string
- * @returns Array of strings
- */
-export declare function splitByComma(s: string): string[];
-/**
- * Replaces relative paths in markdown links with absolute URLs
- *
- * @param file - Path to the markdown file to process
- * @param url - Base URL to use for absolute links
- */
-export declare function replaceRelativePath(file: string, url: string): void;
-/**
- * Processes README files to fix various link formats
- *
- * @param file - Path to the README file to process
- * @param url - Base URL to use for absolute links
- */
-export declare function replaceReadmePath(file: string, url: string): void;
-export {};