gitpt 1.6.1 → 1.7.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitpt",
-  "version": "1.6.1",
+  "version": "1.7.2",
   "description": "CLI tool that helps you write commit messages & pull request descriptions using AI",
   "main": "dist/index.js",
   "type": "module",
@@ -14,11 +14,16 @@
   ],
   "scripts": {
     "typecheck": "tsc --noEmit",
-    "build": "tsc",
-    "test": "npm run typecheck",
+    "lint": "oxlint",
+    "build": "vite build",
+    "test": "vitest run",
+    "test:watch": "vitest",
     "test:apple": "npm run build && node tests/apple-foundation-models/run.mjs",
     "bench:apple": "npm run build && node tests/apple-foundation-models/benchmark.mjs",
+    "bench:local": "npm run build && node tests/local-model/run.mjs",
+    "bench:all": "npm run build && node tests/run-all.mjs",
     "check:prompt": "npm run build && node tests/snapshots/check.mjs",
+    "build:demo": "node scripts/build-demo.mjs",
     "prepublishOnly": "npm run build"
   },
   "repository": {
@@ -41,8 +46,13 @@
     "@types/inquirer": "^9.0.7",
     "@types/node": "^22.14.1",
     "@types/node-fetch": "^2.6.12",
+    "ffmpeg-static": "^5.3.0",
+    "oxlint": "^1.71.0",
+    "pngjs": "^7.0.0",
     "tsc-alias": "^1.8.16",
-    "typescript": "^5.8.3"
+    "typescript": "^5.8.3",
+    "vite": "^8.1.0",
+    "vitest": "^4.1.9"
   },
   "dependencies": {
     "@commitlint/cli": "^19.8.1",

package/dist/commands/commit/context/buildPrompt.d.ts

@@ -1,4 +0,0 @@
-export declare const buildCommitPrompt: (diff: string, validationErrors?: string) => {
-    system: string;
-    user: string;
-};

package/dist/commands/commit/context/summaryPrompt.d.ts

@@ -1,2 +0,0 @@
-export declare const summarySystemPrompt = "\nYou are condensing a fragment of a git diff so a commit message can be written afterwards.\n\nOutput exactly one line per changed file, in this format:\n<path>: <what changed>\n\nRules:\n- One line per file \u2014 no more, no less.\n- Keep each description under ~12 words.\n- Describe the functional change (what was added, removed, refactored, or fixed), not file mechanics.\n- Output ONLY these lines. No preamble, no commentary, no code fences, no headings, no blank lines.\n";
-export declare const summaryUserPrompt: (diffChunk: string) => string;

package/dist/commands/commit/context/systemPrompt.d.ts

@@ -1 +0,0 @@
-export declare const systemPrompt = "\nYou are a helpful assistant that generates concise, informative Git commit messages.\n\nFollow these strict rules:\n1. Use conventional commit format: type: description\n2. Types are: feat, fix, docs, style, refactor, test, chore\n3. NO scopes in parentheses - do not use feat(scope)\n4. Keep the entire message under 100 characters\n5. Use present tense (e.g., \"add feature\" not \"added feature\")\n6. Be brief but descriptive about WHAT changed\n7. Do not include detailed explanations\n\nCritical Rules:\n- Return a SINGLE LINE commit message only, with no additional explanations or paragraphs\n- Do NOT include a detailed message body section, just the commit title line\n- Do NOT use multiple lines, even for a single message\n\nExamples of Good Commit Messages:\n- feat: add user authentication system\n- fix: resolve crash when opening settings menu\n- refactor: simplify data processing pipeline\n- docs: update installation instructions in README\n- chore: update npm dependencies to latest versions\n- style: fix indentation in CSS files\n- test: add unit tests for payment processing\n- perf: optimize database queries for faster loading\n- build: update webpack configuration\n- ci: fix GitHub Actions workflow\n\nExamples of Bad Commit Messages:\n- added login screen                    \u274C (missing type prefix)\n- feat(auth): implement OAuth login     \u274C (using scope parentheses)\n- This is a really long commit message that exceeds the limit and contains too much information \u274C (too long)\n- feat: Adding user auth\n  \n  This implements the login page...     \u274C (contains multiple lines)\n- \"fix: update styling\"                 \u274C (includes quotes)\n";

package/dist/commands/commit/context/userPrompt.d.ts

@@ -1 +0,0 @@
-export declare const userPrompt: (diff: string) => string;

package/dist/commands/commit/generateCommitMessage.d.ts

@@ -1 +0,0 @@
-export declare const generateCommitMessage: (diff: string, validationErrors?: string) => Promise<string>;

package/dist/commands/commit/index.d.ts

@@ -1,7 +0,0 @@
-interface CommitOptions {
-    message?: string;
-    edit?: boolean;
-    [key: string]: any;
-}
-export declare const commitCommand: (options: CommitOptions) => Promise<void>;
-export {};

package/dist/commands/commit/summarizeDiff.d.ts

@@ -1 +0,0 @@
-export declare const prepareCommitContext: (diff: string) => Promise<string>;

package/dist/commands/config.d.ts

@@ -1 +0,0 @@
-export declare const configCommand: () => Promise<void>;

package/dist/commands/middleware/capabilitiesMiddleware/ghCapability.d.ts

@@ -1 +0,0 @@
-export declare const ghCapability: () => void;

package/dist/commands/middleware/capabilitiesMiddleware/gitCapability.d.ts

@@ -1 +0,0 @@
-export declare const gitCapability: () => void;

package/dist/commands/middleware/capabilitiesMiddleware/index.d.ts

@@ -1,3 +0,0 @@
-type Capability = "git" | "gh";
-export declare const capabilitiesMiddleware: (requiredCapabilities: Capability[]) => void;
-export {};

package/dist/commands/middleware/hasStagedChangesMiddleware.d.ts

@@ -1 +0,0 @@
-export declare const hasStagedChangesMiddleware: () => void;

package/dist/commands/middleware/setupMiddleware/defaultModels.d.ts

@@ -1,8 +0,0 @@
-import { GitPTConfig } from "../../../config.js";
-export interface DefaultModel {
-    id: string;
-    label: string;
-    isAvailable: () => boolean;
-    config: GitPTConfig;
-}
-export declare const resolveDefaultModel: () => DefaultModel | undefined;

package/dist/commands/middleware/setupMiddleware/index.d.ts

@@ -1,4 +0,0 @@
-import { GitPTConfig } from "../../../config.js";
-export declare const setupMiddleware: (options?: {
-    context?: "setup" | "model" | "command";
-}) => Promise<GitPTConfig>;

package/dist/commands/model.d.ts

@@ -1 +0,0 @@
-export declare const modelCommand: () => Promise<void>;

package/dist/commands/pr/context/systemPrompt.d.ts

@@ -1 +0,0 @@
-export declare const systemPrompt = "\nYou are a helpful assistant that generates clear, informative GitHub pull request titles and descriptions.\n\nFor the title:\n- Keep it concise (under 80 characters)\n- Start with a verb in present tense (e.g., \"Add\", \"Fix\", \"Update\")\n- Clearly summarize the main purpose of the changes\n\nFor the description:\n- Start with a brief summary (1-2 sentences) of what the PR accomplishes\n- Include a more detailed explanation of changes if needed\n- List key changes as bullet points if there are multiple components\n- Include any relevant context that reviewers should know\n- End with any testing instructions if applicable\n\nFormat the description in Markdown with sections.\nDo not include \"PR\" or \"Pull Request\" in the title.\n";

package/dist/commands/pr/context/userPrompt.d.ts

@@ -1 +0,0 @@
-export declare const userPrompt: (context: string) => string;

package/dist/commands/pr/generatePRDetails.d.ts

@@ -1,4 +0,0 @@
-export declare const generatePRDetails: () => Promise<{
-    title: string;
-    body: string;
-}>;

package/dist/commands/pr/getPRContext.d.ts

@@ -1 +0,0 @@
-export declare const getPRContext: () => string[];

package/dist/commands/pr/index.d.ts

@@ -1,10 +0,0 @@
-interface PullRequestOptions {
-    title?: string;
-    body?: string;
-    draft?: boolean;
-    base?: string;
-    edit?: boolean;
-    [key: string]: any;
-}
-export declare const prCreateCommand: (options?: PullRequestOptions) => Promise<void>;
-export {};

package/dist/commands/reset.d.ts

@@ -1,3 +0,0 @@
-export declare const resetCommand: (options?: {
-    yes?: boolean;
-}) => Promise<void>;

package/dist/commands/setup.d.ts

@@ -1,3 +0,0 @@
-export declare const setupCommand: (options?: {
-    clearConfig?: boolean;
-}) => Promise<void>;

package/dist/config.d.ts

@@ -1,14 +0,0 @@
-export interface GitPTConfig {
-    provider?: "openrouter" | "local" | "apple" | "openai" | "anthropic";
-    customLLMEndpoint?: string;
-    model?: string;
-    apiKey?: string;
-    apiKeys?: Record<string, string>;
-    contextWindow?: number;
-}
-export declare const getConfig: () => GitPTConfig;
-export declare const saveConfig: (newConfig: GitPTConfig) => void;
-export declare const clearConfig: () => void;
-export declare const getAcceptedDefault: () => string | undefined;
-export declare const setAcceptedDefault: (id: string) => void;
-export declare const clearAcceptedDefault: () => void;

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node --experimental-specifier-resolution=node
-export {};

package/dist/llm/client.d.ts

@@ -1,24 +0,0 @@
-import type OpenAI from "openai";
-export type ChatCompletionCreateParams = OpenAI.Chat.Completions.ChatCompletionCreateParamsNonStreaming;
-export interface LLMChatCompletion {
-    choices: Array<{
-        message: {
-            content: string | null;
-        };
-    }>;
-}
-export interface LLMModelsPage {
-    data: OpenAI.Models.Model[];
-    hasNextPage(): boolean;
-    getNextPage(): Promise<LLMModelsPage>;
-}
-export interface LLMClient {
-    chat: {
-        completions: {
-            create(body: ChatCompletionCreateParams): Promise<LLMChatCompletion>;
-        };
-    };
-    models: {
-        list(): Promise<LLMModelsPage>;
-    };
-}

package/dist/llm/client.js

@@ -1 +0,0 @@
-export {};

package/dist/llm/index.d.ts

@@ -1,6 +0,0 @@
-import type { LLMClient } from "./client.js";
-export declare const OPENROUTER_API_URL = "https://openrouter.ai/api/v1";
-export declare const getLLMClient: (options?: {
-    baseURLOverride?: string;
-    apiKey?: string;
-}) => LLMClient;

package/dist/llm/providers/anthropic/index.d.ts

@@ -1,9 +0,0 @@
-import { GitPTConfig } from "../../../config.js";
-import { OpenAICompatibleProvider } from "../openaiCompatible.js";
-export declare class AnthropicProvider extends OpenAICompatibleProvider {
-    static readonly id = "anthropic";
-    static readonly label = "Anthropic";
-    static readonly baseURL = "https://api.anthropic.com/v1";
-    static setup(existingConfig: GitPTConfig): Promise<GitPTConfig>;
-    protected baseURL(): string;
-}

package/dist/llm/providers/apiKey.d.ts

@@ -1,3 +0,0 @@
-export declare const getApiKey: () => string | undefined;
-export declare const saveApiKey: (providerId: string, key: string) => void;
-export declare const promptApiKey: (existingKey?: string, label?: string) => Promise<string>;

package/dist/llm/providers/apple/client.d.ts

@@ -1,3 +0,0 @@
-import type { LLMClient } from "../../client.js";
-export declare const FM_BINARY = "fm";
-export declare const getAppleFoundationClient: () => LLMClient;

package/dist/llm/providers/apple/index.d.ts

@@ -1,13 +0,0 @@
-import { GitPTConfig } from "../../../config.js";
-import type { LLMClient } from "../../client.js";
-import { Provider } from "../base.js";
-export declare class AppleProvider extends Provider {
-    static readonly id = "apple";
-    static readonly label = "Apple Foundation Models (macOS 27+)";
-    static isAvailable(): boolean;
-    static setup(existingConfig: GitPTConfig): Promise<GitPTConfig>;
-    constructor(model: string);
-    getContextWindow(): Promise<number>;
-    countTokens(text: string): number;
-    protected getClient(): LLMClient;
-}

package/dist/llm/providers/apple/models.d.ts

@@ -1,14 +0,0 @@
-export declare const CANDIDATE_MODELS: ({
-    id: string;
-    name: string;
-    context_length: number;
-} | {
-    id: string;
-    name: string;
-    context_length?: undefined;
-})[];
-export declare const probeModel: (modelId: string) => {
-    available: boolean;
-    reason?: string;
-};
-export declare const isAppleModelAvailable: (modelId: string) => boolean;

package/dist/llm/providers/base.d.ts

@@ -1,30 +0,0 @@
-import type { GitPTConfig } from "../../config.js";
-import type { LLMClient } from "../client.js";
-export interface CompletionRequest {
-    system: string;
-    user: string;
-    maxTokens: number;
-}
-export declare abstract class Provider {
-    readonly model: string;
-    static readonly requiresApiKey: boolean;
-    static readonly requiresEndpoint: boolean;
-    static isAvailable(): boolean;
-    readonly maxOutputTokens: number;
-    protected readonly usesCompletionTokensParam: boolean;
-    constructor(model: string);
-    getContextWindow(): Promise<number>;
-    countTokens(text: string): number;
-    protected abstract getClient(): LLMClient;
-    complete(req: CompletionRequest): Promise<string>;
-}
-export type ProviderClass = {
-    new (model: string): Provider;
-    readonly id: string;
-    readonly label: string;
-    readonly requiresApiKey: boolean;
-    readonly requiresEndpoint: boolean;
-    readonly baseURL?: string;
-    isAvailable(): boolean;
-    setup(existingConfig: GitPTConfig): Promise<GitPTConfig>;
-};

package/dist/llm/providers/local/index.d.ts

@@ -1,11 +0,0 @@
-import { GitPTConfig } from "../../../config.js";
-import { OpenAICompatibleProvider } from "../openaiCompatible.js";
-export declare class LocalProvider extends OpenAICompatibleProvider {
-    static readonly id = "local";
-    static readonly label = "Local LLM";
-    static readonly requiresApiKey = false;
-    static readonly requiresEndpoint = true;
-    static setup(existingConfig: GitPTConfig): Promise<GitPTConfig>;
-    getContextWindow(): Promise<number>;
-    protected baseURL(): string;
-}

package/dist/llm/providers/openai/index.d.ts

@@ -1,10 +0,0 @@
-import { GitPTConfig } from "../../../config.js";
-import { OpenAICompatibleProvider } from "../openaiCompatible.js";
-export declare class OpenAIProvider extends OpenAICompatibleProvider {
-    static readonly id = "openai";
-    static readonly label = "OpenAI";
-    static readonly baseURL = "https://api.openai.com/v1";
-    protected readonly usesCompletionTokensParam = true;
-    static setup(existingConfig: GitPTConfig): Promise<GitPTConfig>;
-    protected baseURL(): string;
-}

package/dist/llm/providers/openaiCompatible.d.ts

@@ -1,15 +0,0 @@
-import { GitPTConfig } from "../../config.js";
-import type { LLMClient } from "../client.js";
-import { Model } from "../setup/types.js";
-import { Provider } from "./base.js";
-export declare abstract class OpenAICompatibleProvider extends Provider {
-    static readonly requiresApiKey: boolean;
-    readonly maxOutputTokens = 2048;
-    protected abstract baseURL(): string;
-    protected getClient(): LLMClient;
-}
-export declare const setupApiKeyProvider: (existingConfig: GitPTConfig, opts: {
-    baseURL: string;
-    label: string;
-    listModels?: (apiKey: string) => Promise<Model[]>;
-}) => Promise<GitPTConfig>;

package/dist/llm/providers/openrouter/index.d.ts

@@ -1,9 +0,0 @@
-import { GitPTConfig } from "../../../config.js";
-import { OpenAICompatibleProvider } from "../openaiCompatible.js";
-export declare class OpenRouterProvider extends OpenAICompatibleProvider {
-    static readonly id = "openrouter";
-    static readonly label = "OpenRouter (remote)";
-    static readonly baseURL = "https://openrouter.ai/api/v1";
-    static setup(existingConfig: GitPTConfig): Promise<GitPTConfig>;
-    protected baseURL(): string;
-}

package/dist/llm/registry.d.ts

@@ -1,8 +0,0 @@
-import type { Provider, ProviderClass } from "./providers/base.js";
-export declare const PROVIDERS: ProviderClass[];
-export declare const getProviderClass: (id: string | undefined) => ProviderClass | undefined;
-export declare const getProvider: () => Provider;
-export declare const validateConfig: () => {
-    isValid: boolean;
-    errors: string[];
-};

package/dist/llm/setup/getAvailableModels.d.ts

@@ -1,5 +0,0 @@
-import { Model } from "openai/resources/models";
-export declare const getAvailableModels: (options?: {
-    baseURLOverride?: string;
-    apiKey?: string;
-}) => Promise<Model[]>;

package/dist/llm/setup/selectModel.d.ts

@@ -1,5 +0,0 @@
-import { Model } from "./types.js";
-/**
- * Show a list of models to select from
- */
-export declare const selectModel: (models: Model[], existingModel?: string, notes?: string[]) => Promise<string>;

package/dist/llm/setup/types.d.ts

@@ -1,13 +0,0 @@
-export interface Model {
-    id: string;
-    name?: string;
-    context_length?: number;
-    pricing?: {
-        prompt: number;
-        completion: number;
-    };
-}
-export interface ModelResponse {
-    data: Model[];
-    object?: string;
-}

package/dist/llm/setup/types.js

@@ -1 +0,0 @@
-export {};

package/dist/llm/tokenCount.d.ts

@@ -1,3 +0,0 @@
-export declare const RESERVED_OUTPUT_TOKENS = 1024;
-export declare const countTokens: (text: string) => number;
-export declare const getContextWindow: () => Promise<number>;

package/dist/services/gh/createPullRequest.d.ts

@@ -1 +0,0 @@
-export declare const createPullRequest: (title: string, body: string, baseBranch: string, draft: boolean) => void;

package/dist/services/gh/index.d.ts

@@ -1,4 +0,0 @@
-export declare const gh: {
-    createPullRequest: (title: string, body: string, baseBranch: string, draft: boolean) => void;
-    isAvailable: () => boolean;
-};

package/dist/services/gh/isAvailable.d.ts

@@ -1 +0,0 @@
-export declare const isAvailable: () => boolean;

package/dist/services/git/executeGitAdd.d.ts

@@ -1 +0,0 @@
-export declare const executeGitAdd: (files: string[]) => void;

package/dist/services/git/executeGitCommit.d.ts

@@ -1 +0,0 @@
-export declare const executeGitCommit: (message: string, additionalArgs?: string[]) => void;

package/dist/services/git/getChangedFiles.d.ts

@@ -1 +0,0 @@
-export declare const getChangedFiles: (baseBranch: string) => string[];

package/dist/services/git/getCommitsSinceBaseBranch.d.ts

@@ -1 +0,0 @@
-export declare const getCommitsSinceBaseBranch: (baseBranch: string) => string[];

package/dist/services/git/getCurrentBranch.d.ts

@@ -1 +0,0 @@
-export declare const getCurrentBranch: () => string;

package/dist/services/git/getDefaultBranch.d.ts

@@ -1 +0,0 @@
-export declare const getDefaultBranch: () => string;

package/dist/services/git/getStagedChanges.d.ts

@@ -1 +0,0 @@
-export declare const getStagedChanges: () => string;

package/dist/services/git/getStagedFiles.d.ts

@@ -1 +0,0 @@
-export declare const getStagedFiles: () => string[];

package/dist/services/git/hasStagedChanges.d.ts

@@ -1 +0,0 @@
-export declare const hasStagedChanges: () => boolean;

package/dist/services/git/index.d.ts

@@ -1,13 +0,0 @@
-export declare const git: {
-    add: (files: string[]) => void;
-    commit: (message: string, additionalArgs?: string[]) => void;
-    getChangedFiles: (baseBranch: string) => string[];
-    getCommitsSinceBaseBranch: (baseBranch: string) => string[];
-    getCurrentBranch: () => string;
-    getDefaultBranch: () => string;
-    hasStagedChanges: () => boolean;
-    getStagedChanges: () => string;
-    getStagedFiles: () => string[];
-    isAvailable: () => boolean;
-    isGitRepository: () => boolean;
-};

package/dist/services/git/isAvailable.d.ts

@@ -1 +0,0 @@
-export declare const isAvailable: () => boolean;

package/dist/services/git/isGitRepository.d.ts

@@ -1 +0,0 @@
-export declare const isGitRepository: () => boolean;

package/dist/utils/commitlint.d.ts

@@ -1,25 +0,0 @@
-export interface CommitlintConfig {
-    rules?: Record<string, any>;
-    extends?: string | string[];
-}
-/**
- * Check if a commitlint configuration exists in the repository
- */
-export declare function hasCommitlintConfig(): boolean;
-/**
- * Read commitlint config file (using @commitlint/load) and print it out
- */
-export declare function readCommitlintConfig(): Promise<any>;
-/**
- * Get the commitlint configuration format rules as a string
- */
-export declare function getCommitlintRules(): string;
-/**
- * Validate a commit message against commitlint rules
- * @param message The commit message to validate
- * @returns An object with success status and error message if applicable
- */
-export declare function validateCommitMessage(message: string): Promise<{
-    valid: boolean;
-    errors?: string;
-}>;

package/dist/utils/formatBaseURL.d.ts

@@ -1 +0,0 @@
-export declare const formatBaseURL: (baseURL: string) => string;

package/dist/utils/maskApiKey.d.ts

@@ -1 +0,0 @@
-export declare const maskApiKey: (apiKey: string) => string;