@tobi-or-not/docpress 0.8.3 → 0.9.0

package/package.json

@@ -1,72 +1,34 @@
 {
   "name": "@tobi-or-not/docpress",
   "type": "module",
-  "version": "0.8.3",
+  "version": "0.9.0",
+  "packageManager": "bun@1.3.14",
   "homepage": "https://this-is-tobi.com/docpress/introduction",
   "repository": {
     "type": "git",
     "url": "https://github.com/this-is-tobi/docpress.git"
   },
-  "module": "dist/docpress.js",
-  "types": "types/index.d.ts",
   "bin": {
     "docpress": "bin/docpress.js"
   },
   "files": [
     "bin",
-    "dist",
-    "types"
+    "dist"
   ],
   "engines": {
-    "node": ">=20"
-  },
-  "dependencies": {
-    "@octokit/rest": "^22.0.1",
-    "axios": "^1.13.6",
-    "chalk": "^5.6.2",
-    "commander": "^14.0.3",
-    "octokit": "^5.0.5",
-    "rimraf": "^6.1.3",
-    "simple-git": "^3.33.0",
-    "vitepress": "^1.6.4",
-    "vitepress-plugin-mermaid": "^2.0.17",
-    "yaml": "^2.8.2",
-    "zod": "^4.3.6",
-    "zod-validation-error": "^5.0.0"
-  },
-  "devDependencies": {
-    "@antfu/eslint-config": "^7.7.0",
-    "@commitlint/cli": "^20.4.3",
-    "@commitlint/config-conventional": "^20.4.3",
-    "@octokit/types": "^16.0.0",
-    "@types/node": "^25.4.0",
-    "@vitejs/plugin-vue": "^6.0.4",
-    "@vitest/coverage-v8": "^4.0.18",
-    "eslint": "^10.0.3",
-    "eslint-plugin-import": "^2.32.0",
-    "husky": "^9.1.7",
-    "lint-staged": "^16.3.3",
-    "typescript": "^5.9.3",
-    "vite": "^7.3.1",
-    "vite-node": "^5.3.0",
-    "vitest": "^4.0.18",
-    "vue": "^3.5.30"
-  },
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/",
-    "access": "public",
-    "tag": "latest"
+    "node": ">=22.12.0"
   },
   "scripts": {
-    "build": "pnpm run build:clean && pnpm run build:types && pnpm run build:vite",
+    "build": "bun run build:clean && bun run build:types && bun run build:vite",
     "build:clean": "rimraf ./dist ./types ./tsconfig.tsbuildinfo",
     "build:docker": "docker build --tag tobi-or-not/docpress --target prod .",
     "build:types": "tsc",
     "build:vite": "vite build",
-    "dev": "vite-node ./dev/docpress.ts",
-    "dev:clean": "rimraf ./docpress && pnpm run dev",
+    "dev": "bun ./dev/docpress.ts",
+    "dev:clean": "rimraf ./docpress && bun run dev",
     "format": "eslint . --fix",
     "lint": "eslint .",
+    "prepare": "husky",
     "start": "./bin/docpress.js",
     "start:docker": "docker run --name docpress --rm -v $(pwd)/docpress:/app/docpress:rw tobi-or-not/docpress",
     "stop:docker": "docker rm --force docpress",
@@ -77,5 +39,37 @@
     "vp:dev": "vitepress dev ./docpress --port 8080",
     "vp:dev:docker": "docker run --publish 8080:8080 --name docpress-vp --rm tobi-or-not/docs",
     "vp:preview": "vitepress preview ./docpress --port 8080"
+  },
+  "dependencies": {
+    "@octokit/rest": "^22.0.1",
+    "chalk": "^5.6.2",
+    "commander": "^15.0.0",
+    "rimraf": "^6.1.3",
+    "simple-git": "^3.36.0",
+    "vitepress": "^1.6.4",
+    "vitepress-plugin-mermaid": "^2.0.17",
+    "yaml": "^2.9.0",
+    "zod": "^4.4.3"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^9.1.0",
+    "@commitlint/cli": "^21.2.0",
+    "@commitlint/config-conventional": "^21.2.0",
+    "@octokit/types": "^16.0.0",
+    "@types/node": "^26.1.0",
+    "@vitejs/plugin-vue": "^6.0.7",
+    "@vitest/coverage-v8": "^4.1.9",
+    "eslint": "^10.6.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^17.0.8",
+    "typescript": "^6.0.3",
+    "vite": "^8.1.3",
+    "vitest": "^4.1.9",
+    "vue": "^3.5.39"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public",
+    "tag": "latest"
   }
-}
+}

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

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

package/types/src/cli.d.ts

@@ -1,12 +0,0 @@
-import { Command } from 'commander';
-/**
- * Creates and configures the Command Line Interface for DocPress
- *
- * @returns A configured Commander program instance
- */
-export declare function getProgram(): Command;
-/**
- * Entry point for the DocPress CLI
- * Initializes and runs the command parser
- */
-export declare function main(): void;

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

@@ -1,20 +0,0 @@
-/**
- * Suppress specific Vue warnings during the build process
- *
- * @param callback - Function to execute while warnings are suppressed
- * @returns The result of the callback function
- */
-export declare function suppressVueWarnings<T>(callback: () => Promise<T>): Promise<T>;
-/**
- * Command line options specific to the build command (none currently)
- */
-export declare const buildOpts: never[];
-/**
- * The build command definition for Commander
- */
-export declare const buildCmd: import("commander").Command;
-/**
- * Main function to execute the build command
- * Builds the VitePress static site
- */
-export declare function main(): Promise<void>;

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

