Skip to content

Conversation

@jamaluddinrumi
Copy link
Contributor

I'm just stumbled by runtime config must be prefixed with NITRO_ in .env file.

NITRO_PORT=3000
NITRO_BLA_BLA_BLA=BLA_BLA_BLA
NITRO_XXX=YYY
NITRO_ABC=DEF

I think it's a good idea to emphasize it in an alert component.

🔗 Linked issue

❓ Type of change

  • [ + ] 📖 Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

📝 Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

Added a warning note about variable prefixing in production.
@jamaluddinrumi jamaluddinrumi requested a review from pi0 as a code owner December 30, 2025 12:05
@vercel
Copy link

vercel bot commented Dec 30, 2025

@jamaluddinrumi is attempting to deploy a commit to the Nitro Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link

coderabbitai bot commented Dec 30, 2025

📝 Walkthrough

Walkthrough

Documentation update to the configuration guide. The Production section now wraps existing guidance about NITRO_ prefixed environment variables in a warning block and introduces a clarifying note about key naming conventions between runtime config (camelCase) and environment variables (snake_case with uppercase).

Changes

Cohort / File(s) Summary
Documentation updates
docs/1.docs/50.configuration.md
Wrapped NITRO_ environment variable guidance in warning block; added clarification note on naming conventions (camelCase for runtime config vs. snake_case uppercase for environment variables)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description check ✅ Passed The pull request description is related to the changeset, explaining the motivation for emphasizing the NITRO_ prefix requirement with concrete examples.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title follows conventional commits format with 'docs' scope and clearly describes the main change of emphasizing the NITRO_ environment variable prefix requirement in the documentation.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@pi0 pi0 changed the title Clarify variable prefix requirements for production docs(runtime-config): clarify variable prefix requirements for production Dec 30, 2025
Copy link
Member

@pi0 pi0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thnx!

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/1.docs/50.configuration.md (1)

97-98: Minor grammar issue in variable naming explanation.

The phrasing "define key using camelCase" is awkward. Consider rephrasing to "define keys using camelCase" (plural) or "define the key using camelCase" (singular with article).

🔎 Suggested revision
-In runtime config, define key using camelCase. In environment variables, define key using snake_case and uppercase.
+In runtime config, define keys using camelCase. In environment variables, define keys using snake_case and uppercase.
📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1a1198e and 98a8fc6.

📒 Files selected for processing (1)
  • docs/1.docs/50.configuration.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: tests-rollup (windows-latest)
  • GitHub Check: tests-rollup (ubuntu-latest)
  • GitHub Check: tests-rolldown (windows-latest)
🔇 Additional comments (1)
docs/1.docs/50.configuration.md (1)

87-107: Documentation improvement clearly conveys the NITRO_ prefix requirement.

The warning block effectively highlights the critical prefix requirement, and the camelCase-to-snake_case naming examples are helpful. The update addresses the PR objective well.

@pi0 pi0 changed the title docs(runtime-config): clarify variable prefix requirements for production docs(runtime-config): clarify NITRO_ prefix requirement Dec 30, 2025
@pi0 pi0 changed the title docs(runtime-config): clarify NITRO_ prefix requirement docs(runtime-config): emphasize NITRO_ env prefix requirement Dec 30, 2025
@pi0 pi0 merged commit 9e2ab3f into nitrojs:main Dec 30, 2025
7 of 8 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.

2 participants