Use cases for warnf and errorf

steppa · December 13, 2022, 12:34am

I am trying to find out some use cases of both that I can include in my templates.

jmooring · December 13, 2022, 12:37am

https://discourse.gohugo.io/t/making-error-message-clearer/41845/2

steppa · December 13, 2022, 12:46am

What I meant is a larger perspective outside markdown. I haven’t seen much discussion around both. But I just found these topics with more insights.
https://kodify.net/hugo/functions/hugo-errorf-function/

regis · December 13, 2022, 4:10am

It makes a lot of sense to use warning in a module context in order to alert users about a misuse, or missing parameter etc… without necessarily breaking the build.

divinerites · December 13, 2022, 7:25am

github.com

divinerites/plausible-hugo/blob/master/layouts/partials/plausible_check.html

<!-- Version v1.0.0 relics -->
{{- if isset site.Params.plausible "analytics" }}
   {{- $_text := "plausible-hugo module : Upgrade your config.toml; You have trace of v1.0.0 in [params.plausible.analytics] : %s" }}
   {{- errorf $_text site.Params.plausible.analytics }}
{{- end }}
<!-- Version > v1.1.0 check -->
{{- if not (isset site.Params.plausible "domain") }}
   {{- $_text := "plausible-hugo module : Upgrade your config.toml; You need [params.plausible.domain] : %s" }}
   {{- errorf $_text "your-plausible-domain-id" }}
{{- end }}
<!-- Check deprecated custom_js_domain > v2.0.0 -->
{{- if isset site.Params.plausible "custom_js_domain" }}
   {{- $_text := "plausible-hugo module : `custom_js_domain` %s is now deprecated. Use `proxy_netlify` instead and follow instruction for easy setup." }}
   {{- warnf $_text site.Params.plausible.custom_js_domain }}
{{- end }}

<!-- Write console hint about leaving a star for this module on GitHub -->
{{- if or ( site.Params.plausible.gitstar ) (not (isset site.Params.plausible "gitstar")) }}
{{- if eq site.Language site.Sites.First.Language }}
   <!-- Write information IN CONSOLE about the plugin -->

This file has been truncated. show original

steppa · December 13, 2022, 1:41pm

Thank you all. I have ideas now how to go about it.

system · December 15, 2022, 1:42pm

This topic was automatically closed 2 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
Can I generate a warning instead of an error? support	3	395	December 18, 2019
Warning that does not stop build? support	1	285	June 22, 2019
Would we accept a PR for an infof template function? dev	9	730	November 16, 2021
More user friendly error reporting dev	6	920	March 5, 2018
Hugo server with traceroute support	2	385	May 12, 2019

Use cases for warnf and errorf

Related Topics