Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

environment configuration alias docs ($production, $development and $test) #25812

Closed
lassediercks opened this issue Feb 15, 2024 · 6 comments
Closed

environment configuration alias docs ($production, $development and $test) #25812

lassediercks opened this issue Feb 15, 2024 · 6 comments
Labels
3.x documentation good first issue

Comments

@lassediercks
Copy link
Contributor

lassediercks commented Feb 15, 2024 •
edited

In Getting Started with Unit Tests using $test is the suggested way of handling api requests.

@danielroe provided an example in a PR discussion but besides that there is no documentation about that feature

export default defineNuxtConfig({
  $test: {
    runtimeConfig: {
      apiBase: ''
    }
  }
})

image
@lassediercks lassediercks mentioned this issue Feb 15, 2024
Closed
9 tasks
@danielroe danielroe changed the title Missing Documentation for $test environment configuration alias support Feb 16, 2024
@danielroe danielroe changed the title environment configuration alias support environment configuration alias docs ($production, $development and $test) Feb 16, 2024
@IonianPlayboy IonianPlayboy mentioned this issue Mar 16, 2024
Open
4 tasks
@riddla
Copy link
Contributor

riddla commented May 8, 2024

There is some documentation over at https://github.com/unjs/c12#environment-specific-configuration. At least I think that this is the underlying feature used in the nuxt.config.

@manniL
Copy link
Member

manniL commented May 8, 2024

I agree that this should be covered in the docs though and not only in c12 or in video content 👍🏻

@manniL
Copy link
Member

manniL commented May 12, 2024

It is also documented in https://nuxt.com/docs/getting-started/configuration#environment-overrides, which should suffice. Feel free to point out what is missing if you disagree ☺️

@manniL manniL closed this as not planned Won't fix, can't repro, duplicate, stale May 12, 2024
@maartenvanhunsel
Copy link

@manniL is it possible to change the envname withing Nuxt? https://github.com/unjs/c12?tab=readme-ov-file#envname
For example I would like to use the NUXT_SITE_ENV variable to determine the environment.

@manniL
Copy link
Member

manniL commented May 15, 2024

@maartenvanhunsel follow along nuxt/cli#357 ☺️

lassediercks added a commit to lassediercks/nuxt that referenced this issue May 22, 2024
@lassediercks
docs: introduce hint and link to environment override feature (nuxt#2…
7febdf1 
…5812)
lassediercks added a commit to lassediercks/nuxt that referenced this issue May 22, 2024
@lassediercks
docs: introduce hint and link to environment override feature (nuxt#2…
da0711d 
…5812)
@lassediercks lassediercks mentioned this issue May 22, 2024
Merged
@lassediercks
Copy link
Contributor Author

I do agree that the environment overrides section does greatly document the feature.

Following my personal scenario: from a perspective of someone that explores the nuxt docs for the first time there is still not clear indication what $test is refering to
image

Here is my idea how to battle that: #27315

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
3.x documentation good first issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@riddla @manniL @lassediercks @maartenvanhunsel @danielroe @DamianGlowala