Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
acef00f
Generate the README API reference from JSDoc
amanmahajan7 Oct 22, 2026
461e738
Lint JSDoc comments with oxlint
amanmahajan7 Oct 22, 2026
5529a78
Simplify the generated API reference
amanmahajan7 Oct 22, 2026
e7384dc
Rename the `TRow` and `TSummaryRow` type parameters to `R` and `SR`
amanmahajan7 Oct 22, 2026
64cc553
Don't repeat members inherited through internal types
amanmahajan7 Oct 22, 2026
1b861ea
Name destructured parameters `props` in the API reference
amanmahajan7 Oct 22, 2026
17dbe0d
Show components as JSX elements in the API reference
amanmahajan7 Oct 22, 2026
4baada5
Use TypeScript 6 for TypeDoc as recommended by the TypeScript team
amanmahajan7 Oct 22, 2026
ff50840
Generate the API reference from `lib/index.d.ts` instead of TypeDoc
amanmahajan7 Oct 22, 2026
19848bd
Match the layout and order of the previous README
amanmahajan7 Oct 22, 2026
bb3ba0b
Use name-only headings in the API reference
amanmahajan7 Oct 22, 2026
ca8ae8e
Merge internal base interfaces into the public interfaces in the API …
amanmahajan7 Oct 22, 2026
c436614
Fail the API reference generation on unresolved links, unsupported ta…
amanmahajan7 Oct 22, 2026
c18d42a
Merge branch 'main' into typedoc-readme-api
amanmahajan7 Oct 22, 2026
91084a8
Merge remote-tracking branch 'origin/typedoc-readme-api' into typedoc…
amanmahajan7 Oct 22, 2026
331e384
Generate the API reference with the TypeScript 7 API instead of oxc-p…
amanmahajan7 Oct 23, 2026
c60a5ce
Merge branch 'main' into typedoc-readme-api
amanmahajan7 Oct 23, 2026
0a42091
Set the sections of the API reference in `src/index.ts` instead of `@…
amanmahajan7 Oct 23, 2026
c07cfbf
Fail the API reference generation instead of dropping content in more…
amanmahajan7 Oct 23, 2026
35bdd31
Merge branch 'main' into typedoc-readme-api
amanmahajan7 Oct 23, 2026
59bbf64
Merge branch 'main' into typedoc-readme-api
amanmahajan7 Oct 23, 2026
8422009
Merge branch 'main' into typedoc-readme-api
amanmahajan7 Oct 25, 2026
f8b1805
Merge branch 'main' into typedoc-readme-api
amanmahajan7 Oct 25, 2026
906cb34
Merge branch 'main' into typedoc-readme-api
amanmahajan7 Oct 26, 2026
38e34e0
Merge branch 'main' into typedoc-readme-api
amanmahajan7 Oct 27, 2026
72665b4
Merge branch 'main' into typedoc-readme-api
amanmahajan7 Oct 27, 2026
dbaf9c2
Merge branch 'main' into typedoc-readme-api
amanmahajan7 Oct 27, 2026
31d6b14
Address review comments on the API docs
amanmahajan7 Oct 28, 2026
2639da5
Link the member mentions in the API docs
amanmahajan7 Oct 28, 2026
1416d64
Merge branch 'main' into typedoc-readme-api
amanmahajan7 Oct 30, 2026
9d4fa04
Merge branch 'main' into typedoc-readme-api
amanmahajan7 Nov 2, 2026
00a8f2a
Use JSDoc tags for the examples, return values, defaults, and related…
amanmahajan7 Nov 2, 2026
1f1e05c
Make `RenderCheckboxProps.checked` required, and `SelectCheckboxProps…
amanmahajan7 Nov 2, 2026
f2a070d
Merge branch 'main' into typedoc-readme-api
amanmahajan7 Nov 3, 2026
8833f0f
Merge branch 'main' into typedoc-readme-api
nstepien Nov 6, 2026
26a3344
cache vp pack
nstepien Nov 6, 2026
06ca624
Merge branch 'main' into typedoc-readme-api
amanmahajan7 Nov 11, 2026
b520083
Use the JSDoc tags `@default` and `@template`, and lint the generated…
amanmahajan7 Nov 11, 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
7 changes: 6 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ src/
style/ # build-time CSS via ecij tagged templates; layers.css declares @layer order
cellRenderers/ # default cell renderers (e.g., checkbox, toggleGroup, value)
editors/ # default editors (renderTextEditor)
scripts/
generateApiDocs.ts # generates the API reference of README.md from JSDoc (`vp run docs`)
test/
browser/ # vitest browser-mode tests (Playwright: Chromium, Firefox, WebKit)
node/ # vitest SSR tests (Node.js)
Expand All @@ -25,6 +27,7 @@ website/ # demo site (TanStack Start), prerendered for GitHub Pages
## Conventions

