mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
f21e2f25c9
All config variables starts with low-case and uses camelCase. If there is abbreviation at the beginning of the name, the whole abbreviation will be written in low-case. If there is abbreviation at the end of the name, the whole abbreviation will be written in upper-case. For example, rssURI.
75 lines
2.6 KiB
Go
75 lines
2.6 KiB
Go
// Copyright 2016-present 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 helpers implements general utility functions that work with
|
|
// and on content. The helper functions defined here lay down the
|
|
// foundation of how Hugo works with files and filepaths, and perform
|
|
// string operations on content.
|
|
package helpers
|
|
|
|
import (
|
|
"github.com/spf13/viper"
|
|
)
|
|
|
|
// A cached version of the current ConfigProvider (language) and relatives. These globals
|
|
// are unfortunate, but we still have some places that needs this that does
|
|
// not have access to the site configuration.
|
|
// These values will be set on initialization when rendering a new language.
|
|
//
|
|
// TODO(bep) Get rid of these.
|
|
var (
|
|
currentConfigProvider ConfigProvider
|
|
currentPathSpec *PathSpec
|
|
)
|
|
|
|
// ConfigProvider provides the configuration settings for Hugo.
|
|
type ConfigProvider interface {
|
|
GetString(key string) string
|
|
GetInt(key string) int
|
|
GetBool(key string) bool
|
|
GetStringMap(key string) map[string]interface{}
|
|
GetStringMapString(key string) map[string]string
|
|
Get(key string) interface{}
|
|
}
|
|
|
|
// Config returns the currently active Hugo config. This will be set
|
|
// per site (language) rendered.
|
|
func Config() ConfigProvider {
|
|
if currentConfigProvider != nil {
|
|
return currentConfigProvider
|
|
}
|
|
// Some tests rely on this. We will fix that, eventually.
|
|
return viper.Get("currentContentLanguage").(ConfigProvider)
|
|
}
|
|
|
|
// CurrentPathSpec returns the current PathSpec.
|
|
// If it is not set, a new will be created based in the currently active Hugo config.
|
|
func CurrentPathSpec() *PathSpec {
|
|
if currentPathSpec != nil {
|
|
return currentPathSpec
|
|
}
|
|
// Some tests rely on this. We will fix that, eventually.
|
|
return NewPathSpecFromConfig(Config())
|
|
}
|
|
|
|
// InitConfigProviderForCurrentContentLanguage does what it says.
|
|
func InitConfigProviderForCurrentContentLanguage() {
|
|
currentConfigProvider = viper.Get("CurrentContentLanguage").(ConfigProvider)
|
|
currentPathSpec = NewPathSpecFromConfig(currentConfigProvider)
|
|
}
|
|
|
|
// ResetConfigProvider is used in tests.
|
|
func ResetConfigProvider() {
|
|
currentConfigProvider = nil
|
|
currentPathSpec = nil
|
|
}
|