Update with fixes to collapsing nested cases with lists

Author: matiascr

CHANGELOG.md

@@ -432,3 +432,7 @@
 - Fixed a bug where the data generated for searching documentation was in the
   wrong format, preventing it from being used by Hexdocs search.
   ([Surya Rose](https://github.com/GearsDatapacks))
+
+- Fixed a bug where the collapse nested case would produce invalid code on a
+  list tail pattern.
+  ([Matias Carlander](https://github.com/matiascr))

compiler-core/src/ast.rs

@@ -3162,16 +3162,21 @@ pub struct BoundVariable {
 pub enum BoundVariableName {
     /// A record's labelled field introduced with the shorthand syntax.
     ShorthandLabel { name: EcoString },
+    ListTail {
+        name: EcoString,
+        /// The location of the whole tail, from the `..` prefix until the end of the variable.
+        tail_prefix_location: SrcSpan,
+    },
     /// Any other variable name.
     Regular { name: EcoString },
 }
 
 impl BoundVariable {
     pub fn name(&self) -> EcoString {
         match &self.name {
-            BoundVariableName::ShorthandLabel { name } | BoundVariableName::Regular { name } => {
-                name.clone()
-            }
+            BoundVariableName::ShorthandLabel { name }
+            | BoundVariableName::ListTail { name, .. }
+            | BoundVariableName::Regular { name } => name.clone(),
         }
     }
 }
@@ -3392,13 +3397,27 @@ impl TypedPattern {
                 });
                 pattern.collect_bound_variables(variables);
             }
-            Pattern::List { elements, tail, .. } => {
+            Pattern::List {
+                elements,
+                tail,
+                type_,
+                ..
+            } => {
                 for element in elements {
                     element.collect_bound_variables(variables);
                 }
-                if let Some(tail) = tail {
-                    tail.pattern.collect_bound_variables(variables);
-                }
+                if let Some(tail) = tail
+                    && let Pattern::Variable { name, location, .. } = tail.pattern.to_owned()
+                {
+                    variables.push(BoundVariable {
+                        name: BoundVariableName::ListTail {
+                            name,
+                            tail_prefix_location: tail.location,
+                        },
+                        location,
+                        type_: type_.clone(),
+                    })
+                };
             }
             Pattern::Constructor { arguments, .. } => {
                 for argument in arguments {

compiler-core/src/language_server/code_action.rs

@@ -28,6 +28,7 @@ use ecow::{EcoString, eco_format};
 use im::HashMap;
 use itertools::Itertools;
 use lsp_types::{CodeAction, CodeActionKind, CodeActionParams, Position, Range, TextEdit, Url};
+use regex::Regex;
 use vec1::{Vec1, vec1};
 
 use super::{
@@ -8264,22 +8265,42 @@ impl<'a> CollapseNestedCase<'a> {
         let pattern_text: String = code_at(self.module, matched_pattern_span).into();
         let matched_variable_span = matched_variable.location;
 
-        let pattern_with_variable = |new_content: String| {
+        let pattern_with_variable = |mut new_content: String| {
             let mut new_pattern = pattern_text.clone();
 
             match matched_variable {
                 BoundVariable {
-                    name: BoundVariableName::Regular { .. },
+                    name: BoundVariableName::Regular { .. } | BoundVariableName::ListTail { .. },
                     ..
                 } => {
                     // If the variable is a regular variable we'll have to replace
                     // it entirely with the new pattern taking its place.
+
+                    let variable_span_to_use = if let BoundVariableName::ListTail {
+                        tail_prefix_location: prefix_and_variable_span,
+                        ..
+                    } = matched_variable.name
+                    {
+                        // We need to un-nest the list when replacing the tail
+                        let surrounding_brackets = Regex::new(r"(^\[|\]$)").expect("a valid regex");
+                        new_content = surrounding_brackets
+                            .replace_all(new_content.trim(), "")
+                            .to_string();
+
+                        // We need to also remove the prefix when replacing the variable
+                        // at the tail of the list
+                        prefix_and_variable_span
+                    } else {
+                        matched_variable_span
+                    };
+
                     let variable_start_in_pattern =
-                        matched_variable_span.start - matched_pattern_span.start;
-                    let variable_length = matched_variable_span.end - matched_variable_span.start;
+                        (variable_span_to_use.start - matched_pattern_span.start) as usize;
+                    let variable_length =
+                        (variable_span_to_use.end - variable_span_to_use.start) as usize;
+
                     let variable_end_in_pattern = variable_start_in_pattern + variable_length;
-                    let replaced_range =
-                        variable_start_in_pattern as usize..variable_end_in_pattern as usize;
+                    let replaced_range = variable_start_in_pattern..variable_end_in_pattern;
 
                     new_pattern.replace_range(replaced_range, &new_content);
                 }

compiler-core/src/language_server/tests/action.rs

@@ -9947,6 +9947,49 @@ fn collapse_nested_case_combines_inner_and_outer_guards_and_adds_parentheses_whe
     );
 }
 
+#[test]
+fn collapse_nested_case_combines_list_with_unformatted_tail() {
+    assert_code_action!(
+        COLLAPSE_NESTED_CASE,
+        r#"pub fn main(elems: List(String)) {
+  case elems {
+    [first, .. rest_of_list] ->
+      case rest_of_list {
+        [] -> 0
+        ["first"] -> 1
+        [_, "second"] -> 2
+        [_, "second", "third", _] -> 4
+        _ -> -1
+      }
+    _ -> -1
+  }
+}"#,
+        find_position_of("rest").to_selection()
+    );
+}
+
+#[test]
+fn collapse_nested_case_combines_list_with_tail() {
+    assert_code_action!(
+        COLLAPSE_NESTED_CASE,
+        r#"pub fn main(elems: List(List(Int))) {
+  case elems {
+    [] -> 0
+    [_, ..tail] ->
+      case tail {
+        [] -> -1
+        [[1]] -> 1
+        [_, [3, 4]] -> 3
+        [_, _, [5, 6, 7], _] -> 5
+        _ -> -1
+      }
+    _ -> -1
+  }
+}"#,
+        find_position_of("tail").to_selection()
+    );
+}
+
 // https://github.com/gleam-lang/gleam/issues/3786
 #[test]
 fn type_variables_from_other_functions_do_not_change_annotations() {

compiler-core/src/language_server/tests/snapshots/gleam_core__language_server__tests__action__collapse_nested_case_combines_list_with_tail.snap

@@ -0,0 +1,34 @@
+---
+source: compiler-core/src/language_server/tests/action.rs
+expression: "pub fn main(elems: List(List(Int))) {\n  case elems {\n    [] -> 0\n    [_, ..tail] ->\n      case tail {\n        [] -> -1\n        [[1]] -> 1\n        [_, [3, 4]] -> 3\n        [_, _, [5, 6, 7], _] -> 5\n        _ -> -1\n      }\n    _ -> -1\n  }\n}"
+---
+----- BEFORE ACTION
+pub fn main(elems: List(List(Int))) {
+  case elems {
+    [] -> 0
+    [_, ..tail] ->
+          ↑       
+      case tail {
+        [] -> -1
+        [[1]] -> 1
+        [_, [3, 4]] -> 3
+        [_, _, [5, 6, 7], _] -> 5
+        _ -> -1
+      }
+    _ -> -1
+  }
+}
+
+
+----- AFTER ACTION
+pub fn main(elems: List(List(Int))) {
+  case elems {
+    [] -> 0
+    [_, ] -> -1
+    [_, [1]] -> 1
+    [_, _, [3, 4]] -> 3
+    [_, _, _, [5, 6, 7], _] -> 5
+    [_, _] -> -1
+    _ -> -1
+  }
+}

compiler-core/src/language_server/tests/snapshots/gleam_core__language_server__tests__action__collapse_nested_case_combines_list_with_unformatted_tail.snap

@@ -0,0 +1,32 @@
+---
+source: compiler-core/src/language_server/tests/action.rs
+expression: "pub fn main(elems: List(String)) {\n  case elems {\n    [first, .. rest_of_list] ->\n      case rest_of_list {\n        [] -> 0\n        [\"first\"] -> 1\n        [_, \"second\"] -> 2\n        [_, \"second\", \"third\", _] -> 4\n        _ -> -1\n      }\n    _ -> -1\n  }\n}"
+---
+----- BEFORE ACTION
+pub fn main(elems: List(String)) {
+  case elems {
+    [first, .. rest_of_list] ->
+               ↑               
+      case rest_of_list {
+        [] -> 0
+        ["first"] -> 1
+        [_, "second"] -> 2
+        [_, "second", "third", _] -> 4
+        _ -> -1
+      }
+    _ -> -1
+  }
+}
+
+
+----- AFTER ACTION
+pub fn main(elems: List(String)) {
+  case elems {
+    [first, ] -> 0
+    [first, "first"] -> 1
+    [first, _, "second"] -> 2
+    [first, _, "second", "third", _] -> 4
+    [first, _] -> -1
+    _ -> -1
+  }
+}