Optimize hints in the output of info and inspect commands

Author: CrSjimo

internal/cli/commands/info.go

@@ -5,6 +5,7 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"os"
 	"path/filepath"
 	"sort"
 
@@ -105,6 +106,7 @@ func NewInfoCmd() *cobra.Command {
 func ShowInfo(target string, packagesDir string, languageCode string, jsonOutput bool, out io.Writer) error {
 	reference, err := packageinfo.ParsePackageReference(target)
 	if err != nil {
+		writeInfoInspectSuggestion(jsonOutput, out, target)
 		return writeInfoError(jsonOutput, out, "SCHEMA_ERROR", err.Error(), nil, err)
 	}
 	if reference.PackageID == "" {
@@ -815,3 +817,14 @@ func writeInfoError(jsonOutput bool, out io.Writer, code string, message string,
 	}
 	return err
 }
+
+func writeInfoInspectSuggestion(jsonOutput bool, out io.Writer, target string) {
+	if jsonOutput {
+		return
+	}
+	info, err := os.Stat(target)
+	if err != nil || info.IsDir() {
+		return
+	}
+	fmt.Fprintf(out, "Suggestion: If you want to view information about a package file, use `dspm inspect %s` instead.\n", target)
+}

internal/cli/commands/info_test.go

@@ -100,6 +100,52 @@ func TestShowInfoTextForSingerFiltersModulesAndOmitsStatuses(t *testing.T) {
 	}
 }
 
+func TestShowInfoSuggestsInspectForPackageFile(t *testing.T) {
+	packageFile := filepath.Join(t.TempDir(), "sample package.dspk")
+	if err := os.WriteFile(packageFile, []byte("not used"), 0o644); err != nil {
+		t.Fatalf("write package file: %v", err)
+	}
+
+	var output bytes.Buffer
+	err := ShowInfo(packageFile, t.TempDir(), "en", false, &output)
+	if err == nil {
+		t.Fatalf("ShowInfo() error = nil")
+	}
+
+	got := output.String()
+	if !strings.Contains(got, "Suggestion:") ||
+		!strings.Contains(got, "dspm inspect "+packageFile) {
+		t.Fatalf("output = %q", got)
+	}
+}
+
+func TestShowInfoJSONDoesNotSuggestInspectForPackageFile(t *testing.T) {
+	packageFile := filepath.Join(t.TempDir(), "sample package.dspk")
+	if err := os.WriteFile(packageFile, []byte("not used"), 0o644); err != nil {
+		t.Fatalf("write package file: %v", err)
+	}
+
+	var output bytes.Buffer
+	err := ShowInfo(packageFile, t.TempDir(), "en", true, &output)
+	if err == nil {
+		t.Fatalf("ShowInfo() error = nil")
+	}
+
+	got := output.String()
+	if strings.Contains(got, "Suggestion:") ||
+		strings.Contains(got, "dspm inspect") {
+		t.Fatalf("json output should not include suggestion: %q", got)
+	}
+
+	var payload infoOutput
+	if err := json.Unmarshal(output.Bytes(), &payload); err != nil {
+		t.Fatalf("unmarshal output: %v\n%s", err, output.String())
+	}
+	if payload.OK || payload.Error == nil {
+		t.Fatalf("payload = %#v", payload)
+	}
+}
+
 func TestShowInfoJSONReportsAmbiguousVersion(t *testing.T) {
 	packagesDir := makeInfoTestDatabase(t)
 

internal/cli/commands/inspect.go

@@ -151,11 +151,13 @@ func NewInspectCmd() *cobra.Command {
 func InspectPackageFile(packageFilePath string, packagesDir string, languageCode string, jsonOutput bool, includeHash bool, out io.Writer) error {
 	absolutePackageFilePath, err := filepath.Abs(packageFilePath)
 	if err != nil {
+		writeInspectInfoSuggestion(jsonOutput, out, packageFilePath)
 		return writeInspectError(jsonOutput, out, "IO_ERROR", fmt.Sprintf("resolve package file path: %v", err), err)
 	}
 
 	reader, err := openPackageFileReader(absolutePackageFilePath)
 	if err != nil {
+		writeInspectInfoSuggestion(jsonOutput, out, packageFilePath)
 		return writeInspectError(jsonOutput, out, "IO_ERROR", err.Error(), err)
 	}
 	defer reader.Close()
@@ -558,3 +560,14 @@ func writeInspectError(jsonOutput bool, out io.Writer, code string, message stri
 	}
 	return err
 }
+
+func writeInspectInfoSuggestion(jsonOutput bool, out io.Writer, packageFilePath string) {
+	if jsonOutput {
+		return
+	}
+	reference, err := packageinfo.ParsePackageReference(packageFilePath)
+	if err != nil || reference.PackageID == "" {
+		return
+	}
+	fmt.Fprintf(out, "Suggestion: If you want to view information about an installed package, use `dspm info %s` instead.\n", reference.String())
+}

internal/cli/commands/inspect_test.go

@@ -131,6 +131,42 @@ func TestInspectPackageFileJSONReportsInstalledStatus(t *testing.T) {
 	}
 }
 
+func TestInspectPackageFileSuggestsInfoForPackageReference(t *testing.T) {
+	var output bytes.Buffer
+	err := InspectPackageFile("vendor/package@1.0.0.0", t.TempDir(), "en", false, false, &output)
+	if err == nil {
+		t.Fatalf("InspectPackageFile() error = nil")
+	}
+
+	got := output.String()
+	if !strings.Contains(got, "Suggestion:") ||
+		!strings.Contains(got, "dspm info vendor/package@1.0.0.0") {
+		t.Fatalf("output = %q", got)
+	}
+}
+
+func TestInspectPackageFileJSONDoesNotSuggestInfoForPackageReference(t *testing.T) {
+	var output bytes.Buffer
+	err := InspectPackageFile("vendor/package@1.0.0.0", t.TempDir(), "en", true, false, &output)
+	if err == nil {
+		t.Fatalf("InspectPackageFile() error = nil")
+	}
+
+	got := output.String()
+	if strings.Contains(got, "Suggestion:") ||
+		strings.Contains(got, "dspm info") {
+		t.Fatalf("json output should not include suggestion: %q", got)
+	}
+
+	var payload inspectOutput
+	if err := json.Unmarshal(output.Bytes(), &payload); err != nil {
+		t.Fatalf("unmarshal output: %v\n%s", err, output.String())
+	}
+	if payload.OK || payload.Error == nil {
+		t.Fatalf("payload = %#v", payload)
+	}
+}
+
 func TestInspectPackageFileTextIncludesInstalledReferenceNames(t *testing.T) {
 	packagesDir := t.TempDir()
 	db, err := packagedatabase.Open(filepath.Join(packagesDir, "packages.db"))