@@ -1,15 +0,0 @@
-import type { FetchOpts } from '../schemas/fetch.js';
-/**
- * Command line options specific to the fetch command
- */
-export declare const fetchOpts: import("commander").Option[];
-/**
- * The fetch command definition for Commander
- */
-export declare const fetchCmd: import("commander").Command;
-/**
- * Main function to execute the fetch command
- *
- * @param opts - Validated fetch options
- */
-export declare function main(opts: FetchOpts): Promise<void>;

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

@@ -1,4 +0,0 @@
-/**
- * Global command line options shared across all commands
- */
-export declare const globalOpts: import("commander").Option[];

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

@@ -1,15 +0,0 @@
-import type { PrepareOpts } from '../schemas/prepare.js';
-/**
- * Command line options specific to the prepare command
- */
-export declare const prepareOpts: import("commander").Option[];
-/**
- * The prepare command definition for Commander
- */
-export declare const prepareCmd: import("commander").Command;
-/**
- * Main function to execute the prepare command
- *
- * @param opts - Validated prepare options
- */
-export declare function main(opts: PrepareOpts): Promise<void>;

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

@@ -1,179 +0,0 @@
-import type { GlobalOpts } from '../schemas/global.js';
-import type { FetchOpts, FetchOptsUser } from '../schemas/fetch.js';
-import { getInfos } from './git.js';
-/**
- * Enhanced repository type with DocPress-specific metadata
- */
-export type EnhancedRepository = Awaited<ReturnType<typeof getInfos>>['repos'][number] & {
-    docpress: {
-        branch: string;
-        filtered: boolean;
-        includes: string[];
-        projectPath: string;
-        raw_url: string;
-        replace_url: string;
-    };
-};
-/**
- * Checks for the existence of documentation files in a repository
- *
- * @param repoOwner - Owner of the repository (username)
- * @param repoName - Name of the repository
- * @param branch - Branch to check for documentation
- * @returns Object containing HTTP status codes for different documentation paths
- */
-export declare function checkDoc(repoOwner: GlobalOpts['usernames'][number], repoName: string, branch: FetchOpts['branch']): Promise<{
-    rootReadmeStatus: number;
-    docsFolderStatus: number;
-    docsReadmeStatus: number;
-}>;
-/**
- * Fetches documentation from a user's repositories
- *
- * @param options - Options for fetching documentation
- * @param options.username - GitHub username
- * @param options.branch - Branch to use for documentation
- * @param options.reposFilter - Optional filter for repositories
- * @param options.token - GitHub API token
- */
-export declare function fetchDoc({ username, branch, reposFilter, token }: FetchOptsUser): Promise<void>;
-/**
- * Enhances repository information with DocPress metadata
- *
- * @param repos - List of repositories from Git provider
- * @param branch - Branch to use for documentation
- * @param reposFilter - Optional filter for repositories
- * @returns Array of enhanced repositories with DocPress metadata
- */
-export declare function enhanceRepositories(repos: Awaited<ReturnType<typeof getInfos>>['repos'], branch?: FetchOpts['branch'], reposFilter?: FetchOpts['reposFilter']): Promise<EnhancedRepository[]>;
-/**
- * Determines which files to include in the sparse checkout based on repository structure
- *
- * @param repo - Repository information
- * @param branch - Branch to check for documentation
- * @returns Array of file patterns to include in sparse checkout
- */
-export declare function getSparseCheckout(repo: Awaited<ReturnType<typeof getInfos>>['repos'][number], branch: FetchOpts['branch']): Promise<string[]>;
-/**
- * Generates and saves user and repository information
- *
- * @param user - User information from Git provider
- * @param repos - List of repositories from Git provider
- * @param branch - Branch to use for documentation
- * @param reposFilter - Optional filter for repositories
- * @returns Object containing user and enhanced repository information
- */
-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;
-        user_view_type?: string;
-        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;
-        notification_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;
-        };
-        business_plus?: boolean;
-        ldap_dn?: string;
-    } | {
-        login: string;
-        id: number;
-        user_view_type?: string;
-        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;
-        notification_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;
-        };
-        private_gists?: number;
-        total_private_repos?: number;
-        owned_private_repos?: number;
-        disk_usage?: number;
-        collaborators?: number;
-    };
-    repos: EnhancedRepository[];
-}>;
-/**
- * Fetches documentation from repositories
- *
- * @param repos - List of enhanced repositories
- * @param reposFilter - Optional filter for repositories
- */
-export declare function getDoc(repos?: EnhancedRepository[], reposFilter?: FetchOpts['reposFilter']): Promise<void>;
-/**
- * Determines if a repository should be filtered out based on filter rules
- *
- * @param repo - Repository information
- * @param reposFilter - Optional filter for repositories
- * @returns True if the repository should be filtered out, false otherwise
- */
-export declare function isRepoFiltered(repo: EnhancedRepository | Awaited<ReturnType<typeof getInfos>>['repos'][number], reposFilter?: FetchOpts['reposFilter']): boolean;