Files
supabase/apps/docs/scripts/build-reference-content.test.ts
T
f20cd22dc3 docs: improve SDK automation build step on docs (#46163)
# Second try of making a new better process for SDK automation

Instead of building a new pipeline. We will take the lessons learned
form round 1, plus the good design and improvement on DX quality for
drop-in file as a single step required from SDK team and produce almost
identical set of files as used right now to render using the current
pipeline.



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* New reference-content pipeline producing per-library reference
artifacts and integrating into prebuilds, search ingestion, and
rendering (type-aware examples).

* **Documentation**
* Added comprehensive JavaScript SDK v2 reference content and partials
(Auth MFA, passkeys, admin, TypeScript support, filters, modifiers,
Installing, Initializing, Buckets, etc.).

* **Tests & CI**
* Added regression snapshot test and updated workflows to refresh
reference snapshots and ensure spec downloads.

* **Chores**
* Updated ignore rules, build scripts, Makefile targets, and package
lifecycle hooks.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Katerina Skroumpelou <mandarini@users.noreply.github.com>
Co-authored-by: Katerina Skroumpelou <sk.katherine@gmail.com>
2026-06-03 11:46:02 +03:00

23 lines
934 B
TypeScript

import { describe, expect, it } from 'vitest'
import { collectReferenceContent } from './build-reference-content'
/**
* Regression guard for the new reference-content pipeline. Snapshots the five
* derived artifacts produced for `javascript/v2` so that any change in the
* extraction logic (or in the upstream supabase-js TypeDoc output) shows up
* as a snapshot diff in CI rather than silently shifting what the renderer
* sees. When the supabase-js `make` workflow lands a new release in
* `spec/reference/javascript/v2/`, re-run with `--update` to refresh the
* baseline as part of the same PR.
*/
describe('build-reference-content — javascript/v2', () => {
it('matches snapshot', async () => {
const { bySlug, flat, sections, functionsList, typeSpec } = await collectReferenceContent(
'javascript',
'v2'
)
expect({ bySlug, flat, sections, functionsList, typeSpec }).toMatchSnapshot()
})
})