[code-infra] Bring eslint configuration from core and bump to v9 #344

brijeshb42 · 2025-05-30T11:00:11Z

This is now exposed as a package that can be imported and assembled with
minimum code on the client repos.

Migrated eslint-plugin-material-ui to its own subpath.
Airbnb config has been assembled in its own subpath.
Common configs used in core repo have been moved here.

The package also exposes the common prettier config.

One of the pending discussions would be what level of abstraction do we want in this new package because a lot of the overrides in the core repo target files/folders that pertain to that repo itself and are not relevant in other repos.

Migration PR on core - mui/material-ui#46258
Base UI - mui/base-ui#2054

Closes #264

Janpot · 2025-06-03T11:27:41Z

eslint.config.mjs

+import { includeIgnoreFile } from '@eslint/compat';
+import { defineConfig, globalIgnores } from 'eslint/config';
+import * as path from 'node:path';
+import baseConfig from '@mui/infra/eslint';


Would it make sense for these to be factory functions? So that we can pass configuration such as tsconfig locations:

{ name: 'Base config', extends: createBaseConfig(), rules: { 'import/prefer-default-export': 'off', // No time for this 'react/prop-types': 'off', 'jsx-a11y/control-has-associated-label': 'off', 'jsx-a11y/no-autofocus': 'off', }, },

The only thing that I came across to require factory was conditionally enabling react-compiler plugin based on params.
So far in the process of migration, no other use-case has surfaced.

I can imagine us to cook up some quite extensive factory for things like https://github.com/mui/mui-x/blob/ef29b0c82d874564c2d9a4a59d0164ffb625f9b9/.eslintrc.js#L60

🤔 Maybe it's too much future proofing, but if we make factory functions by default we don't have to make breaking changes to introduce one if needed at some point

Yeah. Makes sense.

Janpot · 2025-06-03T11:28:24Z

eslint.config.mjs

+import { defineConfig, globalIgnores } from 'eslint/config';
+import * as path from 'node:path';
+import baseConfig from '@mui/infra/eslint';
+import testConfig from '@mui/infra/eslint-test';


Let's keep the amount subpath exports low?

Suggested change

import testConfig from '@mui/infra/eslint-test';

import { testConfig, baseConfig } from '@mui/infra/eslint';

Janpot · 2025-06-03T11:28:41Z

eslint.config.mjs

+    settings: {
+      'import/resolver': {
+        typescript: {
+          project: ['tsconfig.node.json', 'apps/*/tsconfig.json', 'packages/*/tsconfig.json'],


This can probably be the default?

Janpot · 2025-06-03T11:31:19Z

prettier.config.mjs

@@ -0,0 +1,3 @@
+import baseline from '@mui/infra/prettier';


Let's use named export? Also, would it be beneficial for the future to use factory functions as well?

Janpot

👌 top-notch!

LukasTy

Great work on this one! 👍 💯
Thank you for taking care of it. 🙏
Leaving some suggestions and questions.

LukasTy · 2025-06-27T10:07:50Z

.github/workflows/scripts/prs/checkTargetBranchLabel.js

@@ -1,6 +1,6 @@
 // @ts-check
 const vBranchRegex = /^v\d{1,3}\.x$/;
-const transferLabels = ['cherry-pick'];
+// const transferLabels = ['cherry-pick'];


Looks like a leftover. 🙈

Suggested change

// const transferLabels = ['cherry-pick'];

packages/code-infra/package.json

LukasTy · 2025-06-27T10:21:12Z

packages/code-infra/package.json

+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mui/mui-public.git",
+    "directory": "packages/mui-internal-code-infra"


Suggested change

"directory": "packages/mui-internal-code-infra"

"directory": "packages/code-infra"

LukasTy · 2025-06-27T10:25:17Z

packages/code-infra/package.json

+  },
+  "peerDependencies": {
+    "eslint": "^9.0.0",
+    "prettier": "^3.0.0"


I assume that typescript-eslint should also be the peer dependency, shouldn't it? 🤔
P.S. Is there point in having only eslint and prettier as optional peer deps, but we still have a bunch of other direct dependencies related to eslint..? 🙈 🤷

It is not needed because in the repo, you don't directly import it or try to use it in some way. It is already configured for you.
Agree about the optional peer dep. Removing it since you anyways need to install these two explicitly to access the CLI command.

LukasTy · 2025-06-27T10:45:35Z

packages/code-infra/src/eslint/testConfig.mjs

@@ -0,0 +1,104 @@
+import mochaPlugin from 'eslint-plugin-mocha';


This is not needed on mui-x.
Maybe we could have made it opt-in as it will be eventually removed from all repos..? 🤔

Making it configurable so that it can be excluded where required.

or perhaps a separate mocha preset?

LukasTy · 2025-06-27T10:50:25Z

packages/code-infra/src/prettier.mjs

+      {
+        files: ['docs/**/*.md', 'docs/src/pages/**/*.{js,tsx}', 'docs/data/**/*.{js,tsx}'],
+        options: {
+          // otherwise code blocks overflow on the docs website
+          // The container is 751px
+          printWidth: 85,
+        },
+      },
+      {
+        files: ['docs/pages/blog/**/*.md'],
+        options: {
+          // otherwise code blocks overflow on the blog website
+          // The container is 692px
+          printWidth: 82,
+        },
+      },


Nitpick: I'd say that these configs could/should be repo-dependent.
I.e, they might make no sense on base-ui.
And in general, I don't understand the point in these...
Am I missing something? But the content will jump to the new line.
What's the point of limiting the length of the line? 🤷

brijeshb42 · 2025-06-27T11:05:07Z

@LukasTy Thanks for the comments. I'll address the feedback in a separate PR

Addresses some of the comments from the previous PR #344

Signed-off-by: Lukas Tyla <[email protected]> Co-authored-by: Brijesh Bittu <[email protected]> Co-authored-by: Lukas Tyla <[email protected]>

brijeshb42 requested a review from Janpot May 30, 2025 11:00

brijeshb42 added the scope: code-infra Specific to the core-infra product label May 30, 2025

oliviertassinari deployed to configs-package - mui-tools-public PR #344 May 30, 2025 11:00 — with Render View deployment

brijeshb42 force-pushed the configs-package branch from 97af236 to de04fb8 Compare May 30, 2025 11:08

oliviertassinari deployed to configs-package - mui-tools-public PR #344 May 30, 2025 11:08 — with Render View deployment

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label May 30, 2025

brijeshb42 force-pushed the configs-package branch from de04fb8 to 2db8a01 Compare May 30, 2025 11:39

oliviertassinari deployed to configs-package - mui-tools-public PR #344 May 30, 2025 11:39 — with Render View deployment

github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label May 30, 2025

brijeshb42 changed the title ~~[code-infra] Bring eslint configuration from core~~ [code-infra] Bring eslint configuration from core and bump to v9 May 30, 2025

brijeshb42 force-pushed the configs-package branch from 2db8a01 to 1057d42 Compare May 30, 2025 11:47

oliviertassinari deployed to configs-package - mui-tools-public PR #344 May 30, 2025 11:47 — with Render View deployment

brijeshb42 force-pushed the configs-package branch from 1057d42 to 2f2eea8 Compare May 30, 2025 11:52

oliviertassinari deployed to configs-package - mui-tools-public PR #344 May 30, 2025 11:52 — with Render View deployment

brijeshb42 force-pushed the configs-package branch from fdb34e6 to b9ecdbd Compare June 2, 2025 07:30

oliviertassinari deployed to configs-package - mui-tools-public PR #344 June 2, 2025 07:30 — with Render View deployment

brijeshb42 force-pushed the configs-package branch 3 times, most recently from 7076f75 to d420d80 Compare June 3, 2025 07:09

oliviertassinari deployed to configs-package - mui-tools-public PR #344 June 3, 2025 07:09 — with Render View deployment

brijeshb42 force-pushed the configs-package branch from c107e55 to cd5a992 Compare June 3, 2025 07:54

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 3, 2025

brijeshb42 force-pushed the configs-package branch 2 times, most recently from 8c92e97 to da2c6db Compare June 3, 2025 09:16

oliviertassinari deployed to configs-package - mui-tools-public PR #344 June 3, 2025 09:16 — with Render View deployment

github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 3, 2025

Janpot reviewed Jun 3, 2025

View reviewed changes

brijeshb42 force-pushed the configs-package branch from d65baf8 to c8f5b38 Compare June 26, 2025 08:01

Add build script

6c49f14

brijeshb42 force-pushed the configs-package branch from c8f5b38 to 6c49f14 Compare June 26, 2025 08:06

brijeshb42 requested a review from a team June 26, 2025 08:46

Brijesh Bittu and others added 13 commits June 26, 2025 15:52

Less verbose

9f1eda1

Fix tests

0195e3c

Fix tests, but still 4 failing ones

097bbf0

fix types

3951914

fix rules-of-use-theme-variants

2f85ab7

skip failing tests

639e12f

Update setupVitest.ts

60b8151

Update no-direct-state-access.mjs

d506e27

Update package.json

3d86cb1

reset tests

44868b5

Update no-direct-state-access.mjs

c13e40a

f it

535cd45

Remove mui-x specific rule

e909514

brijeshb42 force-pushed the configs-package branch from ee1a7c3 to e909514 Compare June 27, 2025 04:22

brijeshb42 requested a review from Janpot June 27, 2025 04:24

Janpot approved these changes Jun 27, 2025

View reviewed changes

Refactor imports

03067f8

brijeshb42 merged commit 8391aed into master Jun 27, 2025
7 checks passed

brijeshb42 deleted the configs-package branch June 27, 2025 10:26

LukasTy reviewed Jun 27, 2025

View reviewed changes

brijeshb42 pushed a commit that referenced this pull request Jun 27, 2025

[code-infra] Infra package followup #344

a486db6

Addresses some of the comments from the previous PR #344

brijeshb42 mentioned this pull request Jun 27, 2025

[code-infra] Infra package followup #344 #373

Merged

brijeshb42 pushed a commit that referenced this pull request Jun 27, 2025

[code-infra] Infra package followup #344

3c62849

Addresses some of the comments from the previous PR #344

brijeshb42 pushed a commit that referenced this pull request Jun 29, 2025

[code-infra] Infra package followup #344

f24c619

Addresses some of the comments from the previous PR #344

brijeshb42 added a commit that referenced this pull request Jun 29, 2025

[code-infra] Infra package followup #344 (#373)

9d51cb3

Signed-off-by: Lukas Tyla <[email protected]> Co-authored-by: Brijesh Bittu <[email protected]> Co-authored-by: Lukas Tyla <[email protected]>

	import testConfig from '@mui/infra/eslint-test';
	import { testConfig, baseConfig } from '@mui/infra/eslint';

	"directory": "packages/mui-internal-code-infra"
	"directory": "packages/code-infra"

		@@ -0,0 +1,104 @@
		import mochaPlugin from 'eslint-plugin-mocha';

[code-infra] Bring eslint configuration from core and bump to v9 #344

[code-infra] Bring eslint configuration from core and bump to v9 #344

Uh oh!

Conversation

brijeshb42 commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Janpot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

LukasTy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brijeshb42 Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brijeshb42 commented Jun 27, 2025

Uh oh!

Uh oh!

brijeshb42 commented May 30, 2025 •

edited

Loading

Janpot left a comment •

edited

Loading

brijeshb42 Jun 27, 2025 •

edited

Loading