Skip to content

Commit dc6a292

Browse files
jmooringbep
jmooring
authored and
bep
committed
common/hugo: Rename IsMultiHost and IsMultiLingual
hugo.IsMultiHost => hugo.IsMultihost hugo.IsMultiLingual => hugo.IsMultilingual Closes gohugoio#12232
1 parent 4f92f94 commit dc6a292

18 files changed

+66
-62
lines changed

‎commands/server.go

+6-7
Original file line numberDiff line numberDiff line change
@@ -617,9 +617,9 @@ func (c *serverCommand) setBaseURLsInConfig() error {
617617
}
618618
return c.withConfE(func(conf *commonConfig) error {
619619
for i, language := range conf.configs.Languages {
620-
isMultiHost := conf.configs.IsMultihost
620+
isMultihost := conf.configs.IsMultihost
621621
var serverPort int
622-
if isMultiHost {
622+
if isMultihost {
623623
serverPort = c.serverPorts[i].p
624624
} else {
625625
serverPort = c.serverPorts[0].p
@@ -737,9 +737,9 @@ func (c *serverCommand) createServerPorts(cd *simplecobra.Commandeer) error {
737737
flags := cd.CobraCommand.Flags()
738738
var cerr error
739739
c.withConf(func(conf *commonConfig) {
740-
isMultiHost := conf.configs.IsMultihost
740+
isMultihost := conf.configs.IsMultihost
741741
c.serverPorts = make([]serverPortListener, 1)
742-
if isMultiHost {
742+
if isMultihost {
743743
if !c.serverAppend {
744744
cerr = errors.New("--appendPort=false not supported when in multihost mode")
745745
return
@@ -852,7 +852,7 @@ func (c *serverCommand) serve() error {
852852
h *hugolib.HugoSites
853853
)
854854
err := c.withConfE(func(conf *commonConfig) error {
855-
isMultiHost := conf.configs.IsMultihost
855+
isMultihost := conf.configs.IsMultihost
856856
var err error
857857
h, err = c.r.HugFromConfig(conf)
858858
if err != nil {
@@ -862,7 +862,7 @@ func (c *serverCommand) serve() error {
862862
// We need the server to share the same logger as the Hugo build (for error counts etc.)
863863
c.r.logger = h.Log
864864

865-
if isMultiHost {
865+
if isMultihost {
866866
for _, l := range conf.configs.ConfigLangs() {
867867
baseURLs = append(baseURLs, l.BaseURL())
868868
roots = append(roots, l.Language().Lang)
@@ -1005,7 +1005,6 @@ func (c *serverCommand) serve() error {
10051005
}
10061006
}
10071007
}()
1008-
10091008
if err != nil {
10101009
c.r.Println("Error:", err)
10111010
}

‎common/hugo/hugo.go

+11-5
Original file line numberDiff line numberDiff line change
@@ -111,14 +111,20 @@ func (i HugoInfo) Deps() []*Dependency {
111111
return i.deps
112112
}
113113

114-
// IsMultiHost reports whether each configured language has a unique baseURL.
114+
// Deprecated: Use hugo.IsMultihost instead.
115115
func (i HugoInfo) IsMultiHost() bool {
116+
Deprecate("hugo.IsMultiHost", "Use hugo.IsMultihost instead.", "v0.124.0")
116117
return i.conf.IsMultihost()
117118
}
118119

119-
// IsMultiLingual reports whether there are two or more configured languages.
120-
func (i HugoInfo) IsMultiLingual() bool {
121-
return i.conf.IsMultiLingual()
120+
// IsMultihost reports whether each configured language has a unique baseURL.
121+
func (i HugoInfo) IsMultihost() bool {
122+
return i.conf.IsMultihost()
123+
}
124+
125+
// IsMultilingual reports whether there are two or more configured languages.
126+
func (i HugoInfo) IsMultilingual() bool {
127+
return i.conf.IsMultilingual()
122128
}
123129

124130
// ConfigProvider represents the config options that are relevant for HugoInfo.
@@ -127,7 +133,7 @@ type ConfigProvider interface {
127133
Running() bool
128134
WorkingDir() string
129135
IsMultihost() bool
130-
IsMultiLingual() bool
136+
IsMultilingual() bool
131137
}
132138

133139
// NewInfo creates a new Hugo Info object.

‎common/hugo/hugo_integration_test.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import (
2020
"github.com/gohugoio/hugo/hugolib"
2121
)
2222

23-
func TestIsMultiLingualAndIsMultiHost(t *testing.T) {
23+
func TestIsMultilingualAndIsMultihost(t *testing.T) {
2424
t.Parallel()
2525

2626
files := `
@@ -36,8 +36,8 @@ baseURL = 'https://en.example.org/'
3636
title: home
3737
---
3838
-- layouts/index.html --
39-
multilingual={{ hugo.IsMultiLingual }}
40-
multihost={{ hugo.IsMultiHost }}
39+
multilingual={{ hugo.IsMultilingual }}
40+
multihost={{ hugo.IsMultihost }}
4141
`
4242

4343
b := hugolib.Test(t, files)

‎common/hugo/hugo_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,6 @@ func (c testConfig) IsMultihost() bool {
8888
return c.multihost
8989
}
9090

91-
func (c testConfig) IsMultiLingual() bool {
91+
func (c testConfig) IsMultilingual() bool {
9292
return c.multilingual
9393
}

‎config/allconfig/allconfig.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -826,7 +826,7 @@ func fromLoadConfigResult(fs afero.Fs, logger loggers.Logger, res config.LoadCon
826826
langConfigMap := make(map[string]*Config)
827827

828828
languagesConfig := cfg.GetStringMap("languages")
829-
var isMultiHost bool
829+
var isMultihost bool
830830

831831
if err := all.CompileConfig(logger); err != nil {
832832
return nil, err
@@ -863,7 +863,7 @@ func fromLoadConfigResult(fs afero.Fs, logger loggers.Logger, res config.LoadCon
863863
}
864864
if kk == "baseurl" {
865865
// baseURL configure don the language level is a multihost setup.
866-
isMultiHost = true
866+
isMultihost = true
867867
}
868868
mergedConfig.Set(kk, vv)
869869
rootv := cfg.Get(kk)
@@ -913,7 +913,7 @@ func fromLoadConfigResult(fs afero.Fs, logger loggers.Logger, res config.LoadCon
913913
}
914914

915915
// Adjust Goldmark config defaults for multilingual, single-host sites.
916-
if len(languagesConfig) > 1 && !isMultiHost && !clone.Markup.Goldmark.DuplicateResourceFiles {
916+
if len(languagesConfig) > 1 && !isMultihost && !clone.Markup.Goldmark.DuplicateResourceFiles {
917917
if !clone.Markup.Goldmark.DuplicateResourceFiles {
918918
if clone.Markup.Goldmark.RenderHooks.Link.EnableDefault == nil {
919919
clone.Markup.Goldmark.RenderHooks.Link.EnableDefault = types.NewBool(true)
@@ -943,7 +943,7 @@ func fromLoadConfigResult(fs afero.Fs, logger loggers.Logger, res config.LoadCon
943943
Base: all,
944944
LanguageConfigMap: langConfigMap,
945945
LoadingInfo: res,
946-
IsMultihost: isMultiHost,
946+
IsMultihost: isMultihost,
947947
}
948948

949949
return cm, nil

‎config/allconfig/configlanguage.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ func (c ConfigLanguage) LanguagePrefix() string {
5252
return c.Language().Lang
5353
}
5454

55-
if !c.IsMultiLingual() || c.DefaultContentLanguage() == c.Language().Lang {
55+
if !c.IsMultilingual() || c.DefaultContentLanguage() == c.Language().Lang {
5656
return ""
5757
}
5858
return c.Language().Lang
@@ -78,7 +78,7 @@ func (c ConfigLanguage) FastRenderMode() bool {
7878
return c.config.Internal.FastRenderMode
7979
}
8080

81-
func (c ConfigLanguage) IsMultiLingual() bool {
81+
func (c ConfigLanguage) IsMultilingual() bool {
8282
return len(c.m.Languages) > 1
8383
}
8484

‎config/configProvider.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ type AllProvider interface {
3535
PathParser() *paths.PathParser
3636
Environment() string
3737
IsMultihost() bool
38-
IsMultiLingual() bool
38+
IsMultilingual() bool
3939
NoBuildLock() bool
4040
BaseConfig() BaseConfig
4141
Dirs() CommonDirs

‎hugolib/config_test.go

+21-21
Original file line numberDiff line numberDiff line change
@@ -508,12 +508,12 @@ func TestLoadConfigFromThemeDir(t *testing.T) {
508508
theme = "test-theme"
509509
510510
[params]
511-
m1 = "mv1"
511+
m1 = "mv1"
512512
`
513513

514514
themeConfig := `
515515
[params]
516-
t1 = "tv1"
516+
t1 = "tv1"
517517
t2 = "tv2"
518518
`
519519

@@ -885,9 +885,9 @@ ThisIsAParam: {{ site.Params.thisIsAParam }}
885885
).BuildE()
886886

887887
b.Assert(err, qt.IsNil)
888-
b.AssertFileContent("public/index.html", `
888+
b.AssertFileContent("public/index.html", `
889889
MyParam: enParamValue
890-
ThisIsAParam: thisIsAParamValue
890+
ThisIsAParam: thisIsAParamValue
891891
`)
892892
}
893893

@@ -919,7 +919,7 @@ title: "My Swedish Section"
919919
-- layouts/index.html --
920920
LanguageCode: {{ eq site.LanguageCode site.Language.LanguageCode }}|{{ site.Language.LanguageCode }}|
921921
{{ range $i, $e := (slice site .Site) }}
922-
{{ $i }}|AllPages: {{ len .AllPages }}|Sections: {{ if .Sections }}true{{ end }}| Author: {{ .Authors }}|BuildDrafts: {{ .BuildDrafts }}|IsMultiLingual: {{ .IsMultiLingual }}|Param: {{ .Language.Params.myparam }}|Language string: {{ .Language }}|Languages: {{ .Languages }}
922+
{{ $i }}|AllPages: {{ len .AllPages }}|Sections: {{ if .Sections }}true{{ end }}| Author: {{ .Authors }}|BuildDrafts: {{ .BuildDrafts }}|IsMultilingual: {{ .IsMultiLingual }}|Param: {{ .Language.Params.myparam }}|Language string: {{ .Language }}|Languages: {{ .Languages }}
923923
{{ end }}
924924
925925
@@ -939,9 +939,9 @@ LanguageCode: {{ eq site.LanguageCode site.Language.LanguageCode }}|{{ site.Lang
939939
b.AssertFileContent("public/index.html", `
940940
AllPages: 4|
941941
Sections: true|
942-
Param: enParamValue
943-
Param: enParamValue
944-
IsMultiLingual: true
942+
Param: enParamValue
943+
Param: enParamValue
944+
IsMultilingual: true
945945
LanguageCode: true|en-US|
946946
`)
947947

@@ -1062,7 +1062,7 @@ Home
10621062
).BuildE()
10631063

10641064
b.Assert(err, qt.IsNil)
1065-
b.AssertFileContent("public/index.html", `
1065+
b.AssertFileContent("public/index.html", `
10661066
Home
10671067
`)
10681068

@@ -1095,7 +1095,7 @@ HTML.
10951095
HTACCESS.
10961096
10971097
1098-
1098+
10991099
`
11001100
b := Test(t, files)
11011101

@@ -1111,7 +1111,7 @@ languageCode = "en-US"
11111111
-- layouts/index.html --
11121112
LanguageCode: {{ .Site.LanguageCode }}|{{ site.Language.LanguageCode }}|
11131113
1114-
1114+
11151115
`
11161116
b := Test(t, files)
11171117

@@ -1137,7 +1137,7 @@ suffixes = ["bar"]
11371137
-- layouts/index.html --
11381138
Home.
11391139
1140-
1140+
11411141
`
11421142
b := Test(t, files)
11431143

@@ -1164,8 +1164,8 @@ func TestConfigMiscPanics(t *testing.T) {
11641164
params:
11651165
-- layouts/index.html --
11661166
Foo: {{ site.Params.foo }}|
1167-
1168-
1167+
1168+
11691169
`
11701170
b := Test(t, files)
11711171

@@ -1188,8 +1188,8 @@ defaultContentLanguage = "en"
11881188
weight = 1
11891189
-- layouts/index.html --
11901190
Foo: {{ site.Params.foo }}|
1191-
1192-
1191+
1192+
11931193
`
11941194
b, err := NewIntegrationTestBuilder(
11951195
IntegrationTestConfig{
@@ -1215,8 +1215,8 @@ languageCode = "en"
12151215
languageName = "English"
12161216
weight = 1
12171217
1218-
1219-
1218+
1219+
12201220
`
12211221
b, err := NewIntegrationTestBuilder(
12221222
IntegrationTestConfig{
@@ -1241,7 +1241,7 @@ contentDir = "mycontent"
12411241
-- layouts/index.html --
12421242
Home.
12431243
1244-
1244+
12451245
`
12461246
b := Test(t, files)
12471247

@@ -1343,7 +1343,7 @@ disabled = true
13431343
-- layouts/index.html --
13441344
Home.
13451345
1346-
1346+
13471347
`
13481348
b := Test(t, files)
13491349

@@ -1438,7 +1438,7 @@ home = ["html"]
14381438
-- hugo.toml --
14391439
baseURL = "https://example.com"
14401440
disableKinds = ["taxonomy", "term", "RSS", "sitemap", "robotsTXT", "page", "section"]
1441-
1441+
14421442
`
14431443

14441444
runVariant(t, files, nil)

‎hugolib/content_map_page.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1778,7 +1778,7 @@ func (sa *sitePagesAssembler) addStandalonePages() error {
17781778

17791779
if sitemapEnabled {
17801780
addStandalone("/_sitemap", kinds.KindSitemap, output.SitemapFormat)
1781-
skipSitemapIndex := s.Conf.IsMultihost() || !(s.Conf.DefaultContentLanguageInSubdir() || s.Conf.IsMultiLingual())
1781+
skipSitemapIndex := s.Conf.IsMultihost() || !(s.Conf.DefaultContentLanguageInSubdir() || s.Conf.IsMultilingual())
17821782

17831783
if !skipSitemapIndex {
17841784
addStandalone("/_sitemapindex", kinds.KindSitemapIndex, output.SitemapIndexFormat)

‎hugolib/filesystems/basefs_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ func TestStaticFs(t *testing.T) {
315315
checkFileContent(sfs, "f2.txt", c, "Hugo Themes Still Rocks!")
316316
}
317317

318-
func TestStaticFsMultiHost(t *testing.T) {
318+
func TestStaticFsMultihost(t *testing.T) {
319319
c := qt.New(t)
320320
v := config.New()
321321
workDir := "mywork"
@@ -537,7 +537,7 @@ SCSS Match: {{ with resources.Match "**.scss" }}{{ . | len }}|{{ range .}}{{ .Re
537537

538538
b := hugolib.Test(t, files)
539539

540-
b.AssertFileContent("public/index.html", `
540+
b.AssertFileContent("public/index.html", `
541541
SCSS: /scss/app.scss|body { color: blue; }|
542542
SCSS Match: 2|
543543
`)

‎hugolib/hugo_sites.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ func (h *HugoSites) pickOneAndLogTheRest(errors []error) error {
269269
return errors[i]
270270
}
271271

272-
func (h *HugoSites) isMultiLingual() bool {
272+
func (h *HugoSites) isMultilingual() bool {
273273
return len(h.Sites) > 1
274274
}
275275

‎hugolib/hugo_sites_multihost_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,12 @@ robots|{{ site.Language.Lang }}
6666
404|{{ site.Language.Lang }}
6767
6868
69-
69+
7070
`
7171

7272
b := Test(t, files)
7373

74-
b.Assert(b.H.Conf.IsMultiLingual(), qt.Equals, true)
74+
b.Assert(b.H.Conf.IsMultilingual(), qt.Equals, true)
7575
b.Assert(b.H.Conf.IsMultihost(), qt.Equals, true)
7676

7777
// helpers.PrintFs(b.H.Fs.PublishDir, "", os.Stdout)

‎hugolib/site.go

+1-2
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,6 @@ func (s *siteRefLinker) refLink(ref string, source any, relative bool, outputFor
297297
ref = filepath.ToSlash(ref)
298298

299299
refURL, err = url.Parse(ref)
300-
301300
if err != nil {
302301
return s.notFoundURL, err
303302
}
@@ -681,7 +680,7 @@ func (s *Site) getLanguagePermalinkLang(alwaysInSubDir bool) string {
681680
return ""
682681
}
683682

684-
if s.h.Conf.IsMultiLingual() && alwaysInSubDir {
683+
if s.h.Conf.IsMultilingual() && alwaysInSubDir {
685684
return s.Language().Lang
686685
}
687686

0 commit comments

Comments
 (0)