Implements build.format: 'preserve'

[matthewp]

Changes

• This replaces Write index routes as index.html with build.format: 'file' #9209
• Adds a new build.format: 'preserve' option to preserve the file system structure in src/ over in dist/

Testing

New test cases added

Docs

• Types are updated in this PR
• No other docs on this (I think)

[changeset-bot]

🦋 Changeset detected

Latest commit: 7b929e2

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

[Princesseuh]

This looks fine to me!

[ematipico]

Can you add more test cases with:

• trailingSlash set to always
• base set to something

[matthewp]

@ematipico I added a test for base.

I don't think trailingSlash has any impact on this feature. If you use trailingSlash: 'always' then you essentially have to use page/index.astro and never page.astro, since the latter would 404. build.format is really only a feature of the build and controls how files are written out in SSG mode. I'd be happy to add more tests but I can't think of what I would be testing.

[ematipico]

@matthewp that's true and I agree with you, although we added a new branching logic inside the function shouldAppendForwardSlash, which is a function that is used in many places of our code base.

So for the sake of code coverage, I'd like to see at least one test that covers this case.

[matthewp]

@ematipico The shouldAppendForwardSlash is only used in the build for displaying the pageName. It's used in i18n as well, so should I add an i18n test as well? The build format is only taken into account with trailingSlash: 'ignore'.

[firxworx]

Regarding discussion on trailingSlash note current issue impacting dev server vs. build behaviour: #9674

[ematipico]

Thank you @matthewp ! Happy to merge it

[sarah11918]

Thanks @matthewp ! I left a suggestion for each of the changeset and the docs to see if we could make this super explicit about what's going on. Obviously, check that this is correct, but see if my suggestions make sense, or give you ideas for more explicitly laying out the difference (especially between file and preserve, which took the most work to really make clear, I think.)

[ematipico]

Hey @sarah11918, I reviewed your suggestions, and they seemed very sound to me. I merged them! Thank you

[sarah11918]

Just correcting three tiny punctuation/conjunction nits, but approved by docs! 🥳

[matthewp]

Edits look good to me, thanks @sarah11918 !

Merge day