fix(docs): generate the API documentation from the built declarations - #40
Merged
Merged
Conversation
Since e1bdc29 dropped the blanket `*.vue` module declaration, typedoc cannot resolve the `.vue` imports in `lib/` and the docs workflow fails on every push to main. typedoc runs plain tsc, which knows nothing about Vue single file components. The declarations `npm run build` rolls up into `dist/index.d.ts` already have those components typed, along with the doc comments, so typedoc now reads that file instead, through a tsconfig that includes it. `build:doc` runs the build first so the file is there. Assisted-by: ClaudeCode:claude-opus-5 Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
skjnldsv
added
status: review
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #40 +/- ##
=======================================
Coverage 87.83% 87.83%
=======================================
Files 36 36
Lines 2474 2474
Branches 519 519
=======================================
Hits 2173 2173
Misses 297 297
Partials 4 4 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
The Documentation workflow has failed on every push to
mainsince #34 (e1bdc29) removed the blanket*.vuemodule declaration:typedoc runs plain tsc, so it cannot resolve single file components on its own. Rather than bringing the shim back (it hid broken component types, which is why #34 removed it), typedoc now reads
dist/index.d.ts, the declarations the build already rolls up with the components typed and the doc comments intact.build:docrunsnpm run buildfirst so the file exists.Generated locally: the
Viewerclass, the five functions,IHandler/ViewerAPI/ViewerEmits/ViewerProps, andViewerOptions, the same set as the last green run. Latest red run: https://github.com/nextcloud-libraries/nextcloud-viewer/actions/runs/34610176996👾 This pull request was assisted by Claude Code, commits carry an
Assisted-bytrailer.