@tobi-or-not/docpress 0.8.2 → 0.9.0

package/types/commands/prepare.d.ts

@@ -1,4 +0,0 @@
-import type { PrepareOpts } from '../schemas/prepare.js';
-export declare const prepareOpts: import("commander").Option[];
-export declare const prepareCmd: import("commander").Command;
-export declare function main(opts: PrepareOpts): Promise<void>;

package/types/lib/fetch.d.ts

@@ -1,120 +0,0 @@
-import type { GlobalOpts } from '../schemas/global.js';
-import type { FetchOpts } from '../schemas/fetch.js';
-import { getInfos } from './git.js';
-export type EnhancedRepository = Awaited<ReturnType<typeof getInfos>>['repos'][number] & {
-    docpress: {
-        branch: string;
-        filtered: boolean;
-        includes: string[];
-        projectPath: string;
-        raw_url: string;
-        replace_url: string;
-    };
-};
-export declare function checkDoc(repoOwner: GlobalOpts['username'], repoName: string, branch: FetchOpts['branch']): Promise<{
-    rootReadmeStatus: number;
-    docsFolderStatus: number;
-    docsReadmeStatus: number;
-}>;
-export declare function fetchDoc({ username, branch, reposFilter, token }: FetchOpts): Promise<void>;
-export declare function enhanceRepositories(repos: Awaited<ReturnType<typeof getInfos>>['repos'], branch?: FetchOpts['branch'], reposFilter?: FetchOpts['reposFilter']): Promise<EnhancedRepository[]>;
-export declare function getSparseCheckout(repo: Awaited<ReturnType<typeof getInfos>>['repos'][number], branch: FetchOpts['branch']): Promise<string[]>;
-export declare function generateInfos(user: Awaited<ReturnType<typeof getInfos>>['user'], repos: Awaited<ReturnType<typeof getInfos>>['repos'], branch?: FetchOpts['branch'], reposFilter?: FetchOpts['reposFilter']): Promise<{
-    user: {
-        login: string;
-        id: number;
-        node_id: string;
-        avatar_url: string;
-        gravatar_id: string | null;
-        url: string;
-        html_url: string;
-        followers_url: string;
-        following_url: string;
-        gists_url: string;
-        starred_url: string;
-        subscriptions_url: string;
-        organizations_url: string;
-        repos_url: string;
-        events_url: string;
-        received_events_url: string;
-        type: string;
-        site_admin: boolean;
-        name: string | null;
-        company: string | null;
-        blog: string | null;
-        location: string | null;
-        email: string | null;
-        hireable: boolean | null;
-        bio: string | null;
-        twitter_username?: string | null;
-        public_repos: number;
-        public_gists: number;
-        followers: number;
-        following: number;
-        created_at: string;
-        updated_at: string;
-        private_gists: number;
-        total_private_repos: number;
-        owned_private_repos: number;
-        disk_usage: number;
-        collaborators: number;
-        two_factor_authentication: boolean;
-        plan?: {
-            collaborators: number;
-            name: string;
-            space: number;
-            private_repos: number;
-        };
-        suspended_at?: string | null;
-        business_plus?: boolean;
-        ldap_dn?: string;
-    } | {
-        login: string;
-        id: number;
-        node_id: string;
-        avatar_url: string;
-        gravatar_id: string | null;
-        url: string;
-        html_url: string;
-        followers_url: string;
-        following_url: string;
-        gists_url: string;
-        starred_url: string;
-        subscriptions_url: string;
-        organizations_url: string;
-        repos_url: string;
-        events_url: string;
-        received_events_url: string;
-        type: string;
-        site_admin: boolean;
-        name: string | null;
-        company: string | null;
-        blog: string | null;
-        location: string | null;
-        email: string | null;
-        hireable: boolean | null;
-        bio: string | null;
-        twitter_username?: string | null;
-        public_repos: number;
-        public_gists: number;
-        followers: number;
-        following: number;
-        created_at: string;
-        updated_at: string;
-        plan?: {
-            collaborators: number;
-            name: string;
-            space: number;
-            private_repos: number;
-        };
-        suspended_at?: string | null;
-        private_gists?: number;
-        total_private_repos?: number;
-        owned_private_repos?: number;
-        disk_usage?: number;
-        collaborators?: number;
-    };
-    repos: EnhancedRepository[];
-}>;
-export declare function getDoc(repos?: EnhancedRepository[], reposFilter?: FetchOpts['reposFilter']): Promise<void>;
-export declare function isRepoFiltered(repo: EnhancedRepository | Awaited<ReturnType<typeof getInfos>>['repos'][number], reposFilter?: FetchOpts['reposFilter']): boolean;

package/types/lib/git.d.ts

@@ -1,515 +0,0 @@
-import type { GlobalOpts } from '../schemas/global.js';
-import type { FetchOpts } from '../schemas/fetch.js';
-import type { EnhancedRepository } from './fetch.js';
-export declare function getInfos({ username, token, branch }: Pick<FetchOpts, 'branch'> & Pick<GlobalOpts, 'token'> & Required<Pick<GlobalOpts, 'username'>>): Promise<{
-    user: {
-        login: string;
-        id: number;
-        node_id: string;
-        avatar_url: string;
-        gravatar_id: string | null;
-        url: string;
-        html_url: string;
-        followers_url: string;
-        following_url: string;
-        gists_url: string;
-        starred_url: string;
-        subscriptions_url: string;
-        organizations_url: string;
-        repos_url: string;
-        events_url: string;
-        received_events_url: string;
-        type: string;
-        site_admin: boolean;
-        name: string | null;
-        company: string | null;
-        blog: string | null;
-        location: string | null;
-        email: string | null;
-        hireable: boolean | null;
-        bio: string | null;
-        twitter_username?: string | null;
-        public_repos: number;
-        public_gists: number;
-        followers: number;
-        following: number;
-        created_at: string;
-        updated_at: string;
-        private_gists: number;
-        total_private_repos: number;
-        owned_private_repos: number;
-        disk_usage: number;
-        collaborators: number;
-        two_factor_authentication: boolean;
-        plan?: {
-            collaborators: number;
-            name: string;
-            space: number;
-            private_repos: number;
-        };
-        suspended_at?: string | null;
-        business_plus?: boolean;
-        ldap_dn?: string;
-    } | {
-        login: string;
-        id: number;
-        node_id: string;
-        avatar_url: string;
-        gravatar_id: string | null;
-        url: string;
-        html_url: string;
-        followers_url: string;
-        following_url: string;
-        gists_url: string;
-        starred_url: string;
-        subscriptions_url: string;
-        organizations_url: string;
-        repos_url: string;
-        events_url: string;
-        received_events_url: string;
-        type: string;
-        site_admin: boolean;
-        name: string | null;
-        company: string | null;
-        blog: string | null;
-        location: string | null;
-        email: string | null;
-        hireable: boolean | null;
-        bio: string | null;
-        twitter_username?: string | null;
-        public_repos: number;
-        public_gists: number;
-        followers: number;
-        following: number;
-        created_at: string;
-        updated_at: string;
-        plan?: {
-            collaborators: number;
-            name: string;
-            space: number;
-            private_repos: number;
-        };
-        suspended_at?: string | null;
-        private_gists?: number;
-        total_private_repos?: number;
-        owned_private_repos?: number;
-        disk_usage?: number;
-        collaborators?: number;
-    };
-    repos: {
-        id: number;
-        node_id: string;
-        name: string;
-        full_name: string;
-        owner: {
-            name?: string | null;
-            email?: string | null;
-            login: string;
-            id: number;
-            node_id: string;
-            avatar_url: string;
-            gravatar_id: string | null;
-            url: string;
-            html_url: string;
-            followers_url: string;
-            following_url: string;
-            gists_url: string;
-            starred_url: string;
-            subscriptions_url: string;
-            organizations_url: string;
-            repos_url: string;
-            events_url: string;
-            received_events_url: string;
-            type: string;
-            site_admin: boolean;
-            starred_at?: string;
-        };
-        private: boolean;
-        html_url: string;
-        description: string | null;
-        fork: boolean;
-        url: string;
-        archive_url: string;
-        assignees_url: string;
-        blobs_url: string;
-        branches_url: string;
-        collaborators_url: string;
-        comments_url: string;
-        commits_url: string;
-        compare_url: string;
-        contents_url: string;
-        contributors_url: string;
-        deployments_url: string;
-        downloads_url: string;
-        events_url: string;
-        forks_url: string;
-        git_commits_url: string;
-        git_refs_url: string;
-        git_tags_url: string;
-        git_url?: string;
-        issue_comment_url: string;
-        issue_events_url: string;
-        issues_url: string;
-        keys_url: string;
-        labels_url: string;
-        languages_url: string;
-        merges_url: string;
-        milestones_url: string;
-        notifications_url: string;
-        pulls_url: string;
-        releases_url: string;
-        ssh_url?: string;
-        stargazers_url: string;
-        statuses_url: string;
-        subscribers_url: string;
-        subscription_url: string;
-        tags_url: string;
-        teams_url: string;
-        trees_url: string;
-        clone_url?: string;
-        mirror_url?: string | null;
-        hooks_url: string;
-        svn_url?: string;
-        homepage?: string | null;
-        language?: string | null;
-        forks_count?: number;
-        stargazers_count?: number;
-        watchers_count?: number;
-        size?: number;
-        default_branch?: string;
-        open_issues_count?: number;
-        is_template?: boolean;
-        topics?: string[];
-        has_issues?: boolean;
-        has_projects?: boolean;
-        has_wiki?: boolean;
-        has_pages?: boolean;
-        has_downloads?: boolean;
-        has_discussions?: boolean;
-        archived?: boolean;
-        disabled?: boolean;
-        visibility?: string;
-        pushed_at?: string | null;
-        created_at?: string | null;
-        updated_at?: string | null;
-        permissions?: {
-            admin?: boolean;
-            maintain?: boolean;
-            push?: boolean;
-            triage?: boolean;
-            pull?: boolean;
-        };
-        role_name?: string;
-        temp_clone_token?: string;
-        delete_branch_on_merge?: boolean;
-        subscribers_count?: number;
-        network_count?: number;
-        code_of_conduct?: {
-            key: string;
-            name: string;
-            url: string;
-            body?: string;
-            html_url: string | null;
-        };
-        license?: {
-            key?: string;
-            name?: string;
-            spdx_id?: string;
-            url?: string;
-            node_id?: string;
-        } | null;
-        forks?: number;
-        open_issues?: number;
-        watchers?: number;
-        allow_forking?: boolean;
-        web_commit_signoff_required?: boolean;
-        security_and_analysis?: {
-            advanced_security?: {
-                status?: "enabled" | "disabled";
-            };
-            dependabot_security_updates?: {
-                status?: "enabled" | "disabled";
-            };
-            secret_scanning?: {
-                status?: "enabled" | "disabled";
-            };
-            secret_scanning_push_protection?: {
-                status?: "enabled" | "disabled";
-            };
-        } | null;
-    }[];
-    branch: string | undefined;
-}>;
-export declare function getContributors({ repository, token, }: {
-    repository: EnhancedRepository;
-    token: GlobalOpts['token'];
-}): Promise<{
-    source: {
-        id: number;
-        node_id: string;
-        name: string;
-        full_name: string;
-        license: {
-            key: string;
-            name: string;
-            url: string | null;
-            spdx_id: string | null;
-            node_id: string;
-            html_url?: string;
-        } | null;
-        forks: number;
-        permissions?: {
-            admin: boolean;
-            pull: boolean;
-            triage?: boolean;
-            push: boolean;
-            maintain?: boolean;
-        };
-        owner: {
-            name?: string | null;
-            email?: string | null;
-            login: string;
-            id: number;
-            node_id: string;
-            avatar_url: string;
-            gravatar_id: string | null;
-            url: string;
-            html_url: string;
-            followers_url: string;
-            following_url: string;
-            gists_url: string;
-            starred_url: string;
-            subscriptions_url: string;
-            organizations_url: string;
-            repos_url: string;
-            events_url: string;
-            received_events_url: string;
-            type: string;
-            site_admin: boolean;
-            starred_at?: string;
-        };
-        private: boolean;
-        html_url: string;
-        description: string | null;
-        fork: boolean;
-        url: string;
-        archive_url: string;
-        assignees_url: string;
-        blobs_url: string;
-        branches_url: string;
-        collaborators_url: string;
-        comments_url: string;
-        commits_url: string;
-        compare_url: string;
-        contents_url: string;
-        contributors_url: string;
-        deployments_url: string;
-        downloads_url: string;
-        events_url: string;
-        forks_url: string;
-        git_commits_url: string;
-        git_refs_url: string;
-        git_tags_url: string;
-        git_url: string;
-        issue_comment_url: string;
-        issue_events_url: string;
-        issues_url: string;
-        keys_url: string;
-        labels_url: string;
-        languages_url: string;
-        merges_url: string;
-        milestones_url: string;
-        notifications_url: string;
-        pulls_url: string;
-        releases_url: string;
-        ssh_url: string;
-        stargazers_url: string;
-        statuses_url: string;
-        subscribers_url: string;
-        subscription_url: string;
-        tags_url: string;
-        teams_url: string;
-        trees_url: string;
-        clone_url: string;
-        mirror_url: string | null;
-        hooks_url: string;
-        svn_url: string;
-        homepage: string | null;
-        language: string | null;
-        forks_count: number;
-        stargazers_count: number;
-        watchers_count: number;
-        size: number;
-        default_branch: string;
-        open_issues_count: number;
-        is_template?: boolean;
-        topics?: string[];
-        has_issues: boolean;
-        has_projects: boolean;
-        has_wiki: boolean;
-        has_pages: boolean;
-        has_downloads: boolean;
-        has_discussions?: boolean;
-        archived: boolean;
-        disabled: boolean;
-        visibility?: string;
-        pushed_at: string | null;
-        created_at: string | null;
-        updated_at: string | null;
-        allow_rebase_merge?: boolean;
-        temp_clone_token?: string;
-        allow_squash_merge?: boolean;
-        allow_auto_merge?: boolean;
-        delete_branch_on_merge?: boolean;
-        allow_update_branch?: boolean;
-        use_squash_pr_title_as_default?: boolean;
-        squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
-        squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
-        merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
-        merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
-        allow_merge_commit?: boolean;
-        allow_forking?: boolean;
-        web_commit_signoff_required?: boolean;
-        open_issues: number;
-        watchers: number;
-        master_branch?: string;
-        starred_at?: string;
-        anonymous_access_enabled?: boolean;
-    } | undefined;
-    contributors: never[];
-} | {
-    source: {
-        id: number;
-        node_id: string;
-        name: string;
-        full_name: string;
-        license: {
-            key: string;
-            name: string;
-            url: string | null;
-            spdx_id: string | null;
-            node_id: string;
-            html_url?: string;
-        } | null;
-        forks: number;
-        permissions?: {
-            admin: boolean;
-            pull: boolean;
-            triage?: boolean;
-            push: boolean;
-            maintain?: boolean;
-        };
-        owner: {
-            name?: string | null;
-            email?: string | null;
-            login: string;
-            id: number;
-            node_id: string;
-            avatar_url: string;
-            gravatar_id: string | null;
-            url: string;
-            html_url: string;
-            followers_url: string;
-            following_url: string;
-            gists_url: string;
-            starred_url: string;
-            subscriptions_url: string;
-            organizations_url: string;
-            repos_url: string;
-            events_url: string;
-            received_events_url: string;
-            type: string;
-            site_admin: boolean;
-            starred_at?: string;
-        };
-        private: boolean;
-        html_url: string;
-        description: string | null;
-        fork: boolean;
-        url: string;
-        archive_url: string;
-        assignees_url: string;
-        blobs_url: string;
-        branches_url: string;
-        collaborators_url: string;
-        comments_url: string;
-        commits_url: string;
-        compare_url: string;
-        contents_url: string;
-        contributors_url: string;
-        deployments_url: string;
-        downloads_url: string;
-        events_url: string;
-        forks_url: string;
-        git_commits_url: string;
-        git_refs_url: string;
-        git_tags_url: string;
-        git_url: string;
-        issue_comment_url: string;
-        issue_events_url: string;
-        issues_url: string;
-        keys_url: string;
-        labels_url: string;
-        languages_url: string;
-        merges_url: string;
-        milestones_url: string;
-        notifications_url: string;
-        pulls_url: string;
-        releases_url: string;
-        ssh_url: string;
-        stargazers_url: string;
-        statuses_url: string;
-        subscribers_url: string;
-        subscription_url: string;
-        tags_url: string;
-        teams_url: string;
-        trees_url: string;
-        clone_url: string;
-        mirror_url: string | null;
-        hooks_url: string;
-        svn_url: string;
-        homepage: string | null;
-        language: string | null;
-        forks_count: number;
-        stargazers_count: number;
-        watchers_count: number;
-        size: number;
-        default_branch: string;
-        open_issues_count: number;
-        is_template?: boolean;
-        topics?: string[];
-        has_issues: boolean;
-        has_projects: boolean;
-        has_wiki: boolean;
-        has_pages: boolean;
-        has_downloads: boolean;
-        has_discussions?: boolean;
-        archived: boolean;
-        disabled: boolean;
-        visibility?: string;
-        pushed_at: string | null;
-        created_at: string | null;
-        updated_at: string | null;
-        allow_rebase_merge?: boolean;
-        temp_clone_token?: string;
-        allow_squash_merge?: boolean;
-        allow_auto_merge?: boolean;
-        delete_branch_on_merge?: boolean;
-        allow_update_branch?: boolean;
-        use_squash_pr_title_as_default?: boolean;
-        squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
-        squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
-        merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
-        merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
-        allow_merge_commit?: boolean;
-        allow_forking?: boolean;
-        web_commit_signoff_required?: boolean;
-        open_issues: number;
-        watchers: number;
-        master_branch?: string;
-        starred_at?: string;
-        anonymous_access_enabled?: boolean;
-    };
-    contributors: any[];
-}>;
-export declare function cloneRepo(name: string, url: string, projectDir: string, branch: string, includes: string[]): Promise<void>;

