[code-infra] Prevent relative imports across packages

[JCQuintas]

This change should allow us to prevent issues like this: 0baadae

import { SizeProvider } from '../../../../x-charts/src/context/SizeProvider';

[mui-bot]

Deploy preview: https://deploy-preview-15437--material-ui-x.netlify.app/

Generated by 🚫 dangerJS against 2bcbfbf

[LukasTy]

It's strange that this was even needed. 🤔
Which IDE are you running?
I'm almost sure that I haven't seen VSCode suggesting cross-package imports. 🤔

The change makes sense, but my concern is the added runtime cost if not strictly needed. 🙈

[JCQuintas]

I run vscode too...

[Janpot]

Would it be possible to use the no-relative-packages rule here? And would it make sense to move this in the core repo instead?

[JCQuintas]

Would it be possible to use the no-relative-packages rule here? And would it make sense to move this in the core repo instead?

core can't enable this 🫠 https://github.com/mui/material-ui/blob/a0ffee42815b110e14107249f193b7505d1761e5/.eslintrc.js#L245-L246

but using no-relative-packages works for us 👍

[oliviertassinari]

core can't enable this 🫠 https://github.com/mui/material-ui/blob/a0ffee42815b110e14107249f193b7505d1761e5/.eslintrc.js#L245-L246

This was initially added in mui/material-ui#34642. When I run the script again, I get only a few hits:

/Users/oliviertassinari/material-ui/apps/pigment-css-next-app/*

/Users/oliviertassinari/material-ui/apps/pigment-css-vite-app/*

/Users/oliviertassinari/material-ui/dangerFileContent.ts
  3:32  error  Relative import from another package is not allowed. Use `size-snapshot` instead of `./scripts/sizeSnapshot`                                                          import/no-relative-packages
  4:24  error  Relative import from another package is not allowed. Use `@mui-internal/api-docs-builder/utils/replaceUrl` instead of `./packages/api-docs-builder/utils/replaceUrl`  import/no-relative-packages

/Users/oliviertassinari/material-ui/docs/scripts/updateIconSynonyms.js
  7:28  error  Relative import from another package is not allowed. Use `@mui/icons-material/renameFilters/material-design-icons` instead of `../../packages/mui-icons-material/renameFilters/material-design-icons`  import/no-relative-packages

/Users/oliviertassinari/material-ui/packages/rsc-builder/buildRsc.ts
  4:28  error  Relative import from another package is not allowed. Use `@mui-internal/api-docs-builder/utils/findComponents` instead of `../api-docs-builder/utils/findComponents`  import/no-relative-packages
  5:23  error  Relative import from another package is not allowed. Use `@mui-internal/api-docs-builder/utils/findHooks` instead of `../api-docs-builder/utils/findHooks`            import/no-relative-packages

So I think the right move here is

Suggested change

	'import/no-relative-packages': 'error',
	// TODO move to @mui/monorepo
	'import/no-relative-packages': 'error',

2. Enabling the rule in the mono repo and opt-in out in the few places where we do this wrong.

[JCQuintas]

Which command did you run? I get

✖ 648 problems (648 errors, 0 warnings)
  648 errors and 0 warnings potentially fixable with the `--fix` option.

When changing

-'import/no-relative-packages': 'off',
+'import/no-relative-packages': 'error',

and running pnpm eslint:ci

[oliviertassinari]

@JCQuintas I had the same number of errors: 648. I collapsed all the errors that seemed to be duplicated. So a "few" that needs to be fixed manually 😄

[JCQuintas]

I tried it out and I don't think I have the necessary knowledge to make the right call on the material package changes 🙃

Once the changes are fixed some other issues appear:

/Users/jcquintas/dev/mui/material-ui/dangerFileContent.ts

// Can't resolve
import { loadComparison } from 'size-snapshot';

/Users/jcquintas/dev/mui/material-ui/docs/scripts/updateIconSynonyms.js

// eslint

  7:1   error  '@mui/icons-material/renameFilters/material-design-icons' import is restricted from being used by a pattern. Prefer one level nested imports to avoid bundling everything in dev mode or breaking CJS/ESM split.
See https://github.com/mui/material-ui/pull/24147 for the kind of win it can unlock  no-restricted-imports
  7:28  error  Unable to resolve path to module '@mui/icons-material/renameFilters/material-design-icons'   

[oliviertassinari]

I tried in mui/material-ui#44489.