Add Hugo Modules

This commit implements Hugo Modules. This is a broad subject, but some keywords include: * A new `module` configuration section where you can import almost anything. You can configure both your own file mounts nd the file mounts of the modules you import. This is the new recommended way of configuring what you earlier put in `configDir`, `staticDir` etc. And it also allows you to mount folders in non-Hugo-projects, e.g. the `SCSS` folder in the Bootstrap GitHub project. * A module consists of a set of mounts to the standard 7 component types in Hugo: `static`, `content`, `layouts`, `data`, `assets`, `i18n`, and `archetypes`. Yes, Theme Components can now include content, which should be very useful, especially in bigger multilingual projects. * Modules not in your local file cache will be downloaded automatically and even "hot replaced" while the server is running. * Hugo Modules supports and encourages semver versioned modules, and uses the minimal version selection algorithm to resolve versions. * A new set of CLI commands are provided to manage all of this: `hugo mod init`, `hugo mod get`, `hugo mod graph`, `hugo mod tidy`, and `hugo mod vendor`. All of the above is backed by Go Modules. Fixes #5973 Fixes #5996 Fixes #6010 Fixes #5911 Fixes #5940 Fixes #6074 Fixes #6082 Fixes #6092
2025-08-29 22:29:56 +02:00 · 2019-05-03 09:16:58 +02:00
parent 47953148b6
commit 9f5a92078a
158 changed files with 9895 additions and 5433 deletions
--- a/hugolib/filesystems/basefs_test.go
+++ b/hugolib/filesystems/basefs_test.go
@@ -1,4 +1,4 @@
-// Copyright 2018 The Hugo Authors. All rights reserved.
+// Copyright 2019 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.
@@ -18,18 +18,59 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"strings"
 	"testing"

+	"github.com/gohugoio/hugo/config"
+
 	"github.com/gohugoio/hugo/langs"

 	"github.com/spf13/afero"

 	"github.com/gohugoio/hugo/hugofs"
 	"github.com/gohugoio/hugo/hugolib/paths"
+	"github.com/gohugoio/hugo/modules"
 	"github.com/spf13/viper"
 	"github.com/stretchr/testify/require"
 )

