Skip to content

Commit d553096

Browse files
committed
Update co pilot instructions
1 parent d0a9019 commit d553096

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

.github/copilot-instructions.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
- `packages/endpoint`: base Endpoint types; `packages/rest`: REST modeling (`resource()`, `RestEndpoint`).
1313
- `packages/core`: framework-agnostic normalized store, actions, Controller, Managers.
1414
- `packages/react`: React bindings (hooks like `useSuspense`, `useLive`, `useQuery`, `DataProvider`).
15-
- `packages/normalizr`: schema/Entity/normalization; used by rest/core/react.
15+
- `packages/vue`: Vue 3 composables (`useSuspense`, `useQuery`, `useLive`, `provideDataClient`).
16+
- `packages/normalizr`: schema/Entity/normalization; used by rest/core/react/vue.
1617

1718
### Developer workflows
1819
- Build all packages: `yarn build` (runs `tsc --build` + each workspace build). Clean with `yarn build:clean`.
@@ -34,12 +35,15 @@
3435
- TypeScript 5.9 project references are used; ambient `.d.ts` files are copied during build (`build:copy:ambient`).
3536

3637
### Where to look first
37-
- High-level usage: root `README.md` and `packages/*/README.md` (react, rest, core) show canonical patterns.
38+
- High-level usage: root `README.md` and `packages/*/README.md` (react, rest, core, vue) show canonical patterns.
3839
- REST patterns: `docs/rest/*`; Core/Controller/Managers: `docs/core/api/*`.
3940
- Example apps: `examples/todo-app`, `examples/github-app`, `examples/nextjs` demonstrate resources, hooks, mutations, and Managers.
41+
- Vue patterns: `packages/vue/src/consumers/` for composables, `packages/vue/src/__tests__/` for Vue-specific test patterns.
4042

4143
### Testing patterns
4244
- Prefer `renderDataHook()` from `@data-client/test` with `initialFixtures`/`resolverFixtures` for hook tests.
4345
- Use `nock` for low-level HTTP tests of endpoints. Keep tests under `packages/*/src/**/__tests__`.
46+
- Vue tests use `@vue/test-utils` with `mount()` and Vue's `Suspense` component for async rendering.
47+
- Test file naming: `.node.test.ts[x]` for Node-only, `.native.test.ts[x]` for React Native, `.web.ts` for browser tests.
4448

4549
If anything here is unclear or missing (e.g., adding a new package, expanding CI/build), point it out and I’ll refine these instructions.

0 commit comments

Comments
 (0)