Add Antigravity guide

[yamcodes]

Closes #521

Summary by CodeRabbit

• Documentation
  • Added an Open VSX integration guide for Cursor, Antigravity and VSCodium IDEs, including install and theme suggestions
  • Split integrations to list VS Code and Open VSX (Cursor) separately for clearer navigation
  • Renamed VS Code integration page title to "Integrate with Visual Studio Code"
  • Updated Vite plugin docs to reflect new environment option names and examples

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

[changeset-bot]

⚠️ No Changeset found

Latest commit: 5334df8

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]

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

Project	Deployment	Preview	Comments	Updated (UTC)
arkenv	Ready	Preview	Comment	Dec 12, 2025 10:26am

[coderabbitai]

Walkthrough

Adds a new Open VSX integration doc for Cursor/Antigravity/VSCodium, splits VS Code and Cursor entries in integrations metadata, renames a JetBrains label, updates the VS Code page title, adjusts Vite plugin docs to new option keys, and updates Playwright tests to match the content/title changes.

Changes

Cohort / File(s)	Summary
Open VSX integration doc apps/www/content/docs/arkenv/integrations/open-vsx.mdx	New documentation page describing Open VSX integration (ArkType, ArkThemes) for Cursor, Antigravity, and VSCodium-based IDEs; includes install guidance, registry cards, and an import-guide include.
Integrations metadata & VS Code doc apps/www/content/docs/arkenv/meta.json, apps/www/content/docs/arkenv/integrations/vscode.mdx	Splits the combined VS Code/Cursor entry into separate entries ([VS Code] and [Cursor, Antigravity, VSCodium]), shortens JetBrains label to [JetBrains], and changes the VS Code page title to "Integrate with Visual Studio Code".
Vite plugin docs apps/www/content/docs/vite-plugin/index.mdx	Replaces previous plugin option examples (VITE_API_URL, VITE_APP_NAME, VITE_DEBUG) with new keys PORT: "number.port" and VITE_MY_VAR: "string", and updates sample arkenv usage and validation messages.
Playwright tests tooling/playwright-www/tests/integrations.test.ts	Updates title expectation to "Integrate with Visual Studio Code"; relaxes external-link attribute checks to simpler presence/visibility assertions for marketplace and external links.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Inspect new open-vsx.mdx for accuracy, links, and include correctness.
• Verify meta.json entries route correctly and appear in navigation.
• Confirm vite-plugin/index.mdx examples match the actual plugin option names/types.
• Run or review updated Playwright test expectations for robustness.

Possibly related PRs

• ArkEnv in vite.config.ts #380 — Related Vite integration/docs changes and schema/option renames.
• Docs improvements #155 — Edits overlapping integration docs and shared includes.
• Integration docs #154 — Prior changes to integration pages and meta.json entries that this PR extends.

Poem

🐰 I hopped through docs with joyous cheer,

Open VSX now lives right here—
Cursor, Antigravity join the race,
VS Code stands proud in its own space,
Vite's new keys make the garden fair.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Out of Scope Changes check	⚠️ Warning	The PR includes several out-of-scope changes: updates to vscode.mdx title, changes to Vite plugin documentation and options, and test updates unrelated to the Antigravity integration objective.	Remove or separate the vscode.mdx title update, Vite plugin documentation changes, and test file modifications as these fall outside the scope of adding an Antigravity integration guide.
Title check	❓ Inconclusive	The title 'Add Antigravity guide' is vague and partially misleading—it omits that the guide combines Antigravity with Cursor and VSCodium (all non-VS Code IDEs using Open VSX), which is the actual scope of the changes.	Consider a more descriptive title like 'Add Open VSX integration guide for Cursor, Antigravity, and VSCodium' to better reflect the comprehensive scope of the changes.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check	✅ Passed	The PR addresses issue #521 by adding an Open VSX integration guide combining Antigravity with Cursor and VSCodium, includes registry cards for both ArkType and ArkThemes, and separates this from the VS Code guide as requested.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch 521-add-google-antigravity-integration-guide

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 316f691 and 5334df8.

📒 Files selected for processing (1)

• tooling/playwright-www/tests/integrations.test.ts (3 hunks)

🧰 Additional context used

📓 Path-based instructions (4)

**/*.{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) as the main function for validated environment objects, available as the default export
Use built-in validators (host, port, url, email) from src/types.ts when available instead of custom validation
Use ArkEnvError for environment variable errors, not generic errors
Environment schema definitions should use built-in validators, ArkType string literals, and support default values in the schema pattern
Use logical grouping for related environment variables in schemas
Use descriptive env...

Files:

• tooling/playwright-www/tests/integrations.test.ts

**/*.test.{ts,tsx}

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

Co-locate tests with components: Component.tsx next to Component.test.tsx

**/*.test.{ts,tsx}: Test individual functions, components, and hooks in isolation with mocked dependencies in unit tests
Keep unit tests fast with execution under 100ms per test
Co-locate unit tests with source files using naming convention: source.ts → source.test.ts
Focus component tests on public API, user behavior, state transitions, and accessibility rather than styling or implementation details
Query component tests by role, name, label, and text using accessibility-first selectors
Use Vitest as the test framework for unit and integration tests
Use Testing Library with user-event for real user simulation in component tests

**/*.test.{ts,tsx}: Test individual functions, components, and hooks in isolation with mocked dependencies using the *.test.ts or *.test.tsx suffix
Mock process.env in tests for different scenarios and save/restore original env in beforeEach/afterEach hooks
Use Vitest's describe/it structure in test files
Test edge cases including invalid and missing environment variable values
Use Vitest for testing framework

