[core] Ensure component class keys aren't missing

[eps1lon]

For review I would suggest going by commits and ignore ff08701 (#25754) and instead review https://gist.github.com/eps1lon/4326159c3968e74548b757cb9c69ccd2 which generated ff08701 (#25754)

The goal is to make sure that Props['classes'] lists all the classes automatically that are used. Unfortunately we can only decide on one:
A. Make sure that all properties in Props['classes'] are listed in generateUtilityClasses
B. Make sure that all classes in generateUtilityClasses are listed in Props['classes']

We can't ensure an exact match (as far as I can tell¹) but at least we can make sure that one is a subset of another. I choose A since that allows us to have "private" classes e.g. in const classes: { root: string } = generateUtilityClasses('MuiComponent', ['root', 'active']) MuiComponent-active would not be documented.

Benefits:

The classes documentation is now available on hover when working in the component implementation:

The public *Classes (e.g. AccordionClasses) type has now the same JSDOC has the classes prop.

I'm also going to remove the JSDOC class documentation from the implementation in a follow-up (for git-blame). We no longer verify these match with the documentation and the JSDOC in the implementation was already outdated. They're still either on hover or one file away. A missing comment is better than a misleading one in the end.

¹TypeScript playground for the proposal

[mui-pr-bot]

Details of bundle changes (experimental)

@material-ui/core: parsed: +0.09% , gzip: +0.05%

Generated by 🚫 dangerJS against b79c297

[mnajdova]

The goal is to make sure that Props['classes'] lists all the classes automatically that are used. Unfortunately we can only decide on one:
A. Make sure that all properties in Props['classes'] are listed in generateUtilityClasses
B. Make sure that all classes in generateUtilityClasses are listed in Props['classes']
We can't ensure an exact match (as far as I can tell1) but at least we can make sure that one is a subset of another. I choose A since that allows us to have "private" classes e.g. in const classes: { root: string } = generateUtilityClasses('MuiComponent', ['root', 'active']) MuiComponent-active would not be documented.

Agree, for choosing A.

[oliviertassinari]

It looks great. So it's a follow-up on #24736, it seems we push option 1 further.

[eps1lon]

Alright, thanks for the feedback. Looks like it's pretty much uncontroversial so I'll go ahead and apply this in all relevant places over the next week.

[mnajdova]

Looks great, I like how you were able to find missing classes and fix them 👍 @siriwatknp to be aware of these changes, for the migration PRs that are coming up.