chore: address PR comments

  - use existing const for "json" parameter
  - lowercase file permissions
  - comment file permissions, interfaces

Author: bsalomon-snyk

internal/commands/ostest/depgraph_flow.go

@@ -150,7 +150,7 @@ func handleOutput(
 	errFactory *errors.ErrorFactory,
 ) ([]workflow.Data, error) {
 	config := ictx.GetConfiguration()
-	jsonOutput := config.GetBool("json")
+	jsonOutput := config.GetBool(outputworkflow.OutputConfigKeyJSON)
 	jsonFileOutput := config.GetString(outputworkflow.OutputConfigKeyJSONFile)
 
 	// Human-readable output is suppressed only when --json is specified.

internal/commands/ostest/test_execution.go

@@ -151,7 +151,7 @@ func prepareOutput(
 		outputData = append(outputData, summaryData)
 	}
 
-	wantsJSONStdOut := config.GetBool("json")
+	wantsJSONStdOut := config.GetBool(outputworkflow.OutputConfigKeyJSON)
 	jsonFileOutput := config.GetString(outputworkflow.OutputConfigKeyJSONFile)
 	wantsJSONFile := jsonFileOutput != ""
 	wantsAnyJSON := wantsJSONStdOut || wantsJSONFile

internal/commands/ostest/workflow_test.go

@@ -25,6 +25,7 @@ import (
 	common "github.com/snyk/cli-extension-os-flows/internal/common"
 	"github.com/snyk/cli-extension-os-flows/internal/flags"
 	"github.com/snyk/cli-extension-os-flows/internal/legacy/definitions"
+	"github.com/snyk/cli-extension-os-flows/internal/outputworkflow"
 )
 
 var legacyWorkflowID = workflow.NewWorkflowIdentifier("legacycli")
@@ -462,7 +463,7 @@ func TestOSWorkflow_AllProjects_UnifiedFlow(t *testing.T) {
 	config.Set(ostest.FeatureFlagRiskScore, true)
 	config.Set(ostest.FeatureFlagRiskScoreInCLI, true)
 	config.Set(flags.FlagAllProjects, true)
-	config.Set("json", true)
+	config.Set(outputworkflow.OutputConfigKeyJSON, true)
 
 	// Temporarily reduce the poll interval for this test to avoid timeouts.
 	originalPollInterval := ostest.PollInterval

internal/outputworkflow/delayedfileopenwritecloser.go

@@ -21,7 +21,7 @@ func (wc *delayedFileOpenWriteCloser) Write(p []byte) (n int, err error) {
 			return 0, pathError
 		}
 
-		file, fileErr := os.OpenFile(wc.Filename, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, Fileperm666)
+		file, fileErr := os.OpenFile(wc.Filename, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, fileperm666)
 		if fileErr != nil {
 			return 0, fmt.Errorf("failed to open file %s: %w", wc.Filename, fileErr)
 		}

internal/outputworkflow/file_utils.go

@@ -8,17 +8,17 @@ import (
 )
 
 const (
-	// Fileperm755 is a constant for file permissions.
-	Fileperm755 fs.FileMode = 0o755 // Owner=rwx, Group=r-x, Other=r-x
-	// Fileperm666 is a constant for file permissions.
-	Fileperm666 fs.FileMode = 0o666 // Owner=rw-, Group=rw-, Other=rw-
+	// fileperm755 is the permission for creating directories: Owner=rwx, Group=r-x, Other=r-x.
+	fileperm755 fs.FileMode = 0o755
+	// fileperm666 is the permission file output: Owner=rw-, Group=rw-, Other=rw-.
+	fileperm666 fs.FileMode = 0o666
 )
 
 // CreateFilePath creates the directory path for a file if it doesn't exist.
 func CreateFilePath(path string) error {
 	dirPath := filepath.Dir(path)
 	if _, err := os.Stat(dirPath); os.IsNotExist(err) {
-		mkdirErr := os.MkdirAll(dirPath, Fileperm755)
+		mkdirErr := os.MkdirAll(dirPath, fileperm755)
 		if mkdirErr != nil {
 			return fmt.Errorf("failed to create directory path %s: %w", dirPath, mkdirErr)
 		}

internal/outputworkflow/output_destination.go

@@ -8,7 +8,7 @@ import (
 	"os"
 )
 
-// OutputDestination is an interface for output destinations.
+// OutputDestination is an interface for where to direct workflow output.
 type OutputDestination interface {
 	Println(a ...any) (n int, err error)
 	Remove(name string) error

internal/outputworkflow/output_workflow_test.go

@@ -30,10 +30,10 @@ func Test_Output_InitOutputWorkflow(t *testing.T) {
 	err := InitOutputWorkflow(engine)
 	assert.Nil(t, err)
 
-	json := config.GetBool("json")
+	json := config.GetBool(OutputConfigKeyJSON)
 	assert.Equal(t, false, json)
 
-	jsonFileOutput := config.GetString("json-file-output")
+	jsonFileOutput := config.GetString(OutputConfigKeyJSONFile)
 	assert.Equal(t, "", jsonFileOutput)
 }