diff options
author | Bjørn Erik Pedersen <[email protected]> | 2018-11-15 09:28:02 +0100 |
---|---|---|
committer | Bjørn Erik Pedersen <[email protected]> | 2018-12-11 13:08:36 +0100 |
commit | 7829474088f835251f04caa1121d47e35fe89f7e (patch) | |
tree | f9b91d601befc966162036559e4418bebf46d643 /htesting | |
parent | 256418917c6642f7e5b3d3206ff4b6fa03b1cb28 (diff) | |
download | hugo-7829474088f835251f04caa1121d47e35fe89f7e.tar.gz hugo-7829474088f835251f04caa1121d47e35fe89f7e.zip |
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 'htesting')
-rw-r--r-- | htesting/test_structs.go | 2 | ||||
-rw-r--r-- | htesting/testdata_builder.go | 59 |
2 files changed, 60 insertions, 1 deletions
diff --git a/htesting/test_structs.go b/htesting/test_structs.go index 168c848aa..f5aa6ff25 100644 --- a/htesting/test_structs.go +++ b/htesting/test_structs.go @@ -39,7 +39,7 @@ func (t testSite) Language() *langs.Language { // NewTestHugoSite creates a new minimal test site. func NewTestHugoSite() hugo.Site { return testSite{ - h: hugo.NewInfo(), + h: hugo.NewInfo(hugo.EnvironmentProduction), l: langs.NewLanguage("en", newTestConfig()), } } diff --git a/htesting/testdata_builder.go b/htesting/testdata_builder.go new file mode 100644 index 000000000..d7ba18521 --- /dev/null +++ b/htesting/testdata_builder.go @@ -0,0 +1,59 @@ +// 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 htesting + +import ( + "path/filepath" + "testing" + + "github.com/spf13/afero" +) + +type testFile struct { + name string + content string +} + +type testdataBuilder struct { + t testing.TB + fs afero.Fs + workingDir string + + files []testFile +} + +func NewTestdataBuilder(fs afero.Fs, workingDir string, t testing.TB) *testdataBuilder { + workingDir = filepath.Clean(workingDir) + return &testdataBuilder{fs: fs, workingDir: workingDir, t: t} +} + +func (b *testdataBuilder) Add(filename, content string) *testdataBuilder { + b.files = append(b.files, testFile{name: filename, content: content}) + return b +} + +func (b *testdataBuilder) Build() *testdataBuilder { + for _, f := range b.files { + if err := afero.WriteFile(b.fs, filepath.Join(b.workingDir, f.name), []byte(f.content), 0666); err != nil { + b.t.Fatalf("failed to add %q: %s", f.name, err) + } + } + return b +} + +func (b testdataBuilder) WithWorkingDir(dir string) *testdataBuilder { + b.workingDir = filepath.Clean(dir) + b.files = make([]testFile, 0) + return &b +} |