Skip to content

Split API reference out of README, fix npm listing, drop two no-op exports #1

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
sovrin merged 3 commits into from
Sep 6, 2026
Merged

Split API reference out of README, fix npm listing, drop two no-op exports #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e468934
docs(readme): split reference out of README and index by intent
sovrin Sep 6, 2026
28dd759
refactor(core): drop forward
sovrin Sep 6, 2026
43d4e3c
refactor(combinators): drop attempt, document that backtracking is free
sovrin Sep 6, 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
10 changes: 7 additions & 3 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ npm run lint:fix # auto-fix lint issues
npm run format # oxfmt (format all files)

npm run generate:index # regenerate all index.ts barrel files from source
npm run generate:readme # regenerate README.MD from JSDoc examples
npm run generate:readme # regenerate README.md and doc/api/*.md from JSDoc examples
npm run test:extract # extract JSDoc @examples from .js files into test/examples.test.ts
```

Expand Down Expand Up @@ -55,13 +55,17 @@ type Failure = { ok: false; error?: string };
- Every combinator/terminal/primitive lives in its own file: `src/combinators/map.ts`
- Co-located test: `src/combinators/map.test.ts`
- `index.ts` in each module is generated — run `npm run generate:index` after adding or removing files; do not edit manually
- JSDoc `@example` blocks in source files are the source of truth for README and `test/examples.test.ts`
- JSDoc `@example` blocks in source files are the source of truth for the docs and `test/examples.test.ts`
- `README.md` is generated from `doc/README.template.md` — a landing page (pitch, quick start, intent-based cheat sheet, one-line API index)
- `doc/api/{core,terminals,primitives,combinators,utils}.md` are generated from `doc/api.template.md` — the full per-export reference; the whole directory is wiped and rewritten on every run
- Neither `README.md` nor `doc/api/` is edited by hand; hand-written prose belongs in the two templates in `doc/`

### Adding a new combinator

1. Create `src/combinators/myThing.ts` + `src/combinators/myThing.test.ts`
2. Run `npm run generate:index` to update `src/combinators/index.ts`
3. Add JSDoc `@example` block — run `npm run generate:readme` and `npm run test:extract` to keep README and examples test in sync
3. Add JSDoc `@example` block — run `npm run generate:readme` and `npm run test:extract` to keep the docs and examples test in sync
4. Add the new name to the "Which function do I need?" cheat sheet in `doc/README.template.md` — that table is hand-written, and `generate:readme` warns about any export missing from it

### Test structure

Expand Down
Loading
Loading