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(material): ng-add should always install matching CDK version #18076

Conversation

devversion
Copy link
Member

Currently ng-add for Angular Material determines the version name
of the CDK and Angular Material by looking for @angular/cdk/package.json
and @angular/material/package.json in the node modules.

This is incorrect because other installed packages could rely on older
CDK versions being installed. In those cases, we don't want to add that
transitively installed CDK version to the package.json file. Instead,
we always want to add the CDK version that matches Angular Material.

We can do this by just relying on the version placeholder we use in
other locations too.

Also in the issue ticket (#18020) it was mentioned that we might want
to warn if a lower CDK version is transitively installed. This seems unnecessary
since we explicitly add a project-scoped dependency on the CDK and transitive
CDK dependencies are scoped to the packages that require it. Also I think it would be
out of scope for ng add to handle potential scenarios of non-matching CDK installations.

Fixes #18020

Currently ng-add for Angular Material determines the version name
of the CDK and Angular Material by looking for `@angular/cdk/package.json`
and `@angular/material/package.json` in the node modules.

This is incorrect because other installed packages could rely on older
CDK versions being installed. In those cases, we don't want to add that
transitively installed CDK version to the `package.json` file. Instead,
we always want to add the CDK version that matches Angular Material.

We can do this by just relying on the version placeholder we use in
other locations too.

Also in the issue ticket (angular#18020) it was mentioned that we might want
to warn if a lower CDK version is transitively installed. This seems
unnecessary since we explicitly add a project-scoped dependency on the
CDK and transitive CDK dependencies are nothing we should bother about.
In general, if someone runs `ng add @angular/material` it's _only_ right
to always install a working/matching version of the CDK.

Fixes angular#18020
@devversion devversion added P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent pr: merge safe target: patch This PR is targeted for the next patch release labels Dec 31, 2019
@devversion devversion requested a review from jelbourn as a code owner December 31, 2019 14:16
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Dec 31, 2019
Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

LGTM

@jelbourn jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker labels Jan 10, 2020
@mmalerba mmalerba merged commit fba22bc into angular:master Jan 10, 2020
@Splaktar Splaktar modified the milestone: 9.0.0 Jan 10, 2020
yifange pushed a commit to yifange/components that referenced this pull request Jan 30, 2020
…ular#18076)

Currently ng-add for Angular Material determines the version name
of the CDK and Angular Material by looking for `@angular/cdk/package.json`
and `@angular/material/package.json` in the node modules.

This is incorrect because other installed packages could rely on older
CDK versions being installed. In those cases, we don't want to add that
transitively installed CDK version to the `package.json` file. Instead,
we always want to add the CDK version that matches Angular Material.

We can do this by just relying on the version placeholder we use in
other locations too.

Also in the issue ticket (angular#18020) it was mentioned that we might want
to warn if a lower CDK version is transitively installed. This seems
unnecessary since we explicitly add a project-scoped dependency on the
CDK and transitive CDK dependencies are nothing we should bother about.
In general, if someone runs `ng add @angular/material` it's _only_ right
to always install a working/matching version of the CDK.

Fixes angular#18020
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Feb 10, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ng-add: schematic breaks if a lower version of CDK is already installed
5 participants