diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2018-11-15 09:28:02 +0100 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2018-12-11 13:08:36 +0100 |
commit | 7829474088f835251f04caa1121d47e35fe89f7e (patch) | |
tree | f9b91d601befc966162036559e4418bebf46d643 /commands/hugo.go | |
parent | 256418917c6642f7e5b3d3206ff4b6fa03b1cb28 (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 'commands/hugo.go')
-rw-r--r-- | commands/hugo.go | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/commands/hugo.go b/commands/hugo.go index 759efc17b..74173fa84 100644 --- a/commands/hugo.go +++ b/commands/hugo.go @@ -718,8 +718,8 @@ func (c *commandeer) newWatcher(dirList ...string) (*watcher.Batcher, error) { // Identifies changes to config (config.toml) files. configSet := make(map[string]bool) + c.logger.FEEDBACK.Println("Watching for config changes in", strings.Join(c.configFiles, ", ")) for _, configFile := range c.configFiles { - c.logger.FEEDBACK.Println("Watching for config changes in", configFile) watcher.Add(configFile) configSet[configFile] = true } @@ -750,7 +750,17 @@ func (c *commandeer) handleEvents(watcher *watcher.Batcher, configSet map[string]bool) { for _, ev := range evs { - if configSet[ev.Name] { + isConfig := configSet[ev.Name] + if !isConfig { + // It may be one of the /config folders + dirname := filepath.Dir(ev.Name) + if dirname != "." && configSet[dirname] { + isConfig = true + } + + } + + if isConfig { if ev.Op&fsnotify.Chmod == fsnotify.Chmod { continue } @@ -766,7 +776,7 @@ func (c *commandeer) handleEvents(watcher *watcher.Batcher, } } } - // Config file changed. Need full rebuild. + // Config file(s) changed. Need full rebuild. c.fullRebuild() break } |