Add quotes by default to yaml dumps

Author: epwalsh

lua/obsidian/yaml.lua

@@ -6,22 +6,14 @@ local yaml = {}
 ---Deserialize a YAML string.
 yaml.loads = _yaml.eval
 
-local should_quote = function(s)
-  local found = string.find(s, [[']], 1, true)
-  return found ~= nil
-end
-
 ---@return string[]
 local dumps
 dumps = function(x, indent, order)
   local indent_str = string.rep(" ", indent)
 
   if type(x) == "string" then
-    if should_quote(x) then
-      return { indent_str .. [["]] .. x .. [["]] }
-    else
-      return { indent_str .. x }
-    end
+    -- TODO: handle double quotes in x
+    return { indent_str .. [["]] .. x .. [["]] }
   end
 
   if type(x) == "boolean" then
@@ -82,7 +74,7 @@ end
 
 ---Dump an object to a YAML string.
 ---@param x any
----@param order function
+---@param order function|?
 ---@return string
 yaml.dumps = function(x, order)
   return table.concat(dumps(x, 0, order), "\n")

test/obsidian/note_spec.lua

@@ -70,11 +70,11 @@ describe("Note", function()
       table.concat(note:frontmatter_lines(), "\n"),
       table.concat({
         "---",
-        "id: note_with_additional_metadata",
+        'id: "note_with_additional_metadata"',
         "aliases:",
-        "  - Note with additional metadata",
+        '  - "Note with additional metadata"',
         "tags: []",
-        "foo: bar",
+        'foo: "bar"',
         "---",
       }, "\n")
     )

test/obsidian/yaml_spec.lua

@@ -5,18 +5,18 @@ describe("obsidian.yaml", function()
     assert.equals(yaml.dumps(1), "1")
   end)
   it("should dump strings", function()
-    assert.equals(yaml.dumps "hi there", "hi there")
+    assert.equals(yaml.dumps "hi there", '"hi there"')
     assert.equals(yaml.dumps "hi it's me", [["hi it's me"]])
-    assert.equals(yaml.dumps { foo = "bar" }, [[foo: bar]])
+    assert.equals(yaml.dumps { foo = "bar" }, [[foo: "bar"]])
   end)
   it("should dump strings with single quote", function()
     assert.equals(yaml.dumps "hi it's me", [["hi it's me"]])
   end)
   it("should dump table with string values", function()
-    assert.equals(yaml.dumps { foo = "bar" }, [[foo: bar]])
+    assert.equals(yaml.dumps { foo = "bar" }, [[foo: "bar"]])
   end)
   it("should dump arrays with string values", function()
-    assert.equals(yaml.dumps { "foo", "bar" }, "- foo\n- bar")
+    assert.equals(yaml.dumps { "foo", "bar" }, '- "foo"\n- "bar"')
   end)
   it("should dump arrays with number values", function()
     assert.equals(yaml.dumps { 1, 2 }, "- 1\n- 2")
@@ -25,13 +25,13 @@ describe("obsidian.yaml", function()
     assert.equals(yaml.dumps { { a = 1 }, { b = 2 } }, "- a: 1\n- b: 2")
   end)
   it("should dump tables with string values", function()
-    assert.equals(yaml.dumps { a = "foo", b = "bar" }, "a: foo\nb: bar")
+    assert.equals(yaml.dumps { a = "foo", b = "bar" }, 'a: "foo"\nb: "bar"')
   end)
   it("should dump tables with number values", function()
     assert.equals(yaml.dumps { a = 1, b = 2 }, "a: 1\nb: 2")
   end)
   it("should dump tables with array values", function()
-    assert.equals(yaml.dumps { a = { "foo" }, b = { "bar" } }, "a:\n  - foo\nb:\n  - bar")
+    assert.equals(yaml.dumps { a = { "foo" }, b = { "bar" } }, 'a:\n  - "foo"\nb:\n  - "bar"')
   end)
   it("should dump tables with empty array", function()
     assert.equals(yaml.dumps { a = {} }, "a: []")

test_fixtures/notes/foo_bar.md

@@ -1,9 +1,9 @@
 ---
-id: foo
+id: "foo"
 aliases:
-  - foo
-  - Foo
-  - Foo Bar
+  - "foo"
+  - "Foo"
+  - "Foo Bar"
 tags: []
 ---
 

test_fixtures/notes/note_with_additional_metadata_saved.md

@@ -1,9 +1,9 @@
 ---
-id: note_with_additional_metadata
+id: "note_with_additional_metadata"
 aliases:
-  - Note with additional metadata
+  - "Note with additional metadata"
 tags: []
-foo: bar
+foo: "bar"
 ---
 
 # Note with additional metadata

test_fixtures/notes/note_without_frontmatter_saved.md

@@ -1,7 +1,7 @@
 ---
-id: test_fixtures/notes/note_without_frontmatter.md
+id: "test_fixtures/notes/note_without_frontmatter.md"
 aliases:
-  - Hey there
+  - "Hey there"
 tags: []
 ---