String value is escaped in an unwanted way

[Schwusch]

When updating a string value with forward slashes, the resulting string escapes the forward slashes unnecessarily:

final doc = YamlEditor('exampleKey: \${file(../../bar.yml)}');

doc.update(['exampleKey'], '\${file(../../foo.yml)}');

print(doc);
// exampleKey: ${file(..\/..\/bar.yml)}

My current workaround is to modify the resulting string:

doc.toString().replaceAll('\\/', '/')

It would be nice to customize that behaviour.

[jonasfj]

// exampleKey: ${file(..\/..\/bar.yml)}

Are you sure it's not double quoting it, as:
// exampleKey: "${file(..\/..\/bar.yml)}"

---

On topic, I'm guessing we could make the strings prettier. Contributions are welcome, but I think it would be best to have:

• Lots of test cases, and,
• Source code comments arguing why not escaping certain sequences is always safe.

[Schwusch]

Are you sure it's not double quoting it, as:
// exampleKey: "${file(../../bar.yml)}"

Oh yeah, that's right. When skipping the { and } characters, everything worked as expected during experimentation, with no double quotes or escaping:

doc.update(['exampleKey'], '\$file(../../foo.yml)');
print(doc);
// exampleKey: $file(../../foo.yml)

So curly braces makes this function return true:

yaml_edit/lib/src/utils.dart

Line 15 in 4fadb43

bool isDangerousString(String string) {

and then that triggers escaping all code units in this map:

yaml_edit/lib/src/strings.dart

Line 286 in 4fadb43

final Map<int, String> doubleQuoteEscapeChars = {

But the forward slashes, in itself, does not trigger any character escaping.

I can make a PR if there is a consensus on the solution. Personally, I'd like to pass a parameter to skip all checks for dangerous strings and skip all character replacing somehow.