埃维杰斯
- 作者仓库星标 11
- 许可证 MIT
- 作者仓库 evjs
- 领域
- 通用
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 94 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @afx-team · MIT
- 上下文用量评级
- 低消耗
- 接入复杂程度
- 需手动接入
- 是否需要外部接口密钥
- 不需要
- 兼容的系统
- Docker
- 运行环境要求
- Node.js · Deno · Docker
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- 网络行为
- 允许外网请求
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
npx @evjs/create-app my-app
cd my-app
npm install
npm run dev
# evjs Agent Skill
Use this skill when developing applications with the evjs framework.
## Overview
evjs is a React fullstack framework built on TanStack Router, TanStack Query, and Hono. It provides:
- **Server Functions** — write backend logic in files (we recommend using the `.server.ts` suffix), call from React as if local
- **Server Routes** — build programmatic REST endpoints and APIs using the `createRoute()` handler
- **Query Integration** — type-safe `useQuery(getUsers)` with auto query keys and transport
- **Type-safe Routing** — TanStack Router with code-defined route modules and route trees
- **Plugin System** — extend builds with `buildStart`, `bundlerConfig`, `transformHtml`, and `buildEnd` hooks
- **Convention over Configuration** — works out of the box, optionally configure via `ev.config.ts`
## Quick Start
```bash
npx @evjs/create-app my-app
cd my-app
npm install
npm run dev
```
## References
For detailed guides on specific topics, see the `references/` directory:
- [quick-start.md](../docs/docs/quick-start.md) — Scaffolding projects with `npx @evjs/create-app`
- [project-structure.md](../docs/docs/project-structure.md) — Recommended directory structure and domain-driven design (features)
- [dev.md](../docs/docs/dev.md) — Development server and configuration
- [build.md](../docs/docs/build.md) — Production builds
- [deploy.md](../docs/docs/deploy.md) — Deploying to Node, Docker, Deno, and Edge environments
- [client-routes.md](../docs/docs/client-routes.md) — Route definitions, layouts, params, loaders, navigation
- [server-functions.md](../docs/docs/server-functions.md) — Server functions, queries, mutations, error handling
- [server-routes.md](../docs/docs/server-routes.md) — Creating REST API endpoints using programmatic `createRoute()`
- [config.md](../docs/docs/config.md) — `ev.config.ts` options, defaults, client/server settings
## Key Rules
**Server Functions (RPC):**
- Server function files must start with `"use server";` so evjs can transform and register them
- Use `useQuery(getUsers)` to query server functions directly — type-safe args & data
- Arguments are spread: `useQuery(getUser, id)` not `useQuery(getUser, [id])`
- For mutations, wrap args in objects/arrays: `mutate({ name, email })` or `mutate([name, email])`
- `ServerError` on server → automatically mapped to `ServerFunctionError` on client
**REST Routes (`createRoute()`):**
- Use `createRoute()` for REST API endpoints, webhooks, or standard Web Request/Response handling
- If mixing `createRoute()` endpoints, you must explicitly configure `server.entry` in `ev.config.ts`
- **Route Paths:** Always use string literals for `path` values (e.g., `path: "/posts"`). The type system **rejects** broad `string` variables and template strings at compile time.
**React Data Loading:**
- Route loaders should fetch using: `context.queryClient.ensureQueryData(getFnQueryOptions(myFn))`
- Invalidate cache after mutations: `queryClient.invalidateQueries({ queryKey: getFnQueryKey(myFn) })`
- Access server function metadata: `myFn.fnId`, `myFn.fnName`, `getFnQueryKey(myFn, ...args)`
**Misc:**
- Use `plugins` in config to extend the build pipeline via `buildStart`, `bundlerConfig`, `transformHtml`, and `buildEnd`
章节与文件索引
按说明文件中的顺序排列。
概述
参考文献
关键规则
文件/命令 -> .server.ts · createRoute() · useQuery(getUsers) · buildStart · bundlerConfig · transformHtml · buildEnd · ev.config.ts
内容校验值 -> 8e82bc61ab68
当前原文的自动摘译,尚未人工审校。
概述
evjs 是一个基于 TanStack Router、TanStack Query 和 Hono 构建的 React 全栈框架。它提供: 服务器功能 - 在文件中写入后端逻辑(我们建议使用
.server.ts后缀),从 React 调用,就像本地服务器路由一样 - 使用createRoute()处理程序构建编程 REST 端点和 API 查询集成 - 类型安全的useQuery(getUsers)具有自动查询键和传输参考文献
有关特定主题的详细指南,请参阅
references/目录:quick-start.md — 使用npx @evjs/create-app搭建项目project-struct.md — 推荐的目录结构和领域驱动设计(功能) dev.md — 开发服务器和配置 build.md — 生产版本关键规则
服务器函数(RPC):服务器函数文件必须以
"use server";开头,以便evjs可以转换和注册它们使用useQuery(getUsers)直接查询服务器函数 - 类型安全的参数和数据参数被传播:useQuery(getUser, id)而不是useQuery(getUser, [id])对于突变,将参数包装在对象/数组中:mutate({ name, email })或mutate([name, email])