Repository navigation
Conversation
TypeDoc omits the GitHub "Defined in" link when the git path does not match the TypeScript filename. src/configuration.ts was tracked with different casing than Configuration.ts, so those links stayed plain text. Match the casing, and fail the docs build if any source line is still unlinked. Closes #93
esitarz
changed the title
2 of 4 tasks
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
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
git ls-filescasing matches the TypeScript filename.src/configuration.tswas tracked in a different case thanConfiguration.ts, so those links stayed plain text no matter how many times docs were built.npm run build:docsnow fails if any generated page still has an unlinked "Defined in" line.npm run build:docs, and a second TypeDoc run produce the sameResources.Addresses.html. The Addresses page from Need to run build twice in order to generate docs links #93 already has GitHub links on the first run with TypeDoc 0.28.20.Closes #93
Test plan
docs/, runnpm run build:docsonce, and confirm the check reports GitHub source linksdocs/classes/Resources.Addresses.htmlanddocs/classes/Resources.Configuration.htmlare unchangedResources.Configuration.html"Defined in" lines are GitHub links tosrc/Configuration.tsnpx jest --config tests/config/server.config.js tests/configuration.test.ts