@tobi-or-not/docpress 0.6.1 → 0.7.1

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

@@ -3,228 +3,93 @@ 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<Pick<import("zod").objectUtil.extendShape<{
-        usernames: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
+    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"]>>>;
-        reposFilter: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        extraHeaderPages: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        extraPublicContent: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        extraTheme: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        forks: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodBoolean>>;
-        vitepressConfig: import("zod").ZodOptional<import("zod").ZodAny>;
-        websiteTitle: import("zod").ZodOptional<import("zod").ZodString>;
-        websiteTagline: import("zod").ZodOptional<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>;
-        usernames: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
-        reposFilter: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
-        extraHeaderPages: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
-        extraPublicContent: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
-        extraTheme: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
+    }, 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>;
-    }>, never>, "strip", import("zod").ZodTypeAny, {}, {}>;
-    fetch: import("zod").ZodEffects<import("zod").ZodObject<Pick<import("zod").objectUtil.extendShape<{
-        usernames: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        branch: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodString>>;
-        gitProvider: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["github"]>>>;
-        reposFilter: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        extraHeaderPages: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        extraPublicContent: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        extraTheme: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        forks: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodBoolean>>;
-        vitepressConfig: import("zod").ZodOptional<import("zod").ZodAny>;
-        websiteTitle: import("zod").ZodOptional<import("zod").ZodString>;
-        websiteTagline: import("zod").ZodOptional<import("zod").ZodString>;
-    }, {
         config: import("zod").ZodOptional<import("zod").ZodString>;
         token: import("zod").ZodOptional<import("zod").ZodString>;
-        usernames: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
-        reposFilter: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
-        extraHeaderPages: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
-        extraPublicContent: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
-        extraTheme: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
-        vitepressConfig: import("zod").ZodOptional<import("zod").ZodString>;
-    }>, "usernames" | "branch" | "gitProvider" | "reposFilter" | "config" | "token">, "strip", import("zod").ZodTypeAny, {
-        usernames?: string[] | undefined;
-        branch?: string | undefined;
-        gitProvider?: "github" | undefined;
-        reposFilter?: string[] | undefined;
-        config?: string | undefined;
-        token?: string | undefined;
-    }, {
-        usernames?: string | undefined;
-        branch?: string | undefined;
-        gitProvider?: "github" | undefined;
-        reposFilter?: string | undefined;
-        config?: string | undefined;
-        token?: string | undefined;
-    }>, {
-        token: string | undefined;
-        usernames: string[];
-        branch?: string | undefined;
-        gitProvider?: "github" | undefined;
-        reposFilter?: string[] | undefined;
-        extraHeaderPages?: string[] | undefined;
-        extraPublicContent?: string[] | undefined;
-        extraTheme?: string[] | undefined;
-        forks?: boolean | undefined;
-        vitepressConfig?: any;
-        websiteTitle?: string | undefined;
-        websiteTagline?: string | undefined;
-    }, {
-        usernames?: string | undefined;
-        branch?: string | undefined;
-        gitProvider?: "github" | undefined;
-        reposFilter?: string | undefined;
-        config?: string | undefined;
-        token?: string | undefined;
-    }>;
-    prepare: import("zod").ZodEffects<import("zod").ZodObject<Pick<import("zod").objectUtil.extendShape<{
-        usernames: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        branch: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodString>>;
-        gitProvider: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodEnum<["github"]>>>;
-        reposFilter: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        extraHeaderPages: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        extraPublicContent: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        extraTheme: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        forks: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodBoolean>>;
-        vitepressConfig: import("zod").ZodOptional<import("zod").ZodAny>;
-        websiteTitle: import("zod").ZodOptional<import("zod").ZodString>;
-        websiteTagline: import("zod").ZodOptional<import("zod").ZodString>;
-    }, {
-        config: import("zod").ZodOptional<import("zod").ZodString>;
-        token: import("zod").ZodOptional<import("zod").ZodString>;
-        usernames: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
-        reposFilter: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
-        extraHeaderPages: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
-        extraPublicContent: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
-        extraTheme: import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>;
-        vitepressConfig: import("zod").ZodOptional<import("zod").ZodString>;
-    }>, "usernames" | "gitProvider" | "reposFilter" | "extraHeaderPages" | "extraPublicContent" | "extraTheme" | "vitepressConfig" | "config" | "token">, "strip", import("zod").ZodTypeAny, {
-        usernames?: string[] | undefined;
-        gitProvider?: "github" | undefined;
-        reposFilter?: string[] | undefined;
-        extraHeaderPages?: string[] | undefined;
-        extraPublicContent?: string[] | undefined;
-        extraTheme?: string[] | undefined;
-        vitepressConfig?: string | undefined;
-        config?: string | undefined;
-        token?: string | undefined;
-    }, {
-        usernames?: string | undefined;
-        gitProvider?: "github" | undefined;
-        reposFilter?: string | undefined;
-        extraHeaderPages?: string | undefined;
-        extraPublicContent?: string | undefined;
-        extraTheme?: string | undefined;
-        vitepressConfig?: string | undefined;
-        config?: string | undefined;
-        token?: string | undefined;
-    }>, {
-        token: string | undefined;
-        usernames: string[];
-        branch?: string | undefined;
-        gitProvider?: "github" | undefined;
-        reposFilter?: string[] | undefined;
-        extraHeaderPages?: string[] | undefined;
-        extraPublicContent?: string[] | undefined;
-        extraTheme?: string[] | undefined;
-        forks?: boolean | undefined;
-        vitepressConfig?: any;
-        websiteTitle?: string | undefined;
-        websiteTagline?: string | undefined;
-    }, {
-        usernames?: string | undefined;
-        gitProvider?: "github" | undefined;
-        reposFilter?: string | undefined;
-        extraHeaderPages?: string | undefined;
-        extraPublicContent?: string | undefined;
-        extraTheme?: string | undefined;
-        vitepressConfig?: string | undefined;
-        config?: string | undefined;
-        token?: string | undefined;
-    }>;
-    global: import("zod").ZodEffects<import("zod").ZodObject<{
+    }, 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"]>>>>;
+        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").ZodEffects<import("zod").ZodString, string[], string>>>;
-        reposFilter: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>>;
-        extraHeaderPages: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>>;
-        extraPublicContent: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>>;
-        extraTheme: import("zod").ZodOptional<import("zod").ZodOptional<import("zod").ZodEffects<import("zod").ZodString, string[], string>>>;
+        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>>;
-    }, "strip", import("zod").ZodTypeAny, {
-        usernames?: string[] | undefined;
+    }, import("zod/v4/core").$strip>, import("zod").ZodTransform<any, {
         branch?: string | undefined;
         gitProvider?: "github" | undefined;
-        reposFilter?: string[] | undefined;
-        extraHeaderPages?: string[] | undefined;
-        extraPublicContent?: string[] | undefined;
-        extraTheme?: string[] | undefined;
         forks?: boolean | undefined;
-        vitepressConfig?: string | undefined;
         websiteTitle?: string | undefined;
         websiteTagline?: string | undefined;
         config?: string | undefined;
         token?: string | undefined;
-    }, {
-        usernames?: string | undefined;
-        branch?: string | undefined;
-        gitProvider?: "github" | undefined;
-        reposFilter?: string | undefined;
-        extraHeaderPages?: string | undefined;
-        extraPublicContent?: string | undefined;
-        extraTheme?: string | undefined;
-        forks?: boolean | undefined;
-        vitepressConfig?: string | undefined;
-        websiteTitle?: string | undefined;
-        websiteTagline?: string | undefined;
-        config?: string | undefined;
-        token?: string | undefined;
-    }>, {
-        token: string | undefined;
-        usernames: string[];
-        branch?: string | undefined;
-        gitProvider?: "github" | undefined;
+        usernames?: string[] | undefined;
         reposFilter?: string[] | undefined;
         extraHeaderPages?: string[] | undefined;
         extraPublicContent?: string[] | undefined;
         extraTheme?: string[] | undefined;
-        forks?: boolean | undefined;
-        vitepressConfig?: any;
-        websiteTitle?: string | undefined;
-        websiteTagline?: string | undefined;
-    }, {
-        usernames?: string | undefined;
-        branch?: string | undefined;
-        gitProvider?: "github" | undefined;
-        reposFilter?: string | undefined;
-        extraHeaderPages?: string | undefined;
-        extraPublicContent?: string | undefined;
-        extraTheme?: string | undefined;
-        forks?: boolean | undefined;
         vitepressConfig?: string | undefined;
-        websiteTitle?: string | undefined;
-        websiteTagline?: string | undefined;
-        config?: string | undefined;
-        token?: string | undefined;
-    }>;
+    }>>;
 };
-export declare function parseOptions<T extends Cmd>(cmd: T, opts: Options[T]): Options[T];
+/**
+ * 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,10 +1,40 @@
+/**
+ * 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,26 +1,116 @@
 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[];
 export {};

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

@@ -1,4 +1,14 @@
 import type { ColorName } from 'chalk';
+/**
+ * Log message types
+ */
 type LogType = keyof Pick<Console, 'info' | 'warn' | 'error' | 'debug' | 'trace'> | 'success';
+/**
+ * Logs a message with color formatting based on type and level
+ *
+ * @param msg - Message to log
+ * @param type - Type of log message (info, warn, error, debug, trace, success)
+ * @param color - Optional specific color to use instead of the default for the type
+ */
 export declare function log(msg: string, type?: LogType, color?: ColorName): void;
 export {};

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

@@ -1,2 +1,14 @@
+/**
+ * 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;

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

@@ -1 +1,7 @@
+/**
+ * Generates a file by copying content from source to destination
+ *
+ * @param src - Path to the source file
+ * @param dest - Path to the destination file
+ */
 export declare function generateFile(src: string, dest: string): void;