From fe2699dd8757d052541c9dd5954aea60987cfbf2 Mon Sep 17 00:00:00 2001 From: Jonas Finnemann Jensen Date: Thu, 2 May 2024 15:42:46 +0200 Subject: [PATCH] Fix 55 (#75) Fix removal of last key from map in block-mode when value is empty. Fixes #55. When the value is empty the `SourceSpan` for the `YamlNode` representing the value in a map points to the colon. Example: ```yaml foo: bar: ``` The `YamlNode` for `foo.bar` has a value of `null` and starts and ends at the colon `:` following `bar`. This means that removal might leave the colon behind, which causes invalid YAML. We have the same issue when removing `foo.bar` from the following YAML document: ```yaml foo: baz: true bar: ``` However, in this case, we have a hack that ensures we always strip away the any comments that follows `bar`. We do this by deleting up-to the next newline. If we apply the same hack when removing `foo.bar` in the first example, then it works. One could argue that it works by accident, but it's kind of desired that trailing comments are removed, when the value they are trailing is removed. --- CHANGELOG.md | 4 +++- lib/src/map_mutations.dart | 19 +++++++++++++++---- pubspec.yaml | 2 +- test/testdata/input/issue_55.test | 11 +++++++++++ test/testdata/input/remove_key.test | 6 ++++++ .../input/remove_key_with_trailing_comma.test | 6 ++++++ test/testdata/input/remove_nested_key.test | 9 +++++++++ .../input/remove_nested_key_with_null.test | 7 +++++++ ...remove_nested_key_with_trailing_comma.test | 7 +++++++ test/testdata/output/issue_55.golden | 15 +++++++++++++++ test/testdata/output/remove_key.golden | 4 ++++ .../remove_key_with_trailing_comma.golden | 4 ++++ test/testdata/output/remove_nested_key.golden | 12 ++++++++++++ .../output/remove_nested_key_with_null.golden | 7 +++++++ ...move_nested_key_with_trailing_comma.golden | 7 +++++++ 15 files changed, 114 insertions(+), 6 deletions(-) create mode 100644 test/testdata/input/issue_55.test create mode 100644 test/testdata/input/remove_key.test create mode 100644 test/testdata/input/remove_key_with_trailing_comma.test create mode 100644 test/testdata/input/remove_nested_key.test create mode 100644 test/testdata/input/remove_nested_key_with_null.test create mode 100644 test/testdata/input/remove_nested_key_with_trailing_comma.test create mode 100644 test/testdata/output/issue_55.golden create mode 100644 test/testdata/output/remove_key.golden create mode 100644 test/testdata/output/remove_key_with_trailing_comma.golden create mode 100644 test/testdata/output/remove_nested_key.golden create mode 100644 test/testdata/output/remove_nested_key_with_null.golden create mode 100644 test/testdata/output/remove_nested_key_with_trailing_comma.golden diff --git a/CHANGELOG.md b/CHANGELOG.md index 9472abf..422afe1 100644 --- a/CHANGELOG.md +++ b/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 diff --git a/lib/src/map_mutations.dart b/lib/src/map_mutations.dart index 321987f..07a2c54 100644 --- a/lib/src/map_mutations.dart +++ b/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; } } diff --git a/pubspec.yaml b/pubspec.yaml index 272da40..e9b1654 100644 --- a/pubspec.yaml +++ b/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 diff --git a/test/testdata/input/issue_55.test b/test/testdata/input/issue_55.test new file mode 100644 index 0000000..ff1ac90 --- /dev/null +++ b/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']] diff --git a/test/testdata/input/remove_key.test b/test/testdata/input/remove_key.test new file mode 100644 index 0000000..b28818c --- /dev/null +++ b/test/testdata/input/remove_key.test @@ -0,0 +1,6 @@ +REMOVE KEY FROM MAP +--- +foo: true +bar: false +--- +- [remove, [bar]] diff --git a/test/testdata/input/remove_key_with_trailing_comma.test b/test/testdata/input/remove_key_with_trailing_comma.test new file mode 100644 index 0000000..ce67551 --- /dev/null +++ b/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]] diff --git a/test/testdata/input/remove_nested_key.test b/test/testdata/input/remove_nested_key.test new file mode 100644 index 0000000..201caca --- /dev/null +++ b/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]] diff --git a/test/testdata/input/remove_nested_key_with_null.test b/test/testdata/input/remove_nested_key_with_null.test new file mode 100644 index 0000000..2a66559 --- /dev/null +++ b/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]] diff --git a/test/testdata/input/remove_nested_key_with_trailing_comma.test b/test/testdata/input/remove_nested_key_with_trailing_comma.test new file mode 100644 index 0000000..35ad665 --- /dev/null +++ b/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]] diff --git a/test/testdata/output/issue_55.golden b/test/testdata/output/issue_55.golden new file mode 100644 index 0000000..f752a14 --- /dev/null +++ b/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: + {} diff --git a/test/testdata/output/remove_key.golden b/test/testdata/output/remove_key.golden new file mode 100644 index 0000000..48b8640 --- /dev/null +++ b/test/testdata/output/remove_key.golden @@ -0,0 +1,4 @@ +foo: true +bar: false +--- +foo: true diff --git a/test/testdata/output/remove_key_with_trailing_comma.golden b/test/testdata/output/remove_key_with_trailing_comma.golden new file mode 100644 index 0000000..d85be35 --- /dev/null +++ b/test/testdata/output/remove_key_with_trailing_comma.golden @@ -0,0 +1,4 @@ +foo: true +bar: false # remove this comment +--- +foo: true diff --git a/test/testdata/output/remove_nested_key.golden b/test/testdata/output/remove_nested_key.golden new file mode 100644 index 0000000..011f1c1 --- /dev/null +++ b/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: + {} diff --git a/test/testdata/output/remove_nested_key_with_null.golden b/test/testdata/output/remove_nested_key_with_null.golden new file mode 100644 index 0000000..b0e771c --- /dev/null +++ b/test/testdata/output/remove_nested_key_with_null.golden @@ -0,0 +1,7 @@ +A: true +B: + foo: +--- +A: true +B: + {} diff --git a/test/testdata/output/remove_nested_key_with_trailing_comma.golden b/test/testdata/output/remove_nested_key_with_trailing_comma.golden new file mode 100644 index 0000000..c93c46a --- /dev/null +++ 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: + {}