Skip to content

chore: clean up .env.example comment formatting + empty values#2581

Merged
serhalp merged 2 commits intonpmx-dev:mainfrom
iiio2:chore/clean-up-env-example
Apr 20, 2026
Merged

chore: clean up .env.example comment formatting + empty values#2581
serhalp merged 2 commits intonpmx-dev:mainfrom
iiio2:chore/clean-up-env-example

Conversation

@iiio2
Copy link
Copy Markdown
Contributor

@iiio2 iiio2 commented Apr 19, 2026

I think it is looking slightly beautiful.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 19, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
npmx.dev Ready Ready Preview, Comment Apr 20, 2026 0:49am
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
docs.npmx.dev Ignored Ignored Preview Apr 20, 2026 0:49am
npmx-lunaria Ignored Ignored Apr 20, 2026 0:49am

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 19, 2026

📝 Walkthrough

Summary by CodeRabbit

  • Chores
    • Improved example environment configuration comments for session password and image proxy secret for clarity and consistency.
    • Adjusted formatting to ensure the example file ends with a newline.

Walkthrough

Updated .env.example comment formatting for NUXT_SESSION_PASSWORD and NUXT_IMAGE_PROXY_SECRET: added a leading space in comment lines, wrapped the openssl rand -hex 32 instruction in backticks, and ensured the file ends with a newline; no environment variable names or values were changed.

Changes

Cohort / File(s) Summary
Environment Configuration
​.env.example
Adjusted comment text for NUXT_SESSION_PASSWORD and NUXT_IMAGE_PROXY_SECRET (added leading space, wrapped openssl rand -hex 32 in backticks) and ensured trailing newline; no functional changes to variable names or values.
🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: cleaning up comment formatting and empty values in .env.example.
Description check ✅ Passed The description is minimal but related to the changeset, referring to aesthetic improvements to the .env.example file.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

Copy link
Copy Markdown
Contributor

@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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.env.example:
- Line 5: The .env.example is missing a trailing blank newline causing
dotenv-linter failure; add a single empty line at the end of the file (after the
NUXT_IMAGE_PROXY_SECRET= line) so the file ends with one final newline character
to satisfy dotenv-linter.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b9ec8bc3-c802-4ace-8ddf-5b3ddf6b3d03

📥 Commits

Reviewing files that changed from the base of the PR and between 400ddf8 and b6824a8.

📒 Files selected for processing (1)
  • .env.example

Comment thread .env.example Outdated
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

Copy link
Copy Markdown
Contributor

@ghostdevv ghostdevv left a comment

Choose a reason for hiding this comment

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

I think the quotes should stay, as they can help prevent issues with parsing!

@serhalp serhalp self-requested a review April 20, 2026 00:46
@serhalp serhalp dismissed ghostdevv’s stale review April 20, 2026 00:48

I addressed the feedback myself

@serhalp serhalp enabled auto-merge April 20, 2026 00:48
Copy link
Copy Markdown
Contributor

@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.

🧹 Nitpick comments (1)
.env.example (1)

2-2: dotenv-linter QuoteCharacter warnings can be safely ignored.

The static analysis tool flags the empty quoted strings (""), but this is a false positive. Using "" in .env.example files is a common and valid pattern to show users the expected string format whilst keeping the example value empty.

If you prefer to silence the linter warnings, you could remove the quotes entirely (leaving just NUXT_SESSION_PASSWORD=), but the current format is equally valid and perhaps clearer for users.

Also applies to: 5-5

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.env.example at line 2, The linter flags the empty quoted value for
NUXT_SESSION_PASSWORD in .env.example; to silence warnings either remove the
quotes so the line reads NUXT_SESSION_PASSWORD= or add a dotenv-linter
disable/ignore directive above the line, but keep the variable name
NUXT_SESSION_PASSWORD unchanged so the example still documents the expected key.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.env.example:
- Line 2: The linter flags the empty quoted value for NUXT_SESSION_PASSWORD in
.env.example; to silence warnings either remove the quotes so the line reads
NUXT_SESSION_PASSWORD= or add a dotenv-linter disable/ignore directive above the
line, but keep the variable name NUXT_SESSION_PASSWORD unchanged so the example
still documents the expected key.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b58d91c2-ad5c-4593-b106-d407d9aaaf36

📥 Commits

Reviewing files that changed from the base of the PR and between b6824a8 and 6f3ff55.

📒 Files selected for processing (1)
  • .env.example

@serhalp serhalp added this pull request to the merge queue Apr 20, 2026
Merged via the queue into npmx-dev:main with commit fecb36c Apr 20, 2026
21 checks passed
@iiio2
Copy link
Copy Markdown
Contributor Author

iiio2 commented Apr 20, 2026

Thanks @serhalp , @ghostdevv 😊

@iiio2 iiio2 deleted the chore/clean-up-env-example branch April 20, 2026 03:39
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