internal: Move github rules to cursor rules

ntucker · ntucker · commit f2feb5b76a82 · 2025-12-01T21:32:43.000-05:00
diff --git a/.cursor/rules/general-instructions.mdc b/.cursor/rules/general-instructions.mdc
@@ -1,3 +1,7 @@
+---
+alwaysApply: true
+---
+
 # Reactive Data Client
 
 Yarn monorepo for normalized reactive state management.
@@ -50,7 +54,7 @@ Yarn monorepo for normalized reactive state management.
 - Internal/private APIs (prefixed with `_`, not exported, or marked `@internal`)
 - Implementation-only changes
 
-Update docs **in the same commit/PR** as code changes. For writing guidelines, see `.cursor/rules/packages-documentation.mdc`.
+Update docs **in the same commit/PR** as code changes. For writing guidelines, see @.cursor/rules/packages-documentation.mdc
 
 ## Common Mistakes to Avoid
 
diff --git a/.cursor/rules/manager.mdc b/.cursor/rules/manager.mdc
@@ -1,14 +1,17 @@
 ---
-applyTo: '**/*.ts'
+description: Guidelines for implementing @data-client/react Managers which handle global side effects
+globs:
+  - '**/*.ts'
+alwaysApply: false
 ---
 # Guide: Using `@data-client/react` Managers for global side effects
 
 [Managers](https://dataclient.io/docs/api/Manager) are singletons that handle global side-effects. Kind of like useEffect() for the central data store.
 They interface with the store using [Controller](https://dataclient.io/docs/api/Controller), and [redux middleware](https://redux.js.org/tutorials/fundamentals/part-4-store#middleware) is run in response to [actions](https://dataclient.io/docs/api/Actions).
 
-Use [Manager API docs](docs/core/api/Manager.md) to validate usage.
+Use @docs/core/api/Manager.md to validate usage.
 
-Always use `actionTypes` when comparing action.type. Refer to [Action API docs](docs/core/api/Actions.md)
+Always use `actionTypes` when comparing action.type. Refer to @docs/core/api/Actions.md
 for list of actions and their payloads.
 
 ## Dispatching actions
@@ -131,4 +134,4 @@ ReactDOM.createRoot(document.body).render(
     <App />
   </DataProvider>,
 );
-```
+```
diff --git a/.cursor/rules/packages-documentation.mdc b/.cursor/rules/packages-documentation.mdc
@@ -4,7 +4,7 @@ alwaysApply: false
 ---
 # Package Documentation Writing Guidelines
 
-This guide covers how to write and format documentation for public library interfaces. For information on **when** documentation updates are required, see `.cursorrules`.
+This guide covers how to write and format documentation for public library interfaces. For information on **when** documentation updates are required, see @.cursor/rules/general-usage.mdc
 
 ## Documentation Structure
 
diff --git a/.cursor/rules/react.mdc b/.cursor/rules/react.mdc
@@ -1,7 +1,9 @@
 ---
-applyTo: '**/*.tsx'
+description: Usage patterns for @data-client/react hooks and components
+globs:
+  - '**/*.tsx'
+alwaysApply: false
 ---
-
 ## Rendering
 
 ```ts
@@ -18,7 +20,7 @@ const todo = useCache(TodoResource.get, { id: 5 });
 const todo = useQuery(Todo, { id: 5 });
 ```
 
-For API definitions (like TodoResource), refer to the [@data-client/rest guide](.github/instructions/rest.instructions.md).
+For API definitions (like TodoResource), see @.cursor/rules/rest.mdc
 
 ## Mutations
 
@@ -107,7 +109,7 @@ const todosByUser = useQuery(groupTodoByUser);
 Custom [Managers](https://dataclient.io/docs/api/Manager) allow for global side effect handling.
 This is useful for webosckets, SSE, logging, etc.
 
-For more detailed usage, refer to the [Manager Guide](.github/instructions/manager.instructions.md).
+For more detailed usage, see @.cursor/rules/manager.mdc
 
 ## Best Practices & Notes
 
@@ -123,4 +125,4 @@ For more detailed usage, refer to the [Manager Guide](.github/instructions/manag
 - [useSuspense](https://dataclient.io/docs/api/useSuspense)
 - [Controller](https://dataclient.io/docs/api/Controller)
 
-**ALWAYS follow these patterns and refer to the official docs for edge cases. Prioritize code generation that is idiomatic, type-safe, and leverages automatic normalization/caching via schema definitions.**
+**ALWAYS follow these patterns and refer to the official docs for edge cases. Prioritize code generation that is idiomatic, type-safe, and leverages automatic normalization/caching via schema definitions.**
diff --git a/.cursor/rules/rest.mdc b/.cursor/rules/rest.mdc
@@ -1,5 +1,9 @@
 ---
-applyTo: '**/*.ts*'
+description: Modeling resources endpoints and schemas with @data-client/rest
+globs:
+  - '**/*.ts'
+  - '**/*.tsx'
+alwaysApply: false
 ---
 # Guide: Using `@data-client/rest` for Resource Modeling
 
@@ -34,6 +38,19 @@ to represent the data expected.
 ### Programmatic
 
 - [new schema.Query(Queryable)](https://dataclient.io/rest/api/Query) - memoized programmatic selectors
+  ```ts
+  const queryRemainingTodos = new schema.Query(
+    TodoResource.getList.schema,
+    entries => entries.filter(todo => !todo.completed).length,
+  );
+  ```
+
+  ```ts
+  const groupTodoByUser = new schema.Query(
+    TodoResource.getList.schema,
+    todos => Object.groupBy(todos, todo => todo.userId),
+  );
+  ```
 
 ---
 
@@ -121,23 +138,7 @@ const deleteTodo = id => ctrl.fetch(TodoResource.delete, { id });
 const getNextPage = (page) => ctrl.fetch(TodoResource.getList.getPage, { userId: 1, page })
 ```
 
-#### Programmatic queries
-
-```ts
-const queryRemainingTodos = new schema.Query(
-  TodoResource.getList.schema,
-  entries => entries.filter(todo => !todo.completed).length,
-);
-```
-
-```ts
-const groupTodoByUser = new schema.Query(
-  TodoResource.getList.schema,
-  todos => Object.groupBy(todos, todo => todo.userId),
-);
-```
-
-For more detailed usage, refer to the [@data-client/react guide](.github/instructions/react.instructions.md).
+For more detailed usage, see @.cursor/rules/react.mdc
 
 ---
 
@@ -241,4 +242,4 @@ export const IssueResource = resource({
 - [Schema Guide](https://dataclient.io/rest/api/schema#schema-overview)
 - [Relational Data Guide](https://dataclient.io/rest/guides/relational-data)
 
-**ALWAYS follow these patterns and refer to the official docs for edge cases. Prioritize code generation that is idiomatic, type-safe, and leverages automatic normalization/caching via schema definitions.**
+**ALWAYS follow these patterns and refer to the official docs for edge cases. Prioritize code generation that is idiomatic, type-safe, and leverages automatic normalization/caching via schema definitions.**
