Skip to content

fix: make multi-editor plugin installs independent of each other #270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rhuanbarreto merged 2 commits into from
May 5, 2026
Merged

fix: make multi-editor plugin installs independent of each other #270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
88ba743
fix: make multi-editor plugin installs independent of each other
rhuanbarreto May 5, 2026
6abbab6
Merge branch 'main' into fix/plugin-install-independent-editors
rhuanbarreto May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .archgate/adrs/ARCH-012-command-error-boundaries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ The top-level `main().catch()` in `cli.ts` remains as a safety net for truly une
try {
// command logic
} catch (err) {
// Re-throw ExitPromptError so main().catch() handles Ctrl+C (exit 130)
if (err instanceof Error && err.name === "ExitPromptError") throw err;
logError(err instanceof Error ? err.message : String(err));
process.exit(1);
}
Expand All @@ -57,12 +59,14 @@ The top-level `main().catch()` in `cli.ts` remains as a safety net for truly une
- Wrap every async command action body in a try-catch
- Use `logError()` for error messages in the catch block
- Exit with code 1 for expected failures
- **Re-throw `ExitPromptError` in command error boundaries** — Commands that use Inquirer prompts (directly or via helpers like `promptEditorSelection`) MUST re-throw `ExitPromptError` from the catch block so `main().catch()` handles Ctrl+C with exit code 130. Pattern: `if (err instanceof Error && err.name === "ExitPromptError") throw err;`

### Don't

- Don't rely on `main().catch()` as the only error handler for commands
- Don't catch and silently swallow errors — always log them
- Don't exit with code 2 in command catch blocks — that code is reserved for unexpected crashes
- Don't catch `ExitPromptError` as a command failure — it represents user cancellation (Ctrl+C), not an error. Let it propagate to `main().catch()` for exit code 130 handling (see [ARCH-002](./ARCH-002-error-handling.md))

## Consequences

Expand Down
193 changes: 108 additions & 85 deletions src/commands/plugin/install.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,104 +135,127 @@ async function installForEditor(
}
}

function printManualInstructions(editor: EditorTarget): void {
switch (editor) {
case "claude": {
const url = buildMarketplaceUrl();
logInfo("To install the plugin manually, run:");
console.log(
` ${styleText("bold", "claude plugin marketplace add")} ${url}`
);
console.log(
` ${styleText("bold", "claude plugin install")} archgate@archgate`
);
break;
}
case "copilot": {
const url = buildVscodeMarketplaceUrl();
logInfo("To install the plugin manually, run:");
console.log(
` ${styleText("bold", "copilot plugin marketplace add")} ${url}`
);
console.log(
` ${styleText("bold", "copilot plugin install")} archgate@archgate`
);
break;
}
case "cursor": {
logInfo("To install the plugin manually, run:");
console.log(
` ${styleText("bold", "curl")} -H "Authorization: Bearer <token>" https://plugins.archgate.dev/api/vscode -o archgate.vsix`
);
console.log(
` Then in Cursor: Ctrl+Shift+P → ${styleText("bold", "Extensions: Install from VSIX...")} → select archgate.vsix`
);
break;
}
case "vscode": {
logInfo("To install the extension manually, run:");
console.log(
` ${styleText("bold", "curl")} -H "Authorization: Bearer <token>" https://plugins.archgate.dev/api/vscode -o archgate.vsix`
);
console.log(
` ${styleText("bold", "code")} --install-extension archgate.vsix`
);
console.log(` rm archgate.vsix`);
break;
}
case "opencode": {
logInfo(
"Retry the install, or refresh your credentials if they have expired:"
);
console.log(` ${styleText("bold", "archgate login refresh")}`);
console.log(
` ${styleText("bold", "archgate plugin install --editor opencode")}`
);
break;
}
}
}

