Skip to content

Conversation

@yamcodes
Copy link
Owner

@yamcodes yamcodes commented Jan 16, 2026

Closes #744

Summary by CodeRabbit

  • Documentation

    • Clarified that ArkType is required for Bun and Vite plugins; validator: "standard" is unsupported, with guidance to use ArkType’s DSL alongside Zod or Valibot.
  • Chores

    • Updated dev/type dependency versions and replaced select dev plugins for consistency.
    • Standardized TypeScript targets to ES2023 across projects.
    • Made path resolution configuration explicit in build tooling and added a dev→build task dependency.
    • Added editor-on-save actions for import organization and fixes.

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

@yamcodes yamcodes linked an issue Jan 16, 2026 that may be closed by this pull request
@changeset-bot
Copy link

changeset-bot bot commented Jan 16, 2026

⚠️ No Changeset found

Latest commit: 3a7729c

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 16, 2026

Walkthrough

Updated docs to require ArkType for certain plugins and note validator limitations; standardized tsconfig-paths usage across Vite/Vitest configs; adjusted many package manifests (notably @types/node/catalog placeholders and removal of a validate plugin); moved multiple tsconfigs' targets/libs from ESNext to ES2023; added dev dependency on build in turbo.json.

Changes

Cohort / File(s) Summary
Docs & READMEs
apps/www/content/docs/bun-plugin/index.mdx, apps/www/content/docs/vite-plugin/index.mdx, packages/bun-plugin/README.md, packages/vite-plugin/README.md
Added IMPORTANT notes: arktype is required, validator: "standard" not supported, and Zod/Valibot may be used with ArkType DSL; linked Standard Schema docs.
Vite/Vitest configs
apps/playgrounds/vite-legacy/vite.config.ts, apps/playgrounds/vite/vite.config.ts, apps/www/vitest.config.ts, examples/with-vite-react/vite.config.ts
Replaced tsconfigPaths() with tsconfigPaths({ projects: ["./tsconfig.json"] }) to explicitly target the tsconfig.
Package manifests & deps
apps/playgrounds/vite-legacy/package.json, apps/playgrounds/vite/package.json, examples/with-vite-react/package.json, apps/playgrounds/node/package.json, .github/actions/size-limit/package.json, pnpm-workspace.yaml, examples/basic/package.json, examples/with-bun-react/package.json
Converted some explicit versions to catalog: placeholders (notably @types/node), removed @julr/vite-plugin-validate-env where present, and bumped specific example deps (e.g., @arkenv/bun-plugin, zod, @types/node).
TypeScript targets / tsconfigs
apps/playgrounds/*/tsconfig.json, apps/www/tsconfig.json, examples/*/tsconfig.json
Changed target/lib from ESNext to ES2023 in multiple tsconfigs; added types: ["node"] in some example configs.
CI / tooling / workspace
turbo.json, .github/actions/size-limit/tsconfig.json, .vscode/settings.json
Added dependsOn: ["^build"] to dev task in turbo.json; adjusted GH Action tsconfig libs/targets/modules; enabled Biome organizeImports/fixAll on save in VSCode settings.

Sequence Diagram(s)

(omitted)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested labels

github_actions

Poem

🐰 I hopped the repo, left notes in readmes bright,
Paths point clear, tsconfigs set to light,
Types swapped coats, deps catalogued just so,
Turbo builds first — then dev can go,
Tiny hops, big fixes — off I go! 🥕

🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Out of Scope Changes check ⚠️ Warning Most changes align with issue #744 objectives. However, TypeScript target changes (ESNext to ES2023) across 15+ files appear unrelated to validator mode documentation or Node LTS alignment. Clarify why TypeScript compilation targets were changed from ESNext to ES2023 across the codebase, as this appears outside the scope of validator mode documentation and Node version alignment.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately captures both main changes: updating plugin documentation to note unsupported validator mode and aligning Node versions to LTS.
Linked Issues check ✅ Passed The PR addresses issue #744 by documenting that plugins do not support 'standard' validator mode and aligning Node versions to LTS, fulfilling the core objective of documenting results.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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


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.

