Using Vale with Hugo - configuration not loading

[techxplorer]

Hi everyone,

I'm using Vale as part of the tool chain for a new website project using Hugo. I believe I have enabled the Hugo package, my .vale.ini file looks like this:

StylesPath = "ci/vale/styles"

MinAlertLevel = suggestion

Packages = alex, proselint, Hugo, techxplorer

Vocab = techxplorer

[*.{md,txt}]
BasedOnStyles = Vale, alex, proselint, techxplorer

Vale.Spelling = NO

I've added my own custom package to enable an Australian dictionary. All is working well except text in Hugo shortcodes is being processed by Vale. For example if I call the shortcode like this:

{{% unsplash name="xxx" href="xxx" %}}

I get the following error from Vale

error Use 'Unsplash' instead of 'unsplash' Vale.Terms

Any thoughts on what I am doing wrong are greatly appreciated.

[jdkato]

What is the output of vale ls-config?

[techxplorer]

Thanks for such a prompt reply. That's a good question, apologies I should have included that in my question. The output is below:

{
  "BlockIgnores": {
    "*.md": [
      "(?sm)^({{[%\u003c] [^{]*? [%\u003e]}})\\n$",
      "(?s) *({{\u003c highlight [^\u003e]* ?\u003e}}.*?{{\u003c ?/ ?highlight \u003e}})",
      "({{[%\u003c] .+ [%\u003e]}})"
    ]
  },
  "Checks": [
    "Vale.Spelling",
    "Vale.Spelling"
  ],
  "Formats": {},
  "Asciidoctor": {},
  "FormatToLang": {},
  "GBaseStyles": null,
  "GChecks": {},
  "IgnoredClasses": null,
  "IgnoredScopes": null,
  "MinAlertLevel": 0,
  "Vocab": [
    "techxplorer"
  ],
  "RuleToLevel": {},
  "SBaseStyles": {
    "*.{md,txt}": [
      "Vale",
      "alex",
      "proselint",
      "techxplorer"
    ]
  },
  "SChecks": {
    "*.md": {},
    "*.{md,txt}": {
      "Vale.Spelling": false
    }
  },
  "SkippedScopes": null,
  "Stylesheets": {},
  "TokenIgnores": {
    "*.md": [
      "({{[%\u003c] .* [%\u003e]}}.*?{{[%\u003c] ?/.* [%\u003e]}})",
      "(\\[.+\\]\\({{\u003c .+ \u003e}}\\))",
      "({{[%\u003c] .+ [%\u003e]}})"
    ]
  },
  "WordTemplate": "",
  "RootINI": "/Users/techxplorer/websites/project/.vale.ini",
  "Paths": [
    "/Users/techxplorer/Library/Application Support/vale/styles",
    "/Users/techxplorer/websites/project/ci/vale/styles"
  ],
  "ConfigFiles": [
    "/Users/techxplorer/websites/project/.vale.ini"
  ],
  "NLPEndpoint": ""
}

I've installed Vale version 3.2.2 on my Mac using Homebrew.

[jdkato]

It looks like everything should be working, and I'm not able to reproduce the issue. Could you share a file (or a section of a file) that exhibits the behavior?

[techxplorer]

I had some more time to explore today, and I think I have an explanation.

This is a valid shortcode and Vale ignores the content inside it:

{{% unsplash name="xxx" href="xxx" %}}

In contrast, this is also a valid short code and Vale checks the content inside it.

{{% unsplash 
  name="xxx" 
  href="xxx" 
%}}

I believe that the Hugo package only works with shortcodes that are on a single line.

Apologies for the confusion, in creating the original post I created an example that worked.

For this shortcode I prefer to use multiple lines. As the name suggests it's a shortcode to make it easier to provide credit for unsplash images, and the URLs can be quite long.

Could the Hugo package be updated to support shortcodes that span multiple lines?

[jdkato]

I've created an issue here: errata-ai/Hugo#3. I'll update that when I get a chance.

[jdkato]

This should be fixed now.

[techxplorer]

Hi @jdkato,

Thanks for working on this, apologies for taking so long to reply.

I can confirm that it nearly works for me.

My editing environment is set to remove trailing whitespace from lines.

If the multiline shortcode starts like this it works:

{{% unsplash

If the multiline shortcode starts like this, it fails:

{{% unsplash

I'm not familiar enough with regular expressions to tell what needs to be changed. Is there any way it could be updated to support multiline shortcodes when trailing whitespace is removed?