Don't add space on the left of ":" in YAML front-matter

foo: "bar" Above form is more conventional than: foo : "bar" Fixes https://github.com/kaushalmodi/ox-hugo/issues/120
8 years ago · dd751cd054
parent c1b355c3eb
commit dd751cd054
12 changed files with 105 additions and 105 deletions
--- a/ox-hugo.el
+++ b/ox-hugo.el
@ -2473,8 +2473,8 @@ are \"toml\" and \"yaml\"."
  (let ((sep (cond ((string= format "toml") "+++\n")
                   ((string= format "yaml") "---\n")
                   (t "")))
-        (sign (cond ((string= format "toml") "=")
-                    ((string= format "yaml") ":")
+        (sign (cond ((string= format "toml") " =") ;Conventional to have space on the left side of "=" in TOML
+                    ((string= format "yaml") ":")  ;Conventional to have no space on the left side of ":" in YAML
                    (t "")))
        (front-matter "")
        (indent (make-string 2 ? ))
@ -2527,7 +2527,7 @@ are \"toml\" and \"yaml\"."
                                              (format "[menu.%s]\n" menu-entry))
                                             ((string= format "yaml")
                                              (prog1
-                                                  (format "menu %s\n%s%s%s\n"
+                                                  (format "menu%s\n%s%s%s\n"
                                                          sign indent menu-entry sign)
                                                (setq indent (concat indent indent)))) ;Double the indent for next use
                                             (t
@ -2550,7 +2550,7 @@ are \"toml\" and \"yaml\"."
                          (setq menu-value (org-hugo--quote-string menu-value))
                          (setq menu-value-str
                                (concat menu-value-str
-                                        (format "%s%s %s %s\n"
+                                        (format "%s%s%s %s\n"
                                                indent menu-key sign menu-value)))))))
                  (setq menu-string (concat menu-entry-str menu-value-str))))))
           ((string= key "blackfriday")
@ -2561,7 +2561,7 @@ are \"toml\" and \"yaml\"."
                (setq bf-entry-str (cond ((string= format "toml")
                                          "[blackfriday]\n")
                                         ((string= format "yaml")
-                                          (format "blackfriday %s\n" sign))
+                                          (format "blackfriday%s\n" sign))
                                         (t
                                          "")))
                (dolist (bf-pair bf-alist)
@ -2580,7 +2580,7 @@ are \"toml\" and \"yaml\"."
                    ;; (message "blackfriday DBG: %S %S" bf-key bf-value)
                    (setq bf-value-str
                          (concat bf-value-str
-                                  (format "%s%s %s %s\n" indent bf-key sign bf-value)))))
+                                  (format "%s%s%s %s\n" indent bf-key sign bf-value)))))
                (setq bf-string (concat bf-entry-str bf-value-str)))))
           ((string= key "resources")
            (when value
@ -2597,7 +2597,7 @@ are \"toml\" and \"yaml\"."
                                             ;; only once.
                                             (if (org-string-nw-p res-string)
                                                 ""
-                                               (format "resources %s\n" sign)))
+                                               (format "resources%s\n" sign)))
                                            (t
                                             "")))
                  (dolist (res-pair res-alist)
@ -2610,7 +2610,7 @@ are \"toml\" and \"yaml\"."
                             (setq res-param-str (cond ((string= format "toml")
                                                        (format "  [resources.%s]\n" res-key))
                                                       ((string= format "yaml")
-                                                        (format "  %s %s\n" res-key sign))
+                                                        (format "  %s%s\n" res-key sign))
                                                       (t
                                                        "")))
                             (dolist (param-pair res-value) ;res-value would be an alist of params
@ -2624,7 +2624,7 @@ are \"toml\" and \"yaml\"."
                                                         (org-hugo--quote-string param-value)))
                                 (setq res-param-str
                                       (concat res-param-str
-                                               (format "%s%s %s %s\n"
+                                               (format "%s%s%s %s\n"
                                                       indent param-key sign param-value-str)))))
                             ;; (message "[resources params DBG] %s" res-param-str)
                             )
@ -2638,7 +2638,7 @@ are \"toml\" and \"yaml\"."
                             (setq res-value (org-hugo--quote-string res-value))
                             (setq res-value-str
                                   (concat res-value-str
-                                           (format "%s%s %s %s\n"
+                                           (format "%s%s%s %s\n"
                                                   indent res-key sign res-value)))))))
                  (unless res-src-present
                    (user-error "`src' must be set for the `resources'"))
@ -2646,7 +2646,7 @@ are \"toml\" and \"yaml\"."
           (t
            (setq front-matter
                  (concat front-matter
-                          (format "%s %s %s\n"
+                          (format "%s%s %s\n"
                                  key
                                  sign
                                  (cond (;; Tags, categories, keywords, aliases,
--- a/test/site/content/posts/blackfriday-ext-enabling-disabling-yaml.md
+++ b/test/site/content/posts/blackfriday-ext-enabling-disabling-yaml.md
@ -1,16 +1,16 @@
 ---
-title : "Enabling/Disabling extensions (YAML)"
-date : 2017-08-02
-tags : ["blackfriday", "yaml"]
-draft : false
-blackfriday :
-  extensionsmask : ["fencedCode", "strikethrough"]
-  extensions : ["tabSizeEight", "hardLineBreak"]
-  plainIDAnchors : false
-  hrefTargetBlank : true
-  smartDashes : false
-  fractions : false
-  angledQuotes : true
+title: "Enabling/Disabling extensions (YAML)"
+date: 2017-08-02
+tags: ["blackfriday", "yaml"]
+draft: false
+blackfriday:
+  extensionsmask: ["fencedCode", "strikethrough"]
+  extensions: ["tabSizeEight", "hardLineBreak"]
+  plainIDAnchors: false
+  hrefTargetBlank: true
+  smartDashes: false
+  fractions: false
+  angledQuotes: true
 ---

 Extensions enabled
--- a/test/site/content/posts/blackfriday-ext-hardlinebreak-wrong-case-toml.md
+++ b/test/site/content/posts/blackfriday-ext-hardlinebreak-wrong-case-toml.md
@ -1,10 +1,10 @@
 ---
-title : "Hard line break (YAML)"
-date : 2017-08-02
-tags : ["blackfriday", "yaml"]
-draft : false
-blackfriday :
-  extensions : ["hardLineBreak"]
+title: "Hard line break (YAML)"
+date: 2017-08-02
+tags: ["blackfriday", "yaml"]
+draft: false
+blackfriday:
+  extensions: ["hardLineBreak"]
 ---

 a
--- a/test/site/content/posts/custom-front-matter-with-list-values-yaml.md
+++ b/test/site/content/posts/custom-front-matter-with-list-values-yaml.md
@ -1,12 +1,12 @@
 ---
-title : "Custom front matter with list values in YAML"
-tags : ["custom-fm", "list-values"]
-draft : false
-animals : ["dog", "cat", "penguin", "mountain gorilla"]
-strings-symbols : ["abc", "def", "two words"]
-integers : [123, -5, 17, 1_234]
-floats : [12.3, -5.0, -1.7e-05]
-booleans : [true, false]
+title: "Custom front matter with list values in YAML"
+tags: ["custom-fm", "list-values"]
+draft: false
+animals: ["dog", "cat", "penguin", "mountain gorilla"]
+strings-symbols: ["abc", "def", "two words"]
+integers: [123, -5, 17, 1_234]
+floats: [12.3, -5.0, -1.7e-05]
+booleans: [true, false]
 ---

 [Issue # 99](https://github.com/kaushalmodi/ox-hugo/issues/99)
--- a/test/site/content/posts/description-multi-line-org-special-block-yaml.md
+++ b/test/site/content/posts/description-multi-line-org-special-block-yaml.md
@ -1,13 +1,13 @@
 ---
-title : "Multi-line description set using Org Special Block (YAML)"
-description : >
+title: "Multi-line description set using Org Special Block (YAML)"
+description: >
  Short description
  of this post


  **bold** -- _italics_ --- ~~strikethrough~~
-tags : ["front-matter", "description", "special-block", "yaml", "multi-line"]
-draft : false
+tags: ["front-matter", "description", "special-block", "yaml", "multi-line"]
+draft: false
 ---

 Post content.
--- a/test/site/content/posts/description-single-line-org-special-block-yaml.md
+++ b/test/site/content/posts/description-single-line-org-special-block-yaml.md
@ -1,8 +1,8 @@
 ---
-title : "Single-line description set using Org Special Block (YAML)"
-description : "Short description"
-tags : ["front-matter", "description", "special-block", "yaml", "single-line"]
-draft : false
+title: "Single-line description set using Org Special Block (YAML)"
+description: "Short description"
+tags: ["front-matter", "description", "special-block", "yaml", "single-line"]
+draft: false
 ---

 Post content.
--- a/test/site/content/posts/menu-meta-data-yaml.md
+++ b/test/site/content/posts/menu-meta-data-yaml.md
@ -1,13 +1,13 @@
 ---
-title : "Menu Meta Data in YAML Front Matter"
-date : 2017-07-18
-tags : ["menu", "yaml"]
-draft : false
-menu :
+title: "Menu Meta Data in YAML Front Matter"
+date: 2017-07-18
+tags: ["menu", "yaml"]
+draft: false
+menu:
  main:
-    identifier : "yaml-menu-override"
-    weight : 25
-    parent : "posts"
+    identifier: "yaml-menu-override"
+    weight: 25
+    parent: "posts"
 ---

 Testing the addition of _menu_ meta data to the YAML front
--- a/test/site/content/posts/menu-meta-data-yaml2.md
+++ b/test/site/content/posts/menu-meta-data-yaml2.md
@ -1,12 +1,12 @@
 ---
-title : "White space in menu entry"
-date : 2017-07-19
-tags : ["menu", "yaml"]
-draft : false
-menu :
+title: "White space in menu entry"
+date: 2017-07-19
+tags: ["menu", "yaml"]
+draft: false
+menu:
  "something here":
-    identifier : "white-space-in-menu-entry"
-    weight : 25
+    identifier: "white-space-in-menu-entry"
+    weight: 25
 ---

 Testing the addition of _menu_ meta data to the YAML front matter.
--- a/test/site/content/posts/menu-meta-data-yaml3.md
+++ b/test/site/content/posts/menu-meta-data-yaml3.md
@ -1,14 +1,14 @@
 ---
-title : "White space in menu name"
-date : 2017-07-19
-tags : ["menu", "yaml"]
-draft : false
-menu :
+title: "White space in menu name"
+date: 2017-07-19
+tags: ["menu", "yaml"]
+draft: false
+menu:
  main:
-    identifier : "white-space-in-menu-name"
-    parent : "posts"
-    weight : 25
-    name : "Menu in YAML"
+    identifier: "white-space-in-menu-name"
+    parent: "posts"
+    weight: 25
+    name: "Menu in YAML"
 ---

 Testing the addition of _menu_ meta data to the YAML front matter.
--- a/test/site/content/posts/resources-custom-params-list-values-yaml.md
+++ b/test/site/content/posts/resources-custom-params-list-values-yaml.md
@ -1,14 +1,14 @@
 ---
-title : "Custom resource params with list values"
-tags : ["resources", "yaml"]
-draft : false
-resources :
- src : "*.png"
-  params :
-    booleans : [true, false]
-    integers : [123, -5, 17, 1_234]
-    animals : ["dog", "cat", "penguin", "mountain gorilla"]
-    strings-symbols : ["abc", "def", "two words"]
-    floats : [12.3, -5.0, -1.7e-05]
-    foo : "bar"
+title: "Custom resource params with list values"
+tags: ["resources", "yaml"]
+draft: false
+resources:
+- src: "*.png"
+  params:
+    booleans: [true, false]
+    integers: [123, -5, 17, 1_234]
+    animals: ["dog", "cat", "penguin", "mountain gorilla"]
+    strings-symbols: ["abc", "def", "two words"]
+    floats: [12.3, -5.0, -1.7e-05]
+    foo: "bar"
 ---
--- a/test/site/content/posts/resources-in-front-matter-yaml.md
+++ b/test/site/content/posts/resources-in-front-matter-yaml.md
@ -1,15 +1,15 @@
 ---
-title : "Post with resources in front-matter"
-tags : ["resources", "yaml"]
-draft : false
-resources :
- src : "image-4.png"
-  title : "The Fourth Image"
- src : "*.png"
-  name : "my-cool-image-:counter"
-  title : "The Image #:counter"
-  params :
-    byline : "bep"
- src : "*.jpg"
-  title : "JPEG Image #:counter"
+title: "Post with resources in front-matter"
+tags: ["resources", "yaml"]
+draft: false
+resources:
+- src: "image-4.png"
+  title: "The Fourth Image"
+- src: "*.png"
+  name: "my-cool-image-:counter"
+  title: "The Image #:counter"
+  params:
+    byline: "bep"
+- src: "*.jpg"
+  title: "JPEG Image #:counter"
 ---
--- a/test/site/content/singles/post-yaml.md
+++ b/test/site/content/singles/post-yaml.md
@ -1,16 +1,16 @@
 ---
-title : "Single Post with YAML front matter"
-date : 2017-07-20
-publishDate : 2017-07-22
-expiryDate : 2017-07-23
-tags : ["single", "yaml"]
-categories : ["cat1", "cat2"]
-draft : false
-menu :
+title: "Single Post with YAML front matter"
+date: 2017-07-20
+publishDate: 2017-07-22
+expiryDate: 2017-07-23
+tags: ["single", "yaml"]
+categories: ["cat1", "cat2"]
+draft: false
+menu:
  foo:
-    parent : "main"
-    weight : 10
-    identifier : "single-yaml"
+    parent: "main"
+    weight: 10
+    identifier: "single-yaml"
 ---

 This is a single post. You do not need to set the `EXPORT_FILE_NAME`