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.

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

docs: env file #12330

Merged
merged 1 commit into from
Apr 29, 2024
Merged

docs: env file #12330

merged 1 commit into from
Apr 29, 2024

Conversation

fz6m
Copy link
Contributor

@fz6m fz6m commented Apr 25, 2024

貌似我犯了一个错误,.env.development 这种形式的环境变量是不支持的。

Summary by CodeRabbit

  • Documentation
    • Updated guides on configuring environment variables, shifting from .env.development and .env.production files to using cross-env in start commands or defining values in Umi configuration files.

Copy link

vercel bot commented Apr 25, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
umi ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 25, 2024 6:28pm

Copy link

coderabbitai bot commented Apr 25, 2024

Walkthrough

The update shifts the method of configuring environment variables in Umi projects. Instead of using separate .env files for different development stages, it now encourages the use of cross-env in start commands or direct definitions in Umi configuration files based on UMI_ENV.

Changes

File Path Change Summary
docs/.../env-variables.md Transitioned from .env.development / .env.production to using cross-env and UMI_ENV based configurations.

🐇✨
In the land of code, where the bits align,
A rabbit hopped through, with a change so fine.
No more juggling dots, in files so vast,
Just a simple switch, and it's changed so fast.
Hop, hop, hooray! The code is clear, 🎉
With Umi's new way, we all cheer!


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 9d160fc and 3e457e5.
Files selected for processing (1)
  • docs/docs/docs/guides/env-variables.md (1 hunks)
Files not reviewed due to errors (1)
  • docs/docs/docs/guides/env-variables.md (no review received)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Wxh16144
Copy link
Member

既然文档都放出去了,注意到之前有人提过类似的 issues?不如直接支持一下更好 🤔

import { existsSync, readFileSync } from 'fs';
import { join as PATH_join } from 'path';
import { parse } from '../../compiled/dotenv';
import { expand } from '../../compiled/dotenv-expand';

export function loadEnv(opts: { cwd: string; envFile: string }) {
  const join = (...args: string[]) => PATH_join(opts.cwd, ...args);

  const files = [
    join(opts.envFile),
    join(`${opts.envFile}.local`),
    process.env.NODE_ENV && join(`${opts.envFile}.${process.env.NODE_ENV}`),
    process.env.NODE_ENV && join(`${opts.envFile}.${process.env.NODE_ENV}.local`),
  ].filter(Boolean) as string[];

  for (const file of files) {
    if (!existsSync(file)) continue;
    const parsed: Record<string, string> = parse(readFileSync(file)) || {};
    expand({ parsed, ignoreProcessEnv: true });
    for (const key of Object.keys(parsed)) {
      process.env[key] = parsed[key];
    }
  }
}

@sorrycc sorrycc merged commit 575590e into umijs:master Apr 29, 2024
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants