Fix 55

CHANGELOG.md

@@ -1,6 +1,8 @@
-## 2.2.1-wip
+## 2.2.1
 
 - Require Dart 3.0
+- Fix removal of last key in blockmap when key has no value
+  ([#55](https://github.com/dart-lang/yaml_edit/issues/55)).
 
 ## 2.2.0
 

lib/src/map_mutations.dart

@@ -145,6 +145,7 @@ SourceEdit _replaceInBlockMap(
   }
 
   /// +1 accounts for the colon
+  // TODO: What if here is a whitespace following the key, before the colon?
   final start = keyNode.span.end.offset + 1;
   var end = getContentSensitiveEnd(map.nodes[key]!);
 
@@ -175,9 +176,19 @@ SourceEdit _removeFromBlockMap(
   final keySpan = keyNode.span;
   var end = getContentSensitiveEnd(valueNode);
   final yaml = yamlEdit.toString();
+  final lineEnding = getLineEnding(yaml);
 
   if (map.length == 1) {
     final start = map.span.start.offset;
+    final nextNewLine = yaml.indexOf(lineEnding, end);
+    if (nextNewLine != -1) {
+      // Remove everything up to the next newline, this strips comments that
+      // follows on the same line as the value we're removing.
+      // It also ensures we consume colon when [valueNode.value] is `null`
+      // because there is no value (e.g. `key: \n`). Because [valueNode.span] in
+      // such cases point to the colon `:`.
+      end = nextNewLine;
+    }
     return SourceEdit(start, end - start, '{}');
   }
 
@@ -187,16 +198,16 @@ SourceEdit _removeFromBlockMap(
   ///
   /// We do this because we suspect that our users will want the inline
   /// comments to disappear too.
-  final nextNewLine = yaml.indexOf('\n', end);
+  final nextNewLine = yaml.indexOf(lineEnding, end);
   if (nextNewLine != -1) {
-    end = nextNewLine + 1;
+    end = nextNewLine + lineEnding.length;
   }
 
   final nextNode = getNextKeyNode(map, keyNode);
 
   if (start > 0) {
     final lastHyphen = yaml.lastIndexOf('-', start - 1);
-    final lastNewLine = yaml.lastIndexOf('\n', start - 1);
+    final lastNewLine = yaml.lastIndexOf(lineEnding, start - 1);
     if (lastHyphen > lastNewLine) {
       start = lastHyphen + 2;
 
@@ -208,7 +219,7 @@ SourceEdit _removeFromBlockMap(
         end += nextNode.span.start.column;
       }
     } else if (lastNewLine > lastHyphen) {
-      start = lastNewLine + 1;
+      start = lastNewLine + lineEnding.length;
     }
   }
 

pubspec.yaml

@@ -1,5 +1,5 @@
 name: yaml_edit
-version: 2.2.1-wip
+version: 2.2.1
 description: >-
   A library for YAML manipulation with comment and whitespace preservation.
 repository: https://github.com/dart-lang/yaml_edit

test/testdata/input/issue_55.test

@@ -0,0 +1,11 @@
+TEST FOR ISSUE #55 -- https://github.com/dart-lang/yaml_edit/issues/55
+---
+name: sample
+version: 0.1.0
+environment:
+  sdk: ^3.0.0
+dependencies:
+dev_dependencies:
+  retry:
+---
+ - [remove, ['dev_dependencies', 'retry']]

test/testdata/input/remove_key.test

@@ -0,0 +1,6 @@
+REMOVE KEY FROM MAP
+---
+foo: true
+bar: false
+---
+- [remove, [bar]]

test/testdata/input/remove_key_with_trailing_comma.test

@@ -0,0 +1,6 @@
+REMOVE KEY FROM MAP WITH TRAILING COMMA
+---
+foo: true
+bar: false # remove this comment
+---
+- [remove, [bar]]

test/testdata/input/remove_nested_key.test

@@ -0,0 +1,9 @@
+REMOVE NESTED KEY FROM MAP
+---
+A: true
+B:
+  foo: true
+  bar: true
+---
+- [remove, [B, foo]]
+- [remove, [B, bar]]

test/testdata/input/remove_nested_key_with_null.test

@@ -0,0 +1,7 @@
+REMOVE NESTED KEY FROM MAP WITH NULL
+---
+A: true
+B:
+  foo:
+---
+- [remove, [B, foo]]

test/testdata/input/remove_nested_key_with_trailing_comma.test

@@ -0,0 +1,7 @@
+REMOVE NESTED KEY FROM MAP WITH TRAILING COMMA
+---
+A: true
+B:
+  bar: false # remove this comment
+---
+- [remove, [B, bar]]

test/testdata/output/issue_55.golden

@@ -0,0 +1,15 @@
+name: sample
+version: 0.1.0
+environment:
+  sdk: ^3.0.0
+dependencies:
+dev_dependencies:
+  retry:
+---
+name: sample
+version: 0.1.0
+environment:
+  sdk: ^3.0.0
+dependencies:
+dev_dependencies:
+  {}

test/testdata/output/remove_key.golden

@@ -0,0 +1,4 @@
+foo: true
+bar: false
+---
+foo: true

test/testdata/output/remove_key_with_trailing_comma.golden

@@ -0,0 +1,4 @@
+foo: true
+bar: false # remove this comment
+---
+foo: true

test/testdata/output/remove_nested_key.golden

@@ -0,0 +1,12 @@
+A: true
+B:
+  foo: true
+  bar: true
+---
+A: true
+B:
+  bar: true
+---
+A: true
+B:
+  {}

test/testdata/output/remove_nested_key_with_null.golden

@@ -0,0 +1,7 @@
+A: true
+B:
+  foo:
+---
+A: true
+B:
+  {}

test/testdata/output/remove_nested_key_with_trailing_comma.golden

@@ -0,0 +1,7 @@
+A: true
+B:
+  bar: false # remove this comment
+---
+A: true
+B:
+  {}