Files:

• tooling/playwright-www/tests/integrations.test.ts

tooling/playwright-www/**/*.{ts,tsx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

End-to-end tests should be located in tooling/playwright-www/ and test complete user workflows in real browsers with no mocking

Files:

• tooling/playwright-www/tests/integrations.test.ts

**/*.{ts,tsx,json,md}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Use Biome for linting and formatting instead of ESLint and Prettier

Files:

• tooling/playwright-www/tests/integrations.test.ts

🧠 Learnings (9)

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

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .cursor/rules/test-patterns.mdc:0-0
Timestamp: 2025-11-24T16:04:36.939Z
Learning: Applies to tooling/playwright-www/**/*.spec.ts : Test complete user workflows and validate real browser behavior across Chromium, Firefox, and WebKit in end-to-end tests

Applied to files:

• tooling/playwright-www/tests/integrations.test.ts

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

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .cursor/rules/test-patterns.mdc:0-0
Timestamp: 2025-11-24T16:04:36.939Z
Learning: Applies to tooling/playwright-www/**/*.spec.ts : Use Playwright for end-to-end tests

Applied to files:

• tooling/playwright-www/tests/integrations.test.ts

📚 Learning: 2025-11-29T22:11:39.931Z

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-29T22:11:39.931Z
Learning: Applies to tooling/playwright-www/**/*.{ts,tsx} : End-to-end tests should be located in `tooling/playwright-www/` and test complete user workflows in real browsers with no mocking

Applied to files:

• tooling/playwright-www/tests/integrations.test.ts

📚 Learning: 2025-11-29T22:11:39.931Z

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-29T22:11:39.931Z
Learning: Applies to **/*.integration.test.{ts,tsx} : Integration tests should verify interactions between multiple units (like components + hooks + services) without mocking their interactions

Applied to files:

• tooling/playwright-www/tests/integrations.test.ts

📚 Learning: 2025-11-29T22:11:39.931Z

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-29T22:11:39.931Z
Learning: Applies to **/*.integration.test.{ts,tsx} : Use integration tests with `*.integration.test.ts` or `*.integration.test.tsx` suffix to test how multiple units work together without mocking their interactions

Applied to files:

• tooling/playwright-www/tests/integrations.test.ts

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

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .cursor/rules/test-patterns.mdc:0-0
Timestamp: 2025-11-24T16:04:36.939Z
Learning: Applies to **/*.integration.test.{ts,tsx} : Test how multiple units (components, hooks, functions) work together without mocking their interactions in integration tests

Applied to files:

• tooling/playwright-www/tests/integrations.test.ts

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

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .cursor/rules/test-patterns.mdc:0-0
Timestamp: 2025-11-24T16:04:36.939Z
Learning: Applies to **/*.test.{ts,tsx} : Focus component tests on public API, user behavior, state transitions, and accessibility rather than styling or implementation details

Applied to files:

• tooling/playwright-www/tests/integrations.test.ts

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

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .cursor/rules/test-patterns.mdc:0-0
Timestamp: 2025-11-24T16:04:36.939Z
Learning: Applies to **/*.integration.test.{ts,tsx} : Use `*.integration.test.ts` suffix to distinguish integration tests from unit tests

Applied to files:

• tooling/playwright-www/tests/integrations.test.ts

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

Learnt from: CR
Repo: yamcodes/arkenv PR: 0
File: .cursor/rules/test-patterns.mdc:0-0
Timestamp: 2025-11-24T16:04:36.939Z
Learning: Applies to **/*.integration.test.{ts,tsx} : Keep integration tests slower but comprehensive (100ms - 2000ms per test) with real interactions between units

Applied to files:

• tooling/playwright-www/tests/integrations.test.ts

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

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

🔇 Additional comments (3)

tooling/playwright-www/tests/integrations.test.ts (3)

11-11: Title update aligns with documentation changes.

The updated heading expectation matches the PR's objective to distinguish the VS Code integration from Cursor/Antigravity integrations.

---

55-68: This test is redundant with the "should have VS Code marketplace links" test (lines 18-41) and should either be consolidated or removed.

The security attributes (target="_blank" and rel="noreferrer noopener") are already validated in lines 18-41 for the specific extension links. The test at lines 55-68 only checks that card links exist and are visible, which duplicates the earlier test's link detection without adding new coverage. Consider either:

• Removing this test as redundant
• Consolidating both tests to verify all card links have proper security attributes

---

126-149: Verify if external links on integration pages include security attributes.

The test now only checks visibility of external links rather than validating target="_blank" and rel="noopener noreferrer" attributes. The integration pages use the fumadocs-ui Card component, which is responsible for rendering external links—verify whether fumadocs-ui adds these security attributes by default. If not, consider either:

• Wrapping the Card component to add security attributes (similar to how star-us-button.tsx and edit-on-github.tsx handle external links)
• Adding a unit test for the Card component to validate security attributes on rendered links
• Documenting the security attribute handling responsibility

The visibility check alone is appropriate for E2E workflow testing, but security attributes should be validated at the component level to ensure consistent security practices across the site.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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