- **Public API** — all exports flow through `src/index.ts`. Keep `README.md` in sync with user-facing changes.
- **API docs** — JSDoc comments are the source of the README's API reference. Edit the JSDoc, then run `vp run docs` to regenerate the section between `<!-- api:start -->` and `<!-- api:end -->`; never edit that section by hand. `src/index.ts` sets the layout of the API reference: the exports are listed in their order, under the section of the comment above them, one of the sections in `scripts/generateApiDocs.ts` (`// Components`, `// Hooks`, `// Render Functions`, `// Context`, `// Other`, `// Types`). Use the JSDoc tags `@default`, `@example`, `@returns`, `@see`, `@template`, and `{@linkcode}` instead of writing these out in the description. Oxlint's `jsdoc` plugin checks the tag names. In the hand-written sections of the README, give links to API members the member as title, e.g., ``[`width`](#width "Column.width")``, so `vp run docs` keeps their anchor up to date.
- **Docs** — keep `AGENTS.md` in sync with tooling, conventions, or architectural changes.
- **Default renderers** — `DataGridRenderersContext` allows overriding default renderers (`renderCheckbox`, `renderSortStatus`, `renderRow`, `renderCell`, `noRowsFallback`) without prop-drilling.
- **TypeScript strict** with `exactOptionalPropertyTypes`, `verbatimModuleSyntax`, `erasableSyntaxOnly`. Distinguish missing properties from `undefined` values.
Expand Down Expand Up @@ -54,8 +57,9 @@ website/ # demo site (TanStack Start), prerendered for GitHub Pages
The project uses [Vite+](https://viteplus.dev/guide/), whose global `vp` CLI wraps Vite, Rolldown, Vitest, tsdown, Oxlint, Oxfmt, and Vite Task. Run `vp` directly, not through `npx`. Its docs are in `node_modules/vite-plus/docs`.

- `vp <command>` runs a built-in command, e.g., `vp dev`, `vp check`, `vp test`, `vp pack`, `vp build`.
- `vp run <task>` runs a task from `vite.config.ts`, e.g., `vp run typecheck`, `vp run eslint`, `vp run ci`.
- `vp run <task>` runs a task from `vite.config.ts`, e.g., `vp run typecheck`, `vp run eslint`, `vp run docs`, `vp run ci`.
- Run `vp install` after pulling changes.
- `vp run docs` runs `vp pack`, then `scripts/generateApiDocs.ts`, which parses the declarations and JSDoc comments of `lib/index.d.ts` with the TypeScript 7 API (`typescript/sync`).

## Validation

Expand All @@ -66,4 +70,5 @@ While iterating, run individual checks instead. The static checks take seconds,
- `vp run typecheck` type checks with `tsc --build`; `vp check` does not type check.
- `vp check --fix` formats and lints, fixing what it can. Without `--fix`, a formatting error stops it before linting.
- `vp run eslint` lints Markdown files.
- `vp run docs` regenerates the README's API reference; CI fails if it changes `README.md`.
- `vp test <files>` runs specific test files, e.g., `vp test test/browser/sorting.test.tsx`. Add `--project "browser (chromium)"` to test in a single browser, or `--project node` to run the SSR test. The full suite takes about a minute.
1,516 changes: 981 additions & 535 deletions README.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
"clsx": "^2.1.1",
"ecij": "^0.7.0",
"eslint": "^10.2.1",
"github-slugger": "^2.0.0",
"jspdf": "^4.2.0",
"jspdf-autotable": "^5.0.7",
"oxc-transform-react": "^0.157.0",
Expand Down
Loading
Loading