Unify slogan by yamcodes · Pull Request #647 · yamcodes/arkenv

yamcodes · 2025-12-27T12:37:55Z

Unify the slogan to be "Environment variable validation from editor to runtime" everywhere

Summary by CodeRabbit

Documentation
- Updated product messaging across the homepage and README: changed wording to "Environment variable validation from editor to runtime" (replacing prior "Typesafe...") for clearer communication of env-var validation capabilities. These are textual/metadata edits only with no behavioral or functional changes.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

changeset-bot · 2025-12-27T12:37:59Z

⚠️ No Changeset found

Latest commit: 36204fa

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2025-12-27T12:37:59Z

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

Project	Deployment	Review	Updated (UTC)
arkenv	Ready	Preview, Comment	Dec 27, 2025 0:52am

coderabbitai · 2025-12-27T12:38:03Z

Caution

Review failed

The pull request is closed.

Walkthrough

Two files had wording updated: the homepage subtitle and the arkenv README now read "Environment variable validation from editor to runtime" instead of "Typesafe environment variables from editor to runtime". No functional changes.

Changes

Cohort / File(s)	Summary
Documentation & UI text `apps/www/app/(home)/page.tsx`, `packages/arkenv/README.md`	Replaced subtitle/description text "Typesafe environment variables from editor to runtime" with "Environment variable validation from editor to runtime". No code or API changes.

Sequence Diagram(s)

(omitted — change is textual only)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Docs improvements #155 — edits the same README text, replacing the same phrase.
Unify slogan #647 — updates the UI subtitle and README with the identical wording change.
Fix playground #189 — modifies apps/www/app/(home)/page.tsx, updating on-page textual content.

Poem

🐰
Hopping through lines of text so bright,
I nudge a phrase to clearer light.
From "typesafe" to "validate" I leap,
A tiny tweak before I sleep. ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately reflects the main change: updating text to change from 'Typesafe environment variables' to 'Environment variable validation' across the README and homepage.

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bb26c61 and 36204fa.

📒 Files selected for processing (1)

apps/www/app/(home)/page.tsx

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

pkg-pr-new · 2025-12-27T12:38:41Z

Open in StackBlitz

npm i https://pkg.pr.new/arkenv@647

npm i https://pkg.pr.new/@arkenv/bun-plugin@647

npm i https://pkg.pr.new/@arkenv/vite-plugin@647

commit: bb26c61

arkenv-bot · 2025-12-27T12:39:02Z

📦 Bundle Size Report

Package	Size	Limit	Diff	Status
`arkenv`	1.41 kB	2 kB	0.0%	✅

✅ All size limits passed!

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

apps/www/app/(home)/page.tsx (1)
14-14: Consider updating metadata description for consistency.

The metadata description still references "Typesafe environment variables" while the visible subtitle was updated to "Environment variable validation". Consider updating this for consistency, unless keeping the original SEO metadata is intentional.
🔎 Suggested update
 export const metadata: Metadata = {
 	title: "ArkEnv",
-	description: "Typesafe environment variables powered by ArkType ⛵️",
+	description: "Environment variable validation powered by ArkType ⛵️",
 };

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9c5137c and bb26c61.

📒 Files selected for processing (2)

apps/www/app/(home)/page.tsx
packages/arkenv/README.md

🧰 Additional context used

📓 Path-based instructions (3)

