refactor(open): trim restate-the-code and dramatic comments

Author: dlevy-msft-sql

cmd/modern/root/open/clipboard.go

@@ -11,8 +11,7 @@ import (
 	"github.com/microsoft/go-sqlcmd/internal/pal"
 )
 
-// copyPasswordToClipboard copies the current context's password to the clipboard for SQL auth.
-// Returns true when a password was actually copied.
+// copyPasswordToClipboard returns true when the password was copied.
 func copyPasswordToClipboard(user *sqlconfig.User, out *output.Output) bool {
 	if out == nil || user == nil || user.AuthenticationType != "basic" || user.BasicAuth == nil {
 		return false
@@ -24,7 +23,6 @@ func copyPasswordToClipboard(user *sqlconfig.User, out *output.Output) bool {
 	}
 
 	if err := pal.CopyToClipboard(password); err != nil {
-		// Don't fail the launch over a clipboard hiccup; warn and continue.
 		out.Warn(localizer.Sprintf("Could not copy password to clipboard: %s", err.Error()))
 		return false
 	}

internal/pal/clipboard_darwin.go

@@ -15,10 +15,7 @@ func copyToClipboard(text string) error {
 	return cmd.Run()
 }
 
-// pbcopyPath returns the canonical macOS pbcopy path so we never pick up an
-// attacker-planted pbcopy from PATH while staging the SQL password on the
-// clipboard. Falls back to bare "pbcopy" only if the canonical binary is
-// missing (non-standard macOS install).
+// pbcopyPath pins pbcopy to its canonical path so PATH order can't redirect the SQL password.
 func pbcopyPath() string {
 	const canonical = "/usr/bin/pbcopy"
 	if _, err := os.Stat(canonical); err == nil {

internal/pal/clipboard_linux.go

@@ -12,8 +12,7 @@ import (
 func copyToClipboard(text string) error {
 	var attempts []string
 	tryCmd := func(name string, args ...string) bool {
-		// Use the resolved absolute path so a later PATH change can't redirect
-		// the SQL password to a different binary between lookup and exec.
+		// Pin the resolved path so PATH order can't redirect the SQL password between lookup and exec.
 		resolved, err := exec.LookPath(name)
 		if err != nil {
 			attempts = append(attempts, fmt.Sprintf("%s not found", name))
@@ -38,7 +37,6 @@ func copyToClipboard(text string) error {
 		return nil
 	}
 
-	// gotext only scans cmd/modern, cmd/sqlcmd, and pkg/sqlcmd, so this stays plain fmt.Errorf.
 	return fmt.Errorf(
 		"failed to copy to clipboard; tried xclip, xsel, wl-copy: %s\n"+
 			"Install one and re-run (use your own judgement on what fits your environment):\n"+

internal/pal/clipboard_windows.go

@@ -16,11 +16,7 @@ func copyToClipboard(text string) error {
 	return cmd.Run()
 }
 
-// clipExePath resolves clip.exe under %SystemRoot%\System32 so we never pick
-// up an attacker-planted clip.exe from PATH or the working directory while
-// copying the SQL password to the clipboard. Falls back through other
-// well-known env vars before defaulting to the canonical C:\Windows path so
-// we never return a bare "clip.exe" that PATH could resolve.
+// clipExePath pins clip.exe to %SystemRoot%\System32 so PATH order can't redirect the SQL password.
 func clipExePath() string {
 	for _, name := range []string{"SystemRoot", "WINDIR"} {
 		if v := os.Getenv(name); v != "" {

internal/tools/tool/vscode_darwin.go

@@ -25,9 +25,7 @@ func (t *VSCode) searchLocations() []string {
 			app = "Visual Studio Code - Insiders.app"
 		}
 		locations = append(locations, filepath.Join("/", "Applications", app))
-		// Skip the per-user paths when $HOME is empty -- filepath.Join would
-		// produce a relative "Applications/..." that could match a directory
-		// in the working directory.
+		// Skip per-user paths when $HOME is empty: filepath.Join would yield a relative match.
 		if userProfile != "" {
 			locations = append(locations,
 				filepath.Join(userProfile, "Applications", app),

internal/tools/tool/vscode_linux.go

@@ -24,9 +24,7 @@ func (t *VSCode) searchLocations() []string {
 		locations = append(locations,
 			filepath.Join("/", "usr", "bin", cli),
 		)
-		// Skip the per-user path when $HOME is empty -- filepath.Join would
-		// produce a relative ".local/bin/<cli>" that could match an unintended
-		// binary in the working directory.
+		// Skip per-user path when $HOME is empty: filepath.Join would yield a relative match.
 		if userProfile != "" {
 			locations = append(locations, filepath.Join(userProfile, ".local", "bin", cli))
 		}

internal/tools/tool/vscode_windows.go

@@ -53,10 +53,7 @@ func vscodeWindowsLocations(build string) []string {
 		locations = append(locations, filepath.Join(install, exeName))
 	}
 
-	// Tier 3: standard default install directories. Skip any whose base env
-	// var was empty -- filepath.Join with an empty base yields a relative
-	// path (e.g. AppData\...\Code.exe) that could match an unintended binary
-	// in the working directory.
+	// Tier 3: standard install dirs. Skip when the base env var is empty: filepath.Join would yield a relative match.
 	if userDir != "" {
 		locations = append(locations, filepath.Join(userDir, exeName))
 	}