mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-01 15:49:11 -05:00
85 lines
2.6 KiB
Go
85 lines
2.6 KiB
Go
// Copyright 2017 The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
// Package fmt provides template functions for formatting strings.
|
|
package fmt
|
|
|
|
import (
|
|
_fmt "fmt"
|
|
|
|
"github.com/gohugoio/hugo/common/loggers"
|
|
|
|
"github.com/gohugoio/hugo/deps"
|
|
"github.com/gohugoio/hugo/helpers"
|
|
)
|
|
|
|
// New returns a new instance of the fmt-namespaced template functions.
|
|
func New(d *deps.Deps) *Namespace {
|
|
ignorableLogger, ok := d.Log.(loggers.IgnorableLogger)
|
|
if !ok {
|
|
ignorableLogger = loggers.NewIgnorableLogger(d.Log)
|
|
}
|
|
|
|
distinctLogger := helpers.NewDistinctLogger(d.Log)
|
|
ns := &Namespace{
|
|
distinctLogger: ignorableLogger.Apply(distinctLogger),
|
|
}
|
|
|
|
d.BuildStartListeners.Add(func() {
|
|
ns.distinctLogger.Reset()
|
|
})
|
|
|
|
return ns
|
|
}
|
|
|
|
// Namespace provides template functions for the "fmt" namespace.
|
|
type Namespace struct {
|
|
distinctLogger loggers.IgnorableLogger
|
|
}
|
|
|
|
// Print returns string representation of the passed arguments.
|
|
func (ns *Namespace) Print(a ...any) string {
|
|
return _fmt.Sprint(a...)
|
|
}
|
|
|
|
// Printf returns a formatted string representation of the passed arguments.
|
|
func (ns *Namespace) Printf(format string, a ...any) string {
|
|
return _fmt.Sprintf(format, a...)
|
|
}
|
|
|
|
// Println returns string representation of the passed arguments ending with a newline.
|
|
func (ns *Namespace) Println(a ...any) string {
|
|
return _fmt.Sprintln(a...)
|
|
}
|
|
|
|
// Errorf formats according to a format specifier and logs an ERROR.
|
|
// It returns an empty string.
|
|
func (ns *Namespace) Errorf(format string, a ...any) string {
|
|
ns.distinctLogger.Errorf(format, a...)
|
|
return ""
|
|
}
|
|
|
|
// Erroridf formats according to a format specifier and logs an ERROR and
|
|
// an information text that the error with the given ID can be suppressed in config.
|
|
// It returns an empty string.
|
|
func (ns *Namespace) Erroridf(id, format string, a ...any) string {
|
|
ns.distinctLogger.Errorsf(id, format, a...)
|
|
return ""
|
|
}
|
|
|
|
// Warnf formats according to a format specifier and logs a WARNING.
|
|
// It returns an empty string.
|
|
func (ns *Namespace) Warnf(format string, a ...any) string {
|
|
ns.distinctLogger.Warnf(format, a...)
|
|
return ""
|
|
}
|