Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ dist/
coverage/
.claude/worktrees/
.vref/index.html
.repos/effect
.DS_Store
1 change: 0 additions & 1 deletion .worktreeinclude

This file was deleted.

10 changes: 10 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,16 @@
- `vref manifest add --json '{"id":"home",...}' --dry-run --output json`
- `vref describe --output json`

## Learning more about the Effect

This repository uses the Effect Typescript library.

Before writing any Effect code, first read `node_modules/effect/AGENTS.md`
**completely**, and follow the links in the file when required.

If you need to learn more about particular Effect apis and concepts that the
guide doesn't cover, search through the source code in `node_modules/effect/src`.

## Repo-Specific Guidance

- Keep `vref` platform-neutral: it renders, validates, and serves visual references; app repos capture and curate screenshots
Expand Down
4 changes: 1 addition & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,10 @@ Use Node `>=24.18.0` and pnpm.

```bash
pnpm install
pnpm run effect:prepare
pnpm run hooks:install
```

The Effect preparation command installs the exact dependency-matched upstream source under
`.repos/effect`. The checked-in pre-push hook runs the full verification gate before each push.
The checked-in pre-push hook runs the full verification gate before each push.

## Run Locally

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
"check": "vp check .",
"clean": "rm -rf coverage dist",
"describe": "node ./dist/cli.mjs describe --output json",
"effect:prepare": "./scripts/prepare-effect-source.sh",
"hooks:install": "git config core.hooksPath .git-hooks",
"pack:dry": "vp pack src/index.ts src/cli.ts --dts && npm pack --dry-run",
"prepack": "vp pack src/index.ts src/cli.ts --dts",
Expand All @@ -43,7 +42,8 @@
"verify": "vp check . && vp run typecheck && vp pack src/index.ts src/cli.ts --dts && vp run smoke && vp test && npm pack --dry-run"
},
"dependencies": {
"effect": "beta"
"@effect/platform-node": "4.0.0-beta.107",
"effect": "4.0.0-beta.107"
},
"devDependencies": {
"@types/node": "^26.1.0",
Expand Down
Loading