]> git.maquefel.me Git - brevno-suite/hugo/commitdiff
common/hugo: Rename IsMultiHost and IsMultiLingual
authorJoe Mooring <joe.mooring@veriphor.com>
Tue, 12 Mar 2024 15:18:23 +0000 (08:18 -0700)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Wed, 13 Mar 2024 15:34:42 +0000 (17:34 +0200)
hugo.IsMultiHost => hugo.IsMultihost
hugo.IsMultiLingual => hugo.IsMultilingual

Closes #12232

18 files changed:
commands/server.go
common/hugo/hugo.go
common/hugo/hugo_integration_test.go
common/hugo/hugo_test.go
config/allconfig/allconfig.go
config/allconfig/configlanguage.go
config/configProvider.go
hugolib/config_test.go
hugolib/content_map_page.go
hugolib/filesystems/basefs_test.go
hugolib/hugo_sites.go
hugolib/hugo_sites_multihost_test.go
hugolib/site.go
hugolib/site_new.go
hugolib/site_render.go
modules/config.go
resources/page/page_matcher_test.go
resources/page/site.go

index 0ce655c5196bf63f30b68daeeb79bb78888f3c5d..afc539c445aced3370616aec6dfb1cb5c1609233 100644 (file)
@@ -617,9 +617,9 @@ func (c *serverCommand) setBaseURLsInConfig() error {
        }
        return c.withConfE(func(conf *commonConfig) error {
                for i, language := range conf.configs.Languages {
-                       isMultiHost := conf.configs.IsMultihost
+                       isMultihost := conf.configs.IsMultihost
                        var serverPort int
-                       if isMultiHost {
+                       if isMultihost {
                                serverPort = c.serverPorts[i].p
                        } else {
                                serverPort = c.serverPorts[0].p
@@ -737,9 +737,9 @@ func (c *serverCommand) createServerPorts(cd *simplecobra.Commandeer) error {
        flags := cd.CobraCommand.Flags()
        var cerr error
        c.withConf(func(conf *commonConfig) {
-               isMultiHost := conf.configs.IsMultihost
+               isMultihost := conf.configs.IsMultihost
                c.serverPorts = make([]serverPortListener, 1)
-               if isMultiHost {
+               if isMultihost {
                        if !c.serverAppend {
                                cerr = errors.New("--appendPort=false not supported when in multihost mode")
                                return
@@ -852,7 +852,7 @@ func (c *serverCommand) serve() error {
                h        *hugolib.HugoSites
        )
        err := c.withConfE(func(conf *commonConfig) error {
-               isMultiHost := conf.configs.IsMultihost
+               isMultihost := conf.configs.IsMultihost
                var err error
                h, err = c.r.HugFromConfig(conf)
                if err != nil {
@@ -862,7 +862,7 @@ func (c *serverCommand) serve() error {
                // We need the server to share the same logger as the Hugo build (for error counts etc.)
                c.r.logger = h.Log
 
-               if isMultiHost {
+               if isMultihost {
                        for _, l := range conf.configs.ConfigLangs() {
                                baseURLs = append(baseURLs, l.BaseURL())
                                roots = append(roots, l.Language().Lang)
@@ -1005,7 +1005,6 @@ func (c *serverCommand) serve() error {
                        }
                }
        }()
-
        if err != nil {
                c.r.Println("Error:", err)
        }
index a3d1a7bfcac41380f38a984ffc59e3c9d7e174d2..0589ac9a36d07029fd682382bd9313286ed33150 100644 (file)
@@ -111,14 +111,20 @@ func (i HugoInfo) Deps() []*Dependency {
        return i.deps
 }
 
-// IsMultiHost reports whether each configured language has a unique baseURL.
+// Deprecated: Use hugo.IsMultihost instead.
 func (i HugoInfo) IsMultiHost() bool {
+       Deprecate("hugo.IsMultiHost", "Use hugo.IsMultihost instead.", "v0.124.0")
        return i.conf.IsMultihost()
 }
 
-// IsMultiLingual reports whether there are two or more configured languages.
-func (i HugoInfo) IsMultiLingual() bool {
-       return i.conf.IsMultiLingual()
+// IsMultihost reports whether each configured language has a unique baseURL.
+func (i HugoInfo) IsMultihost() bool {
+       return i.conf.IsMultihost()
+}
+
+// IsMultilingual reports whether there are two or more configured languages.
+func (i HugoInfo) IsMultilingual() bool {
+       return i.conf.IsMultilingual()
 }
 
 // ConfigProvider represents the config options that are relevant for HugoInfo.
@@ -127,7 +133,7 @@ type ConfigProvider interface {
        Running() bool
        WorkingDir() string
        IsMultihost() bool
-       IsMultiLingual() bool
+       IsMultilingual() bool
 }
 
 // NewInfo creates a new Hugo Info object.
index 9fcfb95cf6dd41ca99f39519a19a60494ba3f1b9..77dbb5c9119eadbccb7d3272f6914023620ea416 100644 (file)
@@ -20,7 +20,7 @@ import (
        "github.com/gohugoio/hugo/hugolib"
 )
 
-func TestIsMultiLingualAndIsMultiHost(t *testing.T) {
+func TestIsMultilingualAndIsMultihost(t *testing.T) {
        t.Parallel()
 
        files := `
@@ -36,8 +36,8 @@ baseURL = 'https://en.example.org/'
 title: home
 ---
 -- layouts/index.html --
-multilingual={{ hugo.IsMultiLingual }}
-multihost={{ hugo.IsMultiHost }}
+multilingual={{ hugo.IsMultilingual }}
+multihost={{ hugo.IsMultihost }}
   `
 
        b := hugolib.Test(t, files)
index e1d9071586a5c747dcbfd4b6dca3c9df1b54cddd..6e8b2620e4a83bf47d044339a929545eec26ffd2 100644 (file)
@@ -88,6 +88,6 @@ func (c testConfig) IsMultihost() bool {
        return c.multihost
 }
 
-func (c testConfig) IsMultiLingual() bool {
+func (c testConfig) IsMultilingual() bool {
        return c.multilingual
 }
index 9cafc876e15d6cb0edca1620a917764c6629a09a..590f2ba60cdf3b3aa4e02ce4afc81dc44ef852cf 100644 (file)
@@ -826,7 +826,7 @@ func fromLoadConfigResult(fs afero.Fs, logger loggers.Logger, res config.LoadCon
        langConfigMap := make(map[string]*Config)
 
        languagesConfig := cfg.GetStringMap("languages")
-       var isMultiHost bool
+       var isMultihost bool
 
        if err := all.CompileConfig(logger); err != nil {
                return nil, err
@@ -863,7 +863,7 @@ func fromLoadConfigResult(fs afero.Fs, logger loggers.Logger, res config.LoadCon
                                }
                                if kk == "baseurl" {
                                        // baseURL configure don the language level is a multihost setup.
-                                       isMultiHost = true
+                                       isMultihost = true
                                }
                                mergedConfig.Set(kk, vv)
                                rootv := cfg.Get(kk)
@@ -913,7 +913,7 @@ func fromLoadConfigResult(fs afero.Fs, logger loggers.Logger, res config.LoadCon
                        }
 
                        // Adjust Goldmark config defaults for multilingual, single-host sites.
-                       if len(languagesConfig) > 1 && !isMultiHost && !clone.Markup.Goldmark.DuplicateResourceFiles {
+                       if len(languagesConfig) > 1 && !isMultihost && !clone.Markup.Goldmark.DuplicateResourceFiles {
                                if !clone.Markup.Goldmark.DuplicateResourceFiles {
                                        if clone.Markup.Goldmark.RenderHooks.Link.EnableDefault == nil {
                                                clone.Markup.Goldmark.RenderHooks.Link.EnableDefault = types.NewBool(true)
@@ -943,7 +943,7 @@ func fromLoadConfigResult(fs afero.Fs, logger loggers.Logger, res config.LoadCon
                Base:              all,
                LanguageConfigMap: langConfigMap,
                LoadingInfo:       res,
-               IsMultihost:       isMultiHost,
+               IsMultihost:       isMultihost,
        }
 
        return cm, nil
index 9971be65f08b8c6fe8815a95fcebdd829db8a6c1..900db75ce6abd7e0798acec8e7e3a0f5103afdc0 100644 (file)
@@ -52,7 +52,7 @@ func (c ConfigLanguage) LanguagePrefix() string {
                return c.Language().Lang
        }
 
-       if !c.IsMultiLingual() || c.DefaultContentLanguage() == c.Language().Lang {
+       if !c.IsMultilingual() || c.DefaultContentLanguage() == c.Language().Lang {
                return ""
        }
        return c.Language().Lang
@@ -78,7 +78,7 @@ func (c ConfigLanguage) FastRenderMode() bool {
        return c.config.Internal.FastRenderMode
 }
 
-func (c ConfigLanguage) IsMultiLingual() bool {
+func (c ConfigLanguage) IsMultilingual() bool {
        return len(c.m.Languages) > 1
 }
 
index 586a9b758fda2268510f2b951b5d0e5844a4e95f..8f74202abf2bd7a702215ba5d9bf92053905cbe6 100644 (file)
@@ -35,7 +35,7 @@ type AllProvider interface {
        PathParser() *paths.PathParser
        Environment() string
        IsMultihost() bool
-       IsMultiLingual() bool
+       IsMultilingual() bool
        NoBuildLock() bool
        BaseConfig() BaseConfig
        Dirs() CommonDirs
index 7914dda45e0714b384a24d17f895eab376c39922..22beea655e8fb6a6de0f8325152706c1a1d927bb 100644 (file)
@@ -508,12 +508,12 @@ func TestLoadConfigFromThemeDir(t *testing.T) {
 theme = "test-theme"
 
 [params]
-m1 = "mv1"     
+m1 = "mv1"
 `
 
        themeConfig := `
 [params]
-t1 = "tv1"     
+t1 = "tv1"
 t2 = "tv2"
 `
 
@@ -885,9 +885,9 @@ ThisIsAParam: {{ site.Params.thisIsAParam }}
        ).BuildE()
 
        b.Assert(err, qt.IsNil)
-       b.AssertFileContent("public/index.html", `              
+       b.AssertFileContent("public/index.html", `
 MyParam: enParamValue
-ThisIsAParam: thisIsAParamValue        
+ThisIsAParam: thisIsAParamValue
 `)
 }
 
@@ -919,7 +919,7 @@ title: "My Swedish Section"
 -- layouts/index.html --
 LanguageCode: {{ eq site.LanguageCode site.Language.LanguageCode }}|{{ site.Language.LanguageCode }}|
 {{ range $i, $e := (slice site .Site) }}
-{{ $i }}|AllPages: {{ len .AllPages }}|Sections: {{ if .Sections }}true{{ end }}| Author: {{ .Authors }}|BuildDrafts: {{ .BuildDrafts }}|IsMultiLingual: {{ .IsMultiLingual }}|Param: {{ .Language.Params.myparam }}|Language string: {{ .Language }}|Languages: {{ .Languages }}
+{{ $i }}|AllPages: {{ len .AllPages }}|Sections: {{ if .Sections }}true{{ end }}| Author: {{ .Authors }}|BuildDrafts: {{ .BuildDrafts }}|IsMultilingual: {{ .IsMultiLingual }}|Param: {{ .Language.Params.myparam }}|Language string: {{ .Language }}|Languages: {{ .Languages }}
 {{ end }}
 
 
@@ -939,9 +939,9 @@ LanguageCode: {{ eq site.LanguageCode site.Language.LanguageCode }}|{{ site.Lang
        b.AssertFileContent("public/index.html", `
 AllPages: 4|
 Sections: true|
-Param: enParamValue    
-Param: enParamValue    
-IsMultiLingual: true
+Param: enParamValue
+Param: enParamValue
+IsMultilingual: true
 LanguageCode: true|en-US|
 `)
 
@@ -1062,7 +1062,7 @@ Home
        ).BuildE()
 
        b.Assert(err, qt.IsNil)
-       b.AssertFileContent("public/index.html", `              
+       b.AssertFileContent("public/index.html", `
 Home
 `)
 
@@ -1095,7 +1095,7 @@ HTML.
 HTACCESS.
 
 
-       
+
 `
        b := Test(t, files)
 
@@ -1111,7 +1111,7 @@ languageCode = "en-US"
 -- layouts/index.html --
 LanguageCode: {{ .Site.LanguageCode }}|{{ site.Language.LanguageCode }}|
 
-       
+
 `
        b := Test(t, files)
 
@@ -1137,7 +1137,7 @@ suffixes = ["bar"]
 -- layouts/index.html --
 Home.
 
-       
+
 `
        b := Test(t, files)
 
@@ -1164,8 +1164,8 @@ func TestConfigMiscPanics(t *testing.T) {
 params:
 -- layouts/index.html --
 Foo: {{ site.Params.foo }}|
-       
-               
+
+
        `
                b := Test(t, files)
 
@@ -1188,8 +1188,8 @@ defaultContentLanguage = "en"
        weight = 1
 -- layouts/index.html --
 Foo: {{ site.Params.foo }}|
-       
-               
+
+
        `
                b, err := NewIntegrationTestBuilder(
                        IntegrationTestConfig{
@@ -1215,8 +1215,8 @@ languageCode = "en"
 languageName = "English"
 weight = 1
 
-       
-               
+
+
        `
                b, err := NewIntegrationTestBuilder(
                        IntegrationTestConfig{
@@ -1241,7 +1241,7 @@ contentDir = "mycontent"
 -- layouts/index.html --
 Home.
 
-       
+
 `
        b := Test(t, files)
 
@@ -1343,7 +1343,7 @@ disabled = true
 -- layouts/index.html --
 Home.
 
-       
+
 `
        b := Test(t, files)
 
@@ -1438,7 +1438,7 @@ home = ["html"]
 -- hugo.toml --
 baseURL = "https://example.com"
 disableKinds = ["taxonomy", "term", "RSS", "sitemap", "robotsTXT", "page", "section"]
-               
+
                `
 
                runVariant(t, files, nil)
index 7640786236856dbdf56c3e12f20e64ee71235d0f..906fced77d4148f32a9b11055b3b8cc31dc6a47d 100644 (file)
@@ -1778,7 +1778,7 @@ func (sa *sitePagesAssembler) addStandalonePages() error {
 
        if sitemapEnabled {
                addStandalone("/_sitemap", kinds.KindSitemap, output.SitemapFormat)
-               skipSitemapIndex := s.Conf.IsMultihost() || !(s.Conf.DefaultContentLanguageInSubdir() || s.Conf.IsMultiLingual())
+               skipSitemapIndex := s.Conf.IsMultihost() || !(s.Conf.DefaultContentLanguageInSubdir() || s.Conf.IsMultilingual())
 
                if !skipSitemapIndex {
                        addStandalone("/_sitemapindex", kinds.KindSitemapIndex, output.SitemapIndexFormat)
index 10b4a4cb296490b27087b2be524a76495fab3e4f..e3970938665f831a31f771d9e594b62bd5be85c5 100644 (file)
@@ -315,7 +315,7 @@ func TestStaticFs(t *testing.T) {
        checkFileContent(sfs, "f2.txt", c, "Hugo Themes Still Rocks!")
 }
 
-func TestStaticFsMultiHost(t *testing.T) {
+func TestStaticFsMultihost(t *testing.T) {
        c := qt.New(t)
        v := config.New()
        workDir := "mywork"
@@ -537,7 +537,7 @@ SCSS Match: {{ with resources.Match "**.scss" }}{{ . | len }}|{{ range .}}{{ .Re
 
        b := hugolib.Test(t, files)
 
-       b.AssertFileContent("public/index.html", `      
+       b.AssertFileContent("public/index.html", `
 SCSS: /scss/app.scss|body { color: blue; }|
 SCSS Match: 2|
 `)
index 99dc88b10a1f78d238c7de174a131cacfab88d2a..671785f448307289de5f210ac65b4f5b47a6f6a1 100644 (file)
@@ -269,7 +269,7 @@ func (h *HugoSites) pickOneAndLogTheRest(errors []error) error {
        return errors[i]
 }
 
-func (h *HugoSites) isMultiLingual() bool {
+func (h *HugoSites) isMultilingual() bool {
        return len(h.Sites) > 1
 }
 
index 4b779ee92164847b276d3e285b7992bc3b14754a..937166146fcffea2c11120887b238e481bc6b4cc 100644 (file)
@@ -66,12 +66,12 @@ robots|{{ site.Language.Lang }}
 404|{{ site.Language.Lang }}
 
 
-       
+
 `
 
        b := Test(t, files)
 
-       b.Assert(b.H.Conf.IsMultiLingual(), qt.Equals, true)
+       b.Assert(b.H.Conf.IsMultilingual(), qt.Equals, true)
        b.Assert(b.H.Conf.IsMultihost(), qt.Equals, true)
 
        // helpers.PrintFs(b.H.Fs.PublishDir, "", os.Stdout)
index 5a58e837318e70c53243c35f57efbb813ba9ab41..117e101442109364129c1323199253f9e9159319 100644 (file)
@@ -297,7 +297,6 @@ func (s *siteRefLinker) refLink(ref string, source any, relative bool, outputFor
        ref = filepath.ToSlash(ref)
 
        refURL, err = url.Parse(ref)
-
        if err != nil {
                return s.notFoundURL, err
        }
@@ -681,7 +680,7 @@ func (s *Site) getLanguagePermalinkLang(alwaysInSubDir bool) string {
                return ""
        }
 
-       if s.h.Conf.IsMultiLingual() && alwaysInSubDir {
+       if s.h.Conf.IsMultilingual() && alwaysInSubDir {
                return s.Language().Lang
        }
 
index 5a58119585b07848523137dbd0a6fc9b64354358..21d5ace96371ea5c77bdee8b8858816d737481d8 100644 (file)
@@ -484,10 +484,10 @@ func (s *Site) BuildDrafts() bool {
        return s.conf.BuildDrafts
 }
 
-// Deprecated: Use hugo.IsMultiLingual instead.
+// Deprecated: Use hugo.IsMultilingual instead.
 func (s *Site) IsMultiLingual() bool {
-       hugo.Deprecate(".Site.IsMultiLingual", "Use hugo.IsMultiLingual instead.", "v0.124.0")
-       return s.h.isMultiLingual()
+       hugo.Deprecate(".Site.IsMultiLingual", "Use hugo.IsMultilingual instead.", "v0.124.0")
+       return s.h.isMultilingual()
 }
 
 func (s *Site) LanguagePrefix() string {
index 1cf4b9a61b4ba1c39ca3c4e86e9f7d668d5f7369..86be897faf5e8a4d401f4f8fe8fdb28f93f2dea1 100644 (file)
@@ -334,7 +334,7 @@ func (s *Site) renderAliases() error {
 // renderMainLanguageRedirect creates a redirect to the main language home,
 // depending on if it lives in sub folder (e.g. /en) or not.
 func (s *Site) renderMainLanguageRedirect() error {
-       if s.h.Conf.IsMultihost() || !(s.h.Conf.DefaultContentLanguageInSubdir() || s.h.Conf.IsMultiLingual()) {
+       if s.h.Conf.IsMultihost() || !(s.h.Conf.DefaultContentLanguageInSubdir() || s.h.Conf.IsMultilingual()) {
                // No need for a redirect
                return nil
        }
index 62671613cf883bbfb322fdb73413b9feaa5ecb29..abb938ac0c404abaaee1484d30885b86a031d813 100644 (file)
@@ -86,7 +86,7 @@ func ApplyProjectConfigDefaults(mod Module, cfgs ...config.AllProvider) error {
 
                first := cfgs[0]
                dirsBase := first.DirsBase()
-               isMultiHost := first.IsMultihost()
+               isMultihost := first.IsMultihost()
 
                for i, cfg := range cfgs {
                        dirs := cfg.Dirs()
@@ -113,7 +113,7 @@ func ApplyProjectConfigDefaults(mod Module, cfgs ...config.AllProvider) error {
                                dir = dirs.AssetDir
                        case files.ComponentFolderStatic:
                                // For static dirs, we only care about the language in multihost setups.
-                               dropLang = !isMultiHost
+                               dropLang = !isMultihost
                        }
 
                        var perLang bool
index 3ab68e8af393455711de899f76fd0337a6afa7c7..dfb479d5ed9ab238d496d42199d878889268580f 100644 (file)
@@ -180,7 +180,7 @@ func (c testConfig) IsMultihost() bool {
        return c.multihost
 }
 
-func (c testConfig) IsMultiLingual() bool {
+func (c testConfig) IsMultilingual() bool {
        return c.multilingual
 }
 
index d9f3d967b8390f0fbb0a25ecfac564f1cac250d3..8f268091ff35c5e5c8f521cb357a11d6d6fe19b9 100644 (file)
@@ -126,7 +126,7 @@ type Site interface {
        // BuildDrafts is deprecated and will be removed in a future release.
        BuildDrafts() bool
 
-       // Deprecated: Use hugo.IsMultiLingual instead.
+       // Deprecated: Use hugo.IsMultilingual instead.
        IsMultiLingual() bool
 
        // LanguagePrefix returns the language prefix for this site.
@@ -292,7 +292,7 @@ func (s *siteWrapper) BuildDrafts() bool {
        return s.s.BuildDrafts()
 }
 
-// Deprecated: Use hugo.IsMultiLingual instead.
+// Deprecated: Use hugo.IsMultilingual instead.
 func (s *siteWrapper) IsMultiLingual() bool {
        return s.s.IsMultiLingual()
 }
@@ -453,7 +453,7 @@ func (s testSite) BuildDrafts() bool {
        return false
 }
 
-// Deprecated: Use hugo.IsMultiLingual instead.
+// Deprecated: Use hugo.IsMultilingual instead.
 func (s testSite) IsMultiLingual() bool {
        return false
 }