export function registerPluginInstallCommand(plugin: Command) {
plugin
.command("install")
.description("Install the archgate plugin for the specified editor")
.addOption(editorOption)
.action(async (opts) => {
const credentials = await loadCredentials();
if (!credentials) {
logError(
"Not logged in.",
"Run `archgate login` first to authenticate."
);
await exitWith(1);
return;
}

// Resolve editors: explicit flag, interactive prompt, or default
let editors: EditorTarget[];
if (opts.editor) {
editors = [opts.editor];
} else if (process.stdin.isTTY) {
const detected = await detectEditors();
editors = await promptEditorSelection(detected);
} else {
editors = ["claude"];
}

for (const editor of editors) {
const label = EDITOR_LABELS[editor];
try {
// oxlint-disable-next-line no-await-in-loop -- sequential install with per-editor output
await installForEditor(editor, label, credentials.token);
} catch (err) {
try {
const credentials = await loadCredentials();
if (!credentials) {
logError(
`Failed to install plugin for ${label}.`,
err instanceof Error ? err.message : String(err)
"Not logged in.",
"Run `archgate login` first to authenticate."
);
await exitWith(1);
return;
}

// Show manual install commands so the user can retry themselves
switch (editor) {
case "claude": {
const url = buildMarketplaceUrl();
logInfo("To install the plugin manually, run:");
console.log(
` ${styleText("bold", "claude plugin marketplace add")} ${url}`
);
console.log(
` ${styleText("bold", "claude plugin install")} archgate@archgate`
);
break;
}
case "copilot": {
const url = buildVscodeMarketplaceUrl();
logInfo("To install the plugin manually, run:");
console.log(
` ${styleText("bold", "copilot plugin marketplace add")} ${url}`
);
console.log(
` ${styleText("bold", "copilot plugin install")} archgate@archgate`
);
break;
}
case "cursor": {
logInfo("To install the plugin manually, run:");
console.log(
` ${styleText("bold", "curl")} -H "Authorization: Bearer <token>" https://plugins.archgate.dev/api/vscode -o archgate.vsix`
);
console.log(
` Then in Cursor: Ctrl+Shift+P → ${styleText("bold", "Extensions: Install from VSIX...")} → select archgate.vsix`
);
break;
}
case "vscode": {
logInfo("To install the extension manually, run:");
console.log(
` ${styleText("bold", "curl")} -H "Authorization: Bearer <token>" https://plugins.archgate.dev/api/vscode -o archgate.vsix`
);
console.log(
` ${styleText("bold", "code")} --install-extension archgate.vsix`
);
console.log(` rm archgate.vsix`);
break;
}
case "opencode": {
logInfo(
"Retry the install, or refresh your credentials if they have expired:"
);
console.log(` ${styleText("bold", "archgate login refresh")}`);
console.log(
` ${styleText("bold", "archgate plugin install --editor opencode")}`
);
break;
}
// Resolve editors: explicit flag, interactive prompt, or default
let editors: EditorTarget[];
if (opts.editor) {
editors = [opts.editor];
} else if (process.stdin.isTTY) {
const detected = await detectEditors();
editors = await promptEditorSelection(detected);
} else {
editors = ["claude"];
}

const failures: {
editor: EditorTarget;
label: string;
error: string;
}[] = [];

for (const editor of editors) {
const label = EDITOR_LABELS[editor];
try {
// oxlint-disable-next-line no-await-in-loop -- sequential install with per-editor output
await installForEditor(editor, label, credentials.token);
} catch (err) {
failures.push({
editor,
label,
error: err instanceof Error ? err.message : String(err),
});
}
}

// oxlint-disable-next-line no-await-in-loop -- exit immediately on first editor failure
// Print all failures together at the end so they are easy to review
if (failures.length > 0) {
console.log();
for (const { editor, label, error } of failures) {
logError(`Failed to install plugin for ${label}.`, error);
printManualInstructions(editor);
console.log();
}
await exitWith(1);
}
} catch (err) {
// Re-throw ExitPromptError so main().catch() handles Ctrl+C (exit 130)
if (err instanceof Error && err.name === "ExitPromptError") throw err;
logError(err instanceof Error ? err.message : String(err));
await exitWith(1);
}
});
}
Loading