mirror/gohugoio-hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-05-11 05:54:58 +00:00
Code Issues Releases Activity

modules: Adjust watch logic vs workspace use definitions

Browse Source
This commit is contained in:
Bjørn Erik Pedersen
2022-12-19 17:49:45 +01:00
parent 6db527483d
commit 330fa89411
3 changed files with 16 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/content/en/hugo-modules/configuration.md
View File

@@ -23,7 +23,7 @@ proxy = "direct"
noProxy = "none"
private = "*.*"
replacements = ""
workspace = ""
workspace = "off"
{{< /code-toggle >}}
noVendor
@@ -42,7 +42,7 @@ private
: Comma separated glob list matching paths that should be treated as private.
workspace
: The workspace file to use. This enables Go workspace mode. Note that this can also be set via OS env, e.g. `export HUGO_MODULE_WORKSPACE=/my/hugo.work` This only works with Go 1.18+.
: The workspace file to use. This enables Go workspace mode. Note that this can also be set via OS env, e.g. `export HUGO_MODULE_WORKSPACE=/my/hugo.work` This only works with Go 1.18+. In Hugo `v0.109.0` we changed the default to `off` and we now resolve any relative work filenames relative to the working directory.
replacements
: A comma separated (or a slice) list of module path to directory replacement mapping, e.g. `github.com/bep/my-theme -> ../..,github.com/bep/shortcodes -> /some/path`. This is mostly useful for temporary locally development of a module, and then it makes sense to set it as an OS environment variable, e.g: `env HUGO_MODULE_REPLACEMENTS="github.com/bep/my-theme -> ../.."`. Any relative path is relate to [themesDir](https://gohugo.io/getting-started/configuration/#all-configuration-settings), and absolute paths are allowed.

14
modules/config_test.go
View File

@@ -14,6 +14,9 @@
package modules
import (
"fmt"
"os"
"path/filepath"
"testing"
"github.com/gohugoio/hugo/common/hugo"
@@ -43,8 +46,9 @@ func TestDecodeConfig(t *testing.T) {
c := qt.New(t)
c.Run("Basic", func(c *qt.C) {
tempDir := c.TempDir()
tomlConfig := `
workingDir = "/src/project"
workingDir = %q
[module]
workspace = "hugo.work"
[module.hugoVersion]
@@ -65,7 +69,11 @@ source="src/markdown/blog"
target="content/blog"
lang="en"
`
cfg, err := config.FromConfigString(tomlConfig, "toml")
hugoWorkFilename := filepath.Join(tempDir, "hugo.work")
f, _ := os.Create(hugoWorkFilename)
f.Close()
cfg, err := config.FromConfigString(fmt.Sprintf(tomlConfig, tempDir), "toml")
c.Assert(err, qt.IsNil)
mcfg, err := DecodeConfig(cfg)
@@ -83,7 +91,7 @@ lang="en"
c.Assert(hv.IsValid(), qt.Equals, true)
}
c.Assert(mcfg.Workspace, qt.Equals, "/src/project/hugo.work")
c.Assert(mcfg.Workspace, qt.Equals, hugoWorkFilename)
c.Assert(len(mcfg.Mounts), qt.Equals, 1)
c.Assert(len(mcfg.Imports), qt.Equals, 1)

4
modules/module.go
View File

@@ -184,5 +184,7 @@ func (m *moduleAdapter) Watch() bool {
return m.Replace().Version() == ""
}
return false
// Any module set up in a workspace file will have Indirect set to false.
// That leaves modules inside the read-only module cache.
return !m.gomod.Indirect
}