+func initConfig(fs afero.Fs, cfg config.Provider) error {
+	if _, err := langs.LoadLanguageSettings(cfg, nil); err != nil {
+		return err
+	}
+
+	modConfig, err := modules.DecodeConfig(cfg)
+	if err != nil {
+		return err
+	}
+
+	workingDir := cfg.GetString("workingDir")
+	themesDir := cfg.GetString("themesDir")
+	if !filepath.IsAbs(themesDir) {
+		themesDir = filepath.Join(workingDir, themesDir)
+	}
+	modulesClient := modules.NewClient(modules.ClientConfig{
+		Fs:           fs,
+		WorkingDir:   workingDir,
+		ThemesDir:    themesDir,
+		ModuleConfig: modConfig,
+		IgnoreVendor: true,
+	})
+
+	moduleConfig, err := modulesClient.Collect()
+	if err != nil {
+		return err
+	}
+
+	if err := modules.ApplyProjectConfigDefaults(cfg, moduleConfig.ActiveModules[len(moduleConfig.ActiveModules)-1]); err != nil {
+		return err
+	}
+
+	cfg.Set("allModules", moduleConfig.ActiveModules)
+
+	return nil
+}
+
 func TestNewBaseFs(t *testing.T) {
 	assert := require.New(t)
 	v := viper.New()
@@ -40,16 +81,21 @@ func TestNewBaseFs(t *testing.T) {

 	workingDir := filepath.FromSlash("/my/work")
 	v.Set("workingDir", workingDir)
+	v.Set("contentDir", "content")
 	v.Set("themesDir", "themes")
+	v.Set("defaultContentLanguage", "en")
 	v.Set("theme", themes[:1])

 	// Write some data to the themes
 	for _, theme := range themes {
 		for _, dir := range []string{"i18n", "data", "archetypes", "layouts"} {
 			base := filepath.Join(workingDir, "themes", theme, dir)
-			filename := filepath.Join(base, fmt.Sprintf("theme-file-%s.txt", theme))
+			filenameTheme := filepath.Join(base, fmt.Sprintf("theme-file-%s.txt", theme))
+			filenameOverlap := filepath.Join(base, "f3.txt")
 			fs.Source.Mkdir(base, 0755)
-			afero.WriteFile(fs.Source, filename, []byte(fmt.Sprintf("content:%s:%s", theme, dir)), 0755)
+			content := []byte(fmt.Sprintf("content:%s:%s", theme, dir))
+			afero.WriteFile(fs.Source, filenameTheme, content, 0755)
+			afero.WriteFile(fs.Source, filenameOverlap, content, 0755)
 		}
 		// Write some files to the root of the theme
 		base := filepath.Join(workingDir, "themes", theme)
@@ -73,6 +119,7 @@ theme = ["atheme"]
 	setConfigAndWriteSomeFilesTo(fs.Source, v, "resourceDir", "myrsesource", 10)

 	v.Set("publishDir", "public")
+	assert.NoError(initConfig(fs.Source, v))

 	p, err := paths.New(fs, v)
 	assert.NoError(err)
@@ -85,33 +132,26 @@ theme = ["atheme"]
 	assert.NoError(err)
 	dirnames, err := root.Readdirnames(-1)
 	assert.NoError(err)
-	assert.Equal([]string{projectVirtualFolder, "btheme", "atheme"}, dirnames)
-	ff, err := bfs.I18n.Fs.Open("myi18n")
-	assert.NoError(err)
-	_, err = ff.Readdirnames(-1)
-	assert.NoError(err)
+	assert.Equal([]string{"f1.txt", "f2.txt", "f3.txt", "f4.txt", "f3.txt", "theme-file-btheme.txt", "f3.txt", "theme-file-atheme.txt"}, dirnames)

 	root, err = bfs.Data.Fs.Open("")
 	assert.NoError(err)
 	dirnames, err = root.Readdirnames(-1)
 	assert.NoError(err)
-	assert.Equal([]string{projectVirtualFolder, "btheme", "atheme"}, dirnames)
-	ff, err = bfs.I18n.Fs.Open("mydata")
-	assert.NoError(err)
-	_, err = ff.Readdirnames(-1)
-	assert.NoError(err)
+	assert.Equal([]string{"f1.txt", "f2.txt", "f3.txt", "f4.txt", "f5.txt", "f6.txt", "f7.txt", "f3.txt", "theme-file-btheme.txt", "f3.txt", "theme-file-atheme.txt"}, dirnames)
+
+	//printFs(bfs.Work, "", os.Stdout)
+
+	checkFileCount(bfs.Layouts.Fs, "", assert, 7)

 	checkFileCount(bfs.Content.Fs, "", assert, 3)
-	checkFileCount(bfs.I18n.Fs, "", assert, 6) // 4 + 2 themes
-	checkFileCount(bfs.Layouts.Fs, "", assert, 7)
+	checkFileCount(bfs.I18n.Fs, "", assert, 8) // 4 + 4 themes
+
 	checkFileCount(bfs.Static[""].Fs, "", assert, 6)
-	checkFileCount(bfs.Data.Fs, "", assert, 9)        // 7 + 2 themes
+	checkFileCount(bfs.Data.Fs, "", assert, 11)       // 7 + 4 themes
 	checkFileCount(bfs.Archetypes.Fs, "", assert, 10) // 8 + 2 themes
 	checkFileCount(bfs.Assets.Fs, "", assert, 9)
-	checkFileCount(bfs.Resources.Fs, "", assert, 10)
-	checkFileCount(bfs.Work.Fs, "", assert, 78)
-
-	assert.Equal([]string{filepath.FromSlash("/my/work/mydata"), filepath.FromSlash("/my/work/themes/btheme/data"), filepath.FromSlash("/my/work/themes/atheme/data")}, bfs.Data.Dirnames)
+	checkFileCount(bfs.Work, "", assert, 82)

 	assert.True(bfs.IsData(filepath.Join(workingDir, "mydata", "file1.txt")))
 	assert.True(bfs.IsI18n(filepath.Join(workingDir, "myi18n", "file1.txt")))
@@ -125,13 +165,13 @@ theme = ["atheme"]
 	assert.Equal("file1.txt", rel)

 	// Check Work fs vs theme
-	checkFileContent(bfs.Work.Fs, "file-root.txt", assert, "content-project")
-	checkFileContent(bfs.Work.Fs, "theme-root-atheme.txt", assert, "content:atheme")
+	checkFileContent(bfs.Work, "file-root.txt", assert, "content-project")
+	checkFileContent(bfs.Work, "theme-root-atheme.txt", assert, "content:atheme")

 	// https://github.com/gohugoio/hugo/issues/5318
 	// Check both project and theme.
 	for _, fs := range []afero.Fs{bfs.Archetypes.Fs, bfs.Layouts.Fs} {
-		for _, filename := range []string{"/file1.txt", "/theme-file-atheme.txt"} {
+		for _, filename := range []string{"/f1.txt", "/theme-file-atheme.txt"} {
 			filename = filepath.FromSlash(filename)
 			f, err := fs.Open(filename)
 			assert.NoError(err)
@@ -153,6 +193,7 @@ func createConfig() *viper.Viper {
 	v.Set("assetDir", "myassets")
 	v.Set("resourceDir", "resources")
 	v.Set("publishDir", "public")
+	v.Set("defaultContentLanguage", "en")

 	return v
 }
@@ -161,17 +202,18 @@ func TestNewBaseFsEmpty(t *testing.T) {
 	assert := require.New(t)
 	v := createConfig()
 	fs := hugofs.NewMem(v)
+	assert.NoError(initConfig(fs.Source, v))
+
 	p, err := paths.New(fs, v)
 	assert.NoError(err)
 	bfs, err := NewBase(p)
 	assert.NoError(err)
 	assert.NotNil(bfs)
-	assert.Equal(hugofs.NoOpFs, bfs.Archetypes.Fs)
-	assert.Equal(hugofs.NoOpFs, bfs.Layouts.Fs)
-	assert.Equal(hugofs.NoOpFs, bfs.Data.Fs)
-	assert.Equal(hugofs.NoOpFs, bfs.Assets.Fs)
-	assert.Equal(hugofs.NoOpFs, bfs.I18n.Fs)
-	assert.NotNil(bfs.Work.Fs)
+	assert.NotNil(bfs.Archetypes.Fs)
+	assert.NotNil(bfs.Layouts.Fs)
+	assert.NotNil(bfs.Data.Fs)
+	assert.NotNil(bfs.I18n.Fs)
+	assert.NotNil(bfs.Work)
 	assert.NotNil(bfs.Content.Fs)
 	assert.NotNil(bfs.Static)
 }
@@ -217,11 +259,14 @@ func TestRealDirs(t *testing.T) {
 	afero.WriteFile(sfs, filepath.Join(filepath.Join(root, "myassets", "js", "f2", "a1.js")), []byte("content"), 0755)
 	afero.WriteFile(sfs, filepath.Join(filepath.Join(root, "myassets", "js", "a2.js")), []byte("content"), 0755)

+	assert.NoError(initConfig(fs.Source, v))
+
 	p, err := paths.New(fs, v)
 	assert.NoError(err)
 	bfs, err := NewBase(p)
 	assert.NoError(err)
 	assert.NotNil(bfs)
+
 	checkFileCount(bfs.Assets.Fs, "", assert, 6)

 	realDirs := bfs.Assets.RealDirs("scss")
@@ -229,13 +274,7 @@ func TestRealDirs(t *testing.T) {
 	assert.Equal(filepath.Join(root, "myassets/scss"), realDirs[0])
 	assert.Equal(filepath.Join(themesDir, "mytheme/assets/scss"), realDirs[len(realDirs)-1])

-	checkFileCount(bfs.Resources.Fs, "", assert, 3)
-
-	assert.NotNil(bfs.themeFs)
-	fi, b, err := bfs.themeFs.(afero.Lstater).LstatIfPossible(filepath.Join("resources", "t1.txt"))
-	assert.NoError(err)
-	assert.False(b)
-	assert.Equal("t1.txt", fi.Name())
+	assert.NotNil(bfs.theBigFs)

 }

@@ -245,20 +284,25 @@ func TestStaticFs(t *testing.T) {
 	workDir := "mywork"
 	v.Set("workingDir", workDir)
 	v.Set("themesDir", "themes")
-	v.Set("theme", "t1")
+	v.Set("theme", []string{"t1", "t2"})

 	fs := hugofs.NewMem(v)

 	themeStaticDir := filepath.Join(workDir, "themes", "t1", "static")
+	themeStaticDir2 := filepath.Join(workDir, "themes", "t2", "static")

 	afero.WriteFile(fs.Source, filepath.Join(workDir, "mystatic", "f1.txt"), []byte("Hugo Rocks!"), 0755)
 	afero.WriteFile(fs.Source, filepath.Join(themeStaticDir, "f1.txt"), []byte("Hugo Themes Rocks!"), 0755)
 	afero.WriteFile(fs.Source, filepath.Join(themeStaticDir, "f2.txt"), []byte("Hugo Themes Still Rocks!"), 0755)
+	afero.WriteFile(fs.Source, filepath.Join(themeStaticDir2, "f2.txt"), []byte("Hugo Themes Rocks in t2!"), 0755)
+
+	assert.NoError(initConfig(fs.Source, v))

 	p, err := paths.New(fs, v)
 	assert.NoError(err)
 	bfs, err := NewBase(p)
 	assert.NoError(err)
+
 	sfs := bfs.StaticFs("en")
 	checkFileContent(sfs, "f1.txt", assert, "Hugo Rocks!")
 	checkFileContent(sfs, "f2.txt", assert, "Hugo Themes Still Rocks!")
@@ -272,21 +316,19 @@ func TestStaticFsMultiHost(t *testing.T) {
 	v.Set("workingDir", workDir)
 	v.Set("themesDir", "themes")
 	v.Set("theme", "t1")
-	v.Set("multihost", true)
+	v.Set("defaultContentLanguage", "en")

-	vn := viper.New()
-	vn.Set("staticDir", "nn_static")
-
-	en := langs.NewLanguage("en", v)
-	no := langs.NewLanguage("no", v)
-	no.Set("staticDir", "static_no")
-
-	languages := langs.Languages{
-		en,
-		no,
+	langConfig := map[string]interface{}{
+		"no": map[string]interface{}{
+			"staticDir": "static_no",
+			"baseURL":   "https://example.org/no/",
+		},
+		"en": map[string]interface{}{
+			"baseURL": "https://example.org/en/",
+		},
 	}

-	v.Set("languagesSorted", languages)
+	v.Set("languages", langConfig)

 	fs := hugofs.NewMem(v)

@@ -298,6 +340,8 @@ func TestStaticFsMultiHost(t *testing.T) {
 	afero.WriteFile(fs.Source, filepath.Join(themeStaticDir, "f1.txt"), []byte("Hugo Themes Rocks!"), 0755)
 	afero.WriteFile(fs.Source, filepath.Join(themeStaticDir, "f2.txt"), []byte("Hugo Themes Still Rocks!"), 0755)

+	assert.NoError(initConfig(fs.Source, v))
+
 	p, err := paths.New(fs, v)
 	assert.NoError(err)
 	bfs, err := NewBase(p)
@@ -312,9 +356,9 @@ func TestStaticFsMultiHost(t *testing.T) {
 }

 func checkFileCount(fs afero.Fs, dirname string, assert *require.Assertions, expected int) {
-	count, _, err := countFileaAndGetDirs(fs, dirname)
-	assert.NoError(err)
-	assert.Equal(expected, count)
+	count, fnames, err := countFileaAndGetFilenames(fs, dirname)
+	assert.NoError(err, fnames)
+	assert.Equal(expected, count, fnames)
 }

 func checkFileContent(fs afero.Fs, filename string, assert *require.Assertions, expected ...string) {
@@ -329,27 +373,38 @@ func checkFileContent(fs afero.Fs, filename string, assert *require.Assertions,
 	}
 }

-func countFileaAndGetDirs(fs afero.Fs, dirname string) (int, []string, error) {
+func countFileaAndGetFilenames(fs afero.Fs, dirname string) (int, []string, error) {
 	if fs == nil {
 		return 0, nil, errors.New("no fs")
 	}

 	counter := 0
-	var dirs []string
+	var filenames []string

-	afero.Walk(fs, dirname, func(path string, info os.FileInfo, err error) error {
-		if info != nil {
-			if !info.IsDir() {
-				counter++
-			} else if info.Name() != "." {
-				dirs = append(dirs, filepath.Join(path, info.Name()))
-			}
+	wf := func(path string, info hugofs.FileMetaInfo, err error) error {
+		if err != nil {
+			return err
+		}
+		if !info.IsDir() {
+			counter++
+		}
+
+		if info.Name() != "." {
+			name := info.Name()
+			name = strings.Replace(name, filepath.FromSlash("/my/work"), "WORK_DIR", 1)
+			filenames = append(filenames, name)
 		}

 		return nil
-	})
+	}

-	return counter, dirs, nil
+	w := hugofs.NewWalkway(hugofs.WalkwayConfig{Fs: fs, Root: dirname, WalkFn: wf})
+
+	if err := w.Walk(); err != nil {
+		return -1, nil, err
+	}
+
+	return counter, filenames, nil
 }

 func setConfigAndWriteSomeFilesTo(fs afero.Fs, v *viper.Viper, key, val string, num int) {
@@ -357,7 +412,7 @@ func setConfigAndWriteSomeFilesTo(fs afero.Fs, v *viper.Viper, key, val string,
 	v.Set(key, val)
 	fs.Mkdir(val, 0755)
 	for i := 0; i < num; i++ {
-		filename := filepath.Join(workingDir, val, fmt.Sprintf("file%d.txt", i+1))
+		filename := filepath.Join(workingDir, val, fmt.Sprintf("f%d.txt", i+1))
 		afero.WriteFile(fs, filename, []byte(fmt.Sprintf("content:%s:%d", key, i+1)), 0755)
 	}
 }