Add support for theme composition and inheritance

This commit adds support for theme composition and inheritance in Hugo. With this, it helps thinking about a theme as a set of ordered components: ```toml theme = ["my-shortcodes", "base-theme", "hyde"] ``` The theme definition example above in `config.toml` creates a theme with the 3 components with presedence from left to right. So, Hugo will, for any given file, data entry etc., look first in the project, and then in `my-shortcode`, `base-theme` and lastly `hyde`. Hugo uses two different algorithms to merge the filesystems, depending on the file type: * For `i18n` and `data` files, Hugo merges deeply using the translation id and data key inside the files. * For `static`, `layouts` (templates) and `archetypes` files, these are merged on file level. So the left-most file will be chosen. The name used in the `theme` definition above must match a folder in `/your-site/themes`, e.g. `/your-site/themes/my-shortcodes`. There are plans to improve on this and get a URL scheme so this can be resolved automatically. Also note that a component that is part of a theme can have its own configuration file, e.g. `config.toml`. There are currently some restrictions to what a theme component can configure: * `params` (global and per language) * `menu` (global and per language) * `outputformats` and `mediatypes` The same rules apply here: The left-most param/menu etc. with the same ID will win. There are some hidden and experimental namespace support in the above, which we will work to improve in the future, but theme authors are encouraged to create their own namespaces to avoid naming conflicts. A final note: Themes/components can also have a `theme` definition in their `config.toml` and similar, which is the "inheritance" part of this commit's title. This is currently not supported by the Hugo theme site. We will have to wait for some "auto dependency" feature to be implemented for that to happen, but this can be a powerful feature if you want to create your own theme-variant based on others. Fixes gohugoio#4460 Fixes gohugoio#4450
it234 · Jun 10, 2018 · 80230f2 · 80230f2
1 parent 6464981
commit 80230f2
Show file tree

Hide file tree

Showing 86 changed files with 2,820 additions and 1,914 deletions.
diff --git a/Gopkg.lock b/Gopkg.lock
diff --git a/commands/benchmark.go b/commands/benchmark.go
@@ -56,7 +56,7 @@ func (c *benchmarkCmd) benchmark(cmd *cobra.Command, args []string) error {
 		return nil
 	}
 
-	comm, err := initializeConfig(false, &c.hugoBuilderCommon, c, cfgInit)
+	comm, err := initializeConfig(true, false, &c.hugoBuilderCommon, c, cfgInit)
 	if err != nil {
 		return err
 	}

