shithub: hugo

ref: ee5aa84f2a34e2a5d3250e01d54298732d77b51b
dir: /tpl/os/init.go/

View raw version
// 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 os

import (
	"github.com/spf13/hugo/deps"
	"github.com/spf13/hugo/tpl/internal"
)

const name = "os"

func init() {
	f := func(d *deps.Deps) *internal.TemplateFuncsNamespace {
		ctx := New(d)

		examples := [][2]string{
			{`{{ range (readDir ".") }}{{ .Name }}{{ end }}`, `README.txt`},
			{`{{ readFile "README.txt" }}`, `Hugo Rocks!`},
		}

		return &internal.TemplateFuncsNamespace{
			Name:    name,
			Context: func() interface{} { return ctx },
			Aliases: map[string]interface{}{
				"getenv":   ctx.Getenv,
				"readDir":  ctx.ReadDir,
				"readFile": ctx.ReadFile,
			},
			Examples: examples,
		}

	}

	internal.AddTemplateFuncsNamespace(f)
}