Skip to content

feat: remove memos (React Compiler) #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ConsoleTVs merged 5 commits into from
Jan 29, 2026
Merged

feat: remove memos (React Compiler) #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
25da77f
feat: remove memos
ConsoleTVs Oct 29, 2025
82a4651
fix: upgrade node version
ConsoleTVs Oct 29, 2025
89c9388
docs: add comprehensive JSDoc documentation to all exported APIs
ConsoleTVs Jan 29, 2026
fe975c8
chore: migrate from eslint+prettier to oxlint+oxfmt
ConsoleTVs Jan 29, 2026
56fecdd
style: format with oxfmt
ConsoleTVs Jan 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 24.0.0
node-version: 25.0.0
cache: 'npm'
cache-dependency-path: package-lock.json

Expand All @@ -39,7 +39,7 @@ jobs:
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 24.0.0
node-version: 25.0.0
cache: 'npm'
cache-dependency-path: package-lock.json

Expand All @@ -59,7 +59,7 @@ jobs:
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 24.0.0
node-version: 25.0.0
cache: 'npm'
cache-dependency-path: package-lock.json

Expand All @@ -81,7 +81,7 @@ jobs:
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 24.0.0
node-version: 25.0.0
cache: 'npm'
cache-dependency-path: package-lock.json

Expand Down
2 changes: 1 addition & 1 deletion .nvmrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
24
25
14 changes: 14 additions & 0 deletions .oxfmtrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"$schema": "./node_modules/oxfmt/configuration_schema.json",
"arrowParens": "always",
"bracketSameLine": true,
"bracketSpacing": true,
"printWidth": 100,
"useTabs": false,
"tabWidth": 2,
"trailingComma": "es5",
"singleQuote": true,
"semi": false,
"quoteProps": "consistent",
"ignorePatterns": []
}
28 changes: 28 additions & 0 deletions .oxlintrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"$schema": "./node_modules/oxlint/configuration_schema.json",
"plugins": ["react", "typescript", "vitest"],
"categories": {
"correctness": "error",
"suspicious": "warn"
},
"rules": {
"react-in-jsx-scope": "off"
},
"settings": {
"react": {
"formComponents": [],
"linkComponents": [],
"version": "19.2",
"componentWrapperFunctions": []
},
"vitest": {
"typecheck": false
}
},
"env": {
"builtin": true,
"browser": true
},
"globals": {},
"ignorePatterns": ["dist", "coverage", "node_modules"]
}
177 changes: 177 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
# AGENTS.md

Guidelines for AI coding agents working in this repository.

## Project Overview

`@studiolambda/query` is a lightweight, isomorphic, framework-agnostic async data management library (SWR-style). It has bindings for React 19+ and Solid.js.

## Build/Lint/Test Commands

```bash
# Install dependencies
npm install

# Run all tests
npm test

# Run tests in watch mode
npm run dev

# Run a single test file
npx vitest run src/query/query.test.ts

# Run tests matching a pattern
npx vitest run -t "can query resources"

# Run with coverage
npm run test:cover

# Lint
npm run lint

# Format code
npm run format

# Check formatting
npm run format:check

# Build (runs format:check and lint first)
npm run build

# Build without checks
npm run build:only
```

## Directory Structure

```
src/
query/ # Core library (framework-agnostic)
react/ # React bindings
hooks/ # useQuery, useQueryBasic, etc.
components/# QueryProvider, QueryPrefetch, etc.
solid/ # Solid.js bindings (partial)
```

## Code Style

### Formatting (Oxfmt)

- Single quotes, no semicolons
- 2-space indentation (no tabs)
- 100 character line width
- Trailing commas: `es5`
- Always use parentheses in arrow functions: `(x) => x`
- Configuration: `.oxfmtrc.json`

### Imports

1. External/framework imports first, then internal imports
2. Use path aliases: `query:index`, `query/react:context`, `query/react:hooks/useQuery`
3. Use inline `type` keyword for type imports:
```typescript
import { type Options } from 'query:index'
```
4. Multi-line imports with trailing comma:
```typescript
import { type Caches, type CacheType, type ItemsCacheItem } from 'query:cache'
```

### TypeScript

- Strict mode enabled with `noUnusedLocals`, `noUnusedParameters`, `noImplicitReturns`
- Use `interface` for object shapes, `type` for unions and function signatures
- Use `readonly` on interface properties
- Generic type parameters with defaults: `<T = unknown>`
- Explicit type assertions when needed: `as T`

### Naming Conventions

| Element | Convention | Example |
| ------------------ | ----------------------------- | ------------------------------------- |
| Files (modules) | camelCase | `useQuery.ts`, `cache.ts` |
| Files (components) | PascalCase | `QueryProvider.tsx` |
| Test files | `.test.ts`/`.test.tsx` suffix | `query.test.ts` |
| Functions | camelCase | `createQuery`, `defaultFetcher` |
| React hooks | `use` prefix | `useQuery`, `useQueryActions` |
| Types/Interfaces | PascalCase | `Cache`, `Configuration` |
| Function types | `*Function` suffix | `FetcherFunction`, `MutationFunction` |
| Props interfaces | `*Props` suffix | `QueryProviderProps` |

### Functions

- Use `function` declarations for named/exported functions (not arrow functions)
- Use arrow functions only for callbacks and inline functions
- Use `async/await` for async code

```typescript
// Correct - regular function for exports
export function createQuery(options?: Configuration): Query {
// ...
}

// Correct - arrow for callbacks
events.addEventListener(`${event}:${key}`, listener)
```

### Exports

- **Named exports only** - never use default exports
- Use barrel files (`index.ts`) for re-exports
- Factory pattern for main API: `createQuery()` returns object with methods

### Error Handling

- Simple `throw new Error('message')` for errors
- Try-catch with event emission pattern for async operations
- Explicit empty catch `catch(() => {})` when intentionally silencing errors

### Comments

- JSDoc-style block comments for function documentation
- Inline comments for explaining specific logic
- Document interface properties with JSDoc

```typescript
/**
* Subscribes to a given keyed event.
*/
function subscribe<T = unknown>(...) {
// For the refetching event, we want to immediately return...
}
```

## Testing

- Test framework: Vitest with happy-dom environment
- Use `describe.concurrent()` for parallel test execution
- Destructure `expect` from test context: `it('...', async ({ expect }) => { ... })`
- React tests use `act()` and `createRoot`

```typescript
import { describe, it, vi } from 'vitest'

describe.concurrent('feature', function () {
it('does something', async ({ expect }) => {
// test code
expect(result).toBe(expected)
})
})
```

## OxLint

- Configuration: `.oxlintrc.json`
- React plugin enabled with hooks rules
- Vitest plugin enabled for test files
- TypeScript plugin enabled
- `react-in-jsx-scope` rule disabled (using new JSX transform)
- Use `// oxlint-disable-next-line` to disable rules inline

## Environment

- Node.js 25+ (see `.nvmrc`)
- npm 11+ (package manager)
- TypeScript ~5.9.3
- React 19.2+ (peer dependency)
49 changes: 0 additions & 49 deletions eslint.config.js
View file
Open in desktop

This file was deleted.

Loading