fix(shell): satisfy lint rules for ssh access hints

Author: skulidropek

packages/lib/src/usecases/actions/docker-up.ts

@@ -1,7 +1,7 @@
 import type * as CommandExecutor from "@effect/platform/CommandExecutor"
 import type { PlatformError } from "@effect/platform/Error"
-import * as FileSystem from "@effect/platform/FileSystem"
-import * as Path from "@effect/platform/Path"
+import type * as FileSystem from "@effect/platform/FileSystem"
+import type * as Path from "@effect/platform/Path"
 import { Duration, Effect, Fiber, Schedule } from "effect"
 
 import type { CreateCommand } from "../../core/domain.js"

packages/lib/src/usecases/menu-helpers.ts

@@ -10,31 +10,35 @@ export const isRepoUrlInput = (input: string): boolean => {
     trimmed.startsWith("git@")
 }
 
+type ConnectionInfoOptions = {
+  readonly authorizedKeysPath: string
+  readonly authorizedKeysExists: boolean
+  readonly sshCommand: string
+  readonly editorAccessDetails?: string
+}
+
 export const formatConnectionInfo = (
   cwd: string,
   config: ProjectConfig,
-  authorizedKeysPath: string,
-  authorizedKeysExists: boolean,
-  sshCommand: string,
-  editorAccessDetails?: string
+  options: ConnectionInfoOptions
 ): string => {
   const hostnameLabel = config.template.clonedOnHostname === undefined
     ? ""
     : `\nCloned on device: ${config.template.clonedOnHostname}`
-  const editorAccessLabel = editorAccessDetails === undefined ? "" : `\n${editorAccessDetails}`
+  const editorAccessLabel = options.editorAccessDetails === undefined ? "" : `\n${options.editorAccessDetails}`
   return `Project directory: ${cwd}
 ` +
     `Container: ${config.template.containerName}
 ` +
     `Service: ${config.template.serviceName}
 ` +
-    `SSH command: ${sshCommand}
+    `SSH command: ${options.sshCommand}
 ` +
     `Repo: ${config.template.repoUrl} (${config.template.repoRef})
 ` +
     `Workspace: ${config.template.targetDir}
 ` +
-    `Authorized keys: ${authorizedKeysPath}${authorizedKeysExists ? "" : " (missing)"}
+    `Authorized keys: ${options.authorizedKeysPath}${options.authorizedKeysExists ? "" : " (missing)"}
 ` +
     `Env global: ${config.template.envGlobalPath}
 ` +

packages/lib/src/usecases/projects-core.ts

@@ -14,11 +14,10 @@ import { findDockerGitConfigPaths } from "./docker-git-config-search.js"
 import { renderError } from "./errors.js"
 import { defaultProjectsRoot, formatConnectionInfo } from "./menu-helpers.js"
 import { findSshPrivateKey, resolveAuthorizedKeysPath, resolvePathFromCwd } from "./path-helpers.js"
-import { buildEditorSshAccess, buildSshCommand, formatEditorSshAccessDetails } from "./ssh-access.js"
 import { withFsPathContext } from "./runtime.js"
+import { buildEditorSshAccess, buildSshCommand, formatEditorSshAccessDetails } from "./ssh-access.js"
 
 export type ProjectLoadError = PlatformError | ConfigNotFoundError | ConfigDecodeError
-export { buildSshCommand }
 
 export type ProjectSummary = {
   readonly projectDir: string
@@ -148,13 +147,15 @@ export const renderProjectSummary = (summary: ProjectSummary): string =>
   formatConnectionInfo(
     summary.projectDir,
     summary.config,
-    summary.authorizedKeysPath,
-    summary.authorizedKeysExists,
-    summary.sshCommand,
-    formatEditorSshAccessDetails(
-      buildEditorSshAccess(summary.config.template, summary.sshKeyPath, summary.ipAddress),
-      summary.config.template.clonedOnHostname
-    )
+    {
+      authorizedKeysPath: summary.authorizedKeysPath,
+      authorizedKeysExists: summary.authorizedKeysExists,
+      sshCommand: summary.sshCommand,
+      editorAccessDetails: formatEditorSshAccessDetails(
+        buildEditorSshAccess(summary.config.template, summary.sshKeyPath, summary.ipAddress),
+        summary.config.template.clonedOnHostname
+      )
+    }
   )
 
 const formatDisplayName = (repoUrl: string): string => {
@@ -309,3 +310,5 @@ export const withProjectIndexAndSsh = <A, E, R>(
         })
     )
   )
