From 4dcf38968fc45549df397d06c691ff6f7a04cc17 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?=
<bjorn.erik.pedersen@gmail.com>
Date: Wed, 1 Nov 2023 15:21:21 +0100
Subject: [PATCH] Add a field prefix to the deprecated log statements
To make theme easier to spot, esp. on INFO level.
---
common/hugo/hugo.go | 2 +-
testscripts/commands/deprecate.txt | 14 +++++++-------
2 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/common/hugo/hugo.go b/common/hugo/hugo.go
index f6eb72d8f..dedbc8c98 100644
--- a/common/hugo/hugo.go
+++ b/common/hugo/hugo.go
@@ -369,7 +369,7 @@ func DeprecateLevel(item, alternative, version string, level logg.Level) {
msg = fmt.Sprintf("%s was deprecated in Hugo %s and will be removed in a future release. %s", item, version, alternative)
}
- loggers.Log().Logger().WithLevel(level).Logf(msg)
+ loggers.Log().Logger().WithLevel(level).WithField(loggers.FieldNameCmd, "deprecated").Logf(msg)
}
// We ususally do about one minor version a month.
diff --git a/testscripts/commands/deprecate.txt b/testscripts/commands/deprecate.txt
index b15d7ec84..3be4976d5 100644
--- a/testscripts/commands/deprecate.txt
+++ b/testscripts/commands/deprecate.txt
@@ -1,13 +1,13 @@
+# Test deprecation logging.
+hugo -e info --logLevel info
+stdout 'INFO deprecated: item was deprecated in Hugo'
-hugo -e info --logLevel info
-stdout 'INFO item was deprecated in Hugo'
+hugo -e warn --logLevel warn
+stdout 'WARN deprecated: item was deprecated in Hugo'
-hugo -e warn --logLevel warn
-stdout 'WARN item was deprecated in Hugo'
-
-! hugo -e error --logLevel warn
-stdout 'ERROR item was deprecated in Hugo'
+! hugo -e error --logLevel warn
+stdout 'ERROR deprecated: item was deprecated in Hugo'
-- hugo.toml --
baseURL = "https://example.com/"