cmd/export: add --preserve-comments flag

Closes cue-lang#1180
felixge · Feb 24, 2022 · 7d63a58 · 7d63a58
1 parent 71e9d03
commit 7d63a58
Show file tree

Hide file tree

Showing 7 changed files with 53 additions and 29 deletions.
diff --git a/cmd/cue/cmd/common.go b/cmd/cue/cmd/common.go
@@ -719,14 +719,15 @@ func (b *buildPlan) parseFlags() (err error) {
 		b.cfg.fileFilter = s
 	}
 	b.encConfig = &encoding.Config{
-		Force:     flagForce.Bool(b.cmd),
-		Mode:      b.cfg.outMode,
-		Stdin:     b.cmd.InOrStdin(),
-		Stdout:    b.cmd.OutOrStdout(),
-		ProtoPath: flagProtoPath.StringArray(b.cmd),
-		AllErrors: flagAllErrors.Bool(b.cmd),
-		PkgName:   flagPackage.String(b.cmd),
-		Strict:    flagStrict.Bool(b.cmd),
+		Force:            flagForce.Bool(b.cmd),
+		Mode:             b.cfg.outMode,
+		Stdin:            b.cmd.InOrStdin(),
+		Stdout:           b.cmd.OutOrStdout(),
+		ProtoPath:        flagProtoPath.StringArray(b.cmd),
+		AllErrors:        flagAllErrors.Bool(b.cmd),
+		PkgName:          flagPackage.String(b.cmd),
+		Strict:           flagStrict.Bool(b.cmd),
+		PreserveComments: flagPreserveComments.Bool(b.cmd),
 	}
 	return nil
 }

diff --git a/cmd/cue/cmd/export.go b/cmd/cue/cmd/export.go
@@ -96,6 +96,7 @@ yaml    output as YAML
 	addOrphanFlags(cmd.Flags())
 	addInjectionFlags(cmd.Flags(), false)
 
+	cmd.Flags().Bool(string(flagPreserveComments), false, "include comments in output")
 	cmd.Flags().Bool(string(flagEscape), false, "use HTML escaping")
 	cmd.Flags().StringArrayP(string(flagExpression), "e", nil, "export this expression only")
 

diff --git a/cmd/cue/cmd/flags.go b/cmd/cue/cmd/flags.go
@@ -21,18 +21,19 @@ import (
 
 // Common flags
 const (
-	flagAll        flagName = "all"
-	flagDryrun     flagName = "dryrun"
-	flagVerbose    flagName = "verbose"
-	flagAllErrors  flagName = "all-errors"
-	flagTrace      flagName = "trace"
-	flagForce      flagName = "force"
-	flagIgnore     flagName = "ignore"
-	flagStrict     flagName = "strict"
-	flagSimplify   flagName = "simplify"
-	flagPackage    flagName = "package"
-	flagInject     flagName = "inject"
-	flagInjectVars flagName = "inject-vars"
+	flagAll              flagName = "all"
+	flagDryrun           flagName = "dryrun"
+	flagVerbose          flagName = "verbose"
+	flagAllErrors        flagName = "all-errors"
+	flagTrace            flagName = "trace"
+	flagForce            flagName = "force"
+	flagIgnore           flagName = "ignore"
+	flagStrict           flagName = "strict"
+	flagSimplify         flagName = "simplify"
+	flagPackage          flagName = "package"
+	flagInject           flagName = "inject"
+	flagInjectVars       flagName = "inject-vars"
+	flagPreserveComments flagName = "preserve-comments"
 
 	flagExpression  flagName = "expression"
 	flagSchema      flagName = "schema"

diff --git a/cmd/cue/cmd/testdata/script/export_yaml_comments.txt b/cmd/cue/cmd/testdata/script/export_yaml_comments.txt
@@ -0,0 +1,18 @@
+cue export --preserve-comments --out yaml ./hello
+cmp stdout expect-stdout
+-- expect-stdout --
+# cloud-config
+foo: bar
+hello:
+  # occupy
+  world: from mars?
+-- hello/hello.cue --
+package hello
+
+//cloud-config
+foo: "bar"
+
+hello: {
+        // occupy
+        world: "from mars?"
+}
diff --git a/internal/encoding/encoder.go b/internal/encoding/encoder.go
@@ -182,7 +182,7 @@ func NewEncoder(f *build.File, cfg *Config) (*Encoder, error) {
 			}
 			streamed = true
 
-			str, err := yaml.Marshal(v)
+			str, err := yaml.Marshal(v, cue.Docs(e.cfg.PreserveComments))
 			if err != nil {
 				return err
 			}

diff --git a/internal/encoding/encoding.go b/internal/encoding/encoding.go
@@ -151,10 +151,11 @@ type Config struct {
 
 	PkgName string // package name for files to generate
 
-	Force     bool // overwrite existing files.
-	Strict    bool
-	Stream    bool // will potentially write more than one document per file
-	AllErrors bool
+	Force            bool // overwrite existing files.
+	Strict           bool
+	Stream           bool // will potentially write more than one document per file
+	AllErrors        bool
+	PreserveComments bool
 
 	Schema cue.Value // used for schema-based decoding
 

diff --git a/pkg/encoding/yaml/manual.go b/pkg/encoding/yaml/manual.go
@@ -26,7 +26,7 @@ import (
 )
 
 // Marshal returns the YAML encoding of v.
-func Marshal(v cue.Value) (string, error) {
+func Marshal(v cue.Value, opts ...cue.Option) (string, error) {
 	if err := v.Validate(cue.Concrete(true)); err != nil {
 		if err := v.Validate(); err != nil {
 			return "", err
@@ -35,13 +35,14 @@ func Marshal(v cue.Value) (string, error) {
 		// messages can be passed.
 		return "", internal.ErrIncomplete
 	}
-	n := v.Syntax(cue.Final(), cue.Concrete(true))
+	opts = append([]cue.Option{cue.Final(), cue.Concrete(true)}, opts...)
+	n := v.Syntax(opts...)
 	b, err := cueyaml.Encode(n)
 	return string(b), err
 }
 
 // MarshalStream returns the YAML encoding of v.
-func MarshalStream(v cue.Value) (string, error) {
+func MarshalStream(v cue.Value, opts ...cue.Option) (string, error) {
 	// TODO: return an io.Reader and allow asynchronous processing.
 	iter, err := v.List()
 	if err != nil {
@@ -61,7 +62,8 @@ func MarshalStream(v cue.Value) (string, error) {
 			// messages can be passed.
 			return "", internal.ErrIncomplete
 		}
-		n := v.Syntax(cue.Final(), cue.Concrete(true))
+		opts = append([]cue.Option{cue.Final(), cue.Concrete(true)}, opts...)
+		n := v.Syntax(opts...)
 		b, err := cueyaml.Encode(n)
 		if err != nil {
 			return "", err