diff --git a/commands/commandeer.go b/commands/commandeer.go
@@ -34,7 +34,7 @@ import (
 	"github.com/gohugoio/hugo/deps"
 	"github.com/gohugoio/hugo/helpers"
 	"github.com/gohugoio/hugo/hugofs"
-	src "github.com/gohugoio/hugo/source"
+	"github.com/gohugoio/hugo/langs"
 )
 
 type commandeer struct {
@@ -45,11 +45,8 @@ type commandeer struct {
 	h    *hugoBuilderCommon
 	ftch flagsToConfigHandler
 
-	pathSpec    *helpers.PathSpec
 	visitedURLs *types.EvictingStringQueue
 
-	staticDirsConfig []*src.Dirs
-
 	// We watch these for changes.
 	configFiles []string
 
@@ -63,7 +60,7 @@ type commandeer struct {
 
 	serverPorts         []int
 	languagesConfigured bool
-	languages           helpers.Languages
+	languages           langs.Languages
 
 	configured bool
 }
@@ -75,31 +72,13 @@ func (c *commandeer) Set(key string, value interface{}) {
 	c.Cfg.Set(key, value)
 }
 
-// PathSpec lazily creates a new PathSpec, as all the paths must
-// be configured before it is created.
-func (c *commandeer) PathSpec() *helpers.PathSpec {
-	c.configured = true
-	return c.pathSpec
-}
-
 func (c *commandeer) initFs(fs *hugofs.Fs) error {
 	c.DepsCfg.Fs = fs
-	ps, err := helpers.NewPathSpec(fs, c.Cfg)
-	if err != nil {
-		return err
-	}
-	c.pathSpec = ps
-
-	dirsConfig, err := c.createStaticDirsConfig()
-	if err != nil {
-		return err
-	}
-	c.staticDirsConfig = dirsConfig
 
 	return nil
 }
 
-func newCommandeer(running bool, h *hugoBuilderCommon, f flagsToConfigHandler, doWithCommandeer func(c *commandeer) error, subCmdVs ...*cobra.Command) (*commandeer, error) {
+func newCommandeer(mustHaveConfigFile, running bool, h *hugoBuilderCommon, f flagsToConfigHandler, doWithCommandeer func(c *commandeer) error, subCmdVs ...*cobra.Command) (*commandeer, error) {
 
 	var rebuildDebouncer func(f func())
 	if running {
@@ -117,10 +96,10 @@ func newCommandeer(running bool, h *hugoBuilderCommon, f flagsToConfigHandler, d
 		debounce:         rebuildDebouncer,
 	}
 
-	return c, c.loadConfig(running)
+	return c, c.loadConfig(mustHaveConfigFile, running)
 }
 
-func (c *commandeer) loadConfig(running bool) error {
+func (c *commandeer) loadConfig(mustHaveConfigFile, running bool) error {
 
 	if c.DepsCfg == nil {
 		c.DepsCfg = &deps.DepsCfg{}
@@ -168,12 +147,18 @@ func (c *commandeer) loadConfig(running bool) error {
 		doWithConfig)
 
 	if err != nil {
-		return err
+		if mustHaveConfigFile {
+			return err
+		}
+		if err != hugolib.ErrNoConfigFile {
+			return err
+		}
+
 	}
 
 	c.configFiles = configFiles
 
-	if l, ok := c.Cfg.Get("languagesSorted").(helpers.Languages); ok {
+	if l, ok := c.Cfg.Get("languagesSorted").(langs.Languages); ok {
 		c.languagesConfigured = true
 		c.languages = l
 	}
@@ -209,6 +194,15 @@ func (c *commandeer) loadConfig(running bool) error {
 		}
 
 		err = c.initFs(fs)
+		if err != nil {
+			return
+		}
+
+		var h *hugolib.HugoSites
+
+		h, err = hugolib.NewHugoSites(*c.DepsCfg)
+		c.hugo = h
+
 	})
 
 	if err != nil {
@@ -232,7 +226,7 @@ func (c *commandeer) loadConfig(running bool) error {
 
 	cfg.Logger.INFO.Println("Using config file:", config.ConfigFileUsed())
 
-	themeDir := c.PathSpec().GetThemeDir()
+	themeDir := c.hugo.PathSpec.GetFirstThemeDir()
 	if themeDir != "" {
 		if _, err := sourceFs.Stat(themeDir); os.IsNotExist(err) {
 			return newSystemError("Unable to find theme Directory:", themeDir)

diff --git a/commands/commands.go b/commands/commands.go
@@ -148,7 +148,7 @@ Complete documentation is available at http://gohugo.io/.`,
 				return nil
 			}
 
-			c, err := initializeConfig(cc.buildWatch, &cc.hugoBuilderCommon, cc, cfgInit)
+			c, err := initializeConfig(true, cc.buildWatch, &cc.hugoBuilderCommon, cc, cfgInit)
 			if err != nil {
 				return err
 			}

diff --git a/commands/commands_test.go b/commands/commands_test.go
@@ -235,6 +235,11 @@ Single: {{ .Title }}
 
 List: {{ .Title }}
 
+`)
+
+	writeFile(t, filepath.Join(d, "static", "my.txt"), `
+MyMy
+
 `)
 
 	return d, nil

diff --git a/commands/config.go b/commands/config.go
@@ -44,7 +44,7 @@ func newConfigCmd() *configCmd {
 }
 
 func (c *configCmd) printConfig(cmd *cobra.Command, args []string) error {
-	cfg, err := initializeConfig(false, &c.hugoBuilderCommon, c, nil)
+	cfg, err := initializeConfig(true, false, &c.hugoBuilderCommon, c, nil)
 
 	if err != nil {
 		return err

diff --git a/commands/convert.go b/commands/convert.go
@@ -96,7 +96,7 @@ func (cc *convertCmd) convertContents(mark rune) error {
 		return newUserError("Unsafe operation not allowed, use --unsafe or set a different output path")
 	}
 
-	c, err := initializeConfig(false, &cc.hugoBuilderCommon, cc, nil)
+	c, err := initializeConfig(true, false, &cc.hugoBuilderCommon, cc, nil)
 	if err != nil {
 		return err
 	}
-Original file line number
+Diff line change
@@ Expand Up / @@ -235,6 +235,11 @@ Single: {{ .Title }} @@
     List: {{ .Title }}
+    `)
+    	writeFile(t, filepath.Join(d, "static", "my.txt"), `
+    MyMy
     `)
     	return d, nil
@@ Expand Down @@