feat(cli): add option --yaml-style-newline

Author: dbohdan

completions/remarshal.bash

@@ -9,7 +9,7 @@ _remarshal() {
     input_formats=$formats
     output_formats="$formats python"
 
-    opts='--help --version --from --if --input-format --input --indent --stringify --max-values --multiline --output --sort-keys --to --of --output-format --unwrap --verbose --width --wrap --yaml-style'
+    opts='--help --version --from --if --input-format --input --indent --stringify --max-values --multiline --output --sort-keys --to --of --output-format --unwrap --verbose --width --wrap --yaml-style --yaml-style-newline'
 
     case "${prev}" in
     --from | --if | --input-format | -f)
@@ -20,7 +20,7 @@ _remarshal() {
         COMPREPLY=($(compgen -W "${output_formats}" -- ${cur}))
         return 0
         ;;
-    --yaml-style)
+    --yaml-style | --yaml-style-newline)
         COMPREPLY=($(compgen -W '\" '"\\' '|' '>'" -- ${cur}))
         return 0
         ;;

completions/remarshal.fish

@@ -1,3 +1,5 @@
+set --local yaml_styles '"\'" "\\"" "|" ">"'
+
 complete -c remarshal -s h -l help -d "Show help message and exit"
 complete -c remarshal -s v -l version -d "Show program's version number and exit"
 
@@ -14,4 +16,5 @@ complete -c remarshal -l unwrap -x -d "Only output data under given key"
 complete -c remarshal -l verbose -d "Print debug information on error"
 complete -c remarshal -l width -x -d "Python and YAML line width"
 complete -c remarshal -l wrap -x -d "Wrap data in a map with given key"
-complete -c remarshal -l yaml-style -x -a '"\'" "\\"" "|" ">"' -d "YAML formatting style"
+complete -c remarshal -l yaml-style -x -a $yaml_styles -d "YAML formatting style"
+complete -c remarshal -l yaml-style-newline -x -a $yaml_styles -d "YAML formatting style override for strings that contain a newline"

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "remarshal"
-version = "1.0.1"
+version = "1.1.0"
 description = "Convert between CBOR, JSON, MessagePack, TOML, and YAML"
 authors = [{ name = "D. Bohdan", email = "dbohdan@dbohdan.com" }]
 license = { text = "MIT" }

src/remarshal/main.py

@@ -41,6 +41,7 @@
 import ruamel.yaml
 import ruamel.yaml.parser
 import ruamel.yaml.representer
+import ruamel.yaml.scalarstring
 import ruamel.yaml.scanner
 import umsgpack
 
@@ -109,6 +110,7 @@ class TOMLOptions(FormatOptions):
 class YAMLOptions(FormatOptions):
     indent: int = Defaults.YAML_INDENT
     style: YAMLStyle = Defaults.YAML_STYLE
+    style_newline: YAMLStyle | None = None
     width: int = Defaults.WIDTH
 
 
@@ -392,6 +394,13 @@ def output_width(value: str) -> int:
         help="YAML formatting style",
     )
 
+    parser.add_argument(
+        "--yaml-style-newline",
+        choices=["", "'", '"', "|", ">"],
+        default=YAMLOptions().style_newline,
+        help="YAML formatting style override for strings that contain a newline",
+    )
+
     parser.add_argument(
         "--yaml-width",
         dest="width",
@@ -761,15 +770,12 @@ def multilinify(item: tomlkit.items.Item) -> None:
         raise ValueError(msg)
 
 
-def _yaml_represent_none(self, data):
-    return self.represent_scalar("tag:yaml.org,2002:null", "null")
-
-
 def _encode_yaml(
     data: Document,
     *,
     indent: int | None,
     style: YAMLStyle,
+    style_newline: YAMLStyle | None,
     width: int,
 ) -> str:
     yaml = ruamel.yaml.YAML(pure=True)
@@ -779,7 +785,15 @@ def _encode_yaml(
     yaml.indent = indent
     yaml.width = width
 
-    yaml.representer.add_representer(type(None), _yaml_represent_none)
+    def represent_none(self, data):
+        return self.represent_scalar("tag:yaml.org,2002:null", "null")
+
+    def represent_str(self, data):
+        str_style = style_newline if "\n" in data else style
+        return self.represent_scalar("tag:yaml.org,2002:str", data, style=str_style)
+
+    yaml.representer.add_representer(type(None), represent_none)
+    yaml.representer.add_representer(str, represent_str)
 
     try:
         out = StringIO()
@@ -804,6 +818,7 @@ def format_options(
     stringify: bool = False,
     width: int = Defaults.WIDTH,
     yaml_style: YAMLStyle = Defaults.YAML_STYLE,
+    yaml_style_newline: YAMLStyle | None = None,
 ) -> FormatOptions:
     match output_format:
         case "cbor":
@@ -837,6 +852,7 @@ def format_options(
             return YAMLOptions(
                 indent=Defaults.YAML_INDENT if indent is None else indent,
                 style=yaml_style,
+                style_newline=yaml_style_newline,
                 width=width,
             )
 
@@ -918,6 +934,7 @@ def encode(
                 data,
                 indent=options.indent,
                 style=options.style,
+                style_newline=options.style_newline,
                 width=options.width,
             ).encode(UTF_8)
 
@@ -1004,6 +1021,7 @@ def main() -> None:
             stringify=args.stringify,
             width=args.width,
             yaml_style=args.yaml_style,
+            yaml_style_newline=args.yaml_style_newline,
         )
 
         remarshal(

tests/newline-default.yaml

@@ -0,0 +1,6 @@
+'single': 'this'
+'multiline': 'is
+
+  an
+
+  example'

tests/newline-double-quote.yaml

@@ -0,0 +1,2 @@
+'single': 'this'
+'multiline': "is\nan\nexample"

tests/newline-empty.yaml

@@ -0,0 +1,2 @@
+'single': 'this'
+'multiline': "is\nan\nexample"

tests/newline-gt.yaml

@@ -0,0 +1,7 @@
+'single': 'this'
+'multiline': >-
+  is
+
+  an
+
+  example

tests/newline-pipe.yaml

@@ -0,0 +1,5 @@
+'single': 'this'
+'multiline': |-
+  is
+  an
+  example

tests/newline-single-quote.yaml

@@ -0,0 +1,6 @@
+'single': 'this'
+'multiline': 'is
+
+  an
+
+  example'