feat: support keeping labels and env instructions on the same line

Author: dsherret

src/parser/context.rs

@@ -1,6 +1,7 @@
 use std::collections::HashSet;
 use std::rc::Rc;
 
+use dockerfile_parser::Dockerfile;
 use dockerfile_parser::Span;
 
 use super::helpers::parse_comments;
@@ -9,6 +10,7 @@ use crate::configuration::Configuration;
 
 pub struct Context<'a> {
   pub config: &'a Configuration,
+  pub dockerfile: &'a Dockerfile,
   pub text: &'a str,
   pub handled_comments: HashSet<usize>,
   current_node: Option<Node<'a>>,
@@ -17,10 +19,11 @@ pub struct Context<'a> {
 }
 
 impl<'a> Context<'a> {
-  pub fn new(text: &'a str, config: &'a Configuration) -> Self {
+  pub fn new(text: &'a str, dockerfile: &'a Dockerfile, config: &'a Configuration) -> Self {
     Self {
       config,
       text,
+      dockerfile,
       handled_comments: HashSet::new(),
       current_node: None,
       parent_stack: Vec::new(),

src/parser/parse.rs

@@ -7,7 +7,7 @@ use super::helpers::*;
 use crate::configuration::Configuration;
 
 pub fn parse_items(file: &Dockerfile, text: &str, config: &Configuration) -> PrintItems {
-  let mut context = Context::new(text, config);
+  let mut context = Context::new(text, file, config);
   let mut items = PrintItems::new();
   let top_level_nodes = context.parse_nodes_with_comments(0, text.len(), file.instructions.iter().map(|i| i.into()));
 
@@ -158,23 +158,61 @@ fn parse_label<'a>(node: &'a Label, context: &mut Context<'a>) -> PrintItems {
 }
 
 fn parse_multi_line_items<'a>(nodes: Vec<Node<'a>>, indent_width: u32, context: &mut Context<'a>) -> PrintItems {
-  let mut items = PrintItems::new();
   let count = nodes.len();
-  for (i, node) in nodes.into_iter().enumerate() {
-    let is_comment = node.is_comment();
-    let mut node_items = parse_node(node, context);
-    if i < count - 1 && !is_comment {
-      node_items.push_str(" \\");
-      node_items.push_signal(Signal::NewLine);
-    }
-
-    if i > 0 {
-      items.extend(parser_helpers::with_indent_times(node_items, indent_width));
-    } else {
-      items.extend(node_items);
-    }
-  }
-  items
+  let nodes_with_line_index = nodes
+    .into_iter()
+    .map(|node| {
+      let (line_index, _) = node.span().relative_span(context.dockerfile);
+      (node, line_index)
+    })
+    .collect::<Vec<_>>();
+  let force_use_new_lines = nodes_with_line_index.len() > 1 && nodes_with_line_index[0].1 < nodes_with_line_index[1].1;
+
+  parser_helpers::parse_separated_values(
+    |is_multiline| {
+      nodes_with_line_index
+        .into_iter()
+        .enumerate()
+        .map(|(i, (node, line_index))| {
+          let is_comment = node.is_comment();
+          let mut node_items = parse_node(node, context);
+          if i < count - 1 && !is_comment {
+            node_items.push_condition(conditions::if_true("endLineText", is_multiline.create_resolver(), {
+              let mut items = PrintItems::new();
+              items.push_str(" \\");
+              items
+            }));
+          }
+
+          parser_helpers::ParsedValue {
+            items: if i > 0 {
+              parser_helpers::with_indent_times(node_items, indent_width)
+            } else {
+              node_items
+            },
+            lines_span: Some(parser_helpers::LinesSpan {
+              start_line: line_index,
+              end_line: line_index,
+            }),
+            allow_inline_multi_line: false,
+            allow_inline_single_line: false,
+          }
+        })
+        .collect()
+    },
+    parser_helpers::ParseSeparatedValuesOptions {
+      prefer_hanging: false,
+      force_use_new_lines,
+      allow_blank_lines: false,
+      single_line_space_at_start: false,
+      single_line_space_at_end: false,
+      single_line_separator: Signal::SpaceOrNewLine.into(),
+      indent_width: 0 as u8,
+      multi_line_options: parser_helpers::MultiLineOptions::same_line_no_indent(),
+      force_possible_newline_at_start: false,
+    },
+  )
+  .items
 }
 
 fn parse_misc_instruction<'a>(node: &'a MiscInstruction, context: &mut Context<'a>) -> PrintItems {

tests/specs/Env/Env_All.txt

@@ -1,12 +1,13 @@
+~~ lineWidth: 50 ~~
 == should format ==
 ENV   MY_NAME="John Doe"
-ENV   MY_CAT=fluffy
+ENV   MY_CAT=fluffy    Test=asdf
 ENV    MY_NAME="John Doe"   MY_DOG=RexTheDog \
      MY_CAT=fluffy
 
 [expect]
 ENV MY_NAME="John Doe"
-ENV MY_CAT=fluffy
+ENV MY_CAT=fluffy Test=asdf
 ENV MY_NAME="John Doe" \
     MY_DOG=RexTheDog \
     MY_CAT=fluffy

tests/specs/Label/Label_All.txt

@@ -1,11 +1,30 @@
-== should format multiple labels on multiple lines ==
+~~ lineWidth: 50 ~~
+== should format a single label ==
+LABEL some.label="value1"
+LABEL some.label2="with some text that goes over limit"
+
+[expect]
+LABEL some.label="value1"
+LABEL some.label2="with some text that goes over limit"
+
+== should format multiple labels on multiple lines when exceeding width ==
+LABEL multi="value1" label="value2"
 LABEL multi.label="value1" multi.label2="value2" other="value3"
 
 [expect]
+LABEL multi="value1" label="value2"
 LABEL multi.label="value1" \
       multi.label2="value2" \
       other="value3"
 
+== should keep on multiple lines when could collapse ==
+LABEL multi="value1" \
+      label="value2"
+
+[expect]
+LABEL multi="value1" \
+      label="value2"
+
 == should format with quotes ==
 LABEL "com.example.vendor"="ACME Incorporated"