+
+export { buildSshCommand } from "./ssh-access.js"

packages/lib/src/usecases/projects-ssh.ts

@@ -25,8 +25,8 @@ import {
   renderProjectStatusHeader,
   withProjectIndexAndSsh
 } from "./projects-core.js"
-import { buildEditorSshAccess, formatEditorSshAccessSummary } from "./ssh-access.js"
 import { runDockerComposeUpWithPortCheck } from "./projects-up.js"
+import { buildEditorSshAccess, formatEditorSshAccessSummary } from "./ssh-access.js"
 import { ensureTerminalCursorVisible } from "./terminal-cursor.js"
 
 const buildSshArgs = (item: ProjectItem): ReadonlyArray<string> => {

packages/lib/src/usecases/ssh-access.ts

@@ -10,12 +10,43 @@ import { findSshPrivateKey, resolveAuthorizedKeysPath } from "./path-helpers.js"
 
 const sshOptions = "-tt -Y -o LogLevel=ERROR -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null"
 
+const aliasCharPattern = /^[A-Za-z0-9._-]$/u
+
+const isAliasChar = (value: string): boolean => aliasCharPattern.test(value)
+
+const trimAliasEdges = (value: string): string => {
+  let start = 0
+  let end = value.length
+
+  while (start < end && (value[start] === "." || value[start] === "-")) {
+    start += 1
+  }
+
+  while (end > start && (value[end - 1] === "." || value[end - 1] === "-")) {
+    end -= 1
+  }
+
+  return value.slice(start, end)
+}
+
 const sanitizeSshHostAlias = (value: string): string => {
-  const normalized = value
-    .trim()
-    .replace(/[^A-Za-z0-9._-]+/g, "-")
-    .replace(/-+/g, "-")
-    .replace(/^[.-]+|[.-]+$/g, "")
+  let normalized = ""
+  let previousWasDash = false
+
+  for (const char of value.trim()) {
+    if (isAliasChar(char)) {
+      normalized += char
+      previousWasDash = false
+      continue
+    }
+
+    if (!previousWasDash) {
+      normalized += "-"
+      previousWasDash = true
+    }
+  }
+
+  normalized = trimAliasEdges(normalized)
   return normalized.length === 0 ? "docker-git" : normalized
 }
 

packages/lib/tests/usecases/connection-info.test.ts

@@ -29,27 +29,33 @@ const makeProjectConfig = (overrides: Partial<ProjectConfig["template"]> = {}):
 describe("formatConnectionInfo", () => {
   it("includes clonedOnHostname when present", () => {
     const config = makeProjectConfig({ clonedOnHostname: "my-laptop" })
-    const output = formatConnectionInfo("/project", config, "/keys", true, "ssh dev@localhost")
+    const output = formatConnectionInfo("/project", config, {
+      authorizedKeysPath: "/keys",
+      authorizedKeysExists: true,
+      sshCommand: "ssh dev@localhost"
+    })
     expect(output).toContain("Cloned on device: my-laptop")
   })
 
   it("omits clonedOnHostname line when undefined", () => {
     const config = makeProjectConfig()
-    const output = formatConnectionInfo("/project", config, "/keys", true, "ssh dev@localhost")
+    const output = formatConnectionInfo("/project", config, {
+      authorizedKeysPath: "/keys",
+      authorizedKeysExists: true,
+      sshCommand: "ssh dev@localhost"
+    })
     expect(output).not.toContain("Cloned on device")
   })
 
   it("includes Remote-SSH details when provided", () => {
     const config = makeProjectConfig({ clonedOnHostname: "meadav" })
     const editorAccess = buildEditorSshAccess(config.template, "/home/user/.ssh/id_ed25519")
-    const output = formatConnectionInfo(
-      "/project",
-      config,
-      "/keys",
-      true,
-      "ssh dev@localhost",
-      formatEditorSshAccessDetails(editorAccess, config.template.clonedOnHostname)
-    )
+    const output = formatConnectionInfo("/project", config, {
+      authorizedKeysPath: "/keys",
+      authorizedKeysExists: true,
+      sshCommand: "ssh dev@localhost",
+      editorAccessDetails: formatEditorSshAccessDetails(editorAccess, config.template.clonedOnHostname)
+    })
     expect(output).toContain("Remote-SSH host: dg-test")
     expect(output).toContain("Terminal shortcut: ssh dg-test")
     expect(output).toContain("VS Code/Cursor: Connect to Host... -> dg-test")