mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-29 19:12:09 -05:00
7829474088
This commit adds support for a configuration directory (default `config`). The different pieces in this puzzle are:
* A new `--environment` (or `-e`) flag. This can also be set with the `HUGO_ENVIRONMENT` OS environment variable. The value for `environment` defaults to `production` when running `hugo` and `development` when running `hugo server`. You can set it to any value you want (e.g. `hugo server -e "Sensible Environment"`), but as it is used to load configuration from the file system, the letter case may be important. You can get this value in your templates with `{{ hugo.Environment }}`.
* A new `--configDir` flag (defaults to `config` below your project). This can also be set with `HUGO_CONFIGDIR` OS environment variable.
If the `configDir` exists, the configuration files will be read and merged on top of each other from left to right; the right-most value will win on duplicates.
Given the example tree below:
If `environment` is `production`, the left-most `config.toml` would be the one directly below the project (this can now be omitted if you want), and then `_default/config.toml` and finally `production/config.toml`. And since these will be merged, you can just provide the environment specific configuration setting in you production config, e.g. `enableGitInfo = true`. The order within the directories will be lexical (`config.toml` and then `params.toml`).
```bash
config
├── _default
│ ├── config.toml
│ ├── languages.toml
│ ├── menus
│ │ ├── menus.en.toml
│ │ └── menus.zh.toml
│ └── params.toml
├── development
│ └── params.toml
└── production
├── config.toml
└── params.toml
```
Some configuration maps support the language code in the filename (e.g. `menus.en.toml`): `menus` (`menu` also works) and `params`.
Also note that the only folders with "a meaning" in the above listing is the top level directories below `config`. The `menus` sub folder is just added for better organization.
We use `TOML` in the example above, but Hugo also supports `JSON` and `YAML` as configuration formats. These can be mixed.
Fixes #5422
116 lines
2.8 KiB
Go
116 lines
2.8 KiB
Go
// Copyright 2018 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 maps
|
|
|
|
import (
|
|
"strings"
|
|
|
|
"github.com/gobwas/glob"
|
|
|
|
"github.com/spf13/cast"
|
|
)
|
|
|
|
// ToLower makes all the keys in the given map lower cased and will do so
|
|
// recursively.
|
|
// Notes:
|
|
// * This will modify the map given.
|
|
// * Any nested map[interface{}]interface{} will be converted to map[string]interface{}.
|
|
func ToLower(m map[string]interface{}) {
|
|
for k, v := range m {
|
|
switch v.(type) {
|
|
case map[interface{}]interface{}:
|
|
v = cast.ToStringMap(v)
|
|
ToLower(v.(map[string]interface{}))
|
|
case map[string]interface{}:
|
|
ToLower(v.(map[string]interface{}))
|
|
}
|
|
|
|
lKey := strings.ToLower(k)
|
|
if k != lKey {
|
|
delete(m, k)
|
|
m[lKey] = v
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
type keyRename struct {
|
|
pattern glob.Glob
|
|
newKey string
|
|
}
|
|
|
|
// KeyRenamer supports renaming of keys in a map.
|
|
type KeyRenamer struct {
|
|
renames []keyRename
|
|
}
|
|
|
|
// NewKeyRenamer creates a new KeyRenamer given a list of pattern and new key
|
|
// value pairs.
|
|
func NewKeyRenamer(patternKeys ...string) (KeyRenamer, error) {
|
|
var renames []keyRename
|
|
for i := 0; i < len(patternKeys); i += 2 {
|
|
g, err := glob.Compile(strings.ToLower(patternKeys[i]), '/')
|
|
if err != nil {
|
|
return KeyRenamer{}, err
|
|
}
|
|
renames = append(renames, keyRename{pattern: g, newKey: patternKeys[i+1]})
|
|
}
|
|
|
|
return KeyRenamer{renames: renames}, nil
|
|
}
|
|
|
|
func (r KeyRenamer) getNewKey(keyPath string) string {
|
|
for _, matcher := range r.renames {
|
|
if matcher.pattern.Match(keyPath) {
|
|
return matcher.newKey
|
|
}
|
|
}
|
|
|
|
return ""
|
|
}
|
|
|
|
// Rename renames the keys in the given map according
|
|
// to the patterns in the current KeyRenamer.
|
|
func (r KeyRenamer) Rename(m map[string]interface{}) {
|
|
r.renamePath("", m)
|
|
}
|
|
|
|
func (KeyRenamer) keyPath(k1, k2 string) string {
|
|
k1, k2 = strings.ToLower(k1), strings.ToLower(k2)
|
|
if k1 == "" {
|
|
return k2
|
|
} else {
|
|
return k1 + "/" + k2
|
|
}
|
|
}
|
|
|
|
func (r KeyRenamer) renamePath(parentKeyPath string, m map[string]interface{}) {
|
|
for key, val := range m {
|
|
keyPath := r.keyPath(parentKeyPath, key)
|
|
switch val.(type) {
|
|
case map[interface{}]interface{}:
|
|
val = cast.ToStringMap(val)
|
|
r.renamePath(keyPath, val.(map[string]interface{}))
|
|
case map[string]interface{}:
|
|
r.renamePath(keyPath, val.(map[string]interface{}))
|
|
}
|
|
|
|
newKey := r.getNewKey(keyPath)
|
|
|
|
if newKey != "" {
|
|
delete(m, key)
|
|
m[newKey] = val
|
|
}
|
|
}
|
|
}
|