Skip to content

Commit 45c6aac

Browse files
committed
chore(public): harden repo for public rollout
1 parent af2432b commit 45c6aac

File tree

5 files changed

+52
-114
lines changed

5 files changed

+52
-114
lines changed

.github/workflows/ci.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,10 +93,12 @@ jobs:
9393
uses: oven-sh/setup-bun@4bc047ad259df6fc24a6c9b0f9a0cb08cf17fbe5 # v2.0.1
9494
with:
9595
bun-version: "1.3.10"
96-
9796
- name: Install dependencies
9897
run: bun install
9998

99+
- name: Build workspace packages
100+
run: bun run build
101+
100102
- name: Run active coverage lane
101103
run: bun run coverage:lane:active
102104

@@ -153,10 +155,12 @@ jobs:
153155
uses: oven-sh/setup-bun@4bc047ad259df6fc24a6c9b0f9a0cb08cf17fbe5 # v2.0.1
154156
with:
155157
bun-version: "1.3.10"
156-
157158
- name: Install dependencies
158159
run: bun install
159160

161+
- name: Build workspace packages
162+
run: bun run build
163+
160164
- name: Expo doctor
161165
working-directory: examples/react-expo
162166
continue-on-error: true

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,5 @@ tmp
2121
__screenshots__
2222
*.tsBuildInfo
2323
.generated
24+
25+
.ai/

AGENTS.md

Lines changed: 24 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -1,127 +1,39 @@
1-
# AI Assistant Instructions: evolu-plan-b
1+
# Repository Notes for Contributors
22

3-
> **Full context**: See `.ai/` directory for detailed instructions and active tasks.
3+
This file is intentionally public-safe and minimal.
44

5-
## 🎯 This Repository
5+
## Purpose
66

