agentleFS
miketrombamiketromba/shadcn-themer/.cursor/rules/hono-rpc.mdc

shadcn-themer / rules

Cursor rule325 starsChanged 13 months agoMITView on GitHub

Colocate server routers and typed client hooks using Hono RPC + React Query

We split this hono-rpc.mdc into the rules it gives an agent

3 rules. About 0 are common, 0 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use the shared apiClient from src/api/client/index.ts and the exported AppType from src/api/routers for full end‑to‑end type safety.

    line 8
  2. Very specific:

    Add router under src/api/routers/* and register by chaining in index.ts.

    line 45
  3. Very specific:

    Add client hook under src/api/client/* using React Query.

    line 46

≈ “Common” is an estimate: at least 1 in 5 of the 6,350 Cursor rule files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
hono-rpc.mdc
---
description: Colocate server routers and typed client hooks using Hono RPC + React Query
alwaysApply: false
---
Conventions
- Backend HTTP is implemented with Hono in `src/api/routers/*`. All routers are registered by chaining in `src/api/routers/index.ts` (keep chaining on the same value for full RPC type inference).
- Frontend accesses APIs via typed clients in `src/api/client/*`. Clients must export React Query hooks (e.g., `useXyzList`) that call the Hono client (`hc<AppType>`) and never plain `fetch`.
- Use the shared `apiClient` from `src/api/client/index.ts` and the exported `AppType` from `src/api/routers` for full end‑to‑end type safety.
- AuthZ: Protected routers must enforce auth via Supabase SSR. Use `getAuthUser(c)` from `src/api/auth.ts` to obtain the authenticated user (throws 401 if not). For Storage writes, prefer the service client when needed.
- Data contracts: Prefer returning JSON objects with cursors for pagination. Keep URL search params as strings; handle parsing server‑side.

Patterns
- Router (server):
```ts
import { Hono } from 'hono'
export const myRouter = new Hono()
  .get('/', async c => { /* auth + data */ return c.json({ items, nextCursor, hasMore }) })
```
- Register:
```ts
export const routes = api
  .route('/ping', pingRouter)
  .route('/my', myRouter)
```
- Client hook (frontend):
```ts
'use client'
import { apiClient } from '@/api/client'
import { useInfiniteQuery } from '@tanstack/react-query'

export function useMyList() {
  return useInfiniteQuery({
    queryKey: ['my'],
    queryFn: async ({ pageParam }) => {
      const res = await apiClient.api.my.$get({ query: { cursor: pageParam ?? undefined } })
      if (!res.ok) throw new Error('Request failed')
      return await res.json()
    },
    initialPageParam: null,
    getNextPageParam: last => last.nextCursor
  })
}
```
Checklist
- Add router under `src/api/routers/*` and register by chaining in `index.ts`.
- Add client hook under `src/api/client/*` using React Query; no raw `fetch`.
- Enforce auth / ownership / access checks in the router using `getAuthUser(c)`; do not assume the client is trusted.

Download now (ZIP)

  • Where files are headingNew Cursor rule files have more rules about planning and tracking tasks, and fewer about code style.

    Of the Cursor rule files we read, the 3,978 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository3 other files it gives its agents.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.