docs: add an MDC migration guide #25543
Conversation
|
|
||
| Depending on the size and complexity of your app, you may want to migrate a single component (or | ||
| small group of components) at a time, rather than all at once. | ||
| TODO(wagnermaciel): Add details on this: script params, which components need to move together |
There was a problem hiding this comment.
The only group of components that need to be migrated together are autocomplete, form-field, input, and select (https://github.com/angular/components/blob/main/src/material/schematics/ng-generate/mdc-migration/index.ts#L21)
There was a problem hiding this comment.
I see, and what happens if I do ng generate @angular/material:mdc-migration --component input? Does that migrate the whole group or do they have to do ng generate @angular/material:mdc-migration --component input,form-field,autocomplete,select?
| identified. | ||
|
|
||
| ```ts | ||
| // TODO(wagnermaciel): Do we have a common format for all TODOs the script adds? |
There was a problem hiding this comment.
For styles, its "TODO: The following rule targets internal classes of COMPONENT_NAME that may no longer apply for the MDC version". (https://github.com/angular/components/blob/main/src/material/schematics/ng-generate/mdc-migration/rules/style-migrator.ts#L183)
There was a problem hiding this comment.
Styles are the only places we add these todos
There was a problem hiding this comment.
We should change it to generate a more searchable TODO, e.g. TODO(MDC):. I'm surprised there's no TODO for templates that use chips-list, are we able to figure out what new version of chips to change them to?
There was a problem hiding this comment.
Yep! It was tricky but we got it working
|
|
||
| Depending on the size and complexity of your app, you may want to migrate a single component (or | ||
| small group of components) at a time, rather than all at once. | ||
| TODO(wagnermaciel): Add details on this: script params, which components need to move together |
There was a problem hiding this comment.
The 3 params are the tsconfig, the directory that will be migrated, and the list of the components (https://github.com/angular/components/blob/main/src/material/schematics/ng-generate/mdc-migration/schema.json).
Right now the integration test's command looks like this:
ng generate @angular/material:mdc-migration --components all --tsconfig tsconfig.app.json (https://github.com/angular/components/blob/main/integration/mdc-migration/migration-test.bzl#L34)
There was a problem hiding this comment.
It'd be good to add an example of migrating specific components as well
There was a problem hiding this comment.
What happens if I don't specify any of the params and just do ng generate @angular/material:mdc-migration do they default to something? does it prompt me?
There was a problem hiding this comment.
I'm 99% sure it does prompt you but @amysorto would know for certain
mmalerba
force-pushed
the
mdc-guide
branch
4 times, most recently
from
5ae81ae to
455af0b
Compare
|
There's still lots of work to be done on this guide, but I'm marking the PR as ready because I'd like to do an initial review and get this in. Then we can divy up the detailed changes section and have everyone contribute improvements |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
No description provided.