Skip to content

feat(api-extractor): emit warnings for missing jsdoc or typings #10899

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Qjuh
Copy link
Member

@Qjuh Qjuh commented May 14, 2025

Please describe the changes this PR makes and why it should be merged:

API Extractor will emit warnings for any typings that have no JSDoc equivalent in the JavaScript files.

Similarly will emit warnings for JSDoc comments that have no matching typing.

Status and versioning classification:

Copy link

vercel bot commented May 14, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
discord-js ⬜️ Ignored (Inspect) Visit Preview May 19, 2025 5:33pm
discord-js-guide ⬜️ Ignored (Inspect) Visit Preview May 19, 2025 5:33pm

@Qjuh Qjuh force-pushed the ae/missing-jsdoc-or-types branch from b818d0d to de09d37 Compare May 19, 2025 17:32
Copy link

codecov bot commented May 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 42.68%. Comparing base (c92a8c2) to head (de09d37).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10899      +/-   ##
==========================================
+ Coverage   42.63%   42.68%   +0.05%     
==========================================
  Files         262      262              
  Lines       16115    16095      -20     
  Branches     1547     1547              
==========================================
  Hits         6870     6870              
+ Misses       9233     9213      -20     
  Partials       12       12              
Flag Coverage Δ
brokers 31.41% <ø> (ø)
builders 80.49% <ø> (ø)
collection 100.00% <ø> (ø)
core 0.89% <ø> (ø)
formatters 99.63% <ø> (ø)
proxy 65.88% <ø> (ø)
rest 87.76% <ø> (ø)
util 43.28% <ø> (ø)
voice 70.90% <ø> (ø)
ws 36.29% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

1 participant
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy