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

Reapply "docs: exclude inherits, update deps (#12628)" (#12645) #12690

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

ThangHuuVu
Copy link
Member

@ThangHuuVu ThangHuuVu commented Feb 22, 2025

  • Upgrade typedoc & plugins
  • Added jonchardy/typedoc-plugin-no-inherit
  • remove warnings.mdx, instead put it in the source code. Updated the reference in the logs to point to the new destination

Copy link

vercel bot commented Feb 22, 2025

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

Name Status Preview Comments Updated (UTC)
auth-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 23, 2025 2:22pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
next-auth-docs ⬜️ Ignored (Inspect) Visit Preview Feb 23, 2025 2:22pm
proxy ⬜️ Ignored (Inspect) Visit Preview Feb 23, 2025 2:22pm

@github-actions github-actions bot added providers adapters Changes related to the core code concerning database adapters core Refers to `@auth/core` prisma @auth/prisma-adapter mongodb @auth/mongodb-adapter kysely labels Feb 22, 2025
Copy link

codecov bot commented Feb 22, 2025

Codecov Report

Attention: Patch coverage is 97.29730% with 3 lines in your changes missing coverage. Please review.

Project coverage is 39.63%. Comparing base (af2ccea) to head (b0be64a).

Files with missing lines Patch % Lines
packages/core/src/lib/utils/logger.ts 50.00% 1 Missing ⚠️
packages/core/src/providers/frontegg.ts 0.00% 1 Missing ⚠️
packages/core/src/providers/logto.ts 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12690      +/-   ##
==========================================
+ Coverage   39.46%   39.63%   +0.17%     
==========================================
  Files         198      198              
  Lines       31306    31397      +91     
  Branches     1372     1372              
==========================================
+ Hits        12354    12445      +91     
  Misses      18952    18952              

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

@@ -32,6 +32,7 @@ packages/next-auth/providers
# copied from @auth/core
packages/frameworks-*/**/providers
packages/*/*.js
!packages/*/typedoc.config.js
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

have to convert some files to .js so this will prevent the file from being deleted by clean scripts

@@ -72,7 +72,7 @@ export default withNextra({
{
source: "/:path(.*)",
has: [{ type: "host", value: "warnings.authjs.dev" }],
destination: "https://authjs.dev/reference/warnings/:path*",
destination: "https://authjs.dev/reference/core/errors#warningcode",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TBD: should we put warning code under /errors or we make a new file for it in the source code.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

had to convert this file to ESM because of [email protected]

],
disableSources: true,
excludeNotDocumented: true,
excludeExternals: true,
excludeInternal: true,
excludePrivate: true,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is now the default

@@ -75,8 +76,5 @@ module.exports = {
expandObjects: true,
parametersFormat: "table",
indexFormat: "table",
textContentMappings: {
Copy link
Member Author

@ThangHuuVu ThangHuuVu Feb 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure about this - I feel like it's unnecessary. This option is also deprecated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
adapters Changes related to the core code concerning database adapters core Refers to `@auth/core` kysely mongodb @auth/mongodb-adapter prisma @auth/prisma-adapter providers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants