chore(jsdoc): fix some JSDoc @link tags
#5448
Merged
Conversation
This file contains 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
PR built and packed!Download the tarball here: https://github.com/ionic-team/stencil/actions/runs/9369282779/artifacts/1567241222 If your browser saves files to |
|
| Path | Error Count |
|---|---|
| src/dev-server/index.ts | 37 |
| src/dev-server/server-process.ts | 32 |
| src/compiler/prerender/prerender-main.ts | 22 |
| src/runtime/vdom/vdom-render.ts | 21 |
| src/runtime/client-hydrate.ts | 20 |
| src/screenshot/connector-base.ts | 19 |
| src/testing/puppeteer/puppeteer-element.ts | 19 |
| src/dev-server/request-handler.ts | 15 |
| src/compiler/prerender/prerender-optimize.ts | 14 |
| src/compiler/sys/stencil-sys.ts | 14 |
| src/runtime/connected-callback.ts | 14 |
| src/sys/node/node-sys.ts | 14 |
| src/compiler/prerender/prerender-queue.ts | 13 |
| src/compiler/sys/in-memory-fs.ts | 13 |
| src/runtime/set-value.ts | 13 |
| src/compiler/output-targets/output-www.ts | 12 |
| src/compiler/transformers/test/parse-vdom.spec.ts | 12 |
| src/compiler/transformers/transform-utils.ts | 12 |
| src/mock-doc/test/attribute.spec.ts | 12 |
| src/compiler/build/compiler-ctx.ts | 11 |
Our most common errors
| Typescript Error Code | Count |
|---|---|
| TS2322 | 351 |
| TS2345 | 330 |
| TS18048 | 193 |
| TS18047 | 76 |
| TS2722 | 27 |
| TS2532 | 24 |
| TS2531 | 19 |
| TS2454 | 14 |
| TS2790 | 11 |
| TS2352 | 9 |
| TS2769 | 8 |
| TS2416 | 7 |
| TS2538 | 4 |
| TS2493 | 3 |
| TS18046 | 2 |
| TS2684 | 1 |
| TS2430 | 1 |
Unused exports report
There are 15 unused exports on this PR. That's the same number of errors on main, so at least we're not creating new ones!
Unused exports
| File | Line | Identifier |
|---|---|---|
| src/runtime/bootstrap-lazy.ts | 21 | setNonce |
| src/screenshot/screenshot-fs.ts | 18 | readScreenshotData |
| src/testing/testing-utils.ts | 198 | withSilentWarn |
| src/utils/index.ts | 145 | CUSTOM |
| src/utils/index.ts | 245 | NODE_TYPES |
| src/utils/index.ts | 269 | normalize |
| src/utils/index.ts | 7 | escapeRegExpSpecialCharacters |
| src/compiler/app-core/app-data.ts | 25 | BUILD |
| src/compiler/app-core/app-data.ts | 116 | Env |
| src/compiler/app-core/app-data.ts | 118 | NAMESPACE |
| src/compiler/fs-watch/fs-watch-rebuild.ts | 123 | updateCacheFromRebuild |
| src/compiler/types/validate-primary-package-output-target.ts | 61 | satisfies |
| src/compiler/types/validate-primary-package-output-target.ts | 61 | Record |
| src/testing/puppeteer/puppeteer-declarations.ts | 485 | WaitForEventOptions |
| src/compiler/sys/fetch/write-fetch-success.ts | 7 | writeFetchSuccessSync |
alicewriteswrongs
force-pushed
the
ap/fix-jsdoc-links
branch
from
b6ce294
to
19e66e8
Compare
This fixes some `@link` tags in JSDoc which weren't resolving correctly. Since the Typedoc tool reports on `@link` tags which it can't resolve we can use that to find them.
alicewriteswrongs
force-pushed
the
ap/fix-jsdoc-links
branch
from
19e66e8
to
8d0fcca
Compare
tanner-reits
approved these changes
Jun 4, 2024
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.
This fixes some
@linktags in JSDoc which weren't resolving correctly. Since the Typedoc tool reports on@linktags which it can't resolve we can use that to find them.What is the current behavior?
Some of these links don't actually resolve! It's a bit hard to see this, but one way that I can test if the
{@link Foo}is correctly resolving the symbolFoois to ask the LSP about it in my editor. If the name can be resolved then I'll see some info about it, otherwise I won't. This shows the before and after of this insrc/cli/run.ts:Screen.Recording.2024-03-08.at.2.24.04.PM.mov
We have
import type * as d from '../declarations';at the top of the file, sod.CompilerSystemcan be resolved butCompilerSystemcannot.What is the new behavior?
Several of these are fixed! A few where it would be required to add a new import to a module in order to get something to resolve I just turned into comments instead.
Does this introduce a breaking change?
Testing
Try to make sure that these actually resolve, possibly using the method outlined above with the LSP in an editor. Or just try to reason about it.