Create spec for better process management
This commit is contained in:
Mateusz Tymek
@@ -0,0 +1,2 @@
|
||||
schema: spec-driven
|
||||
created: 2026-02-14
|
||||
164
openspec/changes/improved-opencode-process-management/design.md
Normal file
164
openspec/changes/improved-opencode-process-management/design.md
Normal file
@@ -0,0 +1,164 @@
|
||||
## Context
|
||||
|
||||
### Current Implementation
|
||||
The plugin uses a simple `opencodePath: string` setting that defaults to "opencode". The `ServerManager` spawns this directly with default arguments:
|
||||
```typescript
|
||||
this.process = this.processImpl.start(
|
||||
this.settings.opencodePath,
|
||||
["serve", "--port", this.settings.port.toString(), ...],
|
||||
options
|
||||
);
|
||||
```
|
||||
|
||||
Platform-specific process implementations (`PosixProcess`, `WindowsProcess`) handle spawning and verification. The `verifyCommand` method checks if the executable exists.
|
||||
|
||||
### New Requirements
|
||||
1. One-time autodetect for new users (empty path on first run)
|
||||
2. Support custom shell commands with full user control
|
||||
3. Maintain backward compatibility with existing path-based configuration
|
||||
|
||||
## Goals / Non-Goals
|
||||
|
||||
**Goals:**
|
||||
- Provide zero-configuration setup for new users via autodetect
|
||||
- Enable power users to use custom commands with full flexibility
|
||||
- Maintain backward compatibility for existing users
|
||||
- Clear UI distinction between path mode and custom command mode
|
||||
- Platform-aware executable detection (PATH + common locations)
|
||||
|
||||
**Non-Goals:**
|
||||
- Complex command builder UI (simple text input for custom commands)
|
||||
- Automatic installation of opencode
|
||||
- Validation of custom commands before execution
|
||||
|
||||
## Decisions
|
||||
|
||||
### 1. Settings Schema Extension
|
||||
**Decision:** Extend existing settings rather than replace.
|
||||
|
||||
**Rationale:**
|
||||
- Maintains backward compatibility - existing configs continue working
|
||||
- Simple migration - just add new fields with sensible defaults
|
||||
- Minimal code changes to existing path-based logic
|
||||
|
||||
**Alternatives considered:**
|
||||
- Replace with structured command object - rejected due to breaking change
|
||||
- Separate settings sections - rejected as overkill for this feature
|
||||
|
||||
**Implementation:**
|
||||
```typescript
|
||||
interface OpenCodeSettings {
|
||||
// ... existing fields ...
|
||||
opencodePath: string; // Still used as primary path
|
||||
customCommand: string; // New: shell command
|
||||
useCustomCommand: boolean; // New: toggle mode
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Autodetect Trigger Strategy
|
||||
**Decision:** Autodetect runs on every plugin startup when path is empty.
|
||||
|
||||
**Rationale:**
|
||||
- Reminds user to configure or disable the plugin if opencode is missing
|
||||
- Simpler implementation - no state tracking needed
|
||||
- If user installs opencode later, it will be detected automatically
|
||||
|
||||
**Alternatives considered:**
|
||||
- Run once and remember with flag - rejected as hides the problem
|
||||
- Run only manually - rejected as adds friction for new users
|
||||
- Explicit "first setup" wizard - rejected as overkill
|
||||
|
||||
**Implementation:**
|
||||
```typescript
|
||||
// In main.ts onload()
|
||||
if (!this.settings.opencodePath && !this.settings.useCustomCommand) {
|
||||
await this.attemptAutodetect();
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Custom Command Spawning Strategy
|
||||
**Decision:** Use `shell: true` for custom commands, user controls ALL arguments.
|
||||
|
||||
**Rationale:**
|
||||
- Maximum flexibility - env vars, pipes, complex invocations all work
|
||||
- Simple mental model - "what you type is what runs"
|
||||
- No ambiguity about argument concatenation
|
||||
|
||||
**Alternatives considered:**
|
||||
- Parse and split custom command - rejected as fragile
|
||||
- Merge plugin args with custom args - rejected as confusing
|
||||
- Separate args array - rejected as limiting
|
||||
|
||||
**Implementation:**
|
||||
```typescript
|
||||
// Path mode
|
||||
this.process = spawn(opencodePath, ["serve", "--port", port, ...], options);
|
||||
|
||||
// Custom mode
|
||||
this.process = spawn(customCommand, [], { ...options, shell: true });
|
||||
```
|
||||
|
||||
### 4. Executable Detection Order
|
||||
**Decision:** Check PATH first, then platform-specific common locations.
|
||||
|
||||
**Rationale:**
|
||||
- Respects user's environment setup
|
||||
- Common locations cover most package manager installs (homebrew, cargo, npm -g, etc.)
|
||||
|
||||
**Search algorithm:**
|
||||
1. If configured path is absolute and exists, return it directly
|
||||
2. Extract basename from configured path (e.g., "opencode" from "/path/to/opencode" or just "opencode")
|
||||
3. Search platform-specific locations for that basename:
|
||||
- **Linux:** `~/.local/bin/`, `~/.opencode/bin/`, `~/.bun/bin/`, `~/.npm-global/bin/`, `~/.nvm/versions/node/*/bin/`, `/usr/local/bin/`, `/usr/bin/`
|
||||
- **macOS:** `~/.local/bin/`, `/opt/homebrew/bin/`, `/usr/local/bin/`
|
||||
- **Windows:** `%LOCALAPPDATA%\opencode\bin\`, `%USERPROFILE%\.bun\bin\`, `%USERPROFILE%\.local\bin\`
|
||||
4. If found, return full path; if not found, return configured path as fallback
|
||||
|
||||
**nvm wildcard handling:** For `~/.nvm/versions/node/*/bin/`, expand the wildcard to find actual Node version directories.
|
||||
|
||||
### 5. UI Layout
|
||||
**Decision:** Toggle switch to select mode, conditional display of relevant input.
|
||||
|
||||
**Rationale:**
|
||||
- Clear mental model - one or the other, not both
|
||||
- Reduces visual clutter
|
||||
- Toggle state directly maps to `useCustomCommand` boolean
|
||||
|
||||
**Layout:**
|
||||
```
|
||||
Command Mode:
|
||||
[ Use custom command ●─────○ ]
|
||||
|
||||
[Path Mode - shown when toggle off]
|
||||
OpenCode path: [____________] [Autodetect]
|
||||
|
||||
[Custom Mode - shown when toggle on]
|
||||
Custom command:
|
||||
[______________________________]
|
||||
(Full shell command with all arguments)
|
||||
```
|
||||
|
||||
## Risks / Trade-offs
|
||||
|
||||
**[Risk]** Custom command mode is powerful but dangerous - users can break their setup.
|
||||
→ **Mitigation:** This is intentional flexibility. Users opting into "custom command" are advanced users. No validation performed - natural failure on spawn.
|
||||
|
||||
**[Risk]** Autodetect could find wrong executable (different binary with same name).
|
||||
→ **Mitigation:** Low probability - "opencode" is unique. Could add version check in future if needed.
|
||||
|
||||
**[Risk]** Users may not understand difference between path and custom command modes.
|
||||
→ **Mitigation:** Clear UI labels and descriptions. Path mode is default, custom mode opt-in.
|
||||
|
||||
**[Risk]** Toast notification on every startup might be annoying if user intentionally leaves path empty.
|
||||
→ **Mitigation:** User can switch to custom command mode (even with empty command) to suppress autodetect, or configure a path.
|
||||
|
||||
## Migration Plan
|
||||
|
||||
1. **No breaking changes** - existing configs with `opencodePath` set continue working
|
||||
2. **New fields** default to empty/false
|
||||
3. **Autodetect** triggers on every startup when path is empty and custom command mode is disabled
|
||||
4. **Settings UI** adapts to existing data - if `opencodePath` is set, starts in path mode
|
||||
|
||||
## Open Questions
|
||||
|
||||
None - design is complete based on user requirements.
|
||||
@@ -0,0 +1,64 @@
|
||||
## Why
|
||||
|
||||
Currently, the plugin requires users to manually specify an OpenCode path in settings, defaulting to just "opencode" (expecting it in PATH). This creates friction for new users who haven't configured anything yet. We need:
|
||||
1. **Autodetect on first run** - Seamless setup for new users
|
||||
2. **Custom command support** - Power users need flexibility for custom flags, env vars, wrapper scripts
|
||||
3. **Backward compatibility** - Existing `opencodePath` settings must continue working
|
||||
|
||||
## What Changes
|
||||
|
||||
### New Capabilities
|
||||
- **Startup autodetect**: On every plugin startup with empty `opencodePath`, automatically search for opencode executable
|
||||
- Check PATH first
|
||||
- Check platform-specific common locations (homebrew, ~/.local/bin, etc.)
|
||||
- Save found path to settings if successful
|
||||
- Show toast notification if not found, prompting user to check Settings
|
||||
- **Manual autodetect button**: "Autodetect" button in Settings to trigger search on demand
|
||||
- **Custom command mode**: Toggle between "Path" and "Custom command"
|
||||
- Path mode: Use `opencodePath` directly, append default args (`--serve --port X`)
|
||||
- Custom mode: Full shell command, user controls all arguments
|
||||
- Custom mode uses `shell: true` for maximum flexibility
|
||||
|
||||
### Settings Schema Changes
|
||||
```typescript
|
||||
interface OpenCodeSettings {
|
||||
// ... existing fields ...
|
||||
opencodePath: string; // Path to executable (or empty)
|
||||
customCommand: string; // Full shell command
|
||||
useCustomCommand: boolean; // Toggle: false=path, true=custom
|
||||
}
|
||||
```
|
||||
|
||||
### UI Changes
|
||||
- Toggle: "Use custom command" (default: off)
|
||||
- When off: Show path input + "Autodetect" button
|
||||
- When on: Show custom command textarea
|
||||
|
||||
### Validation
|
||||
- Path mode: Verify with `opencode --version` (existing behavior)
|
||||
- Custom mode: Trust user, let it fail naturally
|
||||
|
||||
## Capabilities
|
||||
|
||||
### New Capabilities
|
||||
- `executable-autodetect`: Cross-platform executable detection on startup when path is empty
|
||||
- `custom-command-launch`: Shell-based command execution with full user control
|
||||
|
||||
### Modified Capabilities
|
||||
- `process-launch`: Extended to support both direct path execution and shell-based custom commands
|
||||
|
||||
## Impact
|
||||
|
||||
- **Settings (`src/types.ts`)**: Add new fields to `OpenCodeSettings` interface
|
||||
- **Settings UI (`src/settings/SettingsTab.ts`)**: Add toggle, autodetect button, conditional inputs
|
||||
- **Process spawning (`src/server/ServerManager.ts`)**: Route to appropriate spawn method based on mode
|
||||
- **New module**: `src/server/ExecutableResolver.ts` for cross-platform autodetect logic
|
||||
|
||||
## Success Criteria
|
||||
|
||||
- [ ] Plugin attempts autodetect on every startup when path is empty
|
||||
- [ ] If autodetect fails, user sees clear toast notification with action to check Settings
|
||||
- [ ] Existing `opencodePath` values continue working (backward compatibility)
|
||||
- [ ] Users can switch to custom command mode for full control
|
||||
- [ ] Settings UI clearly distinguishes path vs custom command modes
|
||||
- [ ] Manual "Autodetect" button works in Settings
|
||||
@@ -0,0 +1,50 @@
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: Custom shell command execution
|
||||
The system SHALL support executing user-defined shell commands with full control over arguments and environment.
|
||||
|
||||
#### Scenario: Execute custom command with shell
|
||||
- **GIVEN** useCustomCommand setting is true
|
||||
- **AND** customCommand setting contains a shell command string
|
||||
- **WHEN** the server is started
|
||||
- **THEN** the system SHALL spawn the process with shell: true option
|
||||
- **AND** execute the exact command string as provided by the user
|
||||
|
||||
#### Scenario: Custom command with environment variables
|
||||
- **GIVEN** customCommand is "FOO=bar opencode serve --port 14096"
|
||||
- **WHEN** the server is started
|
||||
- **THEN** the system SHALL execute the command with shell: true
|
||||
- **AND** the environment variable FOO SHALL be set to "bar"
|
||||
|
||||
#### Scenario: Custom command with custom arguments
|
||||
- **GIVEN** customCommand is "opencode serve --port 9999 --verbose"
|
||||
- **WHEN** the server is started
|
||||
- **THEN** the system SHALL execute the command with shell: true
|
||||
- **AND** pass exactly "--port 9999 --verbose" as arguments
|
||||
- **AND** NOT append any default arguments (port, hostname, etc.)
|
||||
|
||||
#### Scenario: Custom command with wrapper script
|
||||
- **GIVEN** customCommand is "/path/to/my-wrapper.sh"
|
||||
- **WHEN** the server is started
|
||||
- **THEN** the system SHALL execute the wrapper script via shell
|
||||
- **AND** the wrapper script SHALL have full control of opencode invocation
|
||||
|
||||
### Requirement: No validation for custom commands
|
||||
The system SHALL NOT validate custom commands before execution.
|
||||
|
||||
#### Scenario: Invalid custom command fails naturally
|
||||
- **GIVEN** customCommand is "invalid-command-that-does-not-exist"
|
||||
- **WHEN** the server is started
|
||||
- **THEN** the system SHALL attempt to execute it
|
||||
- **AND** let the spawn fail naturally with ENOENT error
|
||||
- **AND** NOT perform pre-flight validation
|
||||
|
||||
### Requirement: User controls all arguments in custom mode
|
||||
The system SHALL NOT append any default arguments when using custom command mode.
|
||||
|
||||
#### Scenario: User provides complete command
|
||||
- **GIVEN** useCustomCommand is true
|
||||
- **AND** customCommand is "opencode serve"
|
||||
- **WHEN** the server is started
|
||||
- **THEN** the system SHALL execute exactly "opencode serve"
|
||||
- **AND** NOT append --port, --hostname, or --cors arguments
|
||||
@@ -0,0 +1,75 @@
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: Cross-platform executable autodetection
|
||||
The system SHALL provide a mechanism to automatically detect the opencode executable location across macOS, Linux, and Windows platforms.
|
||||
|
||||
#### Scenario: Autodetect finds executable in PATH
|
||||
- **GIVEN** the platform PATH contains an executable named "opencode"
|
||||
- **WHEN** autodetection is triggered
|
||||
- **THEN** the system SHALL return the full path to the executable
|
||||
|
||||
#### Scenario: Configured absolute path takes precedence
|
||||
- **GIVEN** opencodePath is set to an absolute path like "/opt/opencode/bin/opencode"
|
||||
- **AND** the file exists at that location
|
||||
- **WHEN** autodetection is triggered
|
||||
- **THEN** the system SHALL return the configured absolute path directly
|
||||
- **AND** skip searching platform-specific locations
|
||||
|
||||
#### Scenario: Autodetect finds executable in platform-specific location
|
||||
- **GIVEN** opencodePath is set to "opencode" (not an absolute path)
|
||||
- **OR** the configured absolute path does not exist
|
||||
- **AND** opencode is installed at a platform-specific common location
|
||||
- Linux: ~/.local/bin/opencode, ~/.opencode/bin/opencode, ~/.bun/bin/opencode, ~/.npm-global/bin/opencode, ~/.nvm/versions/node/*/bin/opencode, /usr/local/bin/opencode, /usr/bin/opencode
|
||||
- macOS: ~/.local/bin/opencode, /opt/homebrew/bin/opencode, /usr/local/bin/opencode
|
||||
- Windows: %LOCALAPPDATA%\opencode\bin\opencode.exe, %USERPROFILE%\.bun\bin\opencode.exe
|
||||
- **WHEN** autodetection is triggered
|
||||
- **THEN** the system SHALL extract the basename from configured path (e.g., "opencode")
|
||||
- **AND** search platform-specific locations for that basename
|
||||
- **AND** return the full path if found
|
||||
|
||||
#### Scenario: Basename extraction for custom executable names
|
||||
- **GIVEN** opencodePath is set to "my-custom-opencode"
|
||||
- **WHEN** autodetection is triggered
|
||||
- **THEN** the system SHALL search for "my-custom-opencode" in platform-specific locations
|
||||
- **AND** return the full path if found
|
||||
|
||||
#### Scenario: Autodetect fails to find executable - fallback to configured path
|
||||
- **GIVEN** opencode is not in PATH or any platform-specific location
|
||||
- **AND** opencodePath is set to "opencode"
|
||||
- **WHEN** autodetection is triggered
|
||||
- **THEN** the system SHALL return the configured path "opencode" as fallback
|
||||
- **AND** display a toast notification to the user: "Could not find opencode. Please check Settings"
|
||||
|
||||
### Requirement: Startup autodetection
|
||||
The system SHALL attempt to autodetect the opencode executable on every plugin startup when the path is not configured.
|
||||
|
||||
#### Scenario: Startup autodetect succeeds
|
||||
- **GIVEN** the plugin loads
|
||||
- **AND** opencodePath setting is empty
|
||||
- **WHEN** the plugin initializes
|
||||
- **THEN** the system SHALL trigger autodetection
|
||||
- **AND** if found, save the path to opencodePath setting
|
||||
- **AND** display a success notification: "OpenCode executable found at <path>"
|
||||
|
||||
#### Scenario: Startup autodetect fails
|
||||
- **GIVEN** the plugin loads
|
||||
- **AND** opencodePath setting is empty
|
||||
- **WHEN** the plugin initializes
|
||||
- **THEN** the system SHALL trigger autodetection
|
||||
- **AND** if not found, display a toast notification: "Could not find opencode. Please check Settings"
|
||||
|
||||
### Requirement: Manual autodetect trigger
|
||||
The system SHALL provide a UI control to manually trigger autodetection at any time.
|
||||
|
||||
#### Scenario: User clicks Autodetect button
|
||||
- **GIVEN** the user is on the Settings page
|
||||
- **AND** Path mode is selected
|
||||
- **WHEN** the user clicks the "Autodetect" button
|
||||
- **THEN** the system SHALL trigger autodetection
|
||||
- **AND** if found, update the opencodePath field with the detected path
|
||||
- **AND** display a success notification
|
||||
|
||||
#### Scenario: Manual autodetect fails
|
||||
- **GIVEN** the user clicks the "Autodetect" button
|
||||
- **WHEN** autodetection fails to find the executable
|
||||
- **THEN** the system SHALL display a toast notification: "Could not find opencode. Please check your installation."
|
||||
@@ -0,0 +1,69 @@
|
||||
## MODIFIED Requirements
|
||||
|
||||
### Requirement: Server Process Spawning (Modified)
|
||||
The plugin SHALL spawn the OpenCode server process using either a configured executable path with default arguments OR a user-defined custom shell command.
|
||||
|
||||
**FROM:**
|
||||
The plugin SHALL spawn the OpenCode server process using the configured executable path, port, and hostname when the user initiates server start.
|
||||
|
||||
**TO:**
|
||||
The plugin SHALL support two execution modes for spawning the OpenCode server process based on the `useCustomCommand` setting.
|
||||
|
||||
#### Scenario: Path mode spawn (Modified)
|
||||
- **GIVEN** useCustomCommand is false
|
||||
- **WHEN** the user starts the server
|
||||
- **THEN** the plugin spawns the executable at `opencodePath` with arguments `["serve", "--port", <port>, "--hostname", <hostname>, "--cors", "app://obsidian.md"]`
|
||||
- **AND** the process runs with the vault directory as the working directory
|
||||
- **AND** the spawn uses `shell: false`
|
||||
|
||||
#### Scenario: Custom command mode spawn (New)
|
||||
- **GIVEN** useCustomCommand is true
|
||||
- **WHEN** the user starts the server
|
||||
- **THEN** the plugin spawns `customCommand` as a shell command
|
||||
- **AND** the spawn uses `shell: true`
|
||||
- **AND** NO additional arguments are appended to the command
|
||||
- **AND** the process runs with the vault directory as the working directory
|
||||
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: Command mode selection
|
||||
The system SHALL support toggling between path mode and custom command mode via settings.
|
||||
|
||||
#### Scenario: Path mode configuration
|
||||
- **GIVEN** useCustomCommand is false (default)
|
||||
- **WHEN** the server starts
|
||||
- **THEN** the system uses the configured opencodePath executable
|
||||
- **AND** appends default arguments for port, hostname, and CORS
|
||||
|
||||
#### Scenario: Custom command mode configuration
|
||||
- **GIVEN** useCustomCommand is true
|
||||
- **WHEN** the server starts
|
||||
- **THEN** the system uses the configured customCommand string
|
||||
- **AND** executes it via shell with no argument manipulation
|
||||
|
||||
### Requirement: Executable verification
|
||||
The system SHALL verify the executable exists in path mode before attempting to spawn.
|
||||
|
||||
#### Scenario: Verify path mode executable
|
||||
- **GIVEN** useCustomCommand is false
|
||||
- **AND** opencodePath is set to an absolute path
|
||||
- **WHEN** the server is about to start
|
||||
- **THEN** the system SHALL verify the file exists and is executable
|
||||
- **AND** if verification fails, return an error before spawning
|
||||
|
||||
#### Scenario: Skip verification for custom command
|
||||
- **GIVEN** useCustomCommand is true
|
||||
- **WHEN** the server is about to start
|
||||
- **THEN** the system SHALL NOT verify the command before spawning
|
||||
- **AND** let execution fail naturally if the command is invalid
|
||||
|
||||
### Requirement: Settings backward compatibility
|
||||
The system SHALL maintain backward compatibility with existing opencodePath configurations.
|
||||
|
||||
#### Scenario: Existing path setting works
|
||||
- **GIVEN** a configuration from a previous plugin version
|
||||
- **AND** opencodePath is set to "/usr/local/bin/opencode"
|
||||
- **AND** useCustomCommand is not set (defaults to false)
|
||||
- **WHEN** the plugin loads
|
||||
- **THEN** the system SHALL use the existing opencodePath
|
||||
- **AND** continue working in path mode with default arguments
|
||||
@@ -0,0 +1,68 @@
|
||||
## 1. Settings Schema Updates
|
||||
|
||||
- [ ] 1.1 Add `customCommand` field to `OpenCodeSettings` interface in `src/types.ts`
|
||||
- [ ] 1.2 Add `useCustomCommand` boolean field to `OpenCodeSettings` interface
|
||||
- [ ] 1.3 Update `DEFAULT_SETTINGS` with new fields (empty string and false)
|
||||
|
||||
## 2. Executable Resolver Module
|
||||
|
||||
- [ ] 2.1 Create `src/server/ExecutableResolver.ts` with cross-platform detection logic
|
||||
- [ ] 2.2 Implement `resolveFromPath()` to check PATH for 'opencode' executable
|
||||
- [ ] 2.3 Implement `resolve()` method with proper precedence:
|
||||
- Check if configured path is absolute and exists → return it
|
||||
- Extract basename from configured path (handle both "opencode" and "/path/to/opencode")
|
||||
- [ ] 2.4 Implement platform-specific directory search:
|
||||
- Linux: ~/.local/bin/, ~/.opencode/bin/, ~/.bun/bin/, ~/.npm-global/bin/, ~/.nvm/versions/node/*/bin/, /usr/local/bin/, /usr/bin/
|
||||
- macOS: ~/.local/bin/, /opt/homebrew/bin/, /usr/local/bin/
|
||||
- Windows: %LOCALAPPDATA%\opencode\bin\, %USERPROFILE%\.bun\bin\, %USERPROFILE%\.local\bin\
|
||||
- [ ] 2.5 Implement nvm wildcard expansion for ~/.nvm/versions/node/*/bin/
|
||||
- [ ] 2.6 Ensure fallback: return configured path if search fails
|
||||
- [ ] 2.4 Implement main `resolve()` method that tries PATH first, then platform locations
|
||||
- [ ] 2.5 Add helper to expand Windows environment variables (%LOCALAPPDATA%, %USERPROFILE%)
|
||||
|
||||
## 3. ServerManager Updates
|
||||
|
||||
- [ ] 3.1 Modify `ServerManager.start()` to check `useCustomCommand` setting
|
||||
- [ ] 3.2 Implement path mode spawning (direct spawn with default args)
|
||||
- [ ] 3.3 Implement custom command mode spawning (shell: true, no args appended)
|
||||
- [ ] 3.4 Ensure working directory is set correctly for both modes
|
||||
- [ ] 3.5 Add support for verifying path mode executable with `opencode --version`
|
||||
|
||||
## 4. Main Plugin Integration
|
||||
|
||||
- [ ] 4.1 Add autodetect logic in `main.ts` `onload()` method
|
||||
- [ ] 4.2 Implement autodetect trigger: when `opencodePath` is empty and `useCustomCommand` is false
|
||||
- [ ] 4.3 On successful autodetect: save path to settings, show success Notice
|
||||
- [ ] 4.4 On failed autodetect: show error Notice "Could not find opencode. Please check Settings"
|
||||
- [ ] 4.5 Import and use `ExecutableResolver` from main plugin
|
||||
|
||||
## 5. Settings UI Updates
|
||||
|
||||
- [ ] 5.1 Add toggle switch "Use custom command" in `SettingsTab.ts`
|
||||
- [ ] 5.2 Conditionally show path input field when toggle is off
|
||||
- [ ] 5.3 Conditionally show custom command textarea when toggle is on
|
||||
- [ ] 5.4 Add "Autodetect" button next to path input
|
||||
- [ ] 5.5 Implement autodetect button click handler that:
|
||||
- Calls `ExecutableResolver.resolve()`
|
||||
- Updates path input if found
|
||||
- Shows success/error Notice
|
||||
- [ ] 5.6 Add descriptive text explaining custom command mode behavior
|
||||
- [ ] 5.7 Ensure settings are saved when toggling between modes
|
||||
|
||||
## 6. Testing & Validation
|
||||
|
||||
- [ ] 6.1 Test autodetect finds opencode in PATH
|
||||
- [ ] 6.2 Test autodetect finds opencode in platform-specific location
|
||||
- [ ] 6.3 Test autodetect shows error when not found
|
||||
- [ ] 6.4 Test path mode spawns correctly with default args
|
||||
- [ ] 6.5 Test custom command mode spawns via shell without extra args
|
||||
- [ ] 6.6 Test custom command with environment variables works
|
||||
- [ ] 6.7 Verify backward compatibility: existing opencodePath values still work
|
||||
- [ ] 6.8 Test manual autodetect button in Settings
|
||||
- [ ] 6.9 Test toggle saves and restores correctly
|
||||
|
||||
## 7. Documentation
|
||||
|
||||
- [ ] 7.1 Update README.md with new settings options
|
||||
- [ ] 7.2 Document autodetect behavior and common installation locations
|
||||
- [ ] 7.3 Add examples of custom command usage
|
||||
Reference in New Issue
Block a user