package/types/lib/prepare.d.ts

@@ -1,62 +0,0 @@
-import type { defineConfig } from 'vitepress';
-import type { GlobalOpts } from '../schemas/global.js';
-import type { getUserInfos } from '../utils/functions.js';
-import type { EnhancedRepository } from './fetch.js';
-import type { getInfos } from './git.js';
-export interface Page {
-    text: string;
-    link: string;
-}
-export interface SidebarProject {
-    text: string;
-    collapsed: boolean;
-    items: Page[];
-}
-export interface Feature {
-    title: string;
-    details: string;
-    link: string;
-}
-export interface Index {
-    layout: string;
-    hero: {
-        name: string;
-        tagline: string;
-    };
-    features: Feature[];
-}
-export declare function generateIndex(features: Feature[], user: ReturnType<typeof getUserInfos>): {
-    layout: string;
-    hero: {
-        name: string;
-        tagline: string;
-    };
-    features: Feature[];
-};
-export declare function generateFeatures(repoName: string, description: string, features?: Feature[]): Feature[];
-export declare function generateSidebarProject(repoName: string, sidebarPages: Page[]): {
-    text: string;
-    collapsed: boolean;
-    items: Page[];
-};
-export declare function generateSidebarPages(repoName: string, fileName: string, sidebarPages?: Page[]): Page[];
-export declare function transformDoc(repositories: EnhancedRepository[], user: ReturnType<typeof getUserInfos>): {
-    sidebar: SidebarProject[];
-    index: {
-        layout: string;
-        hero: {
-            name: string;
-            tagline: string;
-        };
-        features: Feature[];
-    };
-};
-export declare function addExtraPages(paths: string[]): Page[];
-export declare function addContent(paths: string | string[], dir: string, fn?: () => void): void;
-export declare function addForkPage(forks: {
-    repository: Awaited<ReturnType<typeof getInfos>>['repos'][number];
-    contributions: number;
-}[]): void;
-export declare function processForks(repositories: EnhancedRepository[], username: GlobalOpts['username'], token?: GlobalOpts['token']): Promise<void>;
-export declare function parseVitepressConfig(path: string): any;
-export declare function generateVitepressFiles(vitepressConfig: Partial<ReturnType<typeof defineConfig>>, index: Index): void;

package/types/lib/vitepress.d.ts

@@ -1,3 +0,0 @@
-import type { defineConfig } from 'vitepress';
-import type { Page, SidebarProject } from './prepare.js';
-export declare function getVitepressConfig(sidebar: SidebarProject[], nav: Page[], vitepressConfig?: ReturnType<typeof defineConfig>): Partial<ReturnType<typeof defineConfig>>;