docs: include Vite and Next.js plugins in TypeDoc API docs build (NE-6952)#218
Open
kaktus-klaus wants to merge 1 commit intoneedle-tools:mainfrom
Open
docs: include Vite and Next.js plugins in TypeDoc API docs build (NE-6952)#218kaktus-klaus wants to merge 1 commit intoneedle-tools:mainfrom
kaktus-klaus wants to merge 1 commit intoneedle-tools:mainfrom
Conversation
…6952) Adds plugins/types/vite.d.ts and plugins/types/next.d.ts as TypeDoc entry points so that all Needle Engine Vite plugins (needlePlugins, needleAI, needlePWA, needleBuild, etc.) appear in the API docs site. Changes: - tools/build_api_docs.mjs: two new entryPoints for vite.d.ts and next.d.ts - tools/api-plugins/tsconfig.json: extend include glob to cover .temp/**/plugins/types/**/*.ts so TypeScript can resolve plugin types Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Companion to needle-tools/needle-tiny#923 — makes the Needle Engine Vite plugins visible in the public API documentation at
engine.needle.tools/docs/api.tools/build_api_docs.mjs— addsplugins/types/vite.d.tsandplugins/types/next.d.tsas new TypeDoc entry points alongside the existingsrc/engine/api.tsentries.tools/api-plugins/tsconfig.json— extends theincludeglob with../../.temp/**/plugins/types/**/*.tsso TypeScript resolves plugin type imports correctly during the docs build.After this change, TypeDoc will render a Vite Plugins module in the API docs showing
needlePlugins,loadConfig,useGzip, and all ~24 individual sub-plugin exports — each with full JSDoc descriptions, parameter docs, return types, and usage examples.Test plan
node tools/build_api_docs.mjs --devlocally; confirm no TypeDoc errorsapi/directory contains a page for the Vite plugins moduleneedlePluginsandneedlePWAboth appear with their full docstringssrc/module pages are unaffected🤖 Generated with Claude Code