**/*.{ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/coding-guidelines.mdc)

**/*.{ts,tsx}: Prefer type over interface for type definitions in TypeScript
Use TypeScript 5.1+ features when appropriate
Leverage const type parameters for better inference in TypeScript
Use JSDoc comments for public APIs
Use tabs for indentation (configured in Biome)
Use double quotes for strings (configured in Biome)
Organize imports automatically (Biome handles this)
Avoid explicit types when TypeScript can infer them (noInferrableTypes error)
Use as const where appropriate for immutable values (useAsConstAssertion error)
Don't reassign function parameters (noParameterAssign error)
Place default parameters last in function signatures (useDefaultParameterLast error)
Always initialize enum values (useEnumInitializers error)
Declare one variable per statement (useSingleVarDeclarator error)
Avoid unnecessary template literals (noUnusedTemplateLiteral error)
Prefer Number.parseInt over global parseInt (useNumberNamespace error)
Use kebab-case for TypeScript filenames (e.g., create-env.ts)
Use camelCase for function names (e.g., createEnv)
Use PascalCase for type names (e.g., ArkEnvError)
Use UPPER_SNAKE_CASE for environment variables and constants
Include examples in JSDoc comments when helpful for public APIs
Document complex type logic with JSDoc comments
Use ArkEnvError for environment variable validation errors
Provide clear, actionable error messages that include the variable name and expected type

**/*.{ts,tsx}: Use createEnv(schema) function (or default import as arkenv) to create validated environment objects in TypeScript
Use built-in validators (host, port, url, email) from ArkEnv when available instead of custom ArkType schemas
Provide default values for optional environment variables using ArkType syntax (e.g., 'boolean = false')
Use ArkEnvError for environment variable errors instead of generic Error types
For environment schema definition, use ArkType string literal syntax for enumerated values (e.g., "'deve...

Files:

apps/www/app/(home)/page.tsx

**/*.tsx

📄 CodeRabbit inference engine (.cursor/rules/coding-guidelines.mdc)

Use self-closing JSX elements (useSelfClosingElements error)

Files:

apps/www/app/(home)/page.tsx

apps/www/**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (apps/www/.cursor/rules/posthog-integration.mdc)

apps/www/**/*.{ts,tsx,js,jsx}: If using TypeScript, use an enum to store feature flag names. If using JavaScript, store feature flag names as strings to an object declared as a constant to simulate an enum. Use UPPERCASE_WITH_UNDERSCORE naming convention for enum/const object members.
If a custom property for a person or event is referenced in two or more files or two or more callsites in the same file, use an enum or const object with UPPERCASE_WITH_UNDERSCORE naming convention, similar to feature flags.

Files:

apps/www/app/(home)/page.tsx

🧠 Learnings (17)

📓 Common learnings

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .cursor/rules/coding-guidelines.mdc:0-0
Timestamp: 2025-11-24T16:04:00.957Z
Learning: Applies to **/*.{ts,tsx} : Use `ArkEnvError` for environment variable validation errors

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-12-23T07:09:57.082Z
Learning: Applies to **/*.{ts,tsx} : Use descriptive environment variable names that indicate purpose and format (e.g., DATABASE_URL, NODE_ENV, FEATURE_FLAG)

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: openspec/AGENTS.md:0-0
Timestamp: 2025-11-24T16:05:35.714Z
Learning: For bug fixes, typos, formatting, comments, non-breaking dependency updates, and configuration changes, fix directly without creating a proposal

📚 Learning: 2025-11-24T16:03:45.295Z

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .cursor/rules/arktype.mdc:0-0
Timestamp: 2025-11-24T16:03:45.295Z
Learning: Applies to packages/arkenv/**/*.ts : Keep environment variable schemas readable and TypeScript-like using ArkType syntax

Applied to files:

packages/arkenv/README.md

📚 Learning: 2025-11-24T16:03:45.295Z

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .cursor/rules/arktype.mdc:0-0
Timestamp: 2025-11-24T16:03:45.295Z
Learning: Applies to packages/arkenv/**/*.ts : Convert ArkType validation errors to `ArkEnvError` for user-friendly error messages that include variable name and expected type

Applied to files:

packages/arkenv/README.md

📚 Learning: 2025-11-24T16:04:00.957Z

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .cursor/rules/coding-guidelines.mdc:0-0
Timestamp: 2025-11-24T16:04:00.957Z
Learning: Applies to **/*.{ts,tsx} : Use `ArkEnvError` for environment variable validation errors

Applied to files:

packages/arkenv/README.md
apps/www/app/(home)/page.tsx

📚 Learning: 2025-11-24T16:03:45.295Z

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .cursor/rules/arktype.mdc:0-0
Timestamp: 2025-11-24T16:03:45.295Z
Learning: Applies to packages/arkenv/**/*.ts : Use ArkType's `type()` function to define schemas in environment variable definitions

Applied to files:

packages/arkenv/README.md

📚 Learning: 2025-11-24T16:03:45.295Z

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .cursor/rules/arktype.mdc:0-0
Timestamp: 2025-11-24T16:03:45.295Z
Learning: Applies to packages/arkenv/**/*.ts : Leverage ArkType's built-in types (e.g., `string.host`, `number.port`) where possible in environment schemas

Applied to files:

packages/arkenv/README.md

📚 Learning: 2025-12-23T07:09:57.082Z

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-12-23T07:09:57.082Z
Learning: Applies to **/*.{ts,tsx} : Use ArkEnvError for environment variable errors instead of generic Error types

Applied to files:

packages/arkenv/README.md
apps/www/app/(home)/page.tsx

📚 Learning: 2025-11-24T16:03:45.295Z

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .cursor/rules/arktype.mdc:0-0
Timestamp: 2025-11-24T16:03:45.295Z
Learning: ArkType validates environment variables at runtime and TypeScript types are inferred from the schema definition

Applied to files:

packages/arkenv/README.md
apps/www/app/(home)/page.tsx

📚 Learning: 2025-11-24T16:03:45.295Z

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .cursor/rules/arktype.mdc:0-0
Timestamp: 2025-11-24T16:03:45.295Z
Learning: Applies to packages/arkenv/**/*.ts : Use union types for enums in ArkType schemas (e.g., `"'dev' | 'prod'"`) instead of separate enum definitions

Applied to files:

packages/arkenv/README.md

📚 Learning: 2025-12-23T07:09:57.082Z

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-12-23T07:09:57.082Z
Learning: Applies to **/*.{ts,tsx} : For environment schema definition, use ArkType string literal syntax for enumerated values (e.g., "'development' | 'production' | 'test'")

Applied to files:

packages/arkenv/README.md
apps/www/app/(home)/page.tsx

📚 Learning: 2025-09-10T19:35:18.179Z

Learnt from: yamcodes
Repo: yamcodes/arkenv PR: 136
File: .changeset/vast-bananas-win.md:2-3
Timestamp: 2025-09-10T19:35:18.179Z
Learning: The arkenv package is currently in v0.x.x (pre-1.0) development phase, where breaking changes are acceptable in minor version bumps according to semantic versioning conventions.

Applied to files:

packages/arkenv/README.md

📚 Learning: 2025-12-23T07:09:57.082Z

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-12-23T07:09:57.082Z
Learning: Applies to **/*.{ts,tsx} : Use `createEnv(schema)` function (or default import as `arkenv`) to create validated environment objects in TypeScript

Applied to files:

packages/arkenv/README.md
apps/www/app/(home)/page.tsx

📚 Learning: 2025-12-23T07:09:57.082Z

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-12-23T07:09:57.082Z
Learning: Applies to **/*.{ts,tsx} : Provide default values for optional environment variables using ArkType syntax (e.g., 'boolean = false')

Applied to files:

packages/arkenv/README.md
apps/www/app/(home)/page.tsx

📚 Learning: 2025-12-23T07:09:57.082Z

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-12-23T07:09:57.082Z
Learning: Applies to **/*.{ts,tsx} : Use built-in validators (host, port, url, email) from ArkEnv when available instead of custom ArkType schemas

Applied to files:

packages/arkenv/README.md

📚 Learning: 2025-12-23T07:09:57.082Z

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-12-23T07:09:57.082Z
Learning: Applies to **/*.{ts,tsx} : Use descriptive environment variable names that indicate purpose and format (e.g., DATABASE_URL, NODE_ENV, FEATURE_FLAG)

Applied to files:

apps/www/app/(home)/page.tsx

📚 Learning: 2025-11-24T16:04:00.957Z

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .cursor/rules/coding-guidelines.mdc:0-0
Timestamp: 2025-11-24T16:04:00.957Z
Learning: Applies to **/*.{ts,tsx} : Use UPPER_SNAKE_CASE for environment variables and constants

Applied to files:

apps/www/app/(home)/page.tsx

📚 Learning: 2025-12-25T21:14:15.510Z

Learnt from: yamcodes
Repo: yamcodes/arkenv PR: 616
File: apps/www/app/(home)/page.tsx:18-18
Timestamp: 2025-12-25T21:14:15.510Z
Learning: In projects using fumadocs-ui's HomeLayout, do not render a top-level <main> inside page components because HomeLayout already provides a main landmark with id="nd-home-layout". Ensure that page.tsx (and other pages that compose HomeLayout) return content without wrapping a new <main>, and rely on HomeLayout's landmark for accessibility. If a page needs a landmark, use subregions like <section> or <div role="region"> inside the existing main, but avoid duplicate main elements. Verify that HomeLayout is used and that the id remains unique.

Applied to files:

apps/www/app/(home)/page.tsx

⏰ 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). (6)

GitHub Check: test-e2e (a11y)
GitHub Check: test-e2e (e2e)
GitHub Check: test-typesafety
GitHub Check: test-build (latest)
GitHub Check: test-build (lts/*)
GitHub Check: size-limit

🔇 Additional comments (2)

packages/arkenv/README.md (1)

5-5: LGTM! Clear and descriptive subtitle.

The updated text "Environment variable validation from editor to runtime" accurately describes ArkEnv's core functionality.

apps/www/app/(home)/page.tsx (1)

39-39: LGTM! Consistent with README update.

The subtitle text change aligns with the updated messaging in the README and accurately describes ArkEnv's functionality.

Update README to reflect environment variable validation

0d4ebeb

github-actions bot added docs Improvements or additions to documentation arkenv Changes to the `arkenv` npm package. labels Dec 27, 2025

Update text for environment variable validation

bb26c61

yamcodes marked this pull request as ready for review December 27, 2025 12:39

github-actions bot added the www Improvements or additions to arkenv.js.org label Dec 27, 2025

yamcodes changed the title ~~Update README to reflect environment variable validation~~ Unify slogan Dec 27, 2025

coderabbitai bot reviewed Dec 27, 2025

View reviewed changes

coderabbitai bot approved these changes Dec 27, 2025

View reviewed changes

Update page description for HomePage component

36204fa

yamcodes merged commit 54adeb5 into main Dec 27, 2025
14 of 16 checks passed

yamcodes deleted the yamcodes-patch-1 branch December 27, 2025 12:43

vercel bot deployed to Preview December 27, 2025 12:52 View deployment

This was referenced Dec 27, 2025

Ecosystem footer #650

Merged

CLI tool for dev-time environment variable validation #642

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unify slogan#647

Unify slogan#647
yamcodes merged 3 commits intomainfrom
yamcodes-patch-1

yamcodes commented Dec 27, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Dec 27, 2025 •

edited

Loading

Uh oh!

vercel bot commented Dec 27, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Dec 27, 2025 •

edited

Loading

Review failed

Uh oh!

pkg-pr-new bot commented Dec 27, 2025 •

edited

Loading

Uh oh!

arkenv-bot bot commented Dec 27, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

yamcodes commented Dec 27, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Dec 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

vercel bot commented Dec 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Dec 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Poem

Pre-merge checks and finishing touches

Uh oh!

pkg-pr-new bot commented Dec 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

arkenv-bot bot commented Dec 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📦 Bundle Size Report

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

yamcodes commented Dec 27, 2025 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Dec 27, 2025 •

edited

Loading

vercel bot commented Dec 27, 2025 •

edited

Loading

coderabbitai bot commented Dec 27, 2025 •

edited

Loading

pkg-pr-new bot commented Dec 27, 2025 •

edited

Loading

arkenv-bot bot commented Dec 27, 2025 •

edited

Loading