adding a new flag --mode for dev and pro

[JerryWu1234]

Changes

Fix #6575
adding a new --mode flag for dev and pro.
such as dev pnpm run dev --mode=test
such as build pnpm run pnpm --mode=test

Testing

Docs

[changeset-bot]

🦋 Changeset detected

Latest commit: 22f8e79

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

[ematipico]

Things that we should cover before merging the PR:

• add the new flag to the CLI (help section);
• make some manual testing check via CLI to make sure it works;
• make sure that this new flag is documented in docs.astro.build

[sarah11918]

Just a heads up that if we're adding a new flag to the CLI, we would also need to document it here: https://docs.astro.build/en/reference/cli-reference/

[JerryWu1234]

Things that we should cover before merging the PR:

• make some manual testing check via CLI to make sure it works;

What are you referring to recording a video?

[ematipico]

Things that we should cover before merging the PR:

• make some manual testing check via CLI to make sure it works;

What are you referring to recording a video?

It's not necessary unless you want to! Just a mention that you manually tested your new change I think it's enough!

We don't test the CLI directly in our testing suite, so it's always best to test it locally to ensure it works as expected.

[JerryWu1234]

Things that we should cover before merging the PR:

• make some manual testing check via CLI to make sure it works;

What are you referring to recording a video?

It's not necessary unless you want to! Just a mention that you manually tested your new change I think it's enough!

We don't test the CLI directly in our testing suite, so it's always best to test it locally to ensure it works as expected.

I got it, of course I did

[ematipico]

I got it, of course I did

Good to know :) next time you can add this information in the template, under the "Testing" section

[matthewp]

This would be a minor change.

[ematipico]

Looks good to me! We keep it blocked until we are ready release a new minor. @wulinsheng123 Did you create a PR in the docs repo with the new flag?

[JerryWu1234]

Looks good to me! We keep it blocked until we are ready release a new minor. @wulinsheng123 Did you create a PR in the docs repo with the new flag?
ok

[sarah11918]

Just checking in on whether this is planned to be accepted.

An issue has been filed in the docs repo simply stating that we will need documentation to accompany this, but no documentation has been proposed. (Issue: withastro/docs#3024 )

Docs can step in and propose documentation, but we'd rather know that this is going to be accepted first before we do that. 😄

[ematipico]

Happy to merge! @wulinsheng123 could you please update the PR? There's a file that has conflicts

[matthewp]

Let's hold off on this one for now. I would like to understand the use-case better. It appears to set some internal code that was never intended to be exposed externally.

[JerryWu1234]

Let's hold off on this one for now. I would like to understand the use-case better. It appears to set some internal code that was never intended to be exposed externally.

Ok, if there is any progress, please tell me because I need to resolve a conflict.

[Princesseuh]

@matthewp Have you had time to revisit this?

[bluwy]

I was probably the one who pushed for it, as I've seen this work on & off in the past in Astro. I think it makes sense to support custom --mode so users can e.g. build a site for staging mode.

I notice in Astro internals, we only differentiate between development and production mode, so we'd probably have to be careful that e.g. staging mode still builds in production mode. At retrospect maybe this should be discussed first 😬

[ematipico]

I was probably the one who pushed for it, as I've seen this work on & off in the past in Astro. I think it makes sense to support custom --mode so users can e.g. build a site for staging mode.

I notice in Astro internals, we only differentiate between development and production mode, so we'd probably have to be careful that e.g. staging mode still builds in production mode. At retrospect maybe this should be discussed first 😬

I see the use case, but Astro is a bit different and we need to clearly set user expectations of what a --mode is. As far as I understand, development mode is the actual dev server, which differs from the actual production where the pages are actually built into static files (or SSR).

So if the user set a --mode=STAGING, what is it going to affect? What's the expected result in the dev server and in the built artefacts?

[bluwy]

Largely (and maybe only?) it'll affect the value of import.meta.env.MODE which can be used to render things differently. If --mode=staging, I'd expect the dev server to still run in development but with a different import.meta.env.MODE, similarly in build it runs in production with a different import.meta.env.MODE.

The mode name is a bit overloaded with this now though, maybe we should refer --mode as userMode that's used to achieve import.meta.env.MODE and passing that value to Vite's mode.

[matthewp]

Given there's still some unknowns of how/if this should work, I think this warrants a (probably small) RFC where we work through the ideas. We can then reopen this PR if it turns out to be the approach chosen.