@vibeship/types

Shared TypeScript types for all Vibeship DevTools packages.

Installation

npm install @vibeship/types

Usage

import { Task, VibeshipConfig, Command } from '@vibeship/types';

const task: Task = {
  id: '1',
  type: 'todo',
  text: 'Implement feature',
  file: 'src/app.ts',
  line: 42,
  priority: 'high',
  status: 'open'
};

Available Types

Core Types

• Task - Task definition with metadata
• FileInfo - File information
• VibeshipConfig - Configuration structure
• Command - Command palette command

Configuration Types

• FeatureFlags - Feature toggles
• SecurityConfig - Security settings
• TaskPatterns - Task detection patterns
• UIConfig - UI preferences
• APIConfig - API settings

Provider Types

• VibeshipProviderDependencies - Provider dependencies
• SSEClient - Server-sent events client interface

UI Types

• UIState - UI state management
• TaskFilters - Task filtering options
• VibeshipSettings - User settings
• HotkeySettings - Keyboard shortcuts

AI Types

• AISettings - AI configuration
• AIProvider - AI provider types
• AIModel - AI model types

Contributing

This package is part of the Vibeship DevTools monorepo. All types should be:

• Well documented with JSDoc comments
• Exported from the main index
• Used consistently across all packages