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

[license] Rename @mui/x-license-pro to @mui/x-license #11938

Merged
merged 8 commits into from
Feb 6, 2024

Conversation

cherniavskii
Copy link
Member

@cherniavskii cherniavskii commented Feb 5, 2024

Currently, @mui/x-license-pro is used for Pro and Premium packages.
This is confusing, so I'm taking the opportunity to make this change in v7 beta.

Close #4250

TODO:

  • Update migration guide

Changelog

Breaking changes

-import { LicenseInfo } from '@mui/x-license-pro';
+import { LicenseInfo } from '@mui/x-license';

@cherniavskii cherniavskii added breaking change package: x-license Specific to @mui/x-license. labels Feb 5, 2024
@cherniavskii cherniavskii marked this pull request as ready for review February 5, 2024 13:01
@LukasTy LukasTy added the v7.x label Feb 5, 2024
Copy link
Member

@LukasTy LukasTy left a comment

Choose a reason for hiding this comment

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

Great work! 👏

@@ -31,6 +35,22 @@ To have the option of using the latest API from `@mui/material`, the package pee
It is a change in minor version only, so it should not cause any breaking changes.
Please update your `@mui/material` package to this or a newer version.

## Update the license package

If you're using the commerical versions of the Data Grid ([Pro](/x/introduction/licensing/#pro-plan) and [Premium](/x/introduction/licensing/#premium-plan) plans), you need to update the license package to the latest version.
Copy link
Member

Choose a reason for hiding this comment

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

Are we sure about this? 🤔
The license package is a direct dependency of the commercial packages, the latest version will be downloaded if they are using the latest package version. 🤔
If we are referring to cases, where people are adding this dependency due to their package manager behavior, then maybe can make this section optional and move it below the import update, which is a clear BC for everyone? 🤔

Copy link
Member Author

Choose a reason for hiding this comment

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

My assumption here was that if they import from the package, it's very likely they have it in their dependencies as well.
But good point, the import path update is more important here 👍🏻

@cherniavskii cherniavskii requested a review from LukasTy February 5, 2024 19:14
Copy link
Member

@LukasTy LukasTy left a comment

Choose a reason for hiding this comment

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

🙌 💯

@cherniavskii cherniavskii enabled auto-merge (squash) February 6, 2024 09:56
@cherniavskii cherniavskii merged commit 8394944 into mui:next Feb 6, 2024
15 checks passed
@cherniavskii cherniavskii deleted the rename-license-package branch February 6, 2024 10:11
@oliviertassinari
Copy link
Member

This closes #4250

thomasmoon pushed a commit to thomasmoon/mui-x that referenced this pull request Sep 9, 2024
@oliviertassinari
Copy link
Member

oliviertassinari commented Sep 17, 2024

Deprecation message added to the old npm package name:

SCR-20240917-slpt

https://www.npmjs.com/package/@mui/x-license-pro

This should help a bit developers during their migration, at the expense of degrading a bit the DX for folks who don't plan to upgrade. MUI X v7 was released 6 months ago, it's plenty of time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants