@mui/internal-code-infra 0.1.1-canary.14 → 0.1.1-canary.16

package/README.md

@@ -14,9 +14,9 @@ This is stored in the `docs` top-level directory.
 
 1. Go to the publish action -
 
-- [Base UI](https://github.com/mui/base-ui/actions/workflows/publish.yml)
+- [Base UI](https://github.com/mui/base-ui/actions/workflows/publish.yml)
 - [Core](https://github.com/mui/material-ui/actions/workflows/publish.yml)
-- [MUI X](https://github.com/mui/mui-x/actions/workflows/publish.yml)
+- [MUI X](https://github.com/mui/mui-x/actions/workflows/publish.yml)
 
 2. Choose "Run workflow" dropdown
 
@@ -59,7 +59,7 @@ If publishing fails with npm asking for `otp`, run the command again with 6 digi
 pnpm code-infra publish-new-package --otp=123456
 ```
 
-3. Go to the settings link for each package, e.g., `https://www.npmjs.com/package/<pkg-name>/access`, and setup `Trusted Publisher`.
+3. Go to the settings link for each package, for example, `https://www.npmjs.com/package/<pkg-name>/access`, and setup `Trusted Publisher`.
 4. In the `Select your publisher` step in the above link, click on the `GitHub Actions` button to configure GitHub Actions-based trusted publishing.
 5. Fill in the details of the repo -
    1. `Organization or user` as `mui`,

package/build/eslint/packageJsonConfig.d.mts

@@ -0,0 +1,7 @@
+/**
+ * Lints package.json files for publishing metadata. Published packages must
+ * declare an SPDX license, `"author": "MUI Team"` and a repository pointing at
+ * their own directory. Private packages must not carry publishing metadata.
+ * @returns {import('eslint').Linter.Config[]}
+ */
+export declare function createPackageJsonConfig(): import('eslint').Linter.Config[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/internal-code-infra",
-  "version": "0.1.1-canary.14",
+  "version": "0.1.1-canary.16",
   "author": "MUI Team",
   "description": "Infra scripts and configs to be used across MUI repos.",
   "license": "MIT",
@@ -101,6 +101,7 @@
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-mdx": "^3.8.1",
+    "eslint-plugin-package-json": "^1.10.1",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-compiler": "^19.1.0-rc.2",
     "eslint-plugin-react-hooks": "^7.1.1",
@@ -174,8 +175,7 @@
     "remark": "15.0.1",
     "remark-mdx": "3.1.1",
     "serve": "14.2.6",
-    "typescript": "npm:@typescript/typescript6@6.0.2",
-    "typescript-eslint": "8.71.1"
+    "typescript": "npm:@typescript/typescript6@6.0.2"
   },
   "files": [
     "bin",
@@ -190,7 +190,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitSha": "a8db5a1b050cfffe37636173e3d1e18537baaca1",
+  "gitSha": "7909a2801b6402fec32dead2c01dad6d16dcf20d",
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "typescript": "tsc -noEmit",

package/src/eslint/baseConfig.mjs

@@ -17,6 +17,7 @@ import { createCoreConfig } from './mui/config.mjs';
 import muiPlugin from './mui/index.mjs';
 import { EXTENSION_TS } from './extensions.mjs';
 import { createJsonConfig } from './jsonConfig.mjs';
+import { createPackageJsonConfig } from './packageJsonConfig.mjs';
 
 /**
  * @param {string} filePath
@@ -73,6 +74,7 @@ export function createBaseConfig({
     includeIgnoreIfExists(path.join(baseDirectory, '.gitignore'), `Ignore rules from .gitignore`),
     includeIgnoreIfExists(path.join(baseDirectory, '.lintignore'), `Ignore rules from .lintignore`),
     createJsonConfig(),
+    createPackageJsonConfig(),
     prettier,
     // Markdown + MDX linting via eslint-plugin-mdx. Severities for markdown
     // quality checks live in the project's `.remarkrc` (see

package/src/eslint/jsonConfig.mjs

@@ -9,7 +9,8 @@ export function createJsonConfig() {
     {
       name: 'JSON files',
       files: ['**/*.json'],
-      ignores: ['package-lock.json'],
+      // package.json is linted by eslint-plugin-package-json, whose rules need the jsonc-eslint-parser AST.
+      ignores: ['package-lock.json', '**/package.json'],
       plugins: { json },
       language: 'json/json',
       extends: [json.configs.recommended],

package/src/eslint/packageJsonConfig.mjs

@@ -0,0 +1,50 @@
+import { defineConfig } from 'eslint/config';
+import packageJson from 'eslint-plugin-package-json';
+
+/**
+ * Lints package.json files for publishing metadata. Published packages must
+ * declare an SPDX license, `"author": "MUI Team"` and a repository pointing at
+ * their own directory. Private packages must not carry publishing metadata.
+ * @returns {import('eslint').Linter.Config[]}
+ */
+export function createPackageJsonConfig() {
+  return defineConfig([
+    {
+      name: 'package.json files',
+      files: ['**/package.json'],
+      ignores: ['**/__fixtures__/**'],
+      extends: [packageJson.configs.recommended],
+      rules: {
+        'package-json/require-author': ['error', { ignorePrivate: true }],
+        'package-json/require-description': ['error', { ignorePrivate: true }],
+        'package-json/restrict-private-properties': [
+          'error',
+          // `publishConfig.directory` is allowed: `code-infra build` reads it, also for private packages.
+          { blockedProperties: ['files', 'license'] },
+        ],
+        'no-restricted-syntax': [
+          'error',
+          {
+            selector:
+              'Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.value="author"][value.value!="MUI Team"]',
+            message: 'The "author" field must be "MUI Team".',
+          },
+        ],
+        // Condition order in "exports" is significant, and scripts are grouped by purpose.
+        'package-json/sort-collections': 'off',
+        // Packages built with `code-infra build` get these fields in the generated package.json.
+        'package-json/require-files': 'off',
+        'package-json/require-sideEffects': 'off',
+        'package-json/require-type': 'off',
+        // Peer dependencies are installed once at the workspace root.
+        'package-json/specify-peers-locally': 'off',
+        // CLI-only packages have no "exports".
+        'package-json/require-exports': 'off',
+        // Rejects the object form of "browser", which the browser field spec allows.
+        'package-json/valid-browser': 'off',
+        // npm only auto-includes "main" when it has no "./" prefix; removing it from "files" can drop the entry point.
+        'package-json/no-redundant-files': 'off',
+      },
+    },
+  ]);
+}