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

RFC: Rename @simplewebauthn/typescript-types to something shorter #502

Closed
MasterKale opened this issue Dec 31, 2023 · 3 comments · Fixed by #508
Closed

RFC: Rename @simplewebauthn/typescript-types to something shorter #502

MasterKale opened this issue Dec 31, 2023 · 3 comments · Fixed by #508

Comments

@MasterKale
Copy link
Owner

MasterKale commented Dec 31, 2023

Describe the issue

"@simplewebauthn/typescript-types" is a mouthful of a package name. I am once again feeling the need to explore shortening this, to probably "@simplewebauthn/types". It's already implied that TypeScript is what the types are for, so including "typescript" in the package name has always been redundant.

If I decide to go through with this then I found out I can make the transition to the new package name easier by using npm deprecate to communicate the new name:

https://docs.npmjs.com/cli/v10/commands/npm-deprecate

I'll chew on this for a few days, and consider any feedback anyone might stop by with.

@MasterKale MasterKale pinned this issue Dec 31, 2023
@lps88
Copy link

lps88 commented Jan 17, 2024

would make my package.json neat if it was @types/simplewebauthn :)

@MasterKale
Copy link
Owner Author

MasterKale commented Jan 21, 2024

I went ahead with the package name change with #508. I also ran the following npm command to deprecate @simplewebauthn/typescript-types and point people to @simplewebauthn/types instead:

npm deprecate @simplewebauthn/typescript-types "This package has been renamed to @simplewebauthn/types. Please install @simplewebauthn/types instead to ensure you receive future updates."

Screenshot 2024-01-20 at 10 03 32 PM

@simplewebauthn/typescript-types will no longer shows up in searches on npmjs because of this:

Screenshot 2024-01-20 at 10 03 45 PM

The package rename is complete 🚀

@MasterKale MasterKale unpinned this issue Jan 21, 2024
@MasterKale
Copy link
Owner Author

Docs site has been updated accordingly here:

MasterKale/SimpleWebAuthn-homepage#43

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 a pull request may close this issue.

2 participants