@github-actions github-actions bot added example Issues or Pull Requests concerning at least one ArkEnv example. (Found in the `examples/` directory) www Improvements or additions to arkenv.js.org labels Jan 16, 2026
- Remove arktype as a direct dependency
- Add arktype as optional peer for plugins
- Update package lock files
…ns, clarify its requirement in the Vite plugin README, and standardize `@types/node` to catalog references.
@github-actions github-actions bot added docs Improvements or additions to documentation @arkenv/vite-plugin Issues or Pull Requests involving the Vite plugin for ArkEnv labels Jan 16, 2026
@yamcodes yamcodes changed the title Update plugin docs to refer to validator mode Update plugin docs with note of not supporting "standard" validator mode Jan 16, 2026
@yamcodes yamcodes marked this pull request as ready for review January 16, 2026 21:02
@arkenv-bot
Copy link
Contributor

arkenv-bot bot commented Jan 16, 2026

📦 Bundle Size Report

Package Size Limit Diff Status
@arkenv/vite-plugin 1.55 kB 1.95 kB 0.0%
@arkenv/bun-plugin 2.01 kB 2.44 kB 0.0%

All size limits passed!

@pkg-pr-new
Copy link

pkg-pr-new bot commented Jan 16, 2026

Open in StackBlitz

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

commit: 3a7729c

@yamcodes
Copy link
Owner Author

@coderabbitai review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 16, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link
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: 2

🤖 Fix all issues with AI agents
In `@examples/basic/package.json`:
- Line 14: The zod dependency in package.json is pinned to an exact version
"4.3.5"; update the version string for the "zod" dependency to a semver range
(for example "^4.3.5") so the examples use a compatible future-proof range; edit
the "zod" entry in package.json to replace "4.3.5" with the chosen semver range
and save.

In `@pnpm-workspace.yaml`:
- Line 13: The workspace catalog currently pins '@types/node' at 25.0.9 which
mismatches the examples/basic project's declared Node engine; update one side to
align: either set the workspace catalog entry '@types/node' to a 24.x version
(e.g., `@types/node`@24) to match examples/basic's "engines": { "node": "24" }, or
update examples/basic/package.json to declare "engines": { "node": "25" } so it
matches '@types/node@25.0.9'; pick the approach consistent with your supported
Node target and apply the change to the symbol '@types/node' in the workspace
catalog or the "engines" field in examples/basic/package.json accordingly.

@yamcodes yamcodes changed the title Update plugin docs with note of not supporting "standard" validator mode Update plugin docs with note of not supporting "standard" validator mode + align node versions to LTS Jan 17, 2026
@github-actions github-actions bot added the github actions Pull requests that update GitHub Actions code label Jan 17, 2026
Copy link
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

🤖 Fix all issues with AI agents
In `@apps/www/package.json`:
- Line 68: Update the `@types/node` dependency in package.json from "25.x" to
"24.x" to match Node LTS; modify the version string for the "@types/node" entry
and then reinstall/update the lockfile (run npm/Yarn install) so
package-lock.json or yarn.lock reflects the change.

@yamcodes yamcodes merged commit 32ac972 into main Jan 17, 2026
16 of 20 checks passed
@yamcodes yamcodes deleted the 744-update-plugin-docs-for-validator-mode branch January 17, 2026 09:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

@arkenv/vite-plugin Issues or Pull Requests involving the Vite plugin for ArkEnv docs Improvements or additions to documentation example Issues or Pull Requests concerning at least one ArkEnv example. (Found in the `examples/` directory) github actions Pull requests that update GitHub Actions code www Improvements or additions to arkenv.js.org

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update plugin docs for validator mode

2 participants