MasterKale / SimpleWebAuthn

WebAuthn, Simplified. A collection of TypeScript-first libraries for simpler WebAuthn integration. Supports modern browsers, Node, Deno, and more.
https://simplewebauthn.dev
MIT License
1.62k stars 137 forks source link

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

Closed MasterKale closed 10 months ago

MasterKale commented 10 months ago

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.

lps88 commented 10 months ago

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

MasterKale commented 10 months ago

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 commented 10 months ago

Docs site has been updated accordingly here:

https://github.com/MasterKale/SimpleWebAuthn-homepage/pull/43