hugo/tpl/time/init.go

96 lines
2.3 KiB
Go
Raw Normal View History

// 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 (
"errors"
"github.com/gohugoio/hugo/deps"
2021-07-26 16:28:57 +00:00
"github.com/gohugoio/hugo/langs"
"github.com/gohugoio/hugo/tpl/internal"
)
const name = "time"
func init() {
f := func(d *deps.Deps) *internal.TemplateFuncsNamespace {
2021-07-26 16:28:57 +00:00
if d.Language == nil {
panic("Language must be set")
}
ctx := New(langs.GetTimeFormatter(d.Language), langs.GetLocation(d.Language))
ns := &internal.TemplateFuncsNamespace{
Name: name,
Context: func(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{},
)
2017-05-20 08:41:43 +00:00
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)
}