Language Select incorrectly appends locale when switching index pages

[kevinzunigacuellar]

What version of starlight are you using?

0.17

What version of astro are you using?

4.2.6

What package manager are you using?

pnpm

What operating system are you using?

Mac

What browser are you using?

Chrome

Describe the Bug

Using different locales (en,es) and setting my build to format file. My index page is located in en.html and es.html respectively.

When switching from one language to the other using the select element, it incorrectly adds a locale in front of my route instead of replacing the route.

Current behavior ❌

When going from es to en:

es.html -> en/es.html

When going from en to es:

en.html -> es/en.html

Expected behavior ✅

en.html -> es.html and viceversa

Link to Minimal Reproducible Example

https://github.com/kevinzunigacuellar/bug-language-pick

Participation

• I am willing to submit a pull request for this issue.

[delucis]

Thanks for finding this @kevinzunigacuellar! I can confirm I see this in the build output of your reproduction. The language picker produces the following HTML:

<select value="/en/en.html">
	<option value="/en/en.html" selected="true">English</option>
	<option value="/es/en.html">Spanish</option>
</select>

value is set here:

starlight/packages/starlight/components/LanguageSelect.astro

Line 23 in 4b09814

value={localizedPathname(Astro.props.locale)}

So this would be a bug in the localizedPathname() function.

Are you up for Even More Fun With URLs™️?

[kevinzunigacuellar]

Happy to tackle this if we have no other takers. I will leave it open if anyone is interested.

[delucis]

Thanks @kevinzunigacuellar! I tried writing a few tests on the train earlier and the one thing I realised I'm not sure about with sites using build.output: 'file' is what they do for the homepage, like is it example.com/index.html? Or would they expect to special case that as example.com/? I'm honestly not sure what expectations are.

[kevinzunigacuellar]

I think they would expect example.com/index.html. example.com/ would probably redirect to example.com/index.html

[delucis]

I think we can definitely take that as our working hypothesis.

I'm still feeling like our use of build.format as also determining link format may not be what everyone wants, but I think it's ok for us to get this consistent at this point and think about that later when we hear from folks what they need.