tools/flow: move CUE_DEBUG_TOOLS_FLOW=1 to CUE_DEBUG=toolsflow=1

With the rest of the debugging flags, for consistency.

Fixes #3052.

Signed-off-by: Daniel Martí <[email protected]>
Change-Id: I9092741081db6322f65461dbf742cde809a13aa5
Reviewed-on: https://review.gerrithub.io/c/cue-lang/cue/+/1214723
Unity-Result: CUE porcuepine <[email protected]>
TryBot-Result: CUEcueckoo <[email protected]>
Reviewed-by: Matthew Sackman <[email protected]>

Author: mvdan

cmd/cue/cmd/help.go

@@ -315,6 +315,8 @@ If an environment variable is unset or empty, sensible default setting is used.
 			when interacting with module registries.
 		sortfields
 			Force fields in stucts to be sorted lexicographically.
+		toolsflow
+			Print task dependency mermaid graphs in 'cue cmd'.
 
 CUE_EXPERIMENT and CUE_DEBUG are comma-separated lists of key-value strings,
 where the value is a boolean "true" or "1" if omitted. For example:

cmd/cue/cmd/testdata/script/cmd_debug.txtar

@@ -1,4 +1,4 @@
-env CUE_DEBUG_TOOLS_FLOW=1
+env CUE_DEBUG=toolsflow=1
 
 exec cue cmd bar
 cmp stderr stderr.golden

internal/cuedebug/cuedebug.go

@@ -9,7 +9,7 @@ import (
 // Flags holds the set of global CUE_DEBUG flags. It is initialized by Init.
 var Flags Config
 
-// Flags holds the set of known CUE_DEBUG flags.
+// Config holds the set of known CUE_DEBUG flags.
 //
 // When adding, deleting, or modifying entries below,
 // update cmd/cue/cmd/help.go as well for `cue help environment`.
@@ -44,6 +44,9 @@ type Config struct {
 
 	// OpenDef disables the check for closedness of definitions.
 	OpenDef bool
+
+	// ToolsFlow causes [cuelang.org/go/tools/flow] to print a task dependency mermaid graph.
+	ToolsFlow bool
 }
 
 // Init initializes Flags. Note: this isn't named "init" because we

tools/flow/flow.go

@@ -69,7 +69,6 @@ package flow
 import (
 	"context"
 	"fmt"
-	"os"
 	"strings"
 	"sync/atomic"
 
@@ -89,9 +88,6 @@ var (
 
 	// TODO: ErrUpdate: update and run a dependency, but don't complete a
 	// dependency as more results may come. This is useful in server mode.
-
-	// TODO: move CUE_DEBUG_TOOLS_FLOW=1 to e.g. CUE_DEBUG=toolsflow
-	debug = os.Getenv("CUE_DEBUG_TOOLS_FLOW") != ""
 )
 
 // A TaskFunc creates a Runner for v if v defines a task or reports nil

tools/flow/run.go

@@ -33,6 +33,7 @@ import (
 	"cuelang.org/go/cue/errors"
 	"cuelang.org/go/internal/core/adt"
 	"cuelang.org/go/internal/core/eval"
+	"cuelang.org/go/internal/cuedebug"
 	"cuelang.org/go/internal/value"
 )
 
@@ -145,7 +146,8 @@ func (c *Controller) markReady(t *Task) {
 		}
 	}
 
-	if debug {
+	cuedebug.Init()
+	if cuedebug.Flags.ToolsFlow {
 		fmt.Fprintln(os.Stderr, "tools/flow task dependency graph:")
 		fmt.Fprintln(os.Stderr, "```mermaid")
 		fmt.Fprint(os.Stderr, mermaidGraph(c))