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

[RFC] Restructure folder structure #28182

Closed
mnajdova opened this issue Sep 6, 2021 · 2 comments · Fixed by #28185
Closed

[RFC] Restructure folder structure #28182

mnajdova opened this issue Sep 6, 2021 · 2 comments · Fixed by #28185

Comments

@mnajdova
Copy link
Member

mnajdova commented Sep 6, 2021

Now that we renamed the packages, it is probably a good idea to rename the folders we have for each mackage. Currently, the packages are prefixed with "material-ui" and have the old package name. I propose to rename them to: "mui-[package-name]". This is what the updated names would be:

material-ui -> mui-material
material-ui-benchmark -> mui-benchmark
material-ui-codemod -> mui-codemod
material-ui-docs -> mui-docs
material-ui-envinfo -> mui-envinfo
material-ui-icons -> mui-icons-material
material-ui-lab -> mui-lab
material-ui-private-theming -> mui-private-theming
material-ui-styled-engine -> mui-styled-engine
material-ui-styled-engine-sc -> mui-styled-engine-sc
material-ui-styles -> mui-styles
material-ui-system ->mui-system
material-ui-types -> mui-types
material-ui-unstyled -> mui-core
material-ui-utils -> mui-utils
netlify-plugin-cache-docs // no change
typescript-to-proptypes // no change

I am opening the issue so that we can align on the names before I do the change that will basically affect the whole project.

This is not a public change, and we can do it whenever we think it's the right time.

@mnajdova mnajdova added status: waiting for maintainer These issues haven't been looked at yet by a maintainer discussion and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Sep 6, 2021
@eps1lon
Copy link
Member

eps1lon commented Sep 6, 2021

Yep, I think we always wanted to rename the folders anyway for better DX (who wants to type material-ui- all the time?).

Note that we we rely on the naming of the folders in some places. For example, ApiPage is already broken since it assumes material-ui maps to @mui/core and material-ui-unstyled maps to @mui/unstyled: https://github.com/eps1lon/material-ui/blob/4014fb8ade6195edd6921b6357529537458d70d1/docs/src/modules/components/ApiPage.js#L210

There are probably other places as well that assume that folder names map to package names.

@mnajdova
Copy link
Member Author

mnajdova commented Sep 6, 2021

Didn't noticed the issue. Alright, going to do the change today.

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

Successfully merging a pull request may close this issue.

2 participants