mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-13 11:35:54 -05:00
241b21b0fd
Primary motivation is documentation, but it will also hopefully simplify the code. Also, * Lower case the default output format names; this is in line with the custom ones (map keys) and how it's treated all the places. This avoids doing `stringds.EqualFold` everywhere. Closes #10896 Closes #10620
96 lines
2.4 KiB
Go
96 lines
2.4 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 time
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
|
|
"github.com/gohugoio/hugo/deps"
|
|
"github.com/gohugoio/hugo/langs"
|
|
"github.com/gohugoio/hugo/tpl/internal"
|
|
)
|
|
|
|
const name = "time"
|
|
|
|
func init() {
|
|
f := func(d *deps.Deps) *internal.TemplateFuncsNamespace {
|
|
if d.Conf.Language() == nil {
|
|
panic("Language must be set")
|
|
}
|
|
ctx := New(langs.GetTimeFormatter(d.Conf.Language()), langs.GetLocation(d.Conf.Language()))
|
|
|
|
ns := &internal.TemplateFuncsNamespace{
|
|
Name: name,
|
|
Context: func(cctx context.Context, args ...any) (any, error) {
|
|
// Handle overlapping "time" namespace and func.
|
|
//
|
|
// If no args are passed to `time`, assume namespace usage and
|
|
// return namespace context.
|
|
//
|
|
// If args are passed, call AsTime().
|
|
|
|
switch len(args) {
|
|
case 0:
|
|
return ctx, nil
|
|
case 1:
|
|
return ctx.AsTime(args[0])
|
|
case 2:
|
|
return ctx.AsTime(args[0], args[1])
|
|
|
|
// 3 or more arguments. Currently not supported.
|
|
default:
|
|
return nil, errors.New("Invalid arguments supplied to `time`. Refer to time documentation: https://gohugo.io/functions/time/")
|
|
}
|
|
},
|
|
}
|
|
|
|
ns.AddMethodMapping(ctx.Format,
|
|
[]string{"dateFormat"},
|
|
[][2]string{
|
|
{`dateFormat: {{ dateFormat "Monday, Jan 2, 2006" "2015-01-21" }}`, `dateFormat: Wednesday, Jan 21, 2015`},
|
|
},
|
|
)
|
|
|
|
ns.AddMethodMapping(ctx.Now,
|
|
[]string{"now"},
|
|
[][2]string{},
|
|
)
|
|
|
|
ns.AddMethodMapping(ctx.AsTime,
|
|
nil,
|
|
[][2]string{
|
|
{`{{ (time "2015-01-21").Year }}`, `2015`},
|
|
},
|
|
)
|
|
|
|
ns.AddMethodMapping(ctx.Duration,
|
|
[]string{"duration"},
|
|
[][2]string{
|
|
{`{{ mul 60 60 | duration "second" }}`, `1h0m0s`},
|
|
},
|
|
)
|
|
|
|
ns.AddMethodMapping(ctx.ParseDuration,
|
|
nil,
|
|
[][2]string{
|
|
{`{{ "1h12m10s" | time.ParseDuration }}`, `1h12m10s`},
|
|
},
|
|
)
|
|
|
|
return ns
|
|
}
|
|
|
|
internal.AddTemplateFuncsNamespace(f)
|
|
}
|