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

fix(shared): Add Clerk prefix in deprecation warnings #1890

Merged
merged 1 commit into from
Oct 16, 2023

Conversation

dimkl
Copy link
Contributor

@dimkl dimkl commented Oct 16, 2023

Description

Add Clerk prefix in deprecation warnings

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/clerk-js
  • @clerk/clerk-react
  • @clerk/nextjs
  • @clerk/remix
  • @clerk/types
  • @clerk/themes
  • @clerk/localizations
  • @clerk/clerk-expo
  • @clerk/backend
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/fastify
  • @clerk/chrome-extension
  • gatsby-plugin-clerk
  • build/tooling/chore

@dimkl dimkl self-assigned this Oct 16, 2023
@dimkl dimkl requested a review from a team as a code owner October 16, 2023 09:50
@changeset-bot
Copy link

changeset-bot bot commented Oct 16, 2023

🦋 Changeset detected

Latest commit: 113c14d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 11 packages
Name Type
@clerk/shared Patch
@clerk/backend Patch
@clerk/clerk-js Patch
@clerk/clerk-expo Patch
@clerk/fastify Patch
@clerk/nextjs Patch
@clerk/clerk-react Patch
@clerk/remix Patch
@clerk/clerk-sdk-node Patch
gatsby-plugin-clerk Patch
@clerk/chrome-extension Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@@ -29,7 +29,7 @@ export const deprecated = (fnName: string, warning: string, key?: string): void
displayedWarnings.add(messageId);

console.warn(
`DEPRECATION WARNING: "${fnName}" is deprecated and will be removed in the next major release.\n${warning}`,
`DEPRECATION WARNING: Clerk "${fnName}" is deprecated and will be removed in the next major release.\n${warning}`,
Copy link
Member

Choose a reason for hiding this comment

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

Maybe something like this or similar?

Suggested change
`DEPRECATION WARNING: Clerk "${fnName}" is deprecated and will be removed in the next major release.\n${warning}`,
`Clerk - DEPRECATION WARNING: "${fnName}" is deprecated and will be removed in the next major release.\n${warning}`,

Copy link
Member

@LekoArts LekoArts Oct 16, 2023

Choose a reason for hiding this comment

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

If we'd want we could get fancy and use something like https://github.com/GoogleChrome/workbox/blob/v7/packages/workbox-core/src/_private/logger.ts

This relates to https://developer.mozilla.org/en-US/docs/Web/API/console#styling_console_output

So we could do:

console.warn('%cClerk', styles.join(';'), 'MESSAGE')

Copy link
Member

Choose a reason for hiding this comment

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

I do like the styles

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let's open a discussion in Slack about theming our logs in general and implement it as different PRs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nikosdouvlis i have updated the formatting of the warnings. PTAL

@dimkl dimkl added this pull request to the merge queue Oct 16, 2023
Merged via the queue into main with commit 9b644d7 Oct 16, 2023
11 of 12 checks passed
@dimkl dimkl deleted the clerk-prefix-deprecation branch October 16, 2023 12:52
@clerk-cookie clerk-cookie mentioned this pull request Oct 16, 2023
@clerk-cookie
Copy link
Collaborator

This PR has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@clerk clerk locked as resolved and limited conversation to collaborators Oct 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants