Add test and docs for the new `org-hugo-base-dir' variable

Ref: #401
kaushalmodi · May 18, 2021 · 805f18b · 805f18b
1 parent db6adc9
commit 805f18b
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 19 deletions.
diff --git a/doc/ox-hugo-manual.org b/doc/ox-hugo-manual.org
@@ -427,24 +427,28 @@ Spacemacs users can use =ox-hugo= by setting the variable
 :CUSTOM_ID: before-you-export
 :END:
 Before you export check that these properties are set as you need:
-- HUGO_SECTION :: The default Hugo section name for all the posts.  See
-                  [[https://gohugo.io/content-management/sections/][here]] for more information on Hugo sections.  It is
-                  common for this property to be set to =posts= or
-                  =blog=.  The default value is set using
-                  =org-hugo-default-section-directory=. See
-                  {{{doc(hugo-section,,Hugo Section)}}} for details.
 - HUGO_BASE_DIR :: Root directory of the source for the Hugo site. If
-                   this is set to =~/hugo/=, the exported Markdown
-                   files will be saved to
-                   =~/hugo/content/<HUGO_SECTION>/=
-                   directory[fn:section_more].  By default, the
-                   Markdown files reside in a hierarchy under the
-                   =content/= directory in the site root directory
-                   ([[https://gohugo.io/content-management/organization/][ref]]). If you try to export without setting this
-                   property, you will get this error:
+  this is set to =~/hugo/=, the exported Markdown files will be saved
+  to =~/hugo/content/<HUGO_SECTION>/= directory[fn:section_more].  By
+  default, the Markdown files reside in a hierarchy under the
+  =content/= directory in the site root directory ([[https://gohugo.io/content-management/organization/][ref]]).
+
+  If you try to export without setting this property, you will get
+  this error:
   #+begin_example
   user-error: It is mandatory to set the HUGO_BASE_DIR property
+              or the `org-hugo-base-dir' local variable
   #+end_example
+  This property can be set by one of two ways:
+  1. Setting the ~#+hugo_base_dir:~ keyword in the Org file.
+  2. Setting the ~org-hugo-base-dir~ variable in a ~.dir-locals.el~ or
+     File Local Variables.
+
+- HUGO_SECTION :: The default Hugo section name for all the posts.
+  See [[https://gohugo.io/content-management/sections/][here]] for more information on Hugo sections.  It is common for
+  this property to be set to =posts= or =blog=.  The default value is
+  set using =org-hugo-default-section-directory=. See
+  {{{doc(hugo-section,,Hugo Section)}}} for details.
 
 *Important*: If you choose to export an Org subtree as a post, you
  need to set the =EXPORT_FILE_NAME= subtree property. That property is

diff --git a/ox-hugo.el b/ox-hugo.el
@@ -400,9 +400,14 @@ Examples:
 
 (define-obsolete-variable-alias 'org-hugo-default-section-directory 'org-hugo-section "Oct 31, 2018")
 
-(defvar-local org-hugo-base-dir nil
+(defcustom org-hugo-base-dir nil
   "Base directory for Hugo.
-Set either this value, or the HUGO_BASE_DIR global property for export.")
+
+Set either this value, or the HUGO_BASE_DIR global property for
+export."
+  :group 'org-export-hugo
+  :type 'directory)
+;;;###autoload (put 'org-hugo-base-dir 'safe-local-variable 'stringp)
 
 (defcustom org-hugo-section "posts"
   "Default section for Hugo posts.
@@ -1281,7 +1286,7 @@ The publication directory is created if it does not exist.
 INFO is a plist used as a communication channel."
   (let* ((base-dir (if (plist-get info :hugo-base-dir)
                        (file-name-as-directory (plist-get info :hugo-base-dir))
-                     (user-error "It is mandatory to set the HUGO_BASE_DIR property or the org-hugo-base-dir local variable")))
+                     (user-error "It is mandatory to set the HUGO_BASE_DIR property or the `org-hugo-base-dir' local variable")))
          (content-dir "content/")
          (section-path (org-hugo--get-section-path info))
          (bundle-dir (let ((bundle-path (or ;Hugo bundle set in the post subtree gets higher precedence

diff --git a/test/site/content-org/dir-locals/.dir-locals.el b/test/site/content-org/dir-locals/.dir-locals.el
@@ -2,6 +2,7 @@
          (fill-column . 70)
          (sentence-end-double-space . t)))
  (org-mode . ((mode . auto-fill)
+              (org-hugo-base-dir . "../../.")
               (org-hugo-section . "dir-locals-test")
               (org-hugo-front-matter-format . "yaml")
               (org-hugo-footer . "\n\nThis text is auto inserted at the end of the exported Markdown.")

diff --git a/test/site/content-org/dir-locals/dir-locals-test.org b/test/site/content-org/dir-locals/dir-locals-test.org
@@ -1,5 +1,3 @@
-#+hugo_base_dir: ../../.
-
 #+title: .dir-locals.el test
 #+date: <2018-10-31 Wed>
 
@@ -16,6 +14,7 @@ Test setting of few Org Hugo variables via =.dir-locals.el=.
 |----------------------------------------+-------------------------------------------------------------------------|
 | Variable                               | Value                                                                   |
 |----------------------------------------+-------------------------------------------------------------------------|
+| =org-hugo-base-dir=                    | ="../../."=                                                             |
 | =org-hugo-section=                     | ="dir-locals-test"=                                                     |
 | =org-hugo-front-matter-format=         | ="yaml"=                                                                |
 | =org-hugo-footer=                      | ="\n\nThis text is auto inserted at the end of the exported Markdown."= |

diff --git a/test/site/content/dir-locals-test/dir-locals-test.md b/test/site/content/dir-locals-test/dir-locals-test.md
@@ -36,6 +36,7 @@ creator: "Dummy creator string"
 
 | Variable                               | Value                                                                   |
 |----------------------------------------|-------------------------------------------------------------------------|
+| `org-hugo-base-dir`                    | `"../../."`                                                             |
 | `org-hugo-section`                     | `"dir-locals-test"`                                                     |
 | `org-hugo-front-matter-format`         | `"yaml"`                                                                |
 | `org-hugo-footer`                      | `"\n\nThis text is auto inserted at the end of the exported Markdown."` |