summaryrefslogtreecommitdiffstats
path: root/parser
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2018-11-15 09:28:02 +0100
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2018-12-11 13:08:36 +0100
commit7829474088f835251f04caa1121d47e35fe89f7e (patch)
treef9b91d601befc966162036559e4418bebf46d643 /parser
parent256418917c6642f7e5b3d3206ff4b6fa03b1cb28 (diff)
Add /config dir support
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
Diffstat (limited to 'parser')
-rw-r--r--parser/metadecoders/decoder.go15
-rw-r--r--parser/metadecoders/format.go6
-rw-r--r--parser/metadecoders/format_test.go1
3 files changed, 22 insertions, 0 deletions
diff --git a/parser/metadecoders/decoder.go b/parser/metadecoders/decoder.go
index e03a6aacd..6da791c73 100644
--- a/parser/metadecoders/decoder.go
+++ b/parser/metadecoders/decoder.go
@@ -22,6 +22,7 @@ import (
"github.com/BurntSushi/toml"
"github.com/chaseadamsio/goorgeous"
"github.com/pkg/errors"
+ "github.com/spf13/afero"
"github.com/spf13/cast"
yaml "gopkg.in/yaml.v2"
)
@@ -37,7 +38,21 @@ func UnmarshalToMap(data []byte, f Format) (map[string]interface{}, error) {
err := unmarshal(data, f, &m)
return m, err
+}
+
+// UnmarshalFileToMap is the same as UnmarshalToMap, but reads the data from
+// the given filename.
+func UnmarshalFileToMap(fs afero.Fs, filename string) (map[string]interface{}, error) {
+ format := FormatFromString(filename)
+ if format == "" {
+ return nil, errors.Errorf("%q is not a valid configuration format", filename)
+ }
+ data, err := afero.ReadFile(fs, filename)
+ if err != nil {
+ return nil, err
+ }
+ return UnmarshalToMap(data, format)
}
// Unmarshal will unmarshall data in format f into an interface{}.
diff --git a/parser/metadecoders/format.go b/parser/metadecoders/format.go
index b9f7f6919..3f5a8a5c1 100644
--- a/parser/metadecoders/format.go
+++ b/parser/metadecoders/format.go
@@ -14,6 +14,7 @@
package metadecoders
import (
+ "path/filepath"
"strings"
"github.com/gohugoio/hugo/parser/pageparser"
@@ -34,6 +35,11 @@ const (
// into a Format. It returns an empty string for unknown formats.
func FormatFromString(formatStr string) Format {
formatStr = strings.ToLower(formatStr)
+ if strings.Contains(formatStr, ".") {
+ // Assume a filename
+ formatStr = strings.TrimPrefix(filepath.Ext(formatStr), ".")
+
+ }
switch formatStr {
case "yaml", "yml":
return YAML
diff --git a/parser/metadecoders/format_test.go b/parser/metadecoders/format_test.go
index 46b4e434a..a22e84f98 100644
--- a/parser/metadecoders/format_test.go
+++ b/parser/metadecoders/format_test.go
@@ -32,6 +32,7 @@ func TestFormatFromString(t *testing.T) {
{"yaml", YAML},
{"yml", YAML},
{"toml", TOML},
+ {"config.toml", TOML},
{"tOMl", TOML},
{"org", ORG},
{"foo", ""},