@mui/internal-code-infra 0.1.1-canary.23 → 0.1.1-canary.25

package/build/cli/cmdBuild.d.mts

@@ -35,6 +35,10 @@ export type Args = {
      * - Whether to skip checking for main field in package.json.
      */
     skipMainCheck: boolean;
+    /**
+     * - Whether to skip validating the output directory with publint.
+     */
+    skipPublint: boolean;
     /**
      * - Globs to be ignored by Babel.
      */

package/build/eslint/index.d.mts

@@ -1,4 +1,5 @@
 export * from './baseConfig.mjs';
 export * from './docsConfig.mjs';
+export * from './nodeSupportConfig.mjs';
 export * from './testConfig.mjs';
 export * from './extensions.mjs';

package/build/eslint/nodeSupportConfig.d.mts

@@ -0,0 +1,11 @@
+/**
+ * Reports syntax, ECMAScript built-ins and Node.js APIs in package sources that the Node.js
+ * versions allowed by the package's "engines.node" don't support. The ESM bundle is compiled for
+ * the "stable" browserslist environment rather than for "engines.node", and nothing polyfills
+ * built-ins, so all of them reach Node.js consumers as written.
+ * Only packages that declare "engines.node", meaning they're intended to run in Node.js, are
+ * checked.
+ * @param {string} baseDirectory - The repository root. File patterns are resolved against it.
+ * @returns {import('eslint').Linter.Config[]}
+ */
+export declare function createNodeSupportConfig(baseDirectory: string): import('eslint').Linter.Config[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/internal-code-infra",
-  "version": "0.1.1-canary.23",
+  "version": "0.1.1-canary.25",
   "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.2",
+    "eslint-plugin-n": "^18.5.0",
     "eslint-plugin-package-json": "^1.10.1",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-compiler": "^19.1.0-rc.2",
@@ -115,6 +116,7 @@
     "node-html-parser": "^9.0.5",
     "open": "^11.0.4",
     "postcss-styled-syntax": "^0.7.4",
+    "publint": "^0.3.25",
     "regexp.escape": "^2.0.1",
     "rehype-slug": "^6.0.0",
     "rehype-stringify": "^10.0.1",
@@ -190,7 +192,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitSha": "8d779945c318e7e2dada1296b64de1e618a99942",
+  "gitSha": "80d3ec0d49901ddda4af788aeb3b1b51e21c07cc",
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "typescript": "tsc -noEmit",

package/src/cli/cmdBuild.mjs

@@ -28,6 +28,7 @@ import { readPnpmConfig } from '../utils/pnpm.mjs';
  * @property {boolean} skipBabelRuntimeCheck - Whether to skip checking for Babel runtime dependencies in the package.
  * @property {boolean} skipPackageJson - Whether to skip generating the package.json file in the bundle output.
  * @property {boolean} skipMainCheck - Whether to skip checking for main field in package.json.
+ * @property {boolean} skipPublint - Whether to skip validating the output directory with publint.
  * @property {string[]} ignore - Globs to be ignored by Babel.
  * @property {string[]} [copy] - Files/Directories to be copied. Can be a glob pattern.
  * @property {boolean} [enableReactCompiler] - Whether to use the React compiler.
@@ -216,6 +217,11 @@ export default /** @type {import('yargs').CommandModule<{}, Args>} */ ({
         default: false,
         description: 'Skip checking for main field in package.json.',
       })
+      .option('skipPublint', {
+        type: 'boolean',
+        default: false,
+        description: 'Skip validating the output directory with publint.',
+      })
       .option('copy', {
         type: 'string',
         array: true,
@@ -392,9 +398,48 @@ export default /** @type {import('yargs').CommandModule<{}, Args>} */ ({
       buildDir,
       verbose: args.verbose,
     });
+
+    if (!args.skipPublint) {
+      await validateWithPublint(buildDir);
+    }
   },
 });
 
+/**
+ * Lints the output directory with publint. Errors fail the build, warnings are only reported.
+ * @param {string} buildDir - The build directory to validate.
+ * @returns {Promise<void>}
+ */
+async function validateWithPublint(buildDir) {
+  const [{ publint }, { formatMessage }] = await Promise.all([
+    import('publint'),
+    import('publint/utils'),
+  ]);
+  // Everything in the output directory is published, so there is nothing to pack.
+  const result = await publint({ pkgDir: buildDir, pack: false, level: 'warning' });
+  const { pkg } = result;
+  // TODO: remove this filter and bump publint to >=0.3.25, which ships the fix from
+  // https://github.com/publint/publint/pull/265 (publint checks `browser` values
+  // that point at another package as local files).
+  const messages = result.messages.filter((message) => {
+    if (message.code !== 'FILE_DOES_NOT_EXIST' || message.path[0] !== 'browser') {
+      return true;
+    }
+    const value = message.path.length === 2 ? pkg.browser?.[message.path[1]] : undefined;
+    return typeof value !== 'string' || value.startsWith('.');
+  });
+
+  for (const message of messages) {
+    const log = message.type === 'error' ? console.error : console.warn;
+    log(`publint ${message.type}: ${formatMessage(message, pkg)}`);
+  }
+
+  const errorCount = messages.filter((message) => message.type === 'error').length;
+  if (errorCount > 0) {
+    throw new Error(`publint found ${errorCount} error(s) in "${buildDir}".`);
+  }
+}
+
 /**
  * @param {Object} param0
  * @param {string} param0.cwd - The current working directory.

package/src/eslint/baseConfig.mjs

@@ -3,6 +3,7 @@ import eslintJs from '@eslint/js';
 import { defineConfig } from 'eslint/config';
 import prettier from 'eslint-config-prettier/flat';
 import compatPlugin from 'eslint-plugin-compat';
+import nPlugin from 'eslint-plugin-n';
 import importPlugin from 'eslint-plugin-import';
 import jsxA11yPlugin from 'eslint-plugin-jsx-a11y';
 import reactPlugin from 'eslint-plugin-react';
@@ -17,6 +18,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 { createNodeSupportConfig } from './nodeSupportConfig.mjs';
 import { createPackageJsonConfig } from './packageJsonConfig.mjs';
 
 /**
@@ -59,6 +61,9 @@ export function createBaseConfig({
       },
       plugins: {
         mui: muiPlugin,
+        // Registered once for all files, so consumers can enable `n/*` rules without registering
+        // a second, possibly different, instance of the plugin.
+        n: nPlugin,
       },
       settings: {
         react: {
@@ -74,6 +79,7 @@ export function createBaseConfig({
     includeIgnoreIfExists(path.join(baseDirectory, '.gitignore'), `Ignore rules from .gitignore`),
     includeIgnoreIfExists(path.join(baseDirectory, '.lintignore'), `Ignore rules from .lintignore`),
     createJsonConfig(),
+    createNodeSupportConfig(baseDirectory),
     createPackageJsonConfig(),
     prettier,
     // Markdown + MDX linting via eslint-plugin-mdx. Severities for markdown

package/src/eslint/index.mjs

@@ -3,5 +3,6 @@
 
 export * from './baseConfig.mjs';
 export * from './docsConfig.mjs';
+export * from './nodeSupportConfig.mjs';
 export * from './testConfig.mjs';
 export * from './extensions.mjs';

package/src/eslint/nodeSupportConfig.mjs

@@ -0,0 +1,70 @@
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import { defineConfig } from 'eslint/config';
+import nPlugin from 'eslint-plugin-n';
+import { globbySync } from 'globby';
+import { EXTENSION_TEST_FILE, EXTENSION_TS } from './extensions.mjs';
+
+/**
+ * Finds the packages in the `packages*` directories of the repository that declare the Node.js
+ * versions they support in "engines.node". Packages without it, like development tooling, run
+ * on the repository's own Node.js version.
+ * @param {string} baseDirectory
+ * @returns {string[]} Package directories, relative to `baseDirectory`.
+ */
+function findPackageDirsWithEnginesNode(baseDirectory) {
+  return globbySync('packages*/*/package.json', { cwd: baseDirectory })
+    .filter((packageJsonPath) => {
+      const packageJson = JSON.parse(
+        fs.readFileSync(path.join(baseDirectory, packageJsonPath), 'utf8'),
+      );
+      return typeof packageJson.engines?.node === 'string';
+    })
+    .map((packageJsonPath) => path.posix.dirname(packageJsonPath));
+}
+
+/**
+ * Reports syntax, ECMAScript built-ins and Node.js APIs in package sources that the Node.js
+ * versions allowed by the package's "engines.node" don't support. The ESM bundle is compiled for
+ * the "stable" browserslist environment rather than for "engines.node", and nothing polyfills
+ * built-ins, so all of them reach Node.js consumers as written.
+ * Only packages that declare "engines.node", meaning they're intended to run in Node.js, are
+ * checked.
+ * @param {string} baseDirectory - The repository root. File patterns are resolved against it.
+ * @returns {import('eslint').Linter.Config[]}
+ */
+export function createNodeSupportConfig(baseDirectory) {
+  const packageDirs = findPackageDirsWithEnginesNode(baseDirectory);
+  if (packageDirs.length === 0) {
+    return [];
+  }
+  return defineConfig([
+    {
+      name: 'Node.js support of package sources',
+      basePath: baseDirectory,
+      files: packageDirs.map((packageDir) => `${packageDir}/src/**/*${EXTENSION_TS}`),
+      ignores: [`**/*${EXTENSION_TEST_FILE}`, `**/*.spec${EXTENSION_TS}`],
+      plugins: { n: nPlugin },
+      rules: {
+        'n/no-unsupported-features/es-builtins': 'error',
+        'n/no-unsupported-features/es-syntax': 'error',
+        'n/no-unsupported-features/node-builtins': [
+          'error',
+          // Browser APIs that Node.js also exposes, behind an experimental flag. In packages that
+          // combine Node.js tooling with browser code, these refer to the browser API.
+          {
+            ignores: [
+              'localStorage',
+              'sessionStorage',
+              'Storage',
+              'navigator',
+              'Navigator',
+              'Worker',
+              'ErrorEvent',
+            ],
+          },
+        ],
+      },
+    },
+  ]);
+}