Skip to content
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

chore(jsdoc): fix some JSDoc @link tags #5448

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

alicewriteswrongs
Copy link
Member

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.

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 symbol Foo is 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 in src/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, so d.CompilerSystem can be resolved but CompilerSystem cannot.

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?

  • Yes
  • No

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.

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.
Copy link
Contributor

github-actions bot commented Mar 8, 2024

PR built and packed!

Download the tarball here: https://github.com/ionic-team/stencil/actions/runs/8208080438/artifacts/1310381255

If your browser saves files to ~/Downloads you can install it like so:

unzip -d ~/Downloads ~/Downloads/stencil-core-4.12.5-dev.1709926114.54d7136.tgz.zip && npm install ~/Downloads/stencil-core-4.12.5-dev.1709926114.54d7136.tgz

Copy link
Contributor

github-actions bot commented Mar 8, 2024

--strictNullChecks error report

Typechecking with --strictNullChecks resulted in 1144 errors on this branch.

That's the same number of errors on main, so at least we're not creating new ones!

reports and statistics

Our most error-prone files
Path Error Count
src/dev-server/index.ts 37
src/dev-server/server-process.ts 32
src/compiler/prerender/prerender-main.ts 22
src/testing/puppeteer/puppeteer-element.ts 22
src/runtime/client-hydrate.ts 20
src/screenshot/connector-base.ts 19
src/runtime/vdom/vdom-render.ts 17
src/dev-server/request-handler.ts 15
src/compiler/prerender/prerender-optimize.ts 14
src/compiler/sys/stencil-sys.ts 14
src/compiler/transpile/transpile-module.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/connected-callback.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
Our most common errors
Typescript Error Code Count
TS2322 361
TS2345 349
TS18048 206
TS18047 82
TS2722 37
TS2532 24
TS2531 21
TS2454 14
TS2790 11
TS2352 10
TS2769 8
TS2538 8
TS2416 6
TS2493 3
TS18046 2
TS2684 1
TS2430 1

Unused exports report

There are 14 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 269 normalize
src/utils/index.ts 7 escapeRegExpSpecialCharacters
src/compiler/app-core/app-data.ts 25 BUILD
src/compiler/app-core/app-data.ts 115 Env
src/compiler/app-core/app-data.ts 117 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 alicewriteswrongs marked this pull request as draft March 8, 2024 20:03
@tanner-reits tanner-reits removed their request for review May 2, 2024 19:39
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.

None yet

1 participant