diff --git a/.github/workflows/netlify-ops.yml b/.github/workflows/netlify-ops.yml index 3a3638bae8..d235974f16 100644 --- a/.github/workflows/netlify-ops.yml +++ b/.github/workflows/netlify-ops.yml @@ -152,7 +152,7 @@ jobs: echo "CUSTOM DOMAIN CONFIGURED: images.devsy.sh" echo "========================================" echo "" - echo "DNS action required — add this DNS record:" + echo "DNS action required - add this DNS record:" echo " Type: CNAME" echo " Name: images" echo " Value: ${NETLIFY_SUBDOMAIN}.netlify.app" diff --git a/.github/workflows/restore-netlify.yml b/.github/workflows/restore-netlify.yml index 0df800e69f..87dcba9df3 100644 --- a/.github/workflows/restore-netlify.yml +++ b/.github/workflows/restore-netlify.yml @@ -52,7 +52,7 @@ jobs: echo "$BODY" exit 1 fi - echo "Restore API returned HTTP $HTTP_CODE — success" + echo "Restore API returned HTTP $HTTP_CODE - success" echo "" echo "Verifying..." @@ -63,5 +63,5 @@ jobs: if [ "$STATUS" = "200" ]; then echo "SUCCESS: devsy.sh is back online" else - echo "WARNING: devsy.sh returned $STATUS — may need a few more seconds to propagate" + echo "WARNING: devsy.sh returned $STATUS - may need a few more seconds to propagate" fi diff --git a/cmd/internal/agentworkspace/delete_test.go b/cmd/internal/agentworkspace/delete_test.go index 2adf845638..1d3dd0af12 100644 --- a/cmd/internal/agentworkspace/delete_test.go +++ b/cmd/internal/agentworkspace/delete_test.go @@ -73,12 +73,12 @@ func TestForceRemoveAll_ReadOnlyDirectory(t *testing.T) { t.Fatal(err) } - // Remove write+execute from content dir — simulates what crun does. + // Remove write+execute from content dir - simulates what crun does. chmodReadOnly(t, content) // Standard RemoveAll should fail. if err := os.RemoveAll(target); err == nil { - t.Skip("os.RemoveAll succeeded unexpectedly — filesystem may not enforce permissions") + t.Skip("os.RemoveAll succeeded unexpectedly - filesystem may not enforce permissions") } // forceRemoveAll should fix permissions and succeed. diff --git a/cmd/internal/agentworkspace/setup_gpg.go b/cmd/internal/agentworkspace/setup_gpg.go index 4083dd05d4..018b6685b2 100644 --- a/cmd/internal/agentworkspace/setup_gpg.go +++ b/cmd/internal/agentworkspace/setup_gpg.go @@ -98,7 +98,7 @@ func (cmd *SetupGPGCmd) Run(ctx context.Context) error { return nil } -// gpgSetupLockMode is 0666 — flock's default 0600 would lock out whichever +// gpgSetupLockMode is 0666 - flock's default 0600 would lock out whichever // of root/remoteUser did not create the file. const gpgSetupLockMode = 0o666 diff --git a/cmd/internal/git_ssh_signature_test.go b/cmd/internal/git_ssh_signature_test.go index dbc2f563b2..552906800b 100644 --- a/cmd/internal/git_ssh_signature_test.go +++ b/cmd/internal/git_ssh_signature_test.go @@ -42,7 +42,7 @@ func (s *GitSSHSignatureTestSuite) TestParseNonSignCommand() { } func (s *GitSSHSignatureTestSuite) TestParseMissingBufferFile() { - // All args end in a flag — no buffer file present. + // All args end in a flag - no buffer file present. args := []string{"-Y", "sign", "-n", "git", "-f", "/path/to/key.pub", "-U"} result := parseSSHKeygenArgs(args) assert.Equal(s.T(), "", result.bufferFile) diff --git a/cmd/internal/ssh_server_test.go b/cmd/internal/ssh_server_test.go index 12f7e165d7..3be14496f5 100644 --- a/cmd/internal/ssh_server_test.go +++ b/cmd/internal/ssh_server_test.go @@ -110,7 +110,7 @@ func TestEnsureActivityFileCreatesAndIsIdempotent(t *testing.T) { } func TestEnsureActivityFileSurfacesNonExistErrors(t *testing.T) { - // Path through a non-directory is ENOTDIR, which is neither nil nor ErrNotExist — + // Path through a non-directory is ENOTDIR, which is neither nil nor ErrNotExist - // must surface as-is instead of falling into the create branch. tmp := t.TempDir() regular := filepath.Join(tmp, "regular") diff --git a/cmd/internal/widen_shared_file.go b/cmd/internal/widen_shared_file.go index 09dfa7bbb7..05d670a9f9 100644 --- a/cmd/internal/widen_shared_file.go +++ b/cmd/internal/widen_shared_file.go @@ -13,7 +13,7 @@ import ( // NewWidenSharedFileCmd returns a internal command that runs // sharedfile.WidenIfNeeded. sharedfile.WidenWithSudoFallback re-execs this // (via sudo) so the actual mode change still goes through WidenIfNeeded's -// open-with-O_NOFOLLOW-then-fchmod, even when it needs root — `sudo chmod +// open-with-O_NOFOLLOW-then-fchmod, even when it needs root - `sudo chmod // ` has no way to refuse following a symlink at path, so re-execing // into this process is what keeps the escalated path symlink-safe. func NewWidenSharedFileCmd(globalFlags *flags.GlobalFlags) *cobra.Command { diff --git a/cmd/mcp/buffer.go b/cmd/mcp/buffer.go index ca7c3773e9..7c1125204b 100644 --- a/cmd/mcp/buffer.go +++ b/cmd/mcp/buffer.go @@ -23,7 +23,7 @@ func (b *BoundedBuffer) Write(p []byte) (int, error) { n := len(p) b.written += int64(n) if len(p) >= b.cap { - // Incoming chunk fills or exceeds cap — keep only the last cap bytes. + // Incoming chunk fills or exceeds cap - keep only the last cap bytes. b.buf = append(b.buf[:0], p[len(p)-b.cap:]...) return n, nil } diff --git a/cmd/mcp/notify.go b/cmd/mcp/notify.go index cad10a6907..2c47ba5a48 100644 --- a/cmd/mcp/notify.go +++ b/cmd/mcp/notify.go @@ -16,7 +16,7 @@ import ( // long-running tools instead of seeing a single opaque pause. // // Lines from goroutines unrelated to fn are also forwarded for the duration -// — acceptable because the only long-running concurrent work the MCP server +// - acceptable because the only long-running concurrent work the MCP server // kicks off is the call itself. func streamLogsToSession( ctx context.Context, diff --git a/cmd/mcp/tools_exec.go b/cmd/mcp/tools_exec.go index 2905880ae4..546f24106f 100644 --- a/cmd/mcp/tools_exec.go +++ b/cmd/mcp/tools_exec.go @@ -48,7 +48,7 @@ func registerExecTool(s *sdkmcp.Server, cmd *ServeCmd, sem *opSemaphore) { Description: "Run a one-shot command in a running workspace container. The " + "workspace name must match workspace_list; the workspace must already be " + "started (use workspace_start if not). 'command' is argv, NOT a shell " + - "string — pass [\"sh\", \"-c\", \"...\"] to use a shell. Each output " + + "string - pass [\"sh\", \"-c\", \"...\"] to use a shell. Each output " + "stream is capped; long output is truncated tail-only with a marker.", }, safeHandler(func( ctx context.Context, _ *sdkmcp.CallToolRequest, in execInput, diff --git a/cmd/mcp/tools_workspace.go b/cmd/mcp/tools_workspace.go index f99b7add07..52ffbfee35 100644 --- a/cmd/mcp/tools_workspace.go +++ b/cmd/mcp/tools_workspace.go @@ -204,7 +204,7 @@ func registerWorkspaceCreateTool(s *sdkmcp.Server, g *flags.GlobalFlags, sem *op Name: "workspace_create", Description: "Create and start a new workspace. May take several minutes on " + "first use (image pull, git clone, post-create commands); if the call " + - "times out client-side, the server-side operation likely continued — " + + "times out client-side, the server-side operation likely continued - " + "poll workspace_status to check.\n" + "\n" + "source: a git URL (https://, git@host:repo, ssh://, or git:https://... " + diff --git a/cmd/root.go b/cmd/root.go index 3792d84ad8..10ee0b70a9 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -62,7 +62,7 @@ const ( internalCommand = "internal" - rootLong = "Devsy — standardized development workspaces built on devcontainers, " + + rootLong = "Devsy - standardized development workspaces built on devcontainers, " + "running on Docker, Kubernetes, cloud providers, and SSH remote hosts." rootExample = `- Start a workspace from the current directory: diff --git a/cmd/snapshot/create.go b/cmd/snapshot/create.go index 240b74a779..eefb8d800d 100644 --- a/cmd/snapshot/create.go +++ b/cmd/snapshot/create.go @@ -213,7 +213,7 @@ func (cmd *CreateCmd) commitAndPushImage( // tag right after create, and would otherwise have to re-fetch it // remotely (pkg/image.GetImage), which doesn't honor this package's // dockerInternalHost insecure-registry override the way pkg/snapshot's - // own parseReference does — breaking against any plain-HTTP registry + // own parseReference does - breaking against any plain-HTTP registry // (e.g. the e2e registry:2 fixture). Leaving the local image in place // avoids that remote round-trip entirely for the common case. return img, nil @@ -307,7 +307,7 @@ type pushedVolumes struct { // The volumes RPC (StreamSnapshotVolumes) is served by a tunnelServer reading // directly off local disk, so this only works when the CLI process is -// co-located with those mount source paths — true for the docker driver's +// co-located with those mount source paths - true for the docker driver's // local bind mounts, the only driver CommitContainer currently supports. func (cmd *CreateCmd) pushVolumes( ctx context.Context, workspaceConfig *provider.Workspace, repository string, @@ -349,7 +349,7 @@ func (cmd *CreateCmd) pushVolumes( // credentialKeyPattern matches containerEnv key names that conventionally // carry a secret value, so they're dropped by redactedContainerEnv even if -// nothing in this codebase injects them today — devcontainer.json's +// nothing in this codebase injects them today - devcontainer.json's // containerEnv is user-authored and this manifest is pushed to a shared // registry, so a future entry named e.g. API_TOKEN shouldn't round-trip // through restore just because dropping it wasn't specifically taught. @@ -431,7 +431,7 @@ func newLocalTunnelClient( // It also re-pushes the same manifest bytes as a plain blob into repository: // registries store manifests and blobs in separate content stores, and the // snapshot manifest built in Run references this digest as one of its -// layers[] — a manifest-push validates every layer digest exists as a blob, +// layers[] - a manifest-push validates every layer digest exists as a blob, // which fails with MANIFEST_BLOB_UNKNOWN without this re-push. func pushedImageDigestAndSize( ctx context.Context, diff --git a/cmd/workspace/troubleshoot.go b/cmd/workspace/troubleshoot.go index 1d18eb604f..54f94a78a4 100644 --- a/cmd/workspace/troubleshoot.go +++ b/cmd/workspace/troubleshoot.go @@ -84,7 +84,7 @@ func (cmd *TroubleshootCmd) Run(ctx context.Context, args []string) { // Print on every exit path, including panics. defer printTroubleshootInfo(info) - // Collect as much as possible — partial info beats no info, so do not + // Collect as much as possible - partial info beats no info, so do not // return early on errors except where downstream steps require the result. var err error info.Config, err = config.LoadConfig(cmd.Context, cmd.Provider) diff --git a/cmd/workspace/up/up.go b/cmd/workspace/up/up.go index 464fdb8945..28184311ad 100644 --- a/cmd/workspace/up/up.go +++ b/cmd/workspace/up/up.go @@ -639,7 +639,7 @@ func (cmd *UpCmd) executeDevsyUp( if cmd.Platform.Enabled { return nil, nil } - // Guard against a result that lacks the substitution context — that + // Guard against a result that lacks the substitution context - that // indicates the agent returned a half-populated result (e.g. an inner // container-setup failure that didn't carry through as result.Error). // Without this, downstream openIDE would nil-deref on @@ -740,7 +740,7 @@ func watchForForceShutdown(ctx context.Context, done <-chan struct{}) { signal.Notify(signals, shutdownSignals...) select { case <-signals: - os.Exit(1) // second signal — force shutdown + os.Exit(1) // second signal - force shutdown case <-done: signal.Stop(signals) } diff --git a/cmd/workspace/up/up_test.go b/cmd/workspace/up/up_test.go index edfe71215a..0d13b8659f 100644 --- a/cmd/workspace/up/up_test.go +++ b/cmd/workspace/up/up_test.go @@ -330,7 +330,7 @@ func TestBuildUpCmd_DefaultsIDEToNone(t *testing.T) { t, "none", cmd.IDE, - "MCP path must default IDE to none — there's no human to attach an IDE to", + "MCP path must default IDE to none - there's no human to attach an IDE to", ) } diff --git a/desktop/e2e/electron-app.ts b/desktop/e2e/electron-app.ts index 74591724ce..275c07d4ca 100644 --- a/desktop/e2e/electron-app.ts +++ b/desktop/e2e/electron-app.ts @@ -38,7 +38,7 @@ export async function launchApp(): Promise<{ await page.locator('[data-sidebar="sidebar"]').waitFor({ timeout: 10000 }) // Wait for the watcher to poll the mock CLI and populate data - // The watcher polls every 3 seconds — wait for at least one cycle + // The watcher polls every 3 seconds - wait for at least one cycle await page.waitForTimeout(4000) return { app, page } diff --git a/desktop/e2e/integration.e2e.ts b/desktop/e2e/integration.e2e.ts index 30ffdf8108..02e7d077eb 100644 --- a/desktop/e2e/integration.e2e.ts +++ b/desktop/e2e/integration.e2e.ts @@ -2,9 +2,6 @@ import type { ElectronApplication, Page } from "@playwright/test" import { expect, test } from "@playwright/test" import { launchApp, resetMockState } from "./electron-app.js" -// --------------------------------------------------------------------------- -// Flow 1 — Provider CRUD -// --------------------------------------------------------------------------- test.describe .serial("Provider CRUD", () => { let app: ElectronApplication @@ -43,21 +40,17 @@ test.describe const sheet = page.locator('[data-slot="sheet-content"]') await sheet.waitFor({ timeout: 5000 }) - // Click Delete in the sheet await sheet.getByRole("button", { name: "Delete" }).click() - // ConfirmDialog appears — click its destructive Delete button const confirmDialog = page.locator('[data-slot="dialog-content"]') await confirmDialog.waitFor({ timeout: 5000 }) await confirmDialog.getByRole("button", { name: "Delete" }).click() - // Wait for both dialogs to close await sheet.waitFor({ state: "hidden", timeout: 10000 }) // Wait for watcher to poll updated state await page.waitForTimeout(4000) - // Verify docker is gone await expect(main).not.toContainText("docker", { timeout: 10000 }) await expect(main).toContainText("kubernetes", { timeout: 10000 }) }) @@ -91,32 +84,26 @@ test.describe .getByRole("button", { name: /add your first provider/i }) .click() - // The provider wizard opens as a Dialog const wizard = page.locator('[data-slot="dialog-content"]') await wizard.waitFor({ timeout: 5000 }) await expect(wizard).toContainText("Select a Provider") - // Click the docker preset card to select it await wizard .locator("button", { hasText: "docker" }) .filter({ hasText: "Local Docker containers" }) .click() - // Click Continue to add the provider await wizard.getByRole("button", { name: /^Continue$/ }).click() - // Docker mock has no required options -> wizard jumps to init then complete. - // Wait for the "Done" button on the Complete step. + // The mock provider has no required options, so the wizard advances to Complete. await wizard .getByRole("button", { name: "Done" }) .waitFor({ timeout: 15000 }) await wizard.getByRole("button", { name: "Done" }).click() - // Wizard closes, ProviderAddPage redirects to /providers await wizard.waitFor({ state: "hidden", timeout: 10000 }) await page.waitForTimeout(4000) - // Verify docker appears in provider cards const main = page.locator('[data-slot="sidebar-inset"] main') await expect(main).toContainText("docker", { timeout: 10000 }) }) @@ -128,23 +115,18 @@ test.describe const sheet = page.locator('[data-slot="sheet-content"]') await sheet.waitFor({ timeout: 5000 }) - // Click Rename button in the sheet header await sheet.getByRole("button", { name: "Rename" }).click() - // Fill the rename input const renameInput = sheet.locator("input").first() await renameInput.fill("my-docker") - // Click Save in the rename form (the first Save button in the sheet header) await sheet.getByRole("button", { name: "Save" }).first().click() - // Sheet closes after successful rename await sheet.waitFor({ state: "hidden", timeout: 10000 }) // Wait for watcher await page.waitForTimeout(4000) - // Verify 'my-docker' appears await expect(main).toContainText("my-docker", { timeout: 10000 }) }) @@ -196,9 +178,6 @@ test.describe }) }) -// --------------------------------------------------------------------------- -// Flow 2 — Workspace lifecycle (Node.js) -// --------------------------------------------------------------------------- test.describe .serial("Workspace lifecycle - Node.js", () => { let app: ElectronApplication @@ -228,13 +207,10 @@ test.describe const dialog = page.locator('[role="dialog"]').first() await dialog.waitFor({ timeout: 5000 }) - // Step 1 — Provider: select docker, continue await dialog.locator("button", { hasText: "docker" }).first().click() await dialog.getByRole("button", { name: /^continue$/i }).click() - // Step 2 — Source: click Node.js template. Scope to the active source - // panel (Git) so the template button doesn't collide with the Image - // catalog's "Node.js 20" card. + // Scope to the Git panel because the image catalog also has a Node.js card. await dialog .getByTestId("source-panel") .locator("button", { hasText: "Node.js" }) @@ -246,13 +222,10 @@ test.describe ) await dialog.getByRole("button", { name: /^continue$/i }).click() - // Step 3 — IDE: default "None", continue await dialog.getByRole("button", { name: /^continue$/i }).click() - // Step 4 — Review: Launch await dialog.getByRole("button", { name: /^launch$/i }).click() - // Step 5 — Launch: wait for streaming output and success await expect(dialog).toContainText(/resolving|pulling|starting|ready/i, { timeout: 15000, }) @@ -260,7 +233,6 @@ test.describe .getByRole("button", { name: /open workspace/i }) .waitFor({ timeout: 15000 }) - // Close the dialog await page.keyboard.press("Escape") await dialog.waitFor({ state: "hidden", timeout: 5000 }) @@ -276,22 +248,17 @@ test.describe }) test("should navigate to workspace detail and stop it", async () => { - // Click the workspace row await page.locator("table tr", { hasText: "node-js" }).click() - // Wait for detail page await page .locator("h1", { hasText: "node-js" }) .waitFor({ timeout: 10000 }) - // Click Stop await page.getByRole("button", { name: "Stop" }).click() - // Wait for stop operation to complete await page.waitForTimeout(5000) - // Verify the status badge in the header shows "Stopped" - // The header has: h1, provider badge, status badge — target the status badge near h1 + // The header has: h1, provider badge, status badge - target the status badge near h1 const headerArea = page .locator("h1", { hasText: "node-js" }) .locator("..") @@ -301,15 +268,12 @@ test.describe test("can rename a workspace", async () => { // We're on the node-js detail page after stopping it - // Click the rename (pencil) button await page.locator('[data-slot="workspace-rename-btn"]').click() - // Fill the rename input with new name const renameInput = page.locator('[data-slot="workspace-rename-input"]') await renameInput.waitFor({ timeout: 5000 }) await renameInput.fill("node-js-renamed") - // Click Save await page.locator('[data-slot="workspace-rename-save"]').click() // ConfirmDialog warns that the existing container will be reset. @@ -320,25 +284,20 @@ test.describe // Wait for rename to complete and navigation to new URL await page.waitForTimeout(4000) - // Verify the new name appears in the header const headerArea = page.locator("h1", { hasText: "node-js-renamed" }) await expect(headerArea).toBeVisible({ timeout: 10000 }) }) test("should delete workspace from detail page", async () => { - // Open the More actions dropdown, then click Delete await page.getByRole("button", { name: "More actions" }).click() await page.getByRole("menuitem", { name: "Delete" }).click() - // ConfirmDialog appears — click the confirm Delete in the dialog const confirmDialog = page.locator('[data-slot="dialog-content"]') await confirmDialog.waitFor({ timeout: 5000 }) await confirmDialog.getByRole("button", { name: "Delete" }).click() - // Navigates to /workspaces on success — wait for table await page.locator("table").waitFor({ timeout: 15000 }) - // Verify renamed workspace is gone await expect(page.locator("table")).not.toContainText( "node-js-renamed", { timeout: 10000 }, @@ -346,9 +305,6 @@ test.describe }) }) -// --------------------------------------------------------------------------- -// Flow 3 — Workspace lifecycle (Python) -// --------------------------------------------------------------------------- test.describe .serial("Workspace lifecycle - Python", () => { let app: ElectronApplication @@ -372,12 +328,10 @@ test.describe const dialog = page.locator('[role="dialog"]').first() await dialog.waitFor({ timeout: 5000 }) - // Step 1 — Provider: select docker, continue await dialog.locator("button", { hasText: "docker" }).first().click() await dialog.getByRole("button", { name: /^continue$/i }).click() - // Step 2 — Source: click Python template (scope to the active Git source - // panel so it doesn't match the Image catalog's "Python 3.12" entry) + // Scope to the Git panel because the image catalog also has a Python card. await dialog .getByTestId("source-panel") .locator("button", { hasText: "Python" }) @@ -389,18 +343,14 @@ test.describe ) await dialog.getByRole("button", { name: /^continue$/i }).click() - // Step 3 — IDE: default "None", continue await dialog.getByRole("button", { name: /^continue$/i }).click() - // Step 4 — Review: Launch await dialog.getByRole("button", { name: /^launch$/i }).click() - // Step 5 — Launch: wait for success await dialog .getByRole("button", { name: /open workspace/i }) .waitFor({ timeout: 15000 }) - // Close the dialog await page.keyboard.press("Escape") await dialog.waitFor({ state: "hidden", timeout: 5000 }) @@ -415,19 +365,15 @@ test.describe }) test("should delete python workspace", async () => { - // Click workspace row await page.locator("table tr", { hasText: "python" }).click() - // Wait for detail page await page .locator("h1", { hasText: "python" }) .waitFor({ timeout: 10000 }) - // Open the More actions dropdown, then click Delete await page.getByRole("button", { name: "More actions" }).click() await page.getByRole("menuitem", { name: "Delete" }).click() - // Confirm in the dialog const confirmDialog = page.locator('[data-slot="dialog-content"]') await confirmDialog.waitFor({ timeout: 5000 }) await confirmDialog.getByRole("button", { name: "Delete" }).click() diff --git a/desktop/e2e/navigation.e2e.ts b/desktop/e2e/navigation.e2e.ts index c11c3eaba0..37d42e56bf 100644 --- a/desktop/e2e/navigation.e2e.ts +++ b/desktop/e2e/navigation.e2e.ts @@ -40,7 +40,7 @@ test.describe("Sidebar Navigation", () => { test("should navigate to Terminals page", async () => { await page.click('[data-sidebar="sidebar"] a[href="#/terminals"]') - // Terminals page doesn't have an h1 — it shows "No active terminals" or the terminal tabs + // Terminals page doesn't have an h1 - it shows "No active terminals" or the terminal tabs const main = page.locator('[data-slot="sidebar-inset"]') await expect(main).toContainText(/no active terminals|new shell/i, { timeout: 5000, diff --git a/desktop/e2e/providers.e2e.ts b/desktop/e2e/providers.e2e.ts index 0ab4f029cb..0e078b33f7 100644 --- a/desktop/e2e/providers.e2e.ts +++ b/desktop/e2e/providers.e2e.ts @@ -136,7 +136,7 @@ test.describe("Provider lifecycle badges", () => { }) // An abandoned wizard (skip init, or close mid-flow) leaves the install's - // job open. Without an explicit release the card spins on "installing…" + // job open. Without an explicit release the card spins on "installing..." // forever, since nothing else will ever finish that job. test("releases the job when a provider is added but never initialized", async () => { const main = page.locator('[data-slot="sidebar-inset"] main') diff --git a/desktop/e2e/workspaces.e2e.ts b/desktop/e2e/workspaces.e2e.ts index 47cee6408f..5f78d9167d 100644 --- a/desktop/e2e/workspaces.e2e.ts +++ b/desktop/e2e/workspaces.e2e.ts @@ -250,7 +250,6 @@ test.describe.serial("Create Workspace Wizard", () => { test("should open the wizard and show step 1 (provider)", async () => { const dialog = await openCreateWorkspaceWizard(page) - // Step indicator labels — all 5 steps present for (const label of ["Provider", "Source", "IDE", "Review", "Launch"]) { await expect(dialog).toContainText(label) } diff --git a/desktop/src/main/__tests__/tray.test.ts b/desktop/src/main/__tests__/tray.test.ts index cb8cbd1d8d..d6231206b4 100644 --- a/desktop/src/main/__tests__/tray.test.ts +++ b/desktop/src/main/__tests__/tray.test.ts @@ -181,7 +181,7 @@ describe("buildTrayMenuTemplate", () => { makeActions(), ) expect(items[0]).toMatchObject({ - label: "Devsy — 2 running workspaces", + label: "Devsy - 2 running workspaces", enabled: false, }) }) @@ -229,7 +229,7 @@ describe("buildTrayMenuTemplate", () => { model({ workspaces: [{ id: "api", status: "running" }] }), actions, ) - const row = items.find((item) => item.label === "● api — Running") + const row = items.find((item) => item.label === "● api - Running") expect(row).toBeDefined() const submenu = row?.submenu as Electron.MenuItemConstructorOptions[] const stop = submenu.find((item) => item.label === "Stop Workspace") @@ -245,7 +245,7 @@ describe("buildTrayMenuTemplate", () => { model({ workspaces: [{ id: "api", status: "stopped" }] }), actions, ) - const row = items.find((item) => item.label === "○ api — Stopped") + const row = items.find((item) => item.label === "○ api - Stopped") const submenu = row?.submenu as Electron.MenuItemConstructorOptions[] const start = submenu.find((item) => item.label === "Start Workspace") expect(start).toBeDefined() @@ -332,7 +332,7 @@ describe("buildTrayMenuTemplate", () => { const submenu = (name: string) => row(name)?.submenu as Electron.MenuItemConstructorOptions[] - expect(row("stop-failed")?.label).toBe("✖ stop-failed — Stop failed") + expect(row("stop-failed")?.label).toBe("✖ stop-failed - Stop failed") const stop = submenu("stop-failed").find( (item) => item.label === "Stop Workspace", ) @@ -418,7 +418,7 @@ describe("buildTrayMenuTemplate", () => { }), makeActions(), ) - expect(items.some((item) => item.label === "✖ api — Stop failed")).toBe( + expect(items.some((item) => item.label === "✖ api - Stop failed")).toBe( true, ) }) @@ -445,7 +445,7 @@ describe("buildTrayMenuTemplate", () => { }), makeActions(), ) - const row = items.find((item) => item.label === "○ api — Stopped") + const row = items.find((item) => item.label === "○ api - Stopped") const submenu = row?.submenu as Electron.MenuItemConstructorOptions[] const start = submenu.find((item) => item.label?.includes("Start")) expect(start?.enabled).toBe(false) @@ -505,7 +505,7 @@ describe("buildTrayMenuTemplate", () => { const items = buildTrayMenuTemplate(model({}), actions) const prefs = items.find((item) => item.label === "Preferences") const submenu = prefs?.submenu as Electron.MenuItemConstructorOptions[] - const openSettings = submenu.find((item) => item.label === "Open Settings…") + const openSettings = submenu.find((item) => item.label === "Open Settings...") ;(openSettings as { click?: () => void }).click?.() expect(actions.showSettings).toHaveBeenCalledTimes(1) }) diff --git a/desktop/src/main/cli.ts b/desktop/src/main/cli.ts index a97cad9439..6759af1eaf 100644 --- a/desktop/src/main/cli.ts +++ b/desktop/src/main/cli.ts @@ -126,7 +126,7 @@ function parseCommandResult(stdout: string): T { /** * Parse a single stderr line as a zap JSON record. Returns undefined when the - * line is not valid JSON or not a plain object — callers should treat the line + * line is not valid JSON or not a plain object - callers should treat the line * as opaque text in that case. */ function parseStderrLine(line: string): CliLogLine | undefined { @@ -138,7 +138,7 @@ function parseStderrLine(line: string): CliLogLine | undefined { return obj as CliLogLine } } catch { - // not JSON — fall through + // not JSON - fall through } return undefined } diff --git a/desktop/src/main/index.ts b/desktop/src/main/index.ts index b7c9de7995..df49e1d48a 100644 --- a/desktop/src/main/index.ts +++ b/desktop/src/main/index.ts @@ -176,7 +176,7 @@ app.whenReady().then(async () => { const cli = new CliRunner(binaryPath) cli.setDiagnosticLogLevel(appSettingsStore.get().cliCaptureLogLevel) - // Initialize log store. Logs live under ~/.devsy/desktop/logs/ — inside the + // Initialize log store. Logs live under ~/.devsy/desktop/logs/ - inside the // shared ~/.devsy root (no artifact sprawl) but outside the CLI-managed // ~/.devsy/contexts//workspaces// subtree that `workspace delete` // unlinks. That separation closes the file-deletion race by construction. diff --git a/desktop/src/main/ipc.ts b/desktop/src/main/ipc.ts index c65b31d507..cdde1c3451 100644 --- a/desktop/src/main/ipc.ts +++ b/desktop/src/main/ipc.ts @@ -715,9 +715,9 @@ export function registerIpcHandlers(deps: IpcDependencies): { providerJobs.clear(args.name) }) - // Releases a job the caller opened but will not finish — e.g. the wizard + // Releases a job the caller opened but will not finish - e.g. the wizard // installs a provider, then the user skips initialization or closes the - // dialog. Without this the card would spin on "installing…" indefinitely. + // dialog. Without this the card would spin on "installing..." indefinitely. ipcMain.handle( "provider_release_job", async (_event, args: { name: string }) => { diff --git a/desktop/src/main/tray.ts b/desktop/src/main/tray.ts index 13fb63330b..56471f5674 100644 --- a/desktop/src/main/tray.ts +++ b/desktop/src/main/tray.ts @@ -138,8 +138,8 @@ export function buildTrayMenuTemplate( { label: running === 0 - ? "Devsy — No running workspaces" - : `Devsy — ${running} running workspace${running === 1 ? "" : "s"}`, + ? "Devsy - No running workspaces" + : `Devsy - ${running} running workspace${running === 1 ? "" : "s"}`, enabled: false, }, { type: "separator" }, @@ -163,7 +163,7 @@ export function buildTrayMenuTemplate( model.pendingStops.has(workspace.id) || (workspaceJobBusy(job) && !workspaceJobInterruptible(job)) submenu.push({ - label: stopping ? `${jobLabel ?? "Stopping"}…` : "Stop Workspace", + label: stopping ? `${jobLabel ?? "Stopping"}...` : "Stop Workspace", enabled: !stopping, click: stopping ? undefined @@ -172,7 +172,7 @@ export function buildTrayMenuTemplate( } else if (actionState === "stopped") { submenu.push({ label: model.pendingStarts.has(workspace.id) - ? "Starting…" + ? "Starting..." : "Start Workspace", enabled: !model.pendingStarts.has(workspace.id), click: model.pendingStarts.has(workspace.id) @@ -187,7 +187,7 @@ export function buildTrayMenuTemplate( }) } return { - label: `${STATE_GLYPHS[state]} ${workspace.id} — ${jobLabel && (state === "busy" || state === "failed") ? jobLabel : STATE_TEXT[state]}`, + label: `${STATE_GLYPHS[state]} ${workspace.id} - ${jobLabel && (state === "busy" || state === "failed") ? jobLabel : STATE_TEXT[state]}`, submenu, } }, @@ -226,7 +226,7 @@ export function buildTrayMenuTemplate( click: actions.toggleOpenToTray, }, { type: "separator" }, - { label: "Open Settings…", click: actions.showSettings }, + { label: "Open Settings...", click: actions.showSettings }, ], }, ...buildUpdateMenuItems(model.updateStatus, actions.installUpdate), @@ -264,7 +264,7 @@ export class AppTray { setup(): void { if (this.tray) return this.tray = new Tray(this.createTrayIcon()) - this.tray.setToolTip("Devsy — No running workspaces") + this.tray.setToolTip("Devsy - No running workspaces") this.unsubscribeWorkspaceState = this.deps.state.onWorkspacesChange(() => this.rebuildMenu(), ) @@ -330,8 +330,8 @@ export class AppTray { const running = countRunningWorkspaces(this.deps.state.workspaceList()) this.tray.setToolTip( running === 0 - ? "Devsy — No running workspaces" - : `Devsy — ${running} running workspace${running === 1 ? "" : "s"}`, + ? "Devsy - No running workspaces" + : `Devsy - ${running} running workspace${running === 1 ? "" : "s"}`, ) } diff --git a/desktop/src/renderer/src/lib/components/layout/Sidebar.svelte b/desktop/src/renderer/src/lib/components/layout/Sidebar.svelte index 8585b762b3..bf741cfb17 100644 --- a/desktop/src/renderer/src/lib/components/layout/Sidebar.svelte +++ b/desktop/src/renderer/src/lib/components/layout/Sidebar.svelte @@ -26,7 +26,7 @@ import type { Component } from "svelte" let { terminalCount = 0 }: { terminalCount?: number } = $props() -// Matches NAV_KEYS in App.svelte — maps shortcut number to route +// Matches NAV_KEYS in App.svelte - maps shortcut number to route const SHORTCUT_BY_HREF: Record = { "/": "1", "/workspaces": "2", diff --git a/desktop/src/renderer/src/lib/components/log/LogTable.svelte b/desktop/src/renderer/src/lib/components/log/LogTable.svelte index 52c90ef7b5..55bbe63db7 100644 --- a/desktop/src/renderer/src/lib/components/log/LogTable.svelte +++ b/desktop/src/renderer/src/lib/components/log/LogTable.svelte @@ -64,7 +64,7 @@ $effect(() => { {#if hiddenCount > 0}
- {hiddenCount.toLocaleString()} earlier {hiddenCount === 1 ? "line" : "lines"} hidden — open the full log to see everything + {hiddenCount.toLocaleString()} earlier {hiddenCount === 1 ? "line" : "lines"} hidden - open the full log to see everything
{/if} diff --git a/desktop/src/renderer/src/lib/components/provider/ProviderCard.svelte b/desktop/src/renderer/src/lib/components/provider/ProviderCard.svelte index 1fde4a8c8b..aee34a34d3 100644 --- a/desktop/src/renderer/src/lib/components/provider/ProviderCard.svelte +++ b/desktop/src/renderer/src/lib/components/provider/ProviderCard.svelte @@ -52,7 +52,7 @@ function sourceDisplay(p: Provider): string { {:else if status.kind === "failed"} {status.label} diff --git a/desktop/src/renderer/src/lib/components/provider/ProviderSheet.svelte b/desktop/src/renderer/src/lib/components/provider/ProviderSheet.svelte index 5db6f8274c..a2591065f9 100644 --- a/desktop/src/renderer/src/lib/components/provider/ProviderSheet.svelte +++ b/desktop/src/renderer/src/lib/components/provider/ProviderSheet.svelte @@ -493,7 +493,7 @@ async function handleSaveOptions() { {:else if status.kind === "failed"} {status.label} diff --git a/desktop/src/renderer/src/lib/components/terminal/Terminal.svelte b/desktop/src/renderer/src/lib/components/terminal/Terminal.svelte index 2d84501a99..841e9cc482 100644 --- a/desktop/src/renderer/src/lib/components/terminal/Terminal.svelte +++ b/desktop/src/renderer/src/lib/components/terminal/Terminal.svelte @@ -151,7 +151,7 @@ onMount(async () => { return } - // Now safely do async imports — listeners are active, so no events are lost + // Now safely do async imports - listeners are active, so no events are lost const [{ Terminal: XTerm }, { FitAddon: XFitAddon }] = await Promise.all([ import("@xterm/xterm"), import("@xterm/addon-fit"), @@ -230,7 +230,7 @@ $effect(() => { }) onDestroy(() => { - // Only disconnect the observer — keep the terminal instance alive + // Only disconnect the observer - keep the terminal instance alive resizeObserver?.disconnect() }) diff --git a/desktop/src/renderer/src/lib/components/update/UpdateDialog.svelte b/desktop/src/renderer/src/lib/components/update/UpdateDialog.svelte index e5c10bae9b..8c7ab8c8c7 100644 --- a/desktop/src/renderer/src/lib/components/update/UpdateDialog.svelte +++ b/desktop/src/renderer/src/lib/components/update/UpdateDialog.svelte @@ -50,7 +50,7 @@ async function onInstall() { {#if s.state === "checking"} -

Checking for updates…

+

Checking for updates...

{:else if s.state === "available"}

@@ -62,14 +62,14 @@ async function onInstall() {

{/if} {#if autoDownloadEnabled} -

Downloading in the background…

+

Downloading in the background...

{:else} {/if} {:else if s.state === "downloading"}
-

Downloading v{s.availableVersion}…

+

Downloading v{s.availableVersion}...

{s.progress.percent.toFixed(0)}% · {fmtMBps(s.progress.bytesPerSecond)} diff --git a/desktop/src/renderer/src/lib/components/update/UpdatesPanel.svelte b/desktop/src/renderer/src/lib/components/update/UpdatesPanel.svelte index b7afef031e..3b377c0b82 100644 --- a/desktop/src/renderer/src/lib/components/update/UpdatesPanel.svelte +++ b/desktop/src/renderer/src/lib/components/update/UpdatesPanel.svelte @@ -94,7 +94,7 @@ onMount(async () => { try { releaseChannel = await getReleaseChannel() } catch { - // Ignore — defaults to stable + // Ignore - defaults to stable } }) @@ -121,7 +121,7 @@ onMount(async () => {

{#if s.state === "checking"} -

Checking for updates…

+

Checking for updates...

{#if installedVersion} Installed: v{installedVersion} @@ -219,7 +219,7 @@ onMount(async () => { class="gap-2" > - {isChecking() ? "Checking…" : "Check now"} + {isChecking() ? "Checking..." : "Check now"} {/if}
@@ -278,7 +278,7 @@ onMount(async () => { { cardButton(/Stable/)?.click() await tick() - // Downgrade must wait for confirmation — no IPC call yet. + // Downgrade must wait for confirmation - no IPC call yet. expect(setReleaseChannel).not.toHaveBeenCalled() expect(document.body.textContent).toMatch(/switch to the stable channel\?/i) }) diff --git a/desktop/src/renderer/src/lib/components/update/status-copy.ts b/desktop/src/renderer/src/lib/components/update/status-copy.ts index 9c6e2e66cd..2a931e2ea4 100644 --- a/desktop/src/renderer/src/lib/components/update/status-copy.ts +++ b/desktop/src/renderer/src/lib/components/update/status-copy.ts @@ -15,7 +15,7 @@ export function fmtTime(ts: number | null): string { export function statusHeadline(s: UpdateStatus, currentVersion: string | null): string { switch (s.state) { case "checking": - return "Checking for updates…" + return "Checking for updates..." case "available": return `Version ${s.availableVersion} is available` case "downloading": diff --git a/desktop/src/renderer/src/lib/components/update/update-toasts.ts b/desktop/src/renderer/src/lib/components/update/update-toasts.ts index d3c8533a8f..1989f4d1e7 100644 --- a/desktop/src/renderer/src/lib/components/update/update-toasts.ts +++ b/desktop/src/renderer/src/lib/components/update/update-toasts.ts @@ -36,7 +36,7 @@ function fireAvailable( userInitiated = false const version = s.availableVersion if (autoDownload) { - toast.info(`Update v${version} found, downloading…`, { duration: 4000 }) + toast.info(`Update v${version} found, downloading...`, { duration: 4000 }) return } toast(`Update v${version} available`, { diff --git a/desktop/src/renderer/src/lib/components/workspace/ImagePicker.svelte b/desktop/src/renderer/src/lib/components/workspace/ImagePicker.svelte index 24c63ff7fd..12c412502b 100644 --- a/desktop/src/renderer/src/lib/components/workspace/ImagePicker.svelte +++ b/desktop/src/renderer/src/lib/components/workspace/ImagePicker.svelte @@ -66,7 +66,7 @@ function pick(ref: string) {
{#if $imageCatalog.loading} -

Loading catalog…

+

Loading catalog...

{:else if $imageCatalog.error}

Failed to load catalog: {$imageCatalog.error}

{/if} diff --git a/desktop/src/renderer/src/lib/components/workspace/WorkspaceWizard.svelte b/desktop/src/renderer/src/lib/components/workspace/WorkspaceWizard.svelte index 640f5ccf25..77f2109844 100644 --- a/desktop/src/renderer/src/lib/components/workspace/WorkspaceWizard.svelte +++ b/desktop/src/renderer/src/lib/components/workspace/WorkspaceWizard.svelte @@ -823,7 +823,7 @@ function selectTemplate(t: { name: string; source: string }) { {refType === "branch" ? "Branch name" : refType === "commit" ? "Commit SHA" : "PR / MR number"} (refValue = e.currentTarget.value)} /> @@ -1088,7 +1088,7 @@ function selectTemplate(t: { name: string; source: string }) { value={localPath} oninput={(e) => (localPath = e.currentTarget.value)} /> - +

Local sources require a provider running on this machine. @@ -1261,7 +1261,7 @@ function selectTemplate(t: { name: string; source: string }) { {#if sourceType === "image" && compatLoading}

- Checking image compatibility… + Checking image compatibility...

{/if} diff --git a/desktop/src/renderer/src/lib/ipc/bridge.ts b/desktop/src/renderer/src/lib/ipc/bridge.ts index 34d815fdc8..53533e4113 100644 --- a/desktop/src/renderer/src/lib/ipc/bridge.ts +++ b/desktop/src/renderer/src/lib/ipc/bridge.ts @@ -1,5 +1,5 @@ /** - * IPC bridge — uses Electron's contextBridge API when running in Electron, + * IPC bridge - uses Electron's contextBridge API when running in Electron, * falls back to mock implementations for browser-only development. */ diff --git a/desktop/src/renderer/src/lib/ipc/mock.ts b/desktop/src/renderer/src/lib/ipc/mock.ts index d415a0d971..00f93158f5 100644 --- a/desktop/src/renderer/src/lib/ipc/mock.ts +++ b/desktop/src/renderer/src/lib/ipc/mock.ts @@ -372,6 +372,6 @@ export async function listen( _event: string, _callback: (event: { payload: T }) => void, ): Promise { - // No-op in mock mode — events would come from the Rust backend + // No-op in mock mode - events would come from the Rust backend return () => {} } diff --git a/desktop/src/renderer/src/lib/stores/settings.ts b/desktop/src/renderer/src/lib/stores/settings.ts index b1f82dee21..f7c97d3b99 100644 --- a/desktop/src/renderer/src/lib/stores/settings.ts +++ b/desktop/src/renderer/src/lib/stores/settings.ts @@ -97,7 +97,7 @@ export function cycleTheme() { }) } -// Color scheme (accent) — picker is hidden in Settings; force purple for all +// Color scheme (accent) - picker is hidden in Settings; force purple for all // users regardless of any previously persisted value. export const colorScheme = writable("purple") @@ -146,7 +146,7 @@ export function setSidebarPosition(value: SidebarPosition) { sidebarPosition.set(value) } -// Auto-update — main process owns the persistent value. localStorage +// Auto-update - main process owns the persistent value. localStorage // is a cache for instant first paint; `syncAutoUpdateFromMain` reconciles // it with the main-process truth at app boot. export const autoUpdate = writable( diff --git a/desktop/src/renderer/src/lib/types/index.ts b/desktop/src/renderer/src/lib/types/index.ts index c176968e66..183bafc16a 100644 --- a/desktop/src/renderer/src/lib/types/index.ts +++ b/desktop/src/renderer/src/lib/types/index.ts @@ -91,7 +91,7 @@ export interface Provider { /** * In-flight provider work, tracked by the main process. Distinct from * `Provider.state.initialized`, which records whether the provider on disk - * has run its init — false both for "never initialized" and "installing now". + * has run its init - false both for "never initialized" and "installing now". */ export interface ProviderJob { activity: "installing" | "initializing" | "updating" @@ -175,7 +175,7 @@ export interface CommandProgress { done: boolean /** * Whether the command succeeded. Set on the final (done: true) event by the - * main process, which knows the exit code — consumers should read this + * main process, which knows the exit code - consumers should read this * rather than pattern-matching the log text. */ success?: boolean diff --git a/desktop/src/renderer/src/lib/utils/provider-status.ts b/desktop/src/renderer/src/lib/utils/provider-status.ts index 9b478336c4..4771216395 100644 --- a/desktop/src/renderer/src/lib/utils/provider-status.ts +++ b/desktop/src/renderer/src/lib/utils/provider-status.ts @@ -13,15 +13,15 @@ export interface ProviderStatus { } const PHASE_LABELS: Record = { - installing_provider: "installing…", - resolving_options: "resolving options…", - running_init: "initializing…", + installing_provider: "installing...", + resolving_options: "resolving options...", + running_init: "initializing...", } const ACTIVITY_LABELS: Record = { - installing: "installing…", - initializing: "initializing…", - updating: "updating…", + installing: "installing...", + initializing: "initializing...", + updating: "updating...", } /** diff --git a/desktop/src/renderer/src/pages/MachineDetailPage.svelte b/desktop/src/renderer/src/pages/MachineDetailPage.svelte index 787edf380a..dc414de721 100644 --- a/desktop/src/renderer/src/pages/MachineDetailPage.svelte +++ b/desktop/src/renderer/src/pages/MachineDetailPage.svelte @@ -253,7 +253,7 @@ async function handleDelete(force = false) {

Updates every 30 seconds while this page is visible and the machine is running.

- +
{#if diagnosticsError}

{diagnosticsError}

{/if}
diff --git a/desktop/src/shared/cli-error.ts b/desktop/src/shared/cli-error.ts index 7401c6a85b..d7aed5a7d0 100644 --- a/desktop/src/shared/cli-error.ts +++ b/desktop/src/shared/cli-error.ts @@ -129,7 +129,7 @@ export function parseCliEnvelope(line: string): CliEnvelope | undefined { return obj as CliEnvelope } } catch { - // not JSON — fall through + // not JSON - fall through } return undefined } diff --git a/e2e/framework/mcp.go b/e2e/framework/mcp.go index 13b1a845a1..13556ed7db 100644 --- a/e2e/framework/mcp.go +++ b/e2e/framework/mcp.go @@ -168,7 +168,7 @@ func (c *MCPClient) send(req jsonRPCRequest) error { } // readResponseFor reads and discards notifications (no id) until it finds -// the response matching id — tool calls that stream log progress interleave +// the response matching id - tool calls that stream log progress interleave // notifications with the eventual response on the same stream. func (c *MCPClient) readResponseFor(id int64) (*jsonRPCResponse, error) { for { @@ -190,7 +190,7 @@ func (c *MCPClient) readResponseFor(id int64) (*jsonRPCResponse, error) { // readResponseForCtx races readResponseFor against ctx so a hung server // can't block the caller past its deadline. bufio.Reader isn't safe for // concurrent use, so a cancellation that fires while the read is still in -// flight leaves that goroutine's read outstanding on c.stdout — the client +// flight leaves that goroutine's read outstanding on c.stdout - the client // is marked poisoned and every later call on it fails fast instead of // risking a second concurrent read. func (c *MCPClient) readResponseForCtx(ctx context.Context, id int64) (*jsonRPCResponse, error) { diff --git a/e2e/tests/configread/configread.go b/e2e/tests/configread/configread.go index e53a5ad0d4..9466b6d906 100644 --- a/e2e/tests/configread/configread.go +++ b/e2e/tests/configread/configread.go @@ -226,7 +226,7 @@ var _ = ginkgo.Describe("config read command", ginkgo.Label("config-read"), func gomega.Expect(opa["label"]).To(gomega.Equal("default")) }, ginkgo.SpecTimeout(framework.TimeoutShort())) - // Size-limit warning tested via unit test in metadata_test.go — impractical to generate >100KB metadata in E2E. + // Size-limit warning tested via unit test in metadata_test.go - impractical to generate >100KB metadata in E2E. ginkgo.It("preserves containerEnv in configuration output", func(ctx context.Context) { f := framework.NewDefaultFramework(initialDir + "/bin") diff --git a/e2e/tests/machineprovider/machineprovider.go b/e2e/tests/machineprovider/machineprovider.go index 3ba6a2cdfc..05041ccbd0 100644 --- a/e2e/tests/machineprovider/machineprovider.go +++ b/e2e/tests/machineprovider/machineprovider.go @@ -175,7 +175,7 @@ var _ = ginkgo.Describe( func(ctx context.Context) { f := framework.NewDefaultFramework(initialDir + "/bin") - // copy test dir — uses devcontainer.json with shutdownAction: "none" + // copy test dir - uses devcontainer.json with shutdownAction: "none" tempDir, err := framework.CopyToTempDirWithoutChdir( initialDir + "/tests/machineprovider/testdata/machineprovider3", ) diff --git a/e2e/tests/rename/rename.go b/e2e/tests/rename/rename.go index e7b856c992..1957364081 100644 --- a/e2e/tests/rename/rename.go +++ b/e2e/tests/rename/rename.go @@ -147,7 +147,7 @@ var _ = ginkgo.Describe( WithPolling(1 * time.Second). Should(gomega.Equal("Running")) - // Rename while running — should auto-stop + // Rename while running - should auto-stop err = f.DevsyRename(ctx, workspaceName, renamedWorkspaceName) framework.ExpectNoError(err) diff --git a/e2e/tests/snapshot/helper.go b/e2e/tests/snapshot/helper.go index 697c1e8d53..e089ab22c6 100644 --- a/e2e/tests/snapshot/helper.go +++ b/e2e/tests/snapshot/helper.go @@ -41,7 +41,7 @@ const ( // - snapshot.go's BeforeEach sets DEVSY_INSECURE_DOCKER_INTERNAL=true on // this process, inherited by the devsy CLI subprocesses it spawns, so // pkg/snapshot's reference parsing marks host.docker.internal refs as -// name.Insecure (plain HTTP instead of HTTPS) for this suite only — +// name.Insecure (plain HTTP instead of HTTPS) for this suite only - // off by default everywhere else, since a hostname alone isn't proof a // registry is actually local. // - the Docker *daemon* itself must also be configured to allow plain HTTP @@ -51,7 +51,7 @@ const ( // ["host.docker.internal:15500"]}, followed by a daemon restart. This is // an environment/CI prerequisite this fixture cannot configure for // itself (it would need root and to restart the daemon out from under -// any other running containers) — the CI workflow must set this up +// any other running containers) - the CI workflow must set this up // before running this suite, alongside the /etc/hosts entry above. var registryHost = "host.docker.internal:" + registryHostPort diff --git a/e2e/tests/ssh/agent_forward.go b/e2e/tests/ssh/agent_forward.go index 5473908542..52c2504831 100644 --- a/e2e/tests/ssh/agent_forward.go +++ b/e2e/tests/ssh/agent_forward.go @@ -125,7 +125,7 @@ var _ = ginkgo.Describe( framework.ExpectNoError(err, "session B: socket from session A must still work") gomega.Expect(outAddB).To(gomega.ContainSubstring(strings.Fields(pubKey)[1])) - // Session B's reported SSH_AUTH_SOCK should equal S1 too — the + // Session B's reported SSH_AUTH_SOCK should equal S1 too - the // regression is that this used to differ session-to-session. outBSock, _, err := framework.SSHMultiplexedExec( controlPath, host, env, @@ -137,7 +137,7 @@ var _ = ginkgo.Describe( "SSH_AUTH_SOCK must be identical across sessions on one connection", ) - // Session C: open-remote-ssh style use-after-session pattern — + // Session C: open-remote-ssh style use-after-session pattern - // reuse S1 in yet another session. outAddC, _, err := framework.SSHMultiplexedExec( controlPath, host, env, @@ -186,7 +186,7 @@ var _ = ginkgo.Describe( "two independent connections must each get their own agent socket", ) - // Close connection 1 — connection 2 must still work. + // Close connection 1 - connection 2 must still work. close1() closed1 = true diff --git a/e2e/tests/ssh/ports_attributes.go b/e2e/tests/ssh/ports_attributes.go index 2da537802a..1d27009078 100644 --- a/e2e/tests/ssh/ports_attributes.go +++ b/e2e/tests/ssh/ports_attributes.go @@ -284,7 +284,7 @@ var _ = ginkgo.Describe("devsy portsAttributes e2e", n, readErr := conn.Read(buf) _ = conn.Close() // The host listener doesn't write anything, so we should get - // a timeout or EOF — not "PONG\n" from the container + // a timeout or EOF - not "PONG\n" from the container if readErr == nil && n > 0 && string(buf[:n]) == "PONG\n" { return true } diff --git a/e2e/tests/ssh/ssh.go b/e2e/tests/ssh/ssh.go index c85da1067b..3ae113c9fc 100644 --- a/e2e/tests/ssh/ssh.go +++ b/e2e/tests/ssh/ssh.go @@ -405,7 +405,7 @@ var _ = ginkgo.Describe("devsy ssh test suite", ginkgo.Label("ssh"), ginkgo.Orde err = f.DevsyUp(ctx, tempDir, "--git-ssh-signing-key", keyPath+".pub") framework.ExpectNoError(err) - // Attempt a signed commit — this should fail because the key + // Attempt a signed commit - this should fail because the key // is not in the agent, but the error must be human-readable. commitCmd := strings.Join([]string{ "cd /tmp", @@ -439,7 +439,7 @@ var _ = ginkgo.Describe("devsy ssh test suite", ginkgo.Label("ssh"), ginkgo.Orde // The error must NOT contain JSON decode artifacts gomega.Expect(combined).NotTo( gomega.ContainSubstring("invalid character"), - "error should not contain JSON parse errors — error messages must be human-readable", + "error should not contain JSON parse errors - error messages must be human-readable", ) }, ) diff --git a/e2e/tests/up-features/up_features.go b/e2e/tests/up-features/up_features.go index 8edac45167..34f6d8ff9b 100644 --- a/e2e/tests/up-features/up_features.go +++ b/e2e/tests/up-features/up_features.go @@ -225,7 +225,7 @@ var _ = ginkgo.Describe("testing up command", ginkgo.Label("up-features"), func( err = f.DevsyUp(ctx, tempDir2) framework.ExpectNoError(err) - // Only one HTTP request was made — proves cache was reused with passing integrity + // Only one HTTP request was made - proves cache was reused with passing integrity gomega.Expect(server.ReceivedRequests()).To(gomega.HaveLen(1)) }, ginkgo.SpecTimeout(framework.TimeoutLong()), diff --git a/hack/licenses/third-party-licenses.md.tmpl b/hack/licenses/third-party-licenses.md.tmpl index 4aa88b893f..f88458523f 100644 --- a/hack/licenses/third-party-licenses.md.tmpl +++ b/hack/licenses/third-party-licenses.md.tmpl @@ -2,7 +2,7 @@ | Dependency | Version | License | | ---------- | ------- | ------- | {{ range $i, $dep := . -}} -| [{{ $dep.Name }}]({{ with $dep.URL }}{{ . }}{{ else }}https://pkg.go.dev/{{ $dep.Name }}{{ end }}) | {{ with $dep.Version }}`{{ . }}`{{ else }}—{{ end }} | {{ $dep.LicenceType }} | +| [{{ $dep.Name }}]({{ with $dep.URL }}{{ . }}{{ else }}https://pkg.go.dev/{{ $dep.Name }}{{ end }}) | {{ with $dep.Version }}`{{ . }}`{{ else }}-{{ end }} | {{ $dep.LicenceType }} | {{ end -}} {{- end -}} diff --git a/pkg/agent/snapshot/restore_test.go b/pkg/agent/snapshot/restore_test.go index d2452de768..a8401f2041 100644 --- a/pkg/agent/snapshot/restore_test.go +++ b/pkg/agent/snapshot/restore_test.go @@ -144,7 +144,7 @@ func TestRestoreVolumes_ResetRemovesContentNotInSnapshot(t *testing.T) { // a regression where strip depth was derived from the restore-side mount // target's own path-segment count instead of the recorded create-time // prefix. Here the create-time prefix is 1 segment ("workspace") but the -// restore-side target is 2 segments deep ("workspaces/proj") — deriving +// restore-side target is 2 segments deep ("workspaces/proj") - deriving // depth from the restore side would strip 2 levels and destroy the // filename; deriving it from the recorded prefix strips exactly 1 and // restores correctly. diff --git a/pkg/agent/tunnelserver/stream.go b/pkg/agent/tunnelserver/stream.go index 6b0231353e..7dc06450fc 100644 --- a/pkg/agent/tunnelserver/stream.go +++ b/pkg/agent/tunnelserver/stream.go @@ -16,7 +16,7 @@ import ( // successful, but truncated, transfer to whatever is consuming the reader // (extract.Extract for StreamWorkspace/StreamMount, and the snapshot // volumes blob push). This is shared by every Tunnel_StreamWorkspaceClient -// consumer, not just snapshots — see stream_test.go for coverage of both. +// consumer, not just snapshots - see stream_test.go for coverage of both. func NewStreamReader(stream tunnel.Tunnel_StreamWorkspaceClient) io.Reader { reader, writer := io.Pipe() diff --git a/pkg/agent/tunnelserver/stream_test.go b/pkg/agent/tunnelserver/stream_test.go index f65c4fa9e9..d9fa9ccdc8 100644 --- a/pkg/agent/tunnelserver/stream_test.go +++ b/pkg/agent/tunnelserver/stream_test.go @@ -41,12 +41,12 @@ func TestNewStreamReader_CleanEOFYieldsFullContentAndNoError(t *testing.T) { // TestNewStreamReader_NonEOFErrorPropagatesInsteadOfMaskingAsEOF guards // against a regression to the previous behavior, where any stream.Recv() -// error (not just io.EOF) was converted to a clean io.EOF for the reader — +// error (not just io.EOF) was converted to a clean io.EOF for the reader - // silently treating a truncated, failed transfer as a complete one. This is // shared by every Tunnel_StreamWorkspaceClient consumer: StreamWorkspace // (cmd/internal/agentworkspace/up.go), StreamMount // (cmd/internal/agentcontainer/setup.go), and the snapshot volumes push -// (pkg/snapshot/create.go) — not just the snapshot feature. +// (pkg/snapshot/create.go) - not just the snapshot feature. func TestNewStreamReader_NonEOFErrorPropagatesInsteadOfMaskingAsEOF(t *testing.T) { streamErr := errors.New("stream broken") client := &fakeStreamWorkspaceClient{ diff --git a/pkg/client/clientimplementation/proxy_client.go b/pkg/client/clientimplementation/proxy_client.go index 7eda800935..cc96d699a4 100644 --- a/pkg/client/clientimplementation/proxy_client.go +++ b/pkg/client/clientimplementation/proxy_client.go @@ -93,7 +93,7 @@ func (e *proxyExecutor) execute(ctx context.Context, params execParams) error { // so every buffered log line is forwarded through zap before the caller // can observe completion. Without this drain, callers that propagate the // error and exit (e.g. cmd/root.go calls os.Exit on failure) race the -// goroutine and can lose the tail of the sub-process stderr — which is +// goroutine and can lose the tail of the sub-process stderr - which is // where the actionable error message usually lives. func (e *proxyExecutor) executeWithJSONLog(ctx context.Context, params execParams) error { writer, done := log.PipeJSONStream() diff --git a/pkg/clihelp/help.go b/pkg/clihelp/help.go index 7319090a17..b9558fb0ec 100644 --- a/pkg/clihelp/help.go +++ b/pkg/clihelp/help.go @@ -130,7 +130,7 @@ func writeCommands(b *strings.Builder, cmd *cobra.Command, width int) { b.WriteString("\n") continue } - // Pad from the plain name — the styled string carries escape bytes + // Pad from the plain name - the styled string carries escape bytes // that would otherwise be counted as visible columns. b.WriteString(strings.Repeat(" ", max(1, nameColumn-len(name)))) descCol := len(indent) + nameColumn diff --git a/pkg/config/pathmanager.go b/pkg/config/pathmanager.go index 46e061a9b3..5ea0902623 100644 --- a/pkg/config/pathmanager.go +++ b/pkg/config/pathmanager.go @@ -41,7 +41,7 @@ func homeOverrideDir(sub ...string) (string, bool, error) { // ├── config.yaml (ConfigFilePath, stamped with Config.SchemaVersion) // └── contexts// (ContextDir) // ├── workspaces//{agent,logs} (WorkspaceDir, WorkspaceAgentDir, WorkspaceLogDir) -// ├── contents/ (WorkspaceContentsDir/WorkspaceContentDir — parent never removed) +// ├── contents/ (WorkspaceContentsDir/WorkspaceContentDir - parent never removed) // ├── machines/ (MachineDir) // ├── providers//{binaries,daemon} (ProviderDir) // ├── pro_instances/ (ProInstanceDir) diff --git a/pkg/config/pathmanager_test.go b/pkg/config/pathmanager_test.go index 63a839bcb9..ae6d6b95fa 100644 --- a/pkg/config/pathmanager_test.go +++ b/pkg/config/pathmanager_test.go @@ -44,7 +44,7 @@ func TestResetPathManager(t *testing.T) { pm2 := DefaultPathManager() if pm1 == pm2 { - t.Error("ResetPathManager did not clear the singleton — same instance returned") + t.Error("ResetPathManager did not clear the singleton - same instance returned") } } diff --git a/pkg/copy/copy_test.go b/pkg/copy/copy_test.go index f2204380c2..0f690ffb0f 100644 --- a/pkg/copy/copy_test.go +++ b/pkg/copy/copy_test.go @@ -226,7 +226,7 @@ func TestParseUserSpecStripsGroup(t *testing.T) { func mustReadFile(t *testing.T, path string) []byte { t.Helper() - b, err := os.ReadFile(path) //nolint:gosec // G304 — test temp file + b, err := os.ReadFile(path) //nolint:gosec // G304 - test temp file if err != nil { t.Fatalf("read %s: %v", path, err) } @@ -239,7 +239,7 @@ func TestChownRDeniedFailuresAreTyped(t *testing.T) { } root := t.TempDir() file := filepath.Join(root, "f.txt") - //nolint:gosec // G306 — test temp file + //nolint:gosec // G306 - test temp file if err := os.WriteFile(file, []byte("x"), 0o600); err != nil { t.Fatalf("write: %v", err) } @@ -262,7 +262,7 @@ func TestChownRDeniedFailuresAreTyped(t *testing.T) { func TestChownRSameOwnerSucceeds(t *testing.T) { root := t.TempDir() file := filepath.Join(root, "f.txt") - //nolint:gosec // G306 — test temp file + //nolint:gosec // G306 - test temp file if err := os.WriteFile(file, []byte("x"), 0o600); err != nil { t.Fatalf("write: %v", err) } diff --git a/pkg/daemon/agent/daemon.go b/pkg/daemon/agent/daemon.go index 97528f8e2b..e99c42958f 100644 --- a/pkg/daemon/agent/daemon.go +++ b/pkg/daemon/agent/daemon.go @@ -505,7 +505,7 @@ func stopFallbackDaemon() error { pid := strings.TrimSpace(string(pidData)) if _, err := strconv.Atoi(pid); err != nil { - // Corrupt PID file — clean up and move on + // Corrupt PID file - clean up and move on _ = os.Remove(pidFile) return nil } @@ -516,7 +516,7 @@ func stopFallbackDaemon() error { func killDaemonIfOurs(pidFile, pid string) error { running, err := command.IsRunning(pid) if err != nil || !running { - // Process gone or check failed — stale PID file + // Process gone or check failed - stale PID file _ = os.Remove(pidFile) return nil } @@ -541,7 +541,7 @@ func killDaemonIfOurs(pidFile, pid string) error { func isDaemonProcess(pid string) bool { exePath, err := os.Readlink("/proc/" + pid + "/exe") if err != nil { - // Can't verify — assume it's not ours to be safe + // Can't verify - assume it's not ours to be safe return false } baseName := filepath.Base(exePath) diff --git a/pkg/devcontainer/compose_test.go b/pkg/devcontainer/compose_test.go index 41009c0d6f..ea8cbf1d9e 100644 --- a/pkg/devcontainer/compose_test.go +++ b/pkg/devcontainer/compose_test.go @@ -590,7 +590,7 @@ func TestEscapeComposeLabelValue(t *testing.T) { {name: "backslash preserved", in: `a\b`, want: `a\b`}, {name: "backtick preserved", in: "a`b", want: "a`b"}, {name: "newline preserved", in: "line1\nline2", want: "line1\nline2"}, - {name: "unicode preserved", in: "café—naïve 🚀", want: "café—naïve 🚀"}, + {name: "unicode preserved", in: "café-naïve 🚀", want: "café-naïve 🚀"}, // Realistic metadata: JSON containing an apostrophe must survive so it // can be json.Unmarshal'd back on read. Only "$" is altered. diff --git a/pkg/devcontainer/config/host_requirements.go b/pkg/devcontainer/config/host_requirements.go index fcc0735f1c..cfb1fe53d0 100644 --- a/pkg/devcontainer/config/host_requirements.go +++ b/pkg/devcontainer/config/host_requirements.go @@ -104,7 +104,7 @@ func appendGPUWarning(warnings []string, gpu *GPURequirement) []string { return warnings } return append(warnings, - "gpu: required — availability will be verified at container creation", + "gpu: required - availability will be verified at container creation", ) } diff --git a/pkg/devcontainer/config/substitute.go b/pkg/devcontainer/config/substitute.go index e0bfa54465..2524fe40aa 100644 --- a/pkg/devcontainer/config/substitute.go +++ b/pkg/devcontainer/config/substitute.go @@ -56,7 +56,7 @@ type SubstitutionContext struct { // SubstituteContainerEnv pass for remoteEnv. // // remoteEnv is included here for parity with containerEnv per the -// devcontainers spec — the reference implementation +// devcontainers spec - the reference implementation // (devcontainers/cli src/spec-common/variableSubstitution.ts) treats // ${containerWorkspaceFolder} the same in both fields, while // ${containerEnv:VAR} stays unresolved until the container env is known. @@ -209,7 +209,7 @@ func baseOrMatch(value, match string) string { // shells and the container runtime do not perform devcontainer variable // expansion on env-var values. // -// Only ${containerEnv:VAR} refs remain literal here — those depend on the +// Only ${containerEnv:VAR} refs remain literal here - those depend on the // running container's environment and are resolved later, either host-side // from the image's inspected env (see ResolveContainerEnvFromImage) or // inside the container via SubstituteContainerEnv. diff --git a/pkg/devcontainer/config/substitute_test.go b/pkg/devcontainer/config/substitute_test.go index b6a4adb50f..3a8f7bd388 100644 --- a/pkg/devcontainer/config/substitute_test.go +++ b/pkg/devcontainer/config/substitute_test.go @@ -222,7 +222,7 @@ func TestComputeDevContainerIDDeterministic(t *testing.T) { } func TestComputeDevContainerIDSortedKeys(t *testing.T) { - // Keys must be sorted — order of insertion should not matter. + // Keys must be sorted - order of insertion should not matter. labels1 := map[string]string{ "a": "1", "b": "2", diff --git a/pkg/devcontainer/config_test.go b/pkg/devcontainer/config_test.go index e450fb825d..410fe168a8 100644 --- a/pkg/devcontainer/config_test.go +++ b/pkg/devcontainer/config_test.go @@ -897,7 +897,7 @@ func TestGetRawConfig_SourcePreservesRootDevcontainerJSON(t *testing.T) { t.Fatalf("getRawConfig: %v", err) } - got, err := os.ReadFile(rootConfig) //nolint:gosec // G304 — test temp file + got, err := os.ReadFile(rootConfig) //nolint:gosec // G304 - test temp file if err != nil { t.Fatal(err) } diff --git a/pkg/devcontainer/feature/features.go b/pkg/devcontainer/feature/features.go index 5fedd2bfde..a4bcc64d2c 100644 --- a/pkg/devcontainer/feature/features.go +++ b/pkg/devcontainer/feature/features.go @@ -624,7 +624,6 @@ func processDirectTarFeature( featureExtractedFolder := filepath.Join(featureFolder, "extracted") - // Check cache — verify integrity if present. cached, err := checkDirectTarCache(checkDirectTarCacheParams{ featureFolder: featureFolder, extractedFolder: featureExtractedFolder, diff --git a/pkg/devcontainer/feature/features_integrity_test.go b/pkg/devcontainer/feature/features_integrity_test.go index f1de31e73a..fd3dca6417 100644 --- a/pkg/devcontainer/feature/features_integrity_test.go +++ b/pkg/devcontainer/feature/features_integrity_test.go @@ -69,6 +69,6 @@ func (s *IntegrityTestSuite) TestVerifyCacheIntegrity_MissingHashFile() { _, err := createTestTarball(dir) s.Require().NoError(err) - // No .sha256 file — backward compat: should return true. + // No .sha256 file - backward compat: should return true. s.True(verifyCacheIntegrity(dir, "test-feature")) } diff --git a/pkg/devcontainer/import_external_test.go b/pkg/devcontainer/import_external_test.go index ab17f3a3dd..fa815813b3 100644 --- a/pkg/devcontainer/import_external_test.go +++ b/pkg/devcontainer/import_external_test.go @@ -47,7 +47,7 @@ func TestImportExternalDevContainer_SelfContainedFolder(t *testing.T) { func TestImportExternalDevContainer_ProjectRootCopiesOnlyConfig(t *testing.T) { // A config that lives at a project root (parent is NOT .devcontainer) must - // copy only the config file — never the surrounding tree (secrets, .git, + // copy only the config file - never the surrounding tree (secrets, .git, // node_modules, ...). external := t.TempDir() writeFile(t, filepath.Join(external, "devcontainer.json"), `{"image":"alpine"}`) diff --git a/pkg/devcontainer/run_test.go b/pkg/devcontainer/run_test.go index 7dc93fe0d3..e86f50a230 100644 --- a/pkg/devcontainer/run_test.go +++ b/pkg/devcontainer/run_test.go @@ -50,7 +50,7 @@ func TestRunInitializeCommand_ParallelErrorCollection(t *testing.T) { t.Fatalf("error should mention 'will-fail', got: %v", err) } - data, readErr := os.ReadFile(markerFile) //nolint:gosec // G304 — test temp file + data, readErr := os.ReadFile(markerFile) //nolint:gosec // G304 - test temp file if readErr != nil { t.Fatalf("success marker not written; parallel commands should all run: %v", readErr) } @@ -73,7 +73,7 @@ func TestRunInitializeCommand_SingleKey(t *testing.T) { t.Fatalf("unexpected error: %v", err) } - data, err := os.ReadFile(outFile) //nolint:gosec // G304 — test temp file + data, err := os.ReadFile(outFile) //nolint:gosec // G304 - test temp file if err != nil { t.Fatalf("output file not created: %v", err) } @@ -97,7 +97,7 @@ func TestRunInitializeCommand_StringFormat(t *testing.T) { t.Fatalf("unexpected error: %v", err) } - data, err := os.ReadFile(outFile) //nolint:gosec // G304 — test temp file + data, err := os.ReadFile(outFile) //nolint:gosec // G304 - test temp file if err != nil { t.Fatalf("output file not created: %v", err) } diff --git a/pkg/devcontainer/setup/lifecyclehooks.go b/pkg/devcontainer/setup/lifecyclehooks.go index eb7699a4c0..a41a4b71db 100644 --- a/pkg/devcontainer/setup/lifecyclehooks.go +++ b/pkg/devcontainer/setup/lifecyclehooks.go @@ -691,7 +691,7 @@ func mergePATH( if !remoteOk { return } - // nil PATH means unset — already handled by the delete above. + // nil PATH means unset - already handled by the delete above. if remotePath == nil { return } diff --git a/pkg/devcontainer/setup/lifecyclehooks_test.go b/pkg/devcontainer/setup/lifecyclehooks_test.go index 9612aa00ca..325f89461a 100644 --- a/pkg/devcontainer/setup/lifecyclehooks_test.go +++ b/pkg/devcontainer/setup/lifecyclehooks_test.go @@ -246,7 +246,7 @@ func (s *LifecycleHookTestSuite) TestPrebuildIgnoresWaitFor() { result := &config.Result{ MergedConfig: &config.MergedDevContainerConfig{ DevContainerConfigBase: config.DevContainerConfigBase{ - // Set waitFor to onCreateCommand — prebuild should ignore this. + // Set waitFor to onCreateCommand - prebuild should ignore this. WaitFor: "onCreateCommand", }, }, @@ -491,7 +491,7 @@ func (s *LifecycleHookTestSuite) TestInsertDotfilesPhaseSkippedWhenEmpty() { result := insertDotfilesPhase(ctx, all, DotfilesConfig{}, "test-created") - // No dotfiles repo — phase list unchanged. + // No dotfiles repo - phase list unchanged. assert.Len(t, result, 4) for i, ph := range result { assert.Equal(t, all[i].phase, ph.phase) @@ -597,7 +597,7 @@ func (s *LifecycleHookTestSuite) TestPromoteDotfilesWaitForInitializeCommandNotP func (s *LifecycleHookTestSuite) TestPromoteDotfilesWaitForNoDotfiles() { t := s.T() - // No dotfiles configured — no promotion regardless of waitFor. + // No dotfiles configured - no promotion regardless of waitFor. result := promoteDotfilesWaitFor(DefaultWaitFor, DotfilesConfig{}) assert.Equal(t, DefaultWaitFor, result) } @@ -723,7 +723,7 @@ func (s *LifecycleHookTestSuite) TestPostAttachHooksRunEveryTime() { }, } - // Run postAttachCommand multiple times — it must execute every time. + // Run postAttachCommand multiple times - it must execute every time. for i := 1; i <= 3; i++ { err := RunPostAttachHooks(context.Background(), result, nil, nil) assert.NoError(t, err) @@ -783,12 +783,12 @@ func (s *LifecycleHookTestSuite) TestPostAttachHookHasNoOnceGuard() { t := s.T() // RunPostAttachHooks passes content="" which means shouldSkipHook always - // returns false — the hook runs every time. Verify the contract. + // returns false - the hook runs every time. Verify the contract. skip, err := shouldSkipHook("postAttachCommands", "") assert.NoError(t, err) assert.False(t, skip, "postAttachCommand must never be skipped (content is always empty)") - // Call shouldSkipHook multiple times with empty content — must never skip. + // Call shouldSkipHook multiple times with empty content - must never skip. for i := range 5 { skip, err := shouldSkipHook("postAttachCommands", "") assert.NoError(t, err) diff --git a/pkg/devcontainer/setup/setup_unix_test.go b/pkg/devcontainer/setup/setup_unix_test.go index 9bf13b1580..dbec14a3ac 100644 --- a/pkg/devcontainer/setup/setup_unix_test.go +++ b/pkg/devcontainer/setup/setup_unix_test.go @@ -12,7 +12,7 @@ import ( // TestWriteResultFileTo_RejectsSymlinkWithoutFollowing guards against a // symlink planted at DevContainerResultPath's fixed, predictable path -// redirecting the write onto an arbitrary target — the same class of +// redirecting the write onto an arbitrary target - the same class of // attack pkg/sharedfile's other callers (the GPG lock, the activity file) // already defend against. func TestWriteResultFileTo_RejectsSymlinkWithoutFollowing(t *testing.T) { diff --git a/pkg/devcontainer/sshtunnel/sshtunnel.go b/pkg/devcontainer/sshtunnel/sshtunnel.go index 8398657c4e..9ea49e8f3d 100644 --- a/pkg/devcontainer/sshtunnel/sshtunnel.go +++ b/pkg/devcontainer/sshtunnel/sshtunnel.go @@ -208,7 +208,7 @@ func establishSSHSession( // - clientloop.c: client_request_agent() returns NULL on failure, // sending SSH2_MSG_CHANNEL_OPEN_FAILURE without terminating the session. // - ssh_config(5) ExitOnForwardFailure only covers "dynamic, tunnel, -// local, and remote port forwardings" — agent forwarding is excluded. +// local, and remote port forwardings" - agent forwarding is excluded. // // Stale SSH_AUTH_SOCK is common in practice (tmux, screen, reconnected // terminals), so a fatal error here would break devsy up for many users. diff --git a/pkg/devcontainer/sshtunnel/sshtunnel_test.go b/pkg/devcontainer/sshtunnel/sshtunnel_test.go index 3ff7b1aefa..4181a74569 100644 --- a/pkg/devcontainer/sshtunnel/sshtunnel_test.go +++ b/pkg/devcontainer/sshtunnel/sshtunnel_test.go @@ -205,7 +205,7 @@ func TestExecuteCommand_PipeBridgeIntegration(t *testing.T) { }, }) - // Context cancellation is an expected error — RunPair classifies it + // Context cancellation is an expected error - RunPair classifies it // and may return nil or a wrapped error. Either way, no hang. _ = err }) diff --git a/pkg/driver/docker.go b/pkg/driver/docker.go index fbc0d5dc8e..6bbb51547a 100644 --- a/pkg/driver/docker.go +++ b/pkg/driver/docker.go @@ -90,7 +90,7 @@ type DockerHelperProvider interface { // can commit a running container's filesystem to a new image. Not every // ImageDriver can do this (e.g. Apple's `container`), so callers detect // support via a type assertion rather than forcing every ImageDriver to stub -// the method — the same pattern ComposeDriver and DockerHelperProvider +// the method - the same pattern ComposeDriver and DockerHelperProvider // already establish in this file. type SnapshotCapableDriver interface { Driver diff --git a/pkg/driver/docker/build_test.go b/pkg/driver/docker/build_test.go index 506ff7ec5e..b2025f935b 100644 --- a/pkg/driver/docker/build_test.go +++ b/pkg/driver/docker/build_test.go @@ -106,12 +106,12 @@ func TestSelectStrategy_DockerRuntime_BuildxWhenAvailable(t *testing.T) { strategy := o.selectStrategy(provider.BuildOptions{}) // With real Docker, buildx is typically available, so expect buildx strategy. - // If buildx isn't installed, it falls back to buildkit — both are valid for Docker. + // If buildx isn't installed, it falls back to buildkit - both are valid for Docker. switch strategy.(type) { case *dockerBuildxStrategy: // Docker with buildx available case *buildkitStrategy: - // Docker without buildx — still valid, not Podman + // Docker without buildx - still valid, not Podman default: t.Fatalf("unexpected strategy type: %T", strategy) } diff --git a/pkg/extract/extract_test.go b/pkg/extract/extract_test.go index 2b754c8529..402408fd82 100644 --- a/pkg/extract/extract_test.go +++ b/pkg/extract/extract_test.go @@ -206,7 +206,7 @@ func TestExtract_HardLinkResolvesFromArchiveRootWhenNested(t *testing.T) { } linkPath := filepath.Join(dest, "dir", "sub", "link") - content, err := os.ReadFile(linkPath) //nolint:gosec // G304 — test temp file + content, err := os.ReadFile(linkPath) //nolint:gosec // G304 - test temp file if err != nil { t.Fatalf("read hard link: %v", err) } @@ -267,7 +267,7 @@ func TestExtract_PreserveHeaderOwnership(t *testing.T) { t.Fatalf("extracted entry is not a directory: %v", info.Mode()) } if stat, ok := info.Sys().(*syscall.Stat_t); ok { - //nolint:gosec // G115 — uid/gid are uint32 on every supported platform + //nolint:gosec // G115 - uid/gid are uint32 on every supported platform if stat.Uid != uint32(os.Getuid()) || stat.Gid != uint32(os.Getgid()) { t.Fatalf( "dir owner = %d:%d, want %d:%d", @@ -291,7 +291,7 @@ func TestExtract_PreserveHeaderOwnershipUnprivilegedDegrades(t *testing.T) { t.Fatalf("unexpected error: %v", err) } path := filepath.Join(dest, "hello.txt") - content, err := os.ReadFile(path) //nolint:gosec // G304 — test temp file + content, err := os.ReadFile(path) //nolint:gosec // G304 - test temp file if err != nil { t.Fatalf("read extracted file: %v", err) } diff --git a/pkg/git/repo_test.go b/pkg/git/repo_test.go index 7b089d7dc3..260a980b82 100644 --- a/pkg/git/repo_test.go +++ b/pkg/git/repo_test.go @@ -167,7 +167,7 @@ func TestRepoCheckoutPRAmbiguousSourceBranchLeftUntracked(t *testing.T) { err := repo.CheckoutPR(context.Background(), testGitLabURL, "merge-requests/7/head") assert.NilError(t, err) - assert.Equal(t, 3, len(fake.calls)) // fetch, switch, for-each-ref — no set-upstream + assert.Equal(t, 3, len(fake.calls)) // fetch, switch, for-each-ref - no set-upstream assert.Equal(t, "for-each-ref", fake.calls[2].Args[0]) } diff --git a/pkg/gitsshsigning/helper.go b/pkg/gitsshsigning/helper.go index 481b061212..6e0ef475e3 100644 --- a/pkg/gitsshsigning/helper.go +++ b/pkg/gitsshsigning/helper.go @@ -219,7 +219,7 @@ func (f *gitConfigFilter) flush() { })...) case sectionUser: // Only strip [user] sections that contain nothing but signingkey - // entries — these are the ones appended by GitConfigTemplate. + // entries - these are the ones appended by GitConfigTemplate. // Sections with other entries (name, email, etc.) are user-owned // and must be preserved intact to avoid data loss. if !isDevsyOnlyUserSection(f.buf) { diff --git a/pkg/ide/codeserver/codeserver.go b/pkg/ide/codeserver/codeserver.go index 8da6be24a0..d0921c6752 100644 --- a/pkg/ide/codeserver/codeserver.go +++ b/pkg/ide/codeserver/codeserver.go @@ -231,7 +231,7 @@ func (c *CodeServer) installExtensions() error { } } - // Escalate only on total failure — partial failures stay as logged + // Escalate only on total failure - partial failures stay as logged // warnings to match openvscode's behavior. if len(failed) == len(c.extensions) { return fmt.Errorf("all %d extensions failed to install: %v", len(failed), failed) @@ -273,7 +273,7 @@ func (c *CodeServer) installSettings() error { // suOrSh builds an *exec.Cmd that runs runCommand either as the unprivileged // user (via `su -c`) or as the current user (via `sh -c`). All arg -// elements are constants from this package — runCommand itself is built from +// elements are constants from this package - runCommand itself is built from // constants plus internal values, not user-controlled binary paths. func suOrSh(userName, runCommand, workingDir string) *exec.Cmd { var cmd *exec.Cmd diff --git a/pkg/ide/opener/browser_tunnel.go b/pkg/ide/opener/browser_tunnel.go index a77b2c5637..f88ad07e04 100644 --- a/pkg/ide/opener/browser_tunnel.go +++ b/pkg/ide/opener/browser_tunnel.go @@ -43,7 +43,7 @@ func KillBrowserTunnel(contextName, workspaceID string) { return } // If the workspace dir is already gone, there's nothing to lock on and - // nothing to kill — skip silently rather than recreating the dir just + // nothing to kill - skip silently rather than recreating the dir just // for a lock file. if _, statErr := os.Stat(filepath.Dir(statePath)); statErr != nil { return @@ -157,7 +157,7 @@ type inheritedListenerSetup struct { // browserIDEInvocation bundles the per-call IDE-specific knobs that aren't // part of the lower-level tunnel parameters. type browserIDEInvocation struct { - Label string // e.g. "vscode", "jupyter", "rstudio" — used in user-facing log lines + Label string // e.g. "vscode", "jupyter", "rstudio" - used in user-facing log lines OpenBrowser bool // whether to launch a host browser pointing at TargetURL } @@ -523,7 +523,7 @@ func runDaemonBrowserTunnel(ctx context.Context, a daemonTunnelArgs) (string, er // OpenBrowserWhenReachable polls the target URL's TCP port until it accepts // connections, then opens the browser. Exits silently when ctx is cancelled -// (the caller already gave up — warning would duplicate the underlying +// (the caller already gave up - warning would duplicate the underlying // error); emits a "didn't come up" warning only when the budget expires. // // Exported so the long-lived browser-tunnel helper can own the probe-then- diff --git a/pkg/ide/opener/ide_launch_mode.go b/pkg/ide/opener/ide_launch_mode.go index 159ecef176..9ef2194821 100644 --- a/pkg/ide/opener/ide_launch_mode.go +++ b/pkg/ide/opener/ide_launch_mode.go @@ -4,14 +4,14 @@ import "fmt" // IDELaunchMode controls how the openIDE phase runs. // -// - LaunchAuto: full launch — start tunnel (for browser IDEs) and open +// - LaunchAuto: full launch - start tunnel (for browser IDEs) and open // the host browser/app. // - LaunchHeadless: do not open the host browser/app. For browser IDEs // (openvscode, jupyter, rstudio) the detached tunnel still spawns. For // Fleet the workspace-side URL is logged so the user can open it // manually. For other desktop IDEs (VSCode flavors, JetBrains, Zed) the // openIDE phase only does the host launch, so headless is functionally -// equivalent to skip — backend install (where one exists) happens +// equivalent to skip - backend install (where one exists) happens // during workspace setup, not here. // - LaunchSkip: short-circuit the openIDE phase entirely. type IDELaunchMode string diff --git a/pkg/ide/opener/opener.go b/pkg/ide/opener/opener.go index 28a94f67de..415f903173 100644 --- a/pkg/ide/opener/opener.go +++ b/pkg/ide/opener/opener.go @@ -54,7 +54,7 @@ func IsBrowserIDE(ideName string) bool { } // Open dispatches to the correct IDE opener based on ideName. It returns the -// IDE URL (when meaningful — see per-IDE openers) along with any error. +// IDE URL (when meaningful - see per-IDE openers) along with any error. func Open( ctx context.Context, ideName string, diff --git a/pkg/ide/opener/opener_test.go b/pkg/ide/opener/opener_test.go index 9ac6495ec3..f2e91f8a42 100644 --- a/pkg/ide/opener/opener_test.go +++ b/pkg/ide/opener/opener_test.go @@ -36,7 +36,7 @@ func TestIDEParams_Launch_OpenBrowser(t *testing.T) { // TestOpenDesktopIDE_HeadlessShortCircuits verifies that LaunchHeadless makes // openDesktopIDE return nil without dispatching to any per-IDE handler for // non-Fleet desktop IDEs. Each chosen IDE name matches an explicit switch -// case in openDesktopIDE — if the headless guard were ever removed, dispatch +// case in openDesktopIDE - if the headless guard were ever removed, dispatch // would deref nil params.Client / params.Result and panic, failing the test. // Fleet is excluded because it intentionally runs even under headless (to // retrieve the workspace-side URL). diff --git a/pkg/ide/opener/process_alive_unix.go b/pkg/ide/opener/process_alive_unix.go index 22e84339f8..db15f32137 100644 --- a/pkg/ide/opener/process_alive_unix.go +++ b/pkg/ide/opener/process_alive_unix.go @@ -10,7 +10,7 @@ import ( // isProcessAlive reports whether a process with the given PID is alive AND // owned by the current user. On Unix, FindProcess always succeeds, so // liveness is confirmed by sending signal 0. A foreign-UID PID (EPERM) is -// treated as not-alive so respawn proceeds cleanly — at worst this orphans a +// treated as not-alive so respawn proceeds cleanly - at worst this orphans a // foreign-UID tunnel, which is preferable to silently blocking re-launch. func isProcessAlive(pid int) bool { if pid <= 0 { diff --git a/pkg/ide/vscodeweb/vscodeweb.go b/pkg/ide/vscodeweb/vscodeweb.go index 4bd210b600..4c397724d5 100644 --- a/pkg/ide/vscodeweb/vscodeweb.go +++ b/pkg/ide/vscodeweb/vscodeweb.go @@ -255,7 +255,7 @@ func (v *VSCodeWeb) installExtensions() error { } } - // Escalate only on total failure — partial failures stay as logged + // Escalate only on total failure - partial failures stay as logged // warnings to match openvscode's behavior. if len(failed) == len(v.extensions) { return fmt.Errorf("all %d extensions failed to install: %v", len(failed), failed) @@ -296,7 +296,7 @@ func (v *VSCodeWeb) installSettings() error { // suOrSh builds an *exec.Cmd that runs runCommand either as the unprivileged // user (via `su -c`) or as the current user (via `sh -c`). All arg -// elements are constants from this package — runCommand itself is built from +// elements are constants from this package - runCommand itself is built from // constants plus internal values, not user-controlled binary paths. func suOrSh(userName, runCommand, workingDir string) *exec.Cmd { var cmd *exec.Cmd diff --git a/pkg/image/image.go b/pkg/image/image.go index 7cddf1daa5..edc32cd337 100644 --- a/pkg/image/image.go +++ b/pkg/image/image.go @@ -175,7 +175,7 @@ func GetImagePlatforms(ctx context.Context, image string) ([]string, error) { return platforms, nil } - // Not an index — fall back to single-image config OS/Arch. + // Not an index - fall back to single-image config OS/Arch. log.Debugf("Image %q is not an index (%v); falling back to single-image config", image, err) configFile, _, cErr := GetImageConfig(ctx, image) if cErr != nil { diff --git a/pkg/image/image_test.go b/pkg/image/image_test.go index 804b3bec48..ecf4df98e9 100644 --- a/pkg/image/image_test.go +++ b/pkg/image/image_test.go @@ -35,7 +35,7 @@ func TestPlatformsFromManifests_FiltersUnknownAndDedupes(t *testing.T) { // pkg/snapshot's local test-fixture needs (see pkg/snapshot/reference.go), // not to general image operations (devcontainer image/feature pulls, // `devsy build` push checks, etc.). A host.docker.internal reference parsed -// by this package must behave identically to any other registry host — +// by this package must behave identically to any other registry host - // i.e. name.ParseReference without name.Insecure, which rejects an HTTP-only // scheme override and defaults to HTTPS. func TestParseReference_DoesNotSpecialCaseDockerInternalHost(t *testing.T) { diff --git a/pkg/log/logfmt.go b/pkg/log/logfmt.go index f2275864b5..756f4b1e4b 100644 --- a/pkg/log/logfmt.go +++ b/pkg/log/logfmt.go @@ -85,7 +85,7 @@ func quoteLogfmt(s string) string { return s } -// Required interface methods — delegate to buffer for simple types. +// Required interface methods - delegate to buffer for simple types. func (e *logfmtEncoder) AddArray(key string, arr zapcore.ArrayMarshaler) error { return nil } func (e *logfmtEncoder) AddObject(key string, obj zapcore.ObjectMarshaler) error { return nil } func (e *logfmtEncoder) AddBinary(key string, val []byte) {} diff --git a/pkg/log/logger.go b/pkg/log/logger.go index c83b94440c..e91870da34 100644 --- a/pkg/log/logger.go +++ b/pkg/log/logger.go @@ -105,7 +105,7 @@ func (w *redactingWriter) Sync() error { // duration of the returned remove func. Each line of log output is written to // w in addition to stderr. Multiple concurrent sinks are supported. // -// w must be safe for concurrent Write calls — AddSink does not serialize +// w must be safe for concurrent Write calls - AddSink does not serialize // writes to a single sink. io.Pipe writers and io.MultiWriter wrapping // pre-serialized destinations are both fine; bare bytes.Buffer is not. func AddSink(w io.Writer) (remove func()) { @@ -189,7 +189,7 @@ func resolveEncoder(format string) zapcore.Encoder { case "logfmt": return newLogfmtEncoder() default: - // "text" — use console encoder, with color if stderr is a terminal + // "text" - use console encoder, with color if stderr is a terminal if colorEnabled() { return zapcore.NewConsoleEncoder(colorEncoderConfig()) } diff --git a/pkg/machinediagnostics/sanitize.go b/pkg/machinediagnostics/sanitize.go index 51c0ed7dd1..84e456aed6 100644 --- a/pkg/machinediagnostics/sanitize.go +++ b/pkg/machinediagnostics/sanitize.go @@ -31,5 +31,5 @@ func (s *Sanitizer) Message(value string) string { for cut > 0 && !utf8.RuneStart(value[cut]) { cut-- } - return value[:cut] + "…" + return value[:cut] + "..." } diff --git a/pkg/machinediagnostics/store_test.go b/pkg/machinediagnostics/store_test.go index 6ce0b05487..d9bfdee6fa 100644 --- a/pkg/machinediagnostics/store_test.go +++ b/pkg/machinediagnostics/store_test.go @@ -119,7 +119,7 @@ func TestSanitizerBoundsAndNormalizes(t *testing.T) { message := s.Message("top-secret\n" + string(make([]byte, MaxEventMessageBytes+20))) assert.NotContains(t, message, "top-secret") assert.NotContains(t, message, "\n") - assert.LessOrEqual(t, len(message), MaxEventMessageBytes+len("…")) + assert.LessOrEqual(t, len(message), MaxEventMessageBytes+len("...")) } func TestReadFreshness(t *testing.T) { diff --git a/pkg/port/parse.go b/pkg/port/parse.go index 6646d4fd06..ffa88e2c02 100644 --- a/pkg/port/parse.go +++ b/pkg/port/parse.go @@ -86,7 +86,7 @@ func splitParts(rawPort string) (parsedParts, error) { case 2: return parsedParts{hostPort: parts[0], containerPort: containerPort}, nil case 3: - // a:b:c — if middle token is non-numeric, it's a host/IP for the + // a:b:c - if middle token is non-numeric, it's a host/IP for the // container side: hostPort:containerHost:containerPort. // Otherwise it's hostHost:hostPort:containerPort. if _, err := strconv.Atoi(parts[1]); err != nil { diff --git a/pkg/provider/env.go b/pkg/provider/env.go index 3fe387c0c0..7156169edb 100644 --- a/pkg/provider/env.go +++ b/pkg/provider/env.go @@ -24,7 +24,7 @@ func combineOptions( // ToEnvironment builds the full environment for provider subprocess execution. // The provider name is available to subprocesses as PROVIDER_ID (set by GetBaseEnvironment). -// Do NOT add DEVSY_PROVIDER to the subprocess env — it is reserved by the --provider +// Do NOT add DEVSY_PROVIDER to the subprocess env - it is reserved by the --provider // CLI flag via inheritFlagsFromEnvironment in cmd/root.go, and setting it would override // the global provider selection for any child devsy process. func ToEnvironment( diff --git a/pkg/provider/version_cache.go b/pkg/provider/version_cache.go index 3a2cd709a1..ecd623fcd7 100644 --- a/pkg/provider/version_cache.go +++ b/pkg/provider/version_cache.go @@ -141,7 +141,7 @@ func ListVersionsForSourceCached( } // storeVersionCacheEntry persists the given versions under the provider name. -// Errors are intentionally swallowed — cache write failure should not block the lister. +// Errors are intentionally swallowed - cache write failure should not block the lister. func storeVersionCacheEntry(name, sourceHash string, versions []ProviderVersion) { cache, err := LoadProviderVersionCache() if err != nil || cache == nil { diff --git a/pkg/provider/versions_github.go b/pkg/provider/versions_github.go index 0f440af4c4..d4be770cdc 100644 --- a/pkg/provider/versions_github.go +++ b/pkg/provider/versions_github.go @@ -19,7 +19,7 @@ type githubRelease struct { Draft bool `json:"draft"` } -// ListGitHubReleases calls the GitHub Releases API (rooted at baseURL — pass "https://api.github.com" in production) +// ListGitHubReleases calls the GitHub Releases API (rooted at baseURL - pass "https://api.github.com" in production) // and returns versions newest first. Drafts are always filtered out; prereleases only when includePrerelease is true. func ListGitHubReleases( baseURL, org, repo string, diff --git a/pkg/provider/workspace.go b/pkg/provider/workspace.go index 08d2e78297..15ae0fdb44 100644 --- a/pkg/provider/workspace.go +++ b/pkg/provider/workspace.go @@ -540,7 +540,7 @@ func isPlausibleGitSource(s string) bool { if !gitURLSchemes[u.Scheme] || u.Host == "" { return false } - // Catch nested schemes like "https://git:https://host/repo" — Host would + // Catch nested schemes like "https://git:https://host/repo" - Host would // be "git" and a real port would be missing. return !strings.Contains(u.Host, ":") || u.Port() != "" } diff --git a/pkg/sharedfile/sharedfile.go b/pkg/sharedfile/sharedfile.go index 867ac70192..e9844e8b77 100644 --- a/pkg/sharedfile/sharedfile.go +++ b/pkg/sharedfile/sharedfile.go @@ -1,6 +1,6 @@ // Package sharedfile hardens the standard Unix pattern of coordinating // between processes running as different users through a world-writable -// file in a shared, trusted location (e.g. /tmp) — the same idea behind +// file in a shared, trusted location (e.g. /tmp) - the same idea behind // /tmp/.X11-unix or /var/run/utmp. A devsy container runs commands over SSH // sessions authenticated as either root or the workspace's remoteUser // (pkg/ssh/server/ssh_container.go sets the process credential directly @@ -11,7 +11,7 @@ // - Whichever process creates the file first can lock every other user // out, because file creation is subject to the process umask. // - A symlink planted at the file's path redirects Chmod onto an -// arbitrary target, since Chmod follows symlinks — dangerous for a +// arbitrary target, since Chmod follows symlinks - dangerous for a // fixed, predictable, world-writable path any container user can // pre-create. package sharedfile @@ -106,7 +106,7 @@ func WriteFile(path string, data []byte, mode os.FileMode) (err error) { // openNoFollowRegular opens path with flag (plus the no-follow/non-blocking // guards openNoFollow always adds) and rejects the result if it is not a -// regular file — a FIFO would otherwise pass the open (O_NONBLOCK just +// regular file - a FIFO would otherwise pass the open (O_NONBLOCK just // keeps that from hanging) and reach a caller expecting file content. // createMode is only used when flag includes os.O_CREATE. func openNoFollowRegular(path string, flag int, createMode os.FileMode) (*os.File, error) { diff --git a/pkg/sharedfile/sharedfile_supported.go b/pkg/sharedfile/sharedfile_supported.go index 0cef4a44d0..b9076e1315 100644 --- a/pkg/sharedfile/sharedfile_supported.go +++ b/pkg/sharedfile/sharedfile_supported.go @@ -10,7 +10,7 @@ import ( // openNoFollow opens path without following a trailing symlink, so the // caller can chmod/read/write the resulting descriptor's inode regardless // of what path later resolves to. createMode is used only when flag -// includes os.O_CREATE. This always adds O_NOFOLLOW and O_NONBLOCK — the +// includes os.O_CREATE. This always adds O_NOFOLLOW and O_NONBLOCK - the // latter so a FIFO planted at path fails the open immediately // (ENXIO/EAGAIN) instead of blocking forever waiting for a peer. The // caller must still reject non-regular files after Stat: O_NONBLOCK only diff --git a/pkg/sharedfile/sudo.go b/pkg/sharedfile/sudo.go index d2e3716d24..bb00b16c00 100644 --- a/pkg/sharedfile/sudo.go +++ b/pkg/sharedfile/sudo.go @@ -15,7 +15,7 @@ import ( // exists at the wrong mode and this process does not own it) falls back to // re-execing ` internal widen-shared-file` under a non-interactive // sudo, so the escalated mode change still goes through WidenIfNeeded's -// O_NOFOLLOW open rather than a plain `sudo chmod ` — chmod(1) has no +// O_NOFOLLOW open rather than a plain `sudo chmod ` - chmod(1) has no // way to refuse following a symlink at its target path. The fallback's // failure is logged, not returned: this is a best-effort repair, and the // caller's own lock acquisition will surface the real permission error if diff --git a/pkg/snapshot/reference.go b/pkg/snapshot/reference.go index 6c6e1efcf1..33fc2696eb 100644 --- a/pkg/snapshot/reference.go +++ b/pkg/snapshot/reference.go @@ -13,7 +13,7 @@ import ( ) // dockerInternalHost is the well-known hostname Docker Desktop/OrbStack/etc. -// resolve, from inside any container, to the host machine itself — used by +// resolve, from inside any container, to the host machine itself - used by // local registry fixtures (e.g. e2e tests) that must be reachable both from // the host CLI process and from a workspace's own container, where // "localhost" would otherwise resolve to the container's own loopback. diff --git a/pkg/ssh/server/agent.go b/pkg/ssh/server/agent.go index 5fb4a590e7..87b699af04 100644 --- a/pkg/ssh/server/agent.go +++ b/pkg/ssh/server/agent.go @@ -90,7 +90,7 @@ func setupConnectionAgentListener(connID string) (net.Listener, string, error) { // Hold an exclusive flock on a per-directory lockfile for the lifetime // of this process. The kernel releases the lock on any exit (including // SIGKILL by docker exec when the proxy chain tears down). This is the - // only cleanup signal that survives external process termination — the + // only cleanup signal that survives external process termination - the // connection-level ConnectionClosingCallback never fires in that case // because the in-container helper is killed by signal, not via SSH // disconnect. The startup janitor (SweepStaleAgentSockets) uses this diff --git a/pkg/ssh/server/ssh.go b/pkg/ssh/server/ssh.go index 4d248869f7..83fee18f2f 100644 --- a/pkg/ssh/server/ssh.go +++ b/pkg/ssh/server/ssh.go @@ -266,7 +266,7 @@ func makePublicKeyHandler(keys []ssh.PublicKey) func(ctx ssh.Context, key ssh.Pu // cleanupAgentOnConnClosing tears down the per-connection agent state when // HandleConn observes the inbound channels stream close. Runs synchronously -// in HandleConn's defer chain before sshConn.Wait() — so it fires reliably +// in HandleConn's defer chain before sshConn.Wait() - so it fires reliably // even when the underlying transport is stuck (e.g. in stdio mode where EOF // on stdin can be delayed by the proxy chain). func cleanupAgentOnConnClosing(ctx ssh.Context, _ *gossh.ServerConn) { diff --git a/pkg/table/table.go b/pkg/table/table.go index 277be65714..8f16cd62da 100644 --- a/pkg/table/table.go +++ b/pkg/table/table.go @@ -41,7 +41,7 @@ func Print(headers []string, rows [][]string) { } // Markdown renders headers and rows as a GitHub-flavored Markdown table. -// Cell contents are written verbatim — callers must pre-escape pipes if needed. +// Cell contents are written verbatim - callers must pre-escape pipes if needed. func Markdown(headers []string, rows [][]string) string { var sb strings.Builder writeMarkdownRow(&sb, headers) diff --git a/pkg/task/task_test.go b/pkg/task/task_test.go index c7bfc0aa63..94f5204d3a 100644 --- a/pkg/task/task_test.go +++ b/pkg/task/task_test.go @@ -493,7 +493,7 @@ func TestDeleteTerminalTask(t *testing.T) { // TestConcurrentUpdatesAcrossStoreInstancesAreSerialized simulates two // separate processes (each with its own Store instance, as they would be in // practice) racing to update the same task: a worker reporting progress and -// a canceller. Every individual update must be applied atomically — no +// a canceller. Every individual update must be applied atomically - no // update should be silently lost or the file left corrupt. func TestConcurrentUpdatesAcrossStoreInstancesAreSerialized(t *testing.T) { dir := t.TempDir() diff --git a/pkg/workspace/delete_test.go b/pkg/workspace/delete_test.go index dd07b9e5e0..20a404e8b7 100644 --- a/pkg/workspace/delete_test.go +++ b/pkg/workspace/delete_test.go @@ -42,7 +42,7 @@ func TestSweepOrphanWorkspaceDirs(t *testing.T) { func TestSweepOrphanWorkspaceDirs_MissingDirIsNoop(t *testing.T) { setupTestPathManager(t) - // No workspaces dir created yet — sweep must not panic or error. + // No workspaces dir created yet - sweep must not panic or error. SweepOrphanWorkspaceDirs(testDefaultContext) } @@ -58,7 +58,7 @@ func TestSweepOrphanContentDirs_RemovesContentWithNoMatchingWorkspace(t *testing orphanedContent := filepath.Join(contentsDir, "orphaned") require.NoError(t, os.MkdirAll(orphanedContent, 0o750)) - // "kept" has both a content dir and a matching workspace dir — must survive. + // "kept" has both a content dir and a matching workspace dir - must survive. keptContent := filepath.Join(contentsDir, "kept") require.NoError(t, os.MkdirAll(keptContent, 0o750)) require.NoError(t, os.MkdirAll(filepath.Join(workspacesDir, "kept"), 0o750)) diff --git a/pkg/workspace/rename.go b/pkg/workspace/rename.go index 57c33d4d25..6c524a2501 100644 --- a/pkg/workspace/rename.go +++ b/pkg/workspace/rename.go @@ -127,7 +127,7 @@ func (r *pathReplacer) applyToMergedConfig(mc *devcontainerconfig.MergedDevConta // updateWorkspaceResult rewrites workspace_result.json to replace host-side // references to the old workspace name with the new one. Only LocalWorkspaceFolder -// and WorkspaceMount are updated — ContainerWorkspaceFolder is an in-container +// and WorkspaceMount are updated - ContainerWorkspaceFolder is an in-container // path that does not change when the host workspace is renamed. func updateWorkspaceResult(devsyConfig *config.Config, oldName, newName string) { context := devsyConfig.DefaultContext diff --git a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/connect-to-a-workspace.mdx b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/connect-to-a-workspace.mdx index 0e862507e6..d65065ada4 100644 --- a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/connect-to-a-workspace.mdx +++ b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/connect-to-a-workspace.mdx @@ -51,7 +51,7 @@ Start your workspace with: devsy workspace up my-workspace --ide goland ``` -Devsy installs the GoLand server binary into the workspace and opens JetBrains Gateway. After installation, the Gateway SSH dialog appears pre-filled — click **Check Connection and Continue** to start the IDE inside the workspace. +Devsy installs the GoLand server binary into the workspace and opens JetBrains Gateway. After installation, the Gateway SSH dialog appears pre-filled - click **Check Connection and Continue** to start the IDE inside the workspace. To pick a different IDE version: ``` @@ -121,7 +121,7 @@ devsy ide list Devsy Desktop ships a command palette and section shortcuts for fast navigation: -- `Cmd/Ctrl + K` — open the command palette (search workspaces, providers, machines, and pages). -- `Cmd/Ctrl + N` — start the New Workspace wizard. -- `Cmd/Ctrl + 1` through `Cmd/Ctrl + 8` — jump to Dashboard, Workspaces, Providers, Machines, Contexts, Terminals, SSH Keys, and Settings. -- `Esc` — close the active sheet, dialog, or palette (where supported). +- `Cmd/Ctrl + K` - open the command palette (search workspaces, providers, machines, and pages). +- `Cmd/Ctrl + N` - start the New Workspace wizard. +- `Cmd/Ctrl + 1` through `Cmd/Ctrl + 8` - jump to Dashboard, Workspaces, Providers, Machines, Contexts, Terminals, SSH Keys, and Settings. +- `Esc` - close the active sheet, dialog, or palette (where supported). diff --git a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/continuous-integration.mdx b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/continuous-integration.mdx index 5983b54d5d..6021805201 100644 --- a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/continuous-integration.mdx +++ b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/continuous-integration.mdx @@ -15,7 +15,7 @@ still builds. 2. Builds and starts the devcontainer (equivalent to `devsy workspace up`, without launching an IDE or touching your SSH config). 3. Runs the given command inside the running container. -4. Deletes the workspace — always, even when the command fails — unless +4. Deletes the workspace - always, even when the command fails - unless `--keep` is passed. A non-zero exit from the command propagates as the exit code of `devsy ci`, so a diff --git a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/create-a-workspace.mdx b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/create-a-workspace.mdx index 3acb278dad..c5c262d725 100644 --- a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/create-a-workspace.mdx +++ b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/create-a-workspace.mdx @@ -3,7 +3,7 @@ title: Create a Workspace sidebar_label: Create a Workspace --- -A workspace in Devsy is a containerized development environment that holds a project's source code along with the dependencies needed to work on it, such as a compiler and debugger. The underlying environment where the container runs is created and managed through a Devsy provider. This gives every engineer a consistent development experience wherever the container runs — a remote machine in a public cloud, localhost, or a Kubernetes cluster. +A workspace in Devsy is a containerized development environment that holds a project's source code along with the dependencies needed to work on it, such as a compiler and debugger. The underlying environment where the container runs is created and managed through a Devsy provider. This gives every engineer a consistent development experience wherever the container runs - a remote machine in a public cloud, localhost, or a Kubernetes cluster. To configure the development container, Devsy reuses the [devcontainer.json](https://containers.dev/) specification, which is also used by other popular tools such as [VS Code dev containers](https://code.visualstudio.com/docs/devcontainers/containers) and [GitHub Codespaces](https://github.com/features/codespaces). This means any project that already uses this configuration can spin up a workspace in Devsy with no extra setup. If no configuration is found, Devsy detects the project's programming language and provides an appropriate template. @@ -23,16 +23,16 @@ A workspace is defined by a `devcontainer.json`. If none exists, Devsy detects t Open the Workspaces view and click **Create** to launch the wizard. It walks through five steps: -1. **Provider** — pick an initialized provider. Cannot be changed later. If none exists, the wizard offers to add one. -2. **Source** — choose a Quick Start template, browse the image catalog, or enter a custom Git URL / image / local path. **Show advanced options** reveals: +1. **Provider** - pick an initialized provider. Cannot be changed later. If none exists, the wizard offers to add one. +2. **Source** - choose a Quick Start template, browse the image catalog, or enter a custom Git URL / image / local path. **Show advanced options** reveals: - Ref Type and value (branch, commit, or PR number) for Git sources. - Project subfolder within the repo. - Open folder in container (where the editor opens). - Dev container config path (override `.devcontainer/devcontainer.json` location). - Prebuild repository for cached images. -3. **IDE** — pick one or more IDEs to open the workspace with. Optional; defaults to none. -4. **Review** — adjust the auto-derived workspace name and confirm the configuration. If the chosen image has no build for your machine architecture, the Review step shows a compatibility warning and a **Run under emulation** toggle. -5. **Launch** — Devsy creates the workspace and streams progress. A 10-minute watchdog cancels the launch if it stalls. The chosen IDE opens on success. +3. **IDE** - pick one or more IDEs to open the workspace with. Optional; defaults to none. +4. **Review** - adjust the auto-derived workspace name and confirm the configuration. If the chosen image has no build for your machine architecture, the Review step shows a compatibility warning and a **Run under emulation** toggle. +5. **Launch** - Devsy creates the workspace and streams progress. A 10-minute watchdog cancels the launch if it stalls. The chosen IDE opens on success. Under the hood, the Desktop Application will call the CLI command `devsy workspace up REPOSITORY` @@ -147,10 +147,10 @@ devsy workspace describe my-workspace --result-format json Other useful inspection commands: -- `devsy workspace status ` — quick state check (`Running`, `Stopped`, `NotFound`). -- `devsy workspace logs ` — stream the agent logs from the container. -- `devsy workspace ping ` — verify the agent is reachable through the tunnel. -- `devsy workspace troubleshoot ` — bundle diagnostics for issue reports. +- `devsy workspace status ` - quick state check (`Running`, `Stopped`, `NotFound`). +- `devsy workspace logs ` - stream the agent logs from the container. +- `devsy workspace ping ` - verify the agent is reachable through the tunnel. +- `devsy workspace troubleshoot ` - bundle diagnostics for issue reports. ## Recreating a workspace @@ -167,7 +167,7 @@ devsy workspace up my-workspace --recreate ## Resetting a workspace -Reset rebuilds the workspace from a clean slate — it pulls the latest Git changes or re-uploads your local folder. Use it instead of `--recreate` when you need a full restart. +Reset rebuilds the workspace from a clean slate - it pulls the latest Git changes or re-uploads your local folder. Use it instead of `--recreate` when you need a full restart. **A reset preserves nothing.** diff --git a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/credentials.mdx b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/credentials.mdx index 2947cf0875..0fac1b0ac2 100644 --- a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/credentials.mdx +++ b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/credentials.mdx @@ -8,7 +8,7 @@ This allows you to reuse existing local credentials in a safe manner within the Currently Devsy supports this feature for git credentials and docker credentials. -Do not enable credential injection or SSH agent forwarding for untrusted repositories, or for any `devcontainer.json` you have not reviewed. Anything that runs inside the container — including lifecycle commands and features defined in `devcontainer.json` — can use the forwarded credentials. +Do not enable credential injection or SSH agent forwarding for untrusted repositories, or for any `devcontainer.json` you have not reviewed. Anything that runs inside the container - including lifecycle commands and features defined in `devcontainer.json` - can use the forwarded credentials. SSH agent forwarding never exposes your private key to the container, but it is not a full sandbox boundary: anyone with access to the forwarded agent socket inside the container can request signatures, and therefore authenticate as you against any remote service the key is trusted by, for as long as the workspace runs. A malicious or compromised `devcontainer.json` can use this to push, pull, or otherwise act with your identity, even though it can never exfiltrate the key itself. The same caution applies to injected git/docker credentials: they let code in the container act with your access. diff --git a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/devcontainer-json.mdx b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/devcontainer-json.mdx index 355050a71c..30f71b32aa 100644 --- a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/devcontainer-json.mdx +++ b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/devcontainer-json.mdx @@ -81,12 +81,12 @@ To use Docker Compose for your configuration, reference one or more compose file Devsy resolves the Docker Compose project name using the same precedence Docker Compose itself uses, so `devsy workspace up` reuses an already-running compose project instead of spawning a separate one: 1. `COMPOSE_PROJECT_NAME` set in the current shell session. -2. `COMPOSE_PROJECT_NAME` from an `.env` file — checked in the devcontainer config directory (e.g. `.devcontainer/.env`), the workspace root, and each resolved compose file's own directory. +2. `COMPOSE_PROJECT_NAME` from an `.env` file - checked in the devcontainer config directory (e.g. `.devcontainer/.env`), the workspace root, and each resolved compose file's own directory. 3. The top-level `name:` field in the compose files (when multiple files are given, the last one that declares it wins). 4. Otherwise, a name derived from the workspace, sanitized for Docker Compose. -`devcontainer.json`'s `name` field is a display name for the UI (per the [Dev Containers spec](https://containers.dev/implementors/json_reference/#general-fields)) and is never used to name the Docker Compose project. To reuse an existing compose project, set `COMPOSE_PROJECT_NAME` (shell or `.env`) or a top-level `name:` in your compose file — the same options [VS Code documents](https://code.visualstudio.com/remote/advancedcontainers/set-docker-compose-project-name) for this purpose. +`devcontainer.json`'s `name` field is a display name for the UI (per the [Dev Containers spec](https://containers.dev/implementors/json_reference/#general-fields)) and is never used to name the Docker Compose project. To reuse an existing compose project, set `COMPOSE_PROJECT_NAME` (shell or `.env`) or a top-level `name:` in your compose file - the same options [VS Code documents](https://code.visualstudio.com/remote/advancedcontainers/set-docker-compose-project-name) for this purpose. diff --git a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/mcp-server.mdx b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/mcp-server.mdx index d7693e9ca5..8bcbd0874c 100644 --- a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/mcp-server.mdx +++ b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/mcp-server.mdx @@ -5,7 +5,7 @@ sidebar_label: Agent Control (MCP) # Agent Control via MCP -`devsy mcp serve` runs a [Model Context Protocol](https://modelcontextprotocol.io) server over stdio. MCP-compatible AI clients can connect to it and drive Devsy — listing, creating, and executing inside workspaces — without shelling out to the CLI themselves. +`devsy mcp serve` runs a [Model Context Protocol](https://modelcontextprotocol.io) server over stdio. MCP-compatible AI clients can connect to it and drive Devsy - listing, creating, and executing inside workspaces - without shelling out to the CLI themselves. ```sh devsy mcp serve @@ -33,9 +33,9 @@ The server registers 11 tools across workspace and provider domains: `workspace_exec` is bounded by three server flags: -- `--exec-timeout-default` (default `5m`) — default per-call timeout. -- `--exec-timeout-max` (default `30m`) — caller-supplied timeouts are clamped to this. -- `--exec-output-cap` (default `100 KiB`) — per-stream byte cap; excess is replaced with a truncation marker. +- `--exec-timeout-default` (default `5m`) - default per-call timeout. +- `--exec-timeout-max` (default `30m`) - caller-supplied timeouts are clamped to this. +- `--exec-output-cap` (default `100 KiB`) - per-stream byte cap; excess is replaced with a truncation marker. ## Example client config diff --git a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/secrets.mdx b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/secrets.mdx index c130c59e3e..20981c0b73 100644 --- a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/secrets.mdx +++ b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/secrets.mdx @@ -9,9 +9,9 @@ files. Secrets can come from two places: -- **Devsy-managed secrets** — values owned by Devsy and stored in the operating +- **Devsy-managed secrets** - values owned by Devsy and stored in the operating system keyring or Devsy's encrypted local file. -- **External secret sources** — values owned by another system, such as a +- **External secret sources** - values owned by another system, such as a SOPS-encrypted file. Devsy resolves these values when they are needed and does not import them into the local Devsy secret store. @@ -24,9 +24,9 @@ mechanisms. With the default `auto` storage backend, Devsy stores sensitive values in your operating system's keyring when one is available: -- **macOS** — Keychain -- **Windows** — Credential Manager -- **Linux** — Secret Service (libsecret / GNOME Keyring / KWallet) +- **macOS** - Keychain +- **Windows** - Credential Manager +- **Linux** - Secret Service (libsecret / GNOME Keyring / KWallet) When no keyring is available, or when the `file` backend is selected, Devsy stores values in an age-encrypted `secrets.enc` file in the Devsy config @@ -302,10 +302,10 @@ Devsy workspaces protect sensitive values by: For Devsy-managed values, use the supported backends: -- `keyring` — the OS keyring (Keychain / Credential Manager / libsecret). -- `file` — an [age](https://age-encryption.org)-encrypted `secrets.enc` stored +- `keyring` - the OS keyring (Keychain / Credential Manager / libsecret). +- `file` - an [age](https://age-encryption.org)-encrypted `secrets.enc` stored alongside the Devsy config. -- `auto` — choose the keyring when available and otherwise fall back to `file` +- `auto` - choose the keyring when available and otherwise fall back to `file` for new secrets. Set a persistent preference per context with: diff --git a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/workspace-snapshots.mdx b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/workspace-snapshots.mdx index f13835d7cc..fff62e9b76 100644 --- a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/workspace-snapshots.mdx +++ b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/workspace-snapshots.mdx @@ -86,7 +86,7 @@ Removes the snapshot's manifest from the registry. The underlying image and volu ## Export and Import -`devsy workspace export`/`devsy workspace import` automatically carry a workspace's snapshot ref when the workspace was itself restored from one, so exporting and re-importing a snapshot-sourced workspace preserves its actual filesystem and volume state, not just its metadata — provided the snapshot manifest is still present in the registry and the environment doing the import has access to pull that registry artifact. If the manifest has been deleted or the import environment can't reach or authenticate to the registry, only the workspace's metadata carries over, not its filesystem/volume state. +`devsy workspace export`/`devsy workspace import` automatically carry a workspace's snapshot ref when the workspace was itself restored from one, so exporting and re-importing a snapshot-sourced workspace preserves its actual filesystem and volume state, not just its metadata - provided the snapshot manifest is still present in the registry and the environment doing the import has access to pull that registry artifact. If the manifest has been deleted or the import environment can't reach or authenticate to the registry, only the workspace's metadata carries over, not its filesystem/volume state. ## Identifying Snapshot Images diff --git a/sites/docs-devsy-sh/content/docs/developing-providers/binaries.mdx b/sites/docs-devsy-sh/content/docs/developing-providers/binaries.mdx index 7f964b31d5..bbb37f8d26 100644 --- a/sites/docs-devsy-sh/content/docs/developing-providers/binaries.mdx +++ b/sites/docs-devsy-sh/content/docs/developing-providers/binaries.mdx @@ -31,8 +31,8 @@ match the binary for your OS and Arch and download the specific one for it. Not every provider needs a `binaries` section. Built-in providers that wrap an -already-installed local CLI — such as `docker`, `apple` (the `container` CLI) or -`microsandbox` — instead expose an option (e.g. `DOCKER_PATH`, `CONTAINER_PATH`) +already-installed local CLI - such as `docker`, `apple` (the `container` CLI) or +`microsandbox` - instead expose an option (e.g. `DOCKER_PATH`, `CONTAINER_PATH`) pointing to the binary the user already has on their machine, rather than downloading one. Use `binaries` when your provider needs to fetch and manage its own helper binary. diff --git a/sites/docs-devsy-sh/content/docs/getting-started/install.mdx b/sites/docs-devsy-sh/content/docs/getting-started/install.mdx index c64f90506f..b388814bc1 100644 --- a/sites/docs-devsy-sh/content/docs/getting-started/install.mdx +++ b/sites/docs-devsy-sh/content/docs/getting-started/install.mdx @@ -7,8 +7,8 @@ import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; Devsy comes in two forms that share the same workflow: -- **Devsy Desktop** — a guided app for creating and managing workspaces. Start here if you want a UI. -- **Devsy CLI** — the same workflow from a terminal, for automation and scripting. +- **Devsy Desktop** - a guided app for creating and managing workspaces. Start here if you want a UI. +- **Devsy CLI** - the same workflow from a terminal, for automation and scripting. Install either one below, then head to the [Quick Start](./quickstart.mdx). @@ -37,7 +37,7 @@ If the AppImage fails to launch, install FUSE and the GTK/Electron runtime libra -Devsy Desktop needs [WebView 2](https://developer.microsoft.com/en-us/microsoft-edge/webview2/?form=MA13LH). It ships with recent versions of Windows — install it only if the app fails to open. +Devsy Desktop needs [WebView 2](https://developer.microsoft.com/en-us/microsoft-edge/webview2/?form=MA13LH). It ships with recent versions of Windows - install it only if the app fails to open. ## Install Devsy CLI diff --git a/sites/docs-devsy-sh/content/docs/getting-started/quickstart.mdx b/sites/docs-devsy-sh/content/docs/getting-started/quickstart.mdx index b3c02db58f..eb1e7de41a 100644 --- a/sites/docs-devsy-sh/content/docs/getting-started/quickstart.mdx +++ b/sites/docs-devsy-sh/content/docs/getting-started/quickstart.mdx @@ -11,13 +11,13 @@ Go from a fresh install to a running workspace in three steps: add a provider, s Devsy connects a workspace to the editor you choose. Some paths run without any local install: -- **VS Code Browser** (`--ide openvscode`) — opens in your browser, no local install. -- **SSH / Vim / Neovim** (`--ide none`) — no local IDE; you connect over SSH. +- **VS Code Browser** (`--ide openvscode`) - opens in your browser, no local install. +- **SSH / Vim / Neovim** (`--ide none`) - no local IDE; you connect over SSH. For a local editor, install the one you plan to use: -- **VS Code** — [download VS Code](https://code.visualstudio.com/download). -- **JetBrains** (IntelliJ, GoLand, PyCharm, WebStorm, RustRover, RubyMine, CLion) — install a [JetBrains IDE](https://www.jetbrains.com/) and [JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/). +- **VS Code** - [download VS Code](https://code.visualstudio.com/download). +- **JetBrains** (IntelliJ, GoLand, PyCharm, WebStorm, RustRover, RubyMine, CLion) - install a [JetBrains IDE](https://www.jetbrains.com/) and [JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/). ## Devsy CLI @@ -44,7 +44,7 @@ devsy workspace up github.com/microsoft/vscode-remote-try-node --ide openvscode # VS Code, locally devsy workspace up github.com/microsoft/vscode-remote-try-node --ide vscode -# No IDE — connect over SSH +# No IDE - connect over SSH devsy workspace up github.com/microsoft/vscode-remote-try-node --ide none ``` @@ -66,15 +66,15 @@ Prefer a UI? Make sure [Devsy Desktop](./install.mdx) is installed. Go to **Workspaces** > **+ Create** to open the wizard: -1. **Provider** — pick an initialized provider. -2. **Source** — enter your repository URL or choose a quickstart template. -3. **IDE** — choose how to open the workspace: - - **VS Code** — opens locally, connected to the dev container. - - **VS Code Browser** — opens in your browser, connected to the dev container. - - **JetBrains** — opens through JetBrains Gateway. - - **None** — connect over SSH (Vim/Neovim or a plain session). -4. **Review** — confirm the configuration. -5. **Launch** — start the workspace. +1. **Provider** - pick an initialized provider. +2. **Source** - enter your repository URL or choose a quickstart template. +3. **IDE** - choose how to open the workspace: + - **VS Code** - opens locally, connected to the dev container. + - **VS Code Browser** - opens in your browser, connected to the dev container. + - **JetBrains** - opens through JetBrains Gateway. + - **None** - connect over SSH (Vim/Neovim or a plain session). +4. **Review** - confirm the configuration. +5. **Launch** - start the workspace. The wizard streams logs as the workspace starts. When it's ready, your IDE opens connected to the dev container. @@ -93,5 +93,5 @@ ssh WORKSPACE_NAME.devsy For Vim/Neovim, either edit remote files over [Netrw](https://www.vim.org/scripts/script.php?script_id=1075) (`vim scp://WORKSPACE_NAME.devsy/path`) or SSH in and install your config as you would on any new machine. -To use environment variables in `devcontainer.json` — for example, to control the container image version — see [Environment variables in devcontainer.json](../developing-in-workspaces/devcontainer-json.mdx#environment-variables-in-devcontainerjson). +To use environment variables in `devcontainer.json` - for example, to control the container image version - see [Environment variables in devcontainer.json](../developing-in-workspaces/devcontainer-json.mdx#environment-variables-in-devcontainerjson). diff --git a/sites/docs-devsy-sh/content/docs/how-it-works/overview.mdx b/sites/docs-devsy-sh/content/docs/how-it-works/overview.mdx index 8df028f7b7..a46c9a5e1e 100644 --- a/sites/docs-devsy-sh/content/docs/how-it-works/overview.mdx +++ b/sites/docs-devsy-sh/content/docs/how-it-works/overview.mdx @@ -3,11 +3,11 @@ title: How it works sidebar_label: Overview --- -Devsy provisions workspaces on any infrastructure. It wraps the CLI tools you already use — `docker`, `gcloud`, and others — to deploy your development environment and run the dev container, or talks to a provider's API directly (for example, the Kubernetes driver uses the Kubernetes API rather than shelling out to `kubectl`). When creating a workspace, Devsy deploys an agent to both the host machine and the container to handle port forwarding, credential forwarding, and log streaming. The agent acts as a control plane across your development environment. +Devsy provisions workspaces on any infrastructure. It wraps the CLI tools you already use - `docker`, `gcloud`, and others - to deploy your development environment and run the dev container, or talks to a provider's API directly (for example, the Kubernetes driver uses the Kubernetes API rather than shelling out to `kubectl`). When creating a workspace, Devsy deploys an agent to both the host machine and the container to handle port forwarding, credential forwarding, and log streaming. The agent acts as a control plane across your development environment. Devsy uses a client-agent architecture. The client deploys its own agent, which hosts a gRPC server and an SSH server. This resembles a browser-server architecture where the front end is delivered to a remote host. Two practical wins: -- No version conflict between client and server — you only install the client. +- No version conflict between client and server - you only install the client. - No infrastructure to manage. For easier debugging, Devsy pipes the agent's STDIO to your local shell so you can see what's happening locally and inside the container. @@ -21,8 +21,8 @@ Below is a high level overview of how Devsy uses your local environment, a sourc Devsy connects to the workspace through a vendor-specific channel called the **tunnel**. When you run `devsy workspace up`, Devsy picks a provider based on your context and starts your devcontainer. Machine providers create a VM first if needed. Once the devcontainer is running, Devsy deploys the agent into it. -The tunnel's transport depends on the provider — AWS uses Instance Connect, Kubernetes uses the Kubernetes API's exec/attach mechanism, and so on. The Devsy agent starts an SSH server over the tunnel's STDIO so the local CLI/UI can forward ports. Devsy then opens your local IDE and connects it to the devcontainer over SSH. +The tunnel's transport depends on the provider - AWS uses Instance Connect, Kubernetes uses the Kubernetes API's exec/attach mechanism, and so on. The Devsy agent starts an SSH server over the tunnel's STDIO so the local CLI/UI can forward ports. Devsy then opens your local IDE and connects it to the devcontainer over SSH. -Port forwarding requires an active IDE or SSH session — Devsy needs the agent's SSH server, which only runs while one of those connections is open. +Port forwarding requires an active IDE or SSH session - Devsy needs the agent's SSH server, which only runs while one of those connections is open. Instead of building from a devcontainer each time, you can also create a workspace from a previously saved [workspace snapshot](../developing-in-workspaces/workspace-snapshots.mdx) with `devsy workspace up --from-snapshot`, which restores the container filesystem and volumes directly and skips the build step entirely. diff --git a/sites/docs-devsy-sh/content/docs/managing-providers/manage-providers.mdx b/sites/docs-devsy-sh/content/docs/managing-providers/manage-providers.mdx index 17b3a64e23..838bb0fa16 100644 --- a/sites/docs-devsy-sh/content/docs/managing-providers/manage-providers.mdx +++ b/sites/docs-devsy-sh/content/docs/managing-providers/manage-providers.mdx @@ -36,10 +36,10 @@ devsy provider list --available Open the Providers view and click **Add**. The provider wizard has four steps: -1. **Select** — pick a built-in preset, or enter a GitHub link, `provider.yaml` URL, or local file path in the **Provider Source** field below the presets. -2. **Configure** — fill in provider-specific options (the form is generated from the provider's schema). -3. **Initialize** — Devsy runs the provider init and streams logs. -4. **Done** — review the result. Failures show the underlying error. +1. **Select** - pick a built-in preset, or enter a GitHub link, `provider.yaml` URL, or local file path in the **Provider Source** field below the presets. +2. **Configure** - fill in provider-specific options (the form is generated from the provider's schema). +3. **Initialize** - Devsy runs the provider init and streams logs. +4. **Done** - review the result. Failures show the underlying error. The ProviderSheet (click any provider in the list) exposes edit settings, switch version, update, delete, rename, set as default, and re-initialize. @@ -181,7 +181,7 @@ For example, to change the disk size from 40GB to 120GB: devsy provider set aws --option AWS_DISK_SIZE=120 ``` -Run `devsy provider get aws` again to confirm — the `VALUE` column for `AWS_DISK_SIZE` now reads `120`. +Run `devsy provider get aws` again to confirm - the `VALUE` column for `AWS_DISK_SIZE` now reads `120`. ## Docker Provider: Contexts and Daemon Endpoints @@ -190,7 +190,7 @@ Devsy follows standard Docker CLI context and endpoint semantics when running wo ### Context Preservation -When Devsy configures credentials for Docker, it automatically preserves your existing Docker client configuration (`config.json`) and stored context metadata (`contexts/`). This ensures that non-default Docker contexts—such as those managed by Docker Desktop (`desktop-linux`), OrbStack (`orbstack`), or custom remote endpoints—remain active and accessible during workspace creation and execution. +When Devsy configures credentials for Docker, it automatically preserves your existing Docker client configuration (`config.json`) and stored context metadata (`contexts/`). This ensures that non-default Docker contexts-such as those managed by Docker Desktop (`desktop-linux`), OrbStack (`orbstack`), or custom remote endpoints-remain active and accessible during workspace creation and execution. ### Explicit Context Selection (`DOCKER_CONTEXT`) @@ -295,7 +295,7 @@ The table shows the published tag, date, and whether it's the currently-installe devsy provider set-source ``` -Re-resolves the provider's existing source. If the source is a registry entry or a GitHub repo without a pinned tag, this pulls the latest release. If the source is already pinned (e.g. `github.com/org/repo@v0.1.0`), it re-fetches that same version — use `--version` to move to a different one. +Re-resolves the provider's existing source. If the source is a registry entry or a GitHub repo without a pinned tag, this pulls the latest release. If the source is already pinned (e.g. `github.com/org/repo@v0.1.0`), it re-fetches that same version - use `--version` to move to a different one. ### Pin to a specific version @@ -311,7 +311,7 @@ devsy provider set-source github.com/my-org/my-repo@v0.2.0 ### Point at a different source -The `set-source` command also replaces the provider's source entirely — registry name, GitHub repo, URL, or local path: +The `set-source` command also replaces the provider's source entirely - registry name, GitHub repo, URL, or local path: ```sh devsy provider set-source my-org/my-repo @@ -323,9 +323,9 @@ devsy provider set-source ../path-to/provider.yaml Open the Providers sidebar, select a provider, and use the ProviderSheet: -- **Select version** — pick a tag from the versions dropdown to switch versions. -- **Update** — jump to the latest release. The button surfaces an "Update available" banner when one is detected. -- **Initialize** — re-run provider init (handy after upgrades). +- **Select version** - pick a tag from the versions dropdown to switch versions. +- **Update** - jump to the latest release. The button surfaces an "Update available" banner when one is detected. +- **Initialize** - re-run provider init (handy after upgrades). Existing workspaces continue to use the version they were created with. Rebuild a workspace (`devsy workspace up --recreate`) to pick up the new provider. @@ -371,7 +371,7 @@ devsy provider rename my-docker local-docker ### Constraints -- The new name must be unique — it cannot match an existing provider. +- The new name must be unique - it cannot match an existing provider. - Provider names can only contain lowercase letters, numbers, and dashes, up to 32 characters. - Pro providers (proxy/daemon) cannot be renamed. They are managed by the platform. - Workspaces bound to the provider must be stopped before renaming. diff --git a/sites/docs-devsy-sh/content/docs/managing-providers/what-are-providers.mdx b/sites/docs-devsy-sh/content/docs/managing-providers/what-are-providers.mdx index 24c5c357f2..0ce149a8d6 100644 --- a/sites/docs-devsy-sh/content/docs/managing-providers/what-are-providers.mdx +++ b/sites/docs-devsy-sh/content/docs/managing-providers/what-are-providers.mdx @@ -3,7 +3,7 @@ title: What are Providers? sidebar_label: What are Providers? --- -A provider is the CLI program Devsy uses to create, manage, and run workspaces on a given backend. This model is what lets Devsy target any infrastructure — local, cloud, Kubernetes, or remote SSH — without changing how you work. +A provider is the CLI program Devsy uses to create, manage, and run workspaces on a given backend. This model is what lets Devsy target any infrastructure - local, cloud, Kubernetes, or remote SSH - without changing how you work. Each provider is defined by a `provider.yaml` that declares the options, configuration, binaries, and commands Devsy needs to create workspaces on that backend. @@ -15,7 +15,7 @@ Devsy supports two kinds of providers: ### Machine providers -Machine providers create and manage a VM for the workspace, then run the container on it. They also handle the VM lifecycle — starting, stopping, and deleting it as needed. The AWS provider is one example, using EC2 instances to run the environment. +Machine providers create and manage a VM for the workspace, then run the container on it. They also handle the VM lifecycle - starting, stopping, and deleting it as needed. The AWS provider is one example, using EC2 instances to run the environment. ### Non-machine providers diff --git a/sites/docs-devsy-sh/content/docs/troubleshooting/linux-troubleshooting.mdx b/sites/docs-devsy-sh/content/docs/troubleshooting/linux-troubleshooting.mdx index 2518e06a22..fba11ec990 100644 --- a/sites/docs-devsy-sh/content/docs/troubleshooting/linux-troubleshooting.mdx +++ b/sites/docs-devsy-sh/content/docs/troubleshooting/linux-troubleshooting.mdx @@ -79,7 +79,7 @@ If Devsy reports that the Docker daemon is unreachable, start the daemon: sudo systemctl start docker ``` -These failures surface as `code: "UNKNOWN"` with the underlying OS/daemon error text preserved in `message` — see the [Structured CLI errors](./troubleshooting.mdx) reference for details. +These failures surface as `code: "UNKNOWN"` with the underlying OS/daemon error text preserved in `message` - see the [Structured CLI errors](./troubleshooting.mdx) reference for details. ### Podman @@ -93,13 +93,13 @@ devsy provider set podman --option PODMAN_HOST=unix:///run/user/$(id -u)/podman/ #### `podman compose` vs `docker-compose` -`podman compose` is not a built-in implementation — Podman looks for an externally installed Compose provider (`podman-compose`, or a standalone `docker-compose` binary) and delegates to it. If your `devcontainer.json` or workspace scripts call `docker-compose` directly, they will fail once `docker-compose` itself is not installed. Install a provider first, for example: +`podman compose` is not a built-in implementation - Podman looks for an externally installed Compose provider (`podman-compose`, or a standalone `docker-compose` binary) and delegates to it. If your `devcontainer.json` or workspace scripts call `docker-compose` directly, they will fail once `docker-compose` itself is not installed. Install a provider first, for example: ```bash sudo apt-get install -y podman-compose ``` -`docker-compose-plugin` is not a substitute here — it installs the `docker compose` subcommand of the Docker CLI, not a standalone `docker-compose` executable, and it pulls in Docker as a dependency, which defeats the point of a Docker-free Podman setup. +`docker-compose-plugin` is not a substitute here - it installs the `docker compose` subcommand of the Docker CLI, not a standalone `docker-compose` executable, and it pulls in Docker as a dependency, which defeats the point of a Docker-free Podman setup. Verify a provider is available before relying on `podman compose`: @@ -114,7 +114,7 @@ Once a provider is installed, update references to `docker-compose` to use `podm alias docker-compose='podman compose' ``` -`devsy workspace up` handles this automatically — Devsy's compose helper detects Podman via the `ContainerRuntime` interface. The alias is only needed for scripts that run inside the workspace itself. +`devsy workspace up` handles this automatically - Devsy's compose helper detects Podman via the `ContainerRuntime` interface. The alias is only needed for scripts that run inside the workspace itself. #### BuildKit not available diff --git a/sites/docs-devsy-sh/content/docs/troubleshooting/troubleshooting.mdx b/sites/docs-devsy-sh/content/docs/troubleshooting/troubleshooting.mdx index 2181731211..16cc7ba4a5 100644 --- a/sites/docs-devsy-sh/content/docs/troubleshooting/troubleshooting.mdx +++ b/sites/docs-devsy-sh/content/docs/troubleshooting/troubleshooting.mdx @@ -31,7 +31,7 @@ Devsy classifies common failures and prints a stable error `code` alongside a `m } ``` -This happens automatically whenever Devsy detects a non-interactive/machine consumer (for example, stderr is not a TTY, `--log-output json` or `logfmt` is set, or Devsy Desktop invokes the CLI) — human-readable output is used otherwise. Pass `--log-output json` (or `logfmt`) explicitly to force structured errors, or `--log-output text` to force human-readable ones. +This happens automatically whenever Devsy detects a non-interactive/machine consumer (for example, stderr is not a TTY, `--log-output json` or `logfmt` is set, or Devsy Desktop invokes the CLI) - human-readable output is used otherwise. Pass `--log-output json` (or `logfmt`) explicitly to force structured errors, or `--log-output text` to force human-readable ones. There are only four stable codes: @@ -42,7 +42,7 @@ There are only four stable codes: | `BUILD_FAILED_RECOVERABLE` | The devcontainer build failed in a way that can be retried (e.g. with `--recovery`). | | `UNKNOWN` | Devsy could not classify the error into one of the above; the raw underlying error text is preserved verbatim in `message`. | -In practice, most environment-level failures — such as "Docker is not running," "permission denied connecting to docker.sock," or "Podman user socket unavailable" — do not have a dedicated code today. They surface as `code: "UNKNOWN"` with the original OS or daemon error text preserved in `message`. Re-run with `--debug` to see the full original error chain. +In practice, most environment-level failures - such as "Docker is not running," "permission denied connecting to docker.sock," or "Podman user socket unavailable" - do not have a dedicated code today. They surface as `code: "UNKNOWN"` with the original OS or daemon error text preserved in `message`. Re-run with `--debug` to see the full original error chain. ### Windows: `line 2: $'\r': command not found` @@ -58,4 +58,4 @@ NeoVim can misbehave when `$TERM` isn't set correctly over the SSH provider. A w ### VS Code Browser workspace fails to open on first create -Earlier versions of Devsy could race when bootstrapping the workspace metadata file used by the VS Code Browser tunnel, causing the first browser session to fail right after `devsy workspace up --ide openvscode`. This is fixed — if you previously hit this, re-run `devsy workspace up` on the affected workspace. When Devsy exits because the workspace could not be located, it returns exit code `75`, which parent processes (including Devsy Desktop) treat as a transient signal and retry. +Earlier versions of Devsy could race when bootstrapping the workspace metadata file used by the VS Code Browser tunnel, causing the first browser session to fail right after `devsy workspace up --ide openvscode`. This is fixed - if you previously hit this, re-run `devsy workspace up` on the affected workspace. When Devsy exits because the workspace could not be located, it returns exit code `75`, which parent processes (including Devsy Desktop) treat as a transient signal and retry. diff --git a/sites/docs-devsy-sh/content/docs/tutorials/docker-provider-via-wsl.mdx b/sites/docs-devsy-sh/content/docs/tutorials/docker-provider-via-wsl.mdx index 03551fbecc..0cf7269866 100644 --- a/sites/docs-devsy-sh/content/docs/tutorials/docker-provider-via-wsl.mdx +++ b/sites/docs-devsy-sh/content/docs/tutorials/docker-provider-via-wsl.mdx @@ -177,7 +177,7 @@ In VS Code / VSCodium with the [Open Remote - SSH](https://marketplace.visualstu -The Devsy tunnel reuses your local SSH keys and SSH agent. If you set up key authentication in Step 5, the same key works for the editor connection. If you see `write EPIPE` in the editor's remote-SSH log, run `devsy up` with `DEVSY_DEBUG=true` so the structured tunnel logs are surfaced — the underlying cause (for example the WSL SSH server not running, or the host key not yet trusted) is otherwise hidden behind the editor's generic pipe error. +The Devsy tunnel reuses your local SSH keys and SSH agent. If you set up key authentication in Step 5, the same key works for the editor connection. If you see `write EPIPE` in the editor's remote-SSH log, run `devsy up` with `DEVSY_DEBUG=true` so the structured tunnel logs are surfaced - the underlying cause (for example the WSL SSH server not running, or the host key not yet trusted) is otherwise hidden behind the editor's generic pipe error. ## Next steps diff --git a/sites/docs-devsy-sh/content/docs/tutorials/podman-provider-setup.mdx b/sites/docs-devsy-sh/content/docs/tutorials/podman-provider-setup.mdx index 19e37e625d..58fc004a2e 100644 --- a/sites/docs-devsy-sh/content/docs/tutorials/podman-provider-setup.mdx +++ b/sites/docs-devsy-sh/content/docs/tutorials/podman-provider-setup.mdx @@ -5,7 +5,7 @@ sidebar_label: Podman Provider Setup ## Purpose -Podman is a first-class provider in Devsy. It runs containers without a background daemon — each container is a direct child of the calling process — which eliminates the single-point-of-failure that a persistent Docker daemon introduces. Podman is OCI-compatible, so most existing `devcontainer.json` configurations work without changes — see [Dockerfile features not supported during image build](#dockerfile-features-not-supported-during-image-build) and [`podman compose` vs `docker-compose`](#podman-compose-vs-docker-compose) below for the documented exceptions and required adjustments. +Podman is a first-class provider in Devsy. It runs containers without a background daemon - each container is a direct child of the calling process - which eliminates the single-point-of-failure that a persistent Docker daemon introduces. Podman is OCI-compatible, so most existing `devcontainer.json` configurations work without changes - see [Dockerfile features not supported during image build](#dockerfile-features-not-supported-during-image-build) and [`podman compose` vs `docker-compose`](#podman-compose-vs-docker-compose) below for the documented exceptions and required adjustments. This tutorial walks through installing Podman on your platform, registering it as a Devsy provider, and starting a workspace. @@ -42,19 +42,19 @@ podman machine start Podman on Windows runs inside WSL2. Install WSL2 first, then install Podman inside your WSL distro. -**Step 1 — Enable WSL2.** Run the following in **PowerShell (as Administrator)** and restart when prompted: +**Step 1 - Enable WSL2.** Run the following in **PowerShell (as Administrator)** and restart when prompted: ```powershell wsl --install ``` -**Step 2 — Install Podman inside WSL.** Open your WSL terminal and run: +**Step 2 - Install Podman inside WSL.** Open your WSL terminal and run: ```bash sudo apt-get update && sudo apt-get install -y podman ``` -**Step 3 — Start the rootless API socket.** On WSL distros with systemd enabled (Ubuntu 22.04+ on WSL2 supports this by default), enable and start the user socket: +**Step 3 - Start the rootless API socket.** On WSL distros with systemd enabled (Ubuntu 22.04+ on WSL2 supports this by default), enable and start the user socket: ```bash systemctl --user enable --now podman.socket @@ -67,13 +67,13 @@ systemctl --user status podman.socket ls -la $XDG_RUNTIME_DIR/podman/podman.sock ``` -If your WSL distro does not have systemd available, start the API service manually instead. A trailing `&` alone won't survive terminal closure — use `setsid`/`nohup` or a process manager instead. `--time=0` disables the API's own inactivity shutdown timeout: +If your WSL distro does not have systemd available, start the API service manually instead. A trailing `&` alone won't survive terminal closure - use `setsid`/`nohup` or a process manager instead. `--time=0` disables the API's own inactivity shutdown timeout: ```bash setsid nohup podman system service --time=0 unix://$XDG_RUNTIME_DIR/podman/podman.sock >/tmp/podman-service.log 2>&1 & ``` -Note the socket path — you will need it for the `PODMAN_HOST` option: +Note the socket path - you will need it for the `PODMAN_HOST` option: ```bash echo $XDG_RUNTIME_DIR/podman/podman.sock @@ -99,9 +99,9 @@ The Podman provider exposes four options: | Option | Default | Description | |--------|---------|-------------| -| `PODMAN_PATH` | `podman` | Path to the `podman` binary. Override when `podman` is not on `PATH` — for example, `/usr/local/bin/podman`. | +| `PODMAN_PATH` | `podman` | Path to the `podman` binary. Override when `podman` is not on `PATH` - for example, `/usr/local/bin/podman`. | | `PODMAN_HOST` | *(unset)* | Podman host socket or TCP address (sets `DOCKER_HOST` internally). Required on Windows to point Devsy at the WSL socket, e.g. `unix:///run/user//podman/podman.sock` (replace `` with `id -u`). | -| `PODMAN_ELEVATION` | `none` | Optionally run `podman` commands through a privilege-elevation helper (`pkexec`, `sudo`, or `doas`) for a **rootful** Podman socket the current user cannot access. Leave as `none` for rootless Podman (the default and recommended setup below) — elevating would target a separate rootful instance instead. `pkexec` requires a local desktop session with a running polkit agent; prefer `sudo` or `doas` on headless/SSH hosts. | +| `PODMAN_ELEVATION` | `none` | Optionally run `podman` commands through a privilege-elevation helper (`pkexec`, `sudo`, or `doas`) for a **rootful** Podman socket the current user cannot access. Leave as `none` for rootless Podman (the default and recommended setup below) - elevating would target a separate rootful instance instead. `pkexec` requires a local desktop session with a running polkit agent; prefer `sudo` or `doas` on headless/SSH hosts. | | `INACTIVITY_TIMEOUT` | *(unset)* | Stops the container after the specified idle period. Accepts duration strings such as `10m` or `1h`. | Set options after adding the provider using `--option` flags: @@ -131,7 +131,7 @@ Podman can run in two modes: | **Rootless** (default) | Containers run as your user. User namespaces isolate processes from the host. | Recommended for most development workflows. Reduces the blast radius of a compromised container. | | **Rootful** | Containers run as root inside a Podman machine. | Required when a container needs to bind-mount paths owned by root, or when certain network configurations (e.g. macvlan) are needed. | -**macOS / Windows — switching machine mode:** +**macOS / Windows - switching machine mode:** ```bash # Create a new, separate machine that runs rootful @@ -142,12 +142,12 @@ podman machine set --rootful podman machine stop && podman machine start ``` -`podman machine init` always creates a new machine — it does not replace or remove any existing rootless machine. `podman machine set --rootful` changes the mode of an existing machine in place. Switching a machine's mode does not delete its images, containers, or volumes; they belong to whichever mode created them and are simply hidden while the machine is running in the other mode. They reappear once you switch back. +`podman machine init` always creates a new machine - it does not replace or remove any existing rootless machine. `podman machine set --rootful` changes the mode of an existing machine in place. Switching a machine's mode does not delete its images, containers, or volumes; they belong to whichever mode created them and are simply hidden while the machine is running in the other mode. They reappear once you switch back. -**Linux — rootless is the system default.** To run rootful containers, prefix commands with `sudo` or add your user to the `wheel` / `sudo` group and run `podman system service` as root. If Devsy itself needs to reach a rootful socket it can't access directly, set `PODMAN_ELEVATION=sudo` (or `doas`/`pkexec`) instead of switching the whole setup to run as root — see the option description above. +**Linux - rootless is the system default.** To run rootful containers, prefix commands with `sudo` or add your user to the `wheel` / `sudo` group and run `podman system service` as root. If Devsy itself needs to reach a rootful socket it can't access directly, set `PODMAN_ELEVATION=sudo` (or `doas`/`pkexec`) instead of switching the whole setup to run as root - see the option description above. -After switching to rootful mode on macOS or Windows, update the `PODMAN_HOST` option in Devsy to point to the rootful socket. The rootful socket lives inside the Podman machine VM and is not directly reachable from the host — run `podman machine inspect` and read the forwarded socket path from `.ConnectionInfo.PodmanSocket.Path` in the output, then set `PODMAN_HOST` to that path. Leave `PODMAN_ELEVATION` as `none` in this case: on macOS/Windows the rootful socket is reached over the already-authenticated machine connection, not local privilege elevation. +After switching to rootful mode on macOS or Windows, update the `PODMAN_HOST` option in Devsy to point to the rootful socket. The rootful socket lives inside the Podman machine VM and is not directly reachable from the host - run `podman machine inspect` and read the forwarded socket path from `.ConnectionInfo.PodmanSocket.Path` in the output, then set `PODMAN_HOST` to that path. Leave `PODMAN_ELEVATION` as `none` in this case: on macOS/Windows the rootful socket is reached over the already-authenticated machine connection, not local privilege elevation. ## Creating a Workspace with Podman @@ -188,7 +188,7 @@ systemctl --user status podman.socket ls -la $XDG_RUNTIME_DIR/podman/podman.sock ``` -If it does not exist or is inactive, start it with `systemctl --user enable --now podman.socket`. On systemd-less environments (some WSL distros), run `setsid nohup podman system service --time=0 unix://$XDG_RUNTIME_DIR/podman/podman.sock >/tmp/podman-service.log 2>&1 &` instead — a trailing `&` alone won't survive terminal closure. +If it does not exist or is inactive, start it with `systemctl --user enable --now podman.socket`. On systemd-less environments (some WSL distros), run `setsid nohup podman system service --time=0 unix://$XDG_RUNTIME_DIR/podman/podman.sock >/tmp/podman-service.log 2>&1 &` instead - a trailing `&` alone won't survive terminal closure. If the socket path differs from the default, set `PODMAN_HOST` to the correct path: @@ -202,13 +202,13 @@ Podman uses Buildah for image builds, not Docker BuildKit. Most Dockerfiles are ### `podman compose` vs `docker-compose` -`podman compose` is not a built-in implementation — Podman delegates to an externally installed Compose provider, either the `podman-compose` Python package or a standalone `docker-compose` binary. Install one before relying on `podman compose`: +`podman compose` is not a built-in implementation - Podman delegates to an externally installed Compose provider, either the `podman-compose` Python package or a standalone `docker-compose` binary. Install one before relying on `podman compose`: ```bash sudo apt-get install -y podman-compose ``` -`docker-compose-plugin` is not a substitute here — it installs the `docker compose` subcommand of the Docker CLI, not a standalone `docker-compose` executable, and it pulls in Docker as a dependency, which defeats the point of a Docker-free Podman setup. +`docker-compose-plugin` is not a substitute here - it installs the `docker compose` subcommand of the Docker CLI, not a standalone `docker-compose` executable, and it pulls in Docker as a dependency, which defeats the point of a Docker-free Podman setup. Verify a provider is available: diff --git a/sites/docs-devsy-sh/content/docs/tutorials/reduce-build-times-with-cache.mdx b/sites/docs-devsy-sh/content/docs/tutorials/reduce-build-times-with-cache.mdx index 0a30e4fd96..153ade5449 100644 --- a/sites/docs-devsy-sh/content/docs/tutorials/reduce-build-times-with-cache.mdx +++ b/sites/docs-devsy-sh/content/docs/tutorials/reduce-build-times-with-cache.mdx @@ -14,7 +14,7 @@ where registry follows the syntax "\{domain\}/\{project\}/\{repo\}", such as gcr If using the docker provider, ensure your docker environment has the image snapshotter enabled in your daemon (https://docs.docker.com/engine/storage/containerd/) -Merge the `containerd-snapshotter` setting into your existing `/etc/docker/daemon.json` (or the platform-equivalent path, e.g. via Docker Desktop's Settings > Docker Engine on macOS/Windows) — do not overwrite the whole file, since it may already contain other settings such as registry mirrors or proxy configuration: +Merge the `containerd-snapshotter` setting into your existing `/etc/docker/daemon.json` (or the platform-equivalent path, e.g. via Docker Desktop's Settings > Docker Engine on macOS/Windows) - do not overwrite the whole file, since it may already contain other settings such as registry mirrors or proxy configuration: ``` cat /etc/docker/daemon.json diff --git a/sites/docs-devsy-sh/content/docs/what-is-devsy.mdx b/sites/docs-devsy-sh/content/docs/what-is-devsy.mdx index a6b4fb5b67..d419d00504 100644 --- a/sites/docs-devsy-sh/content/docs/what-is-devsy.mdx +++ b/sites/docs-devsy-sh/content/docs/what-is-devsy.mdx @@ -20,7 +20,7 @@ Devsy implements the open [DevContainer standard](https://containers.dev/), so t For engineering organizations, Devsy delivers: * **Standardized environments**: Define a workspace once in `devcontainer.json` and give every engineer the same toolchain, dependencies, and configuration. New hires are productive on day one instead of spending days on setup. * **Cost efficiency at scale**: Run workspaces on the infrastructure you already pay for, and let Devsy shut down idle machines so you spend only on capacity in use. -* **No vendor lock-in**: Choose the infrastructure that fits each team — local, cloud, Kubernetes, or remote SSH hosts. Switch a workspace's provider with a single command, with no rewrite of your environment definition. +* **No vendor lock-in**: Choose the infrastructure that fits each team - local, cloud, Kubernetes, or remote SSH hosts. Switch a workspace's provider with a single command, with no rewrite of your environment definition. * **Flexible development**: Engineers get the same experience locally and remotely, from quick prototyping on a laptop to heavy builds on a cloud machine. * **Cross-IDE support**: VS Code and its variants and the full JetBrains suite are supported out of the box; any other editor can connect over SSH. * **Extensible**: Devsy is open source and extensible. If a provider doesn't exist for your platform, you can build one. diff --git a/sites/docs-devsy-sh/uml/up_sequence.puml b/sites/docs-devsy-sh/uml/up_sequence.puml index a7082fa24f..e8a29209da 100644 --- a/sites/docs-devsy-sh/uml/up_sequence.puml +++ b/sites/docs-devsy-sh/uml/up_sequence.puml @@ -3,7 +3,7 @@ !theme cloudscape-design skinparam BackgroundColor lightgray -title devsy workspace up — sequence +title devsy workspace up - sequence participant "Devsy CLI" as Devsy participant "Machine Provider" as Provider diff --git a/sites/images-devsy-sh/src/components/SearchBar.svelte b/sites/images-devsy-sh/src/components/SearchBar.svelte index aba4541742..37e24fe1a0 100644 --- a/sites/images-devsy-sh/src/components/SearchBar.svelte +++ b/sites/images-devsy-sh/src/components/SearchBar.svelte @@ -5,7 +5,7 @@ let { value = $bindable("") }: { value?: string } = $props()