Skip to content

Sdk spec gen #2029

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.

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Sdk spec gen #2029

wants to merge 3 commits into from

Conversation

gewenyu99
Copy link

@gewenyu99 gewenyu99 commented Jun 18, 2025

Changes

See RFC PostHog/meta#324

2 new commands to generate specs.

        "gen-specs": "npx tsc && npx api-extractor run --config ./api-extractor.json --local",
        "parse-specs": "ts-node scripts/specs/parser.ts"

Uses Microsoft's tsdoc standard and api extractor tool to generate a hogRef spec. We will use this to parse in website to display full API refs.

Changes to existing doc comments are incomplete. Help appreciated if you want to add doc comments for things you own!

Copy link

vercel bot commented Jun 18, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
posthog-js ❌ Failed (Inspect) Jun 23, 2025 2:11pm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant