commands: Add "hugo config mounts" command

This prints the effective file mounts in a project.

Fixes #6144
This commit is contained in:
Bjørn Erik Pedersen 2019-07-31 10:31:26 +02:00
parent 45ee8a7a52
commit d7c233afee
5 changed files with 74 additions and 13 deletions

View file

@ -14,11 +14,18 @@
package commands package commands
import ( import (
"encoding/json"
"os"
"reflect" "reflect"
"regexp" "regexp"
"sort" "sort"
"strings" "strings"
"github.com/gohugoio/hugo/parser"
"github.com/gohugoio/hugo/parser/metadecoders"
"github.com/gohugoio/hugo/modules"
"github.com/spf13/cobra" "github.com/spf13/cobra"
jww "github.com/spf13/jwalterweatherman" jww "github.com/spf13/jwalterweatherman"
"github.com/spf13/viper" "github.com/spf13/viper"
@ -40,14 +47,37 @@ func newConfigCmd() *configCmd {
RunE: cc.printConfig, RunE: cc.printConfig,
}) })
cc.cmd.Flags().StringVarP(&cc.source, "source", "s", "", "filesystem path to read files relative from") cc.cmd.PersistentFlags().StringVarP(&cc.source, "source", "s", "", "filesystem path to read files relative from")
printMountsCmd := &cobra.Command{
Use: "mounts",
Short: "Print the configured file mounts",
RunE: cc.printMounts,
}
cc.cmd.AddCommand(printMountsCmd)
return cc return cc
} }
func (c *configCmd) printMounts(cmd *cobra.Command, args []string) error {
cfg, err := initializeConfig(true, false, &c.hugoBuilderCommon, c, nil)
if err != nil {
return err
}
allModules := cfg.Cfg.Get("allmodules").(modules.Modules)
for _, m := range allModules {
if err := parser.InterfaceToConfig(&modMounts{m: m}, metadecoders.JSON, os.Stdout); err != nil {
return err
}
}
return nil
}
func (c *configCmd) printConfig(cmd *cobra.Command, args []string) error { func (c *configCmd) printConfig(cmd *cobra.Command, args []string) error {
cfg, err := initializeConfig(true, false, &c.hugoBuilderCommon, c, nil) cfg, err := initializeConfig(true, false, &c.hugoBuilderCommon, c, nil)
if err != nil { if err != nil {
return err return err
} }
@ -83,3 +113,35 @@ func (c *configCmd) printConfig(cmd *cobra.Command, args []string) error {
return nil return nil
} }
type modMounts struct {
m modules.Module
}
type modMount struct {
Source string `json:"source"`
Target string `json:"target"`
Lang string `json:"lang,omitempty"`
}
func (m *modMounts) MarshalJSON() ([]byte, error) {
var mounts []modMount
for _, mount := range m.m.Mounts() {
mounts = append(mounts, modMount{
Source: mount.Source,
Target: mount.Target,
Lang: mount.Lang,
})
}
return json.Marshal(&struct {
Path string `json:"path"`
Dir string `json:"dir"`
Mounts []modMount `json:"mounts"`
}{
Path: m.m.Path(),
Dir: m.m.Dir(),
Mounts: mounts,
})
}

View file

@ -217,7 +217,7 @@ func LoadConfig(d ConfigSourceDescriptor, doWithConfig ...func(cfg config.Provid
mods := m.ActiveModules mods := m.ActiveModules
// Apply default project mounts. // Apply default project mounts.
if err := modules.ApplyProjectConfigDefaults(v, mods[len(mods)-1]); err != nil { if err := modules.ApplyProjectConfigDefaults(v, mods[0]); err != nil {
return err return err
} }

View file

@ -452,20 +452,19 @@ func (b *sourceFilesystemsBuilder) createMainOverlayFs(p *paths.Paths) (*filesys
// The theme components are ordered from left to right. // The theme components are ordered from left to right.
// We need to revert it to get the // We need to revert it to get the
// overlay logic below working as expected, with the project on top (last). // overlay logic below working as expected, with the project on top.
for i, mod := range mods { j := 0
for i := len(mods) - 1; i >= 0; i-- {
mod := mods[i]
dir := mod.Dir() dir := mod.Dir()
if i < len(mods)-1 {
i = len(mods) - 2 - i
}
isMainProject := mod.Owner() == nil isMainProject := mod.Owner() == nil
modsReversed[i] = mountsDescriptor{ modsReversed[j] = mountsDescriptor{
Module: mod, Module: mod,
dir: dir, dir: dir,
isMainProject: isMainProject, isMainProject: isMainProject,
} }
j++
} }
err := b.createOverlayFs(collector, modsReversed) err := b.createOverlayFs(collector, modsReversed)

View file

@ -62,7 +62,7 @@ func initConfig(fs afero.Fs, cfg config.Provider) error {
return err return err
} }
if err := modules.ApplyProjectConfigDefaults(cfg, moduleConfig.ActiveModules[len(moduleConfig.ActiveModules)-1]); err != nil { if err := modules.ApplyProjectConfigDefaults(cfg, moduleConfig.ActiveModules[0]); err != nil {
return err return err
} }

View file

@ -478,8 +478,8 @@ func (c *collector) collect() {
return return
} }
// Append the project module at the tail. // Add the project mod on top.
c.modules = append(c.modules, projectMod) c.modules = append(Modules{projectMod}, c.modules...)
} }