7-
**Evolu Plan B** - Fork of [evoluhq/evolu](https://github.com/evoluhq/evolu) with:
8-
- **Bun** as package manager and runtime (not pnpm/Node)
9-
- **Biome** for linting and formatting (not ESLint/Prettier)
10-
- Reduced dependencies
11-
- SQLoot-specific enhancements
7+
`evolu-plan-b` is SQLoot's Bun + Biome fork of Evolu with focus on:
128

13-
## 📊 Quick Context
9+
- upstream compatibility,
10+
- measurable CI/benchmark quality,
11+
- practical local-first runtime hardening.
1412

15-
| Aspect | Value |
16-
| ---------------- | ------------- |
17-
| Package Manager | Bun 1.3.9 |
18-
| Node.js | >=24.0.0 |
19-
| Linter/Formatter | Biome 2.4.0 |
20-
| Test Framework | Vitest |
21-
| Upstream | evoluhq/evolu |
13+
## Development Baseline
2214

23-
## 🗂️ Repository Structure
15+
- Package manager: `bun`
16+
- Lint/format: `biome`
17+
- TypeScript: strict mode
18+
- Main quality gate: `bun run verify`
2419

25-
```
26-
evolu-plan-b/
27-
├── apps/
28-
│ ├── relay/ # Sync relay server
29-
│ └── web/ # Documentation (Dan's) - TO BE REMOVED
30-
├── packages/
31-
│ ├── common/ # Core logic, CRDTs, sync
32-
│ ├── web/ # Browser adapter (wa-sqlite)
33-
│ ├── react/ # React bindings
34-
│ ├── react-web/ # React + web combined
35-
│ ├── react-native/ # React Native adapter
36-
│ ├── nodejs/ # Node.js adapter
37-
│ ├── svelte/ # Svelte bindings
38-
│ ├── vue/ # Vue bindings
39-
│ └── tsconfig/ # Shared TS config
40-
├── examples/ # Framework examples - MIGRATING TO bench-suite
41-
└── .ai/ # AI agent context
42-
```
43-
44-
## 🔧 Common Commands
45-
46-
```bash
47-
# Development
48-
bun install # Install dependencies
49-
bun run dev # Start dev mode (packages + web + relay)
50-
bun run build # Build all packages
51-
52-
# Testing
53-
bun run test # Run tests
54-
bun run test:coverage # Tests with coverage
55-
bun run test:watch # Watch mode
56-
57-
# Quality
58-
bun run lint # Lint with Biome
59-
bun run format # Format with Biome
60-
bun run verify # Full verification (build + lint + test)
61-
62-
# Release
63-
bun run changeset # Add changeset
64-
bun run version # Bump versions
65-
bun run release # Publish packages
66-
```
20+
## Core Commands
6721

68-
## 🔄 Upstream Sync Strategy
69-
70-
This fork cherry-picks from upstream. Dan (@steida) pushes frequently without warning.
71-
72-
**Branches:**
73-
- `main` - Stable
74-
- `sync/upstream-main` - Tracking upstream/main
75-
- `sync/upstream-common-v8` - Tracking upstream/common-v8 (new Task architecture)
76-
- `feat/*` - Feature branches
77-
78-
**Workflow:**
7922
```bash
80-
git fetch upstream
81-
git cherry-pick <commit> # Pick specific commits
82-
# Resolve conflicts, especially in lock files and CI
23+
bun install
24+
bun run build
25+
bun run test
26+
bun run lint
8327
bun run verify
8428
```
8529

86-
## ⚠️ Key Differences from Upstream
87-
88-
1. **Bun over pnpm** - All commands use `bun`
89-
2. **Biome over ESLint** - Single tool for lint + format
90-
3. **No `apps/web`** - Dan's docs site will be removed
91-
4. **Examples migrating** - Moving to `bench-suite` repo
92-
93-
## 📍 Related Resources
94-
95-
| Resource | Location |
96-
| ------------ | ----------------------------------- |
97-
| Issues | `../knowledge/05-Issues/` |
98-
| Roadmap | `../knowledge/01-Vision/ROADMAP.md` |
99-
| Architecture | `../knowledge/02-Architecture/` |
100-
| Bench Suite | `../bench-suite/` (sibling repo) |
101-
| Upstream | https://github.com/evoluhq/evolu |
102-
103-
## 🤖 For AI Agents
104-
105-
### Do
106-
- Use Bun for all package operations
107-
- Run `bun run verify` before suggesting PR
108-
- Check `.ai/tasks/active/` for current work
109-
- Reference upstream issues with `upstream#`
110-
111-
### Don't
112-
- Use npm/pnpm/yarn
113-
- Suggest ESLint/Prettier configs
114-
- Modify `apps/web/` (it's going away)
115-
- Add unnecessary dependencies
30+
## Security
11631

117-
### Context Priority
118-
1. This file
119-
2. `.ai/README.md`
120-
3. `.ai/tasks/active/*.md`
121-
4. `../knowledge/01-Vision/ROADMAP.md`
32+
- Never commit secrets or credentials.
33+
- Use responsible disclosure process from `SECURITY.md`.
12234

123-
---
35+
## Contribution
12436

125-
<div align="center">
126-
<a href="https://github.com/SQLoot/evolu-plan-b">SQLoot/evolu-plan-b</a>
127-
</div>
37+
- Keep changes focused.
38+
- Add/update tests for behavioral changes.
39+
- Update docs when behavior or workflows change.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ Primary goals:
1111

1212
Evolu is a TypeScript library and local-first platform.
1313

14+
## 🪴 Project Activity
15+
16+
<p align="center">
17+
<img src="https://repobeats.axiom.co/api/embed/<hash>.svg" alt="Repobeats analytics image" />
18+
</p>
19+
1420
## Integration Matrix
1521

1622
Coverage snapshot date: `2026-02-27` (from `bun run test:coverage` and `bun run test:coverage:bun`).

renovate.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
3+
"extends": ["config:recommended"],
4+
"dependencyDashboard": true,
5+
"dependencyDashboardApproval": true,
6+
"packageRules": [
7+
{
8+
"description": "Ignore changesets/action due to workflow file protection",
9+
"matchManagers": ["github-actions"],
10+
"matchPackageNames": ["changesets/action"],
11+
"enabled": false
12+
}
13+
]
14+
}

0 commit comments

Comments
 (0)