@mui/internal-code-infra 0.0.4-canary.10 → 0.0.4-canary.100

package/src/utils/testUtils.mjs

@@ -0,0 +1,53 @@
+import * as fs from 'node:fs/promises';
+import * as os from 'node:os';
+import * as path from 'node:path';
+import { onTestFinished } from 'vitest';
+
+import { writePackageJson } from './pnpm.mjs';
+
+/**
+ * Creates a temporary directory and registers an `onTestFinished` hook to
+ * remove it automatically when the current test ends — even if the test throws.
+ *
+ * @returns {Promise<string>} The path of the created temporary directory.
+ */
+export async function makeTempDir() {
+  const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), 'code-infra-test-'));
+  onTestFinished(async () => {
+    await fs.rm(tmpDir, { recursive: true, force: true });
+  });
+  return tmpDir;
+}
+
+/**
+ * Write a package.json into a subdirectory of a temp workspace.
+ *
+ * @param {string} root - Workspace root
+ * @param {string} dir - Subdirectory to create
+ * @param {object} pkgJson - Manifest contents
+ * @returns {Promise<string>} The package directory
+ */
+export async function writePackage(root, dir, pkgJson) {
+  const pkgDir = path.join(root, dir);
+  await fs.mkdir(pkgDir, { recursive: true });
+  await writePackageJson(pkgDir, pkgJson);
+  return pkgDir;
+}
+
+/**
+ * @param {string} name
+ * @param {string} pkgPath
+ * @returns {import('./pnpm.mjs').PublicPackage}
+ */
+export function publicPkg(name, pkgPath) {
+  return { name, version: '1.0.0', path: pkgPath, isPrivate: false };
+}
+
+/**
+ * @param {string} name
+ * @param {string} pkgPath
+ * @returns {import('./pnpm.mjs').PrivatePackage}
+ */
+export function privatePkg(name, pkgPath) {
+  return { name, version: '1.0.0', path: pkgPath, isPrivate: true };
+}

package/src/utils/typescript.mjs

@@ -111,30 +111,21 @@ export async function copyDeclarations(sourceDirectory, destinationDirectory, op
  * @param {Object} param0
  * @param {string} param0.inputDir
  * @param {string} param0.buildDir
- * @param {{type: import('../utils/build.mjs').BundleType, dir: string}[]} param0.bundles
- * @param {boolean} [param0.isFlat]
+ * @param {import('../utils/build.mjs').BundleType[]} param0.bundles
  * @param {'module' | 'commonjs'} [param0.packageType]
  * @returns
  */
-export async function moveAndTransformDeclarations({
-  inputDir,
-  buildDir,
-  bundles,
-  isFlat,
-  packageType,
-}) {
-  // Directly copy to the bundle directory if there's only one bundle, mainly for esm, since
-  // the js files are inside 'esm' folder. resolve-imports plugin needs d.ts to be alongside js files to
-  // resolve paths correctly.
-  const toCopyDir = bundles.length === 1 ? path.join(buildDir, bundles[0].dir) : buildDir;
-  await fs.cp(inputDir, toCopyDir, {
+export async function moveAndTransformDeclarations({ inputDir, buildDir, bundles, packageType }) {
+  // d.ts files sit alongside the js files in the build root so the resolve-imports
+  // plugin can resolve paths correctly.
+  await fs.cp(inputDir, buildDir, {
     recursive: true,
     force: false,
   });
 
-  const dtsFiles = await globby('**/*.d.ts', { absolute: true, cwd: toCopyDir });
+  const dtsFiles = await globby('**/*.d.ts', { absolute: true, cwd: buildDir });
   if (dtsFiles.length === 0) {
-    console.log(`No d.ts files found in ${toCopyDir}. Skipping transformation.`);
+    console.log(`No d.ts files found in ${buildDir}. Skipping transformation.`);
     return;
   }
 
@@ -144,37 +135,30 @@ export async function moveAndTransformDeclarations({
       // Normalize to native separators to make path comparisons reliable on Windows
       const nativeDtsFile = path.normalize(dtsFile);
       const content = await fs.readFile(nativeDtsFile, 'utf8');
-      const relativePath = path.relative(toCopyDir, nativeDtsFile);
+      const relativePath = path.relative(buildDir, nativeDtsFile);
 
-      const writesToOriginalPath =
-        isFlat &&
-        bundles.some((bundle) => {
-          const newFileExtension = getOutExtension(bundle.type, {
-            isFlat,
-            isType: true,
-            packageType,
-          });
-          const outFileRelative = relativePath.replace(/\.d\.ts$/, newFileExtension);
-          const outFilePath = path.join(buildDir, bundle.dir, outFileRelative);
-          // Ensure both paths are normalized before comparison (fixes Windows posix vs win32 separators)
-          return path.resolve(outFilePath) === path.resolve(nativeDtsFile);
+      const writesToOriginalPath = bundles.some((bundle) => {
+        const newFileExtension = getOutExtension(bundle, {
+          isType: true,
+          packageType,
         });
+        const outFileRelative = relativePath.replace(/\.d\.ts$/, newFileExtension);
+        const outFilePath = path.join(buildDir, outFileRelative);
+        // Ensure both paths are normalized before comparison (fixes Windows posix vs win32 separators)
+        return path.resolve(outFilePath) === path.resolve(nativeDtsFile);
+      });
 
       await Promise.all(
         bundles.map(async (bundle) => {
-          const importExtension = getOutExtension(bundle.type, {
-            isFlat,
+          const importExtension = getOutExtension(bundle, {
             packageType,
           });
-          const newFileExtension = getOutExtension(bundle.type, {
-            isFlat,
+          const newFileExtension = getOutExtension(bundle, {
             isType: true,
             packageType,
           });
-          const outFileRelative = isFlat
-            ? relativePath.replace(/\.d\.ts$/, newFileExtension)
-            : relativePath;
-          const outFilePath = path.join(buildDir, bundle.dir, outFileRelative);
+          const outFileRelative = relativePath.replace(/\.d\.ts$/, newFileExtension);
+          const outFilePath = path.join(buildDir, outFileRelative);
 
           const babelPlugins = [
             [pluginTypescriptSyntax, { dts: true }],
@@ -194,7 +178,7 @@ export async function moveAndTransformDeclarations({
           }
         }),
       );
-      if (isFlat && !writesToOriginalPath) {
+      if (!writesToOriginalPath) {
         await fs.unlink(nativeDtsFile);
       }
     },
@@ -208,9 +192,8 @@ export async function moveAndTransformDeclarations({
  * After copying, babel transformations are applied to the copied files because they need to be alongside the actual js files for proper resolution.
  *
  * @param {Object} param0
- * @param {boolean} [param0.isFlat = false] - Whether to place generated declaration files in a flattened directory.
  * @param {boolean} [param0.verbose = false] - Whether to log additional information while generating and moving declaration files.
- * @param {{type: import('../utils/build.mjs').BundleType, dir: string}[]} param0.bundles - The bundles to create declarations for.
+ * @param {import('../utils/build.mjs').BundleType[]} param0.bundles - The bundles to create declarations for.
  * @param {string} param0.srcDir - The source directory.
  * @param {string} param0.buildDir - The build directory.
  * @param {string} param0.cwd - The current working directory.
@@ -225,7 +208,6 @@ export async function createTypes({
   cwd,
   skipTsc,
   useTsgo = false,
-  isFlat = false,
   packageType,
   verbose,
 }) {
@@ -253,7 +235,6 @@ export async function createTypes({
       inputDir: tmpDir,
       buildDir,
       bundles,
-      isFlat,
       packageType,
     });
   } finally {

package/vale/.vale.ini

@@ -0,0 +1 @@
+StylesPath = styles

package/vale/styles/MUI/CorrectReferenceAllCases.yml

@@ -0,0 +1,42 @@
+# Enforce a single way to write specific terms or phrases.
+extends: substitution
+message: Use '%s' instead of '%s'
+level: error
+ignorecase: true # There is only one correct way to spell those, so we want to match inputs regardless of case.
+# swap maps tokens in form of bad: good
+# for more information: https://vale.sh/docs/topics/styles/#substitution
+swap:
+  ' api': ' API'
+  'typescript ': 'TypeScript '
+  ' ts': ' TypeScript'
+  javascript: JavaScript
+  ' js': ' JavaScript'
+  ' css ': ' CSS '
+  ' html ': ' HTML '
+  NPM: npm # https://css-tricks.com/start-sentence-npm/
+  Github: GitHub
+  StackOverflow: Stack Overflow
+  Stack Overflow: Stack Overflow
+  CSS modules: CSS Modules
+  Tailwind CSS: Tailwind CSS
+  Heat map: Heatmap
+  Tree map: Treemap
+  Sparkline Chart: Sparkline chart
+  Gauge Chart: Gauge chart
+  Treemap Chart: Treemap chart
+  sub-component: subcomponent
+  sub-components: subcomponents
+  use-case: use case
+  usecase: use case
+  Material 3: Material Design 3
+  VSCode: VS Code
+  VS Code: VS Code
+  'Codesandbox ': 'CodeSandbox '
+  code sandbox: CodeSandbox
+  Stackblitz: StackBlitz
+  Webpack: webpack # https://x.com/wSokra/status/855800490713649152
+  app router: App Router # Next.js
+  pages router: Pages Router # Next.js
+  page router: Pages Router # Next.js
+  eslint: ESLint
+  ES modules: ES modules

package/vale/styles/MUI/CorrectRererenceCased.yml

@@ -0,0 +1,14 @@
+# Write things correctly, please no wrong references.
+extends: substitution
+message: Use '%s' instead of '%s'
+level: error
+ignorecase: false
+# swap maps tokens in form of bad: good
+# for more information: https://vale.sh/docs/topics/styles/#substitution
+swap:
+  eg: e.g.
+  eg\.: e.g.
+  e\.g: e.g.
+  ie: i.e.
+  ie\.: i.e.
+  i\.e: i.e.

package/vale/styles/MUI/GoogleLatin.yml

@@ -0,0 +1,11 @@
+extends: substitution
+message: Use '%s' instead of '%s'
+link: https://developers.google.com/style/abbreviations
+ignorecase: false
+level: error
+nonword: true
+action:
+  name: replace
+swap:
+  '\b(?:eg|e\.g\.)(?=[\s,;])': for example
+  '\b(?:ie|i\.e\.)(?=[\s,;])': that is

package/vale/styles/MUI/MuiBrandName.yml

@@ -0,0 +1,22 @@
+# Without a non-breaking space, brand names can be split in the middle
+# with the start and end on two different lines.
+# For example, Apple does this meticulously with their brand name: https://www.apple.com/macbook-air/.
+# Also read https://www.chrisdpeters.com/blog/using-non-breaking-spaces-to-help-with-branding/ for why.
+extends: substitution
+message: Use a non-breaking space (option+space on Mac, Alt+0160 on Windows or AltGr+Space on Linux, instead of space) for brand name ('%s' instead of '%s')
+level: error
+ignorecase: true
+# swap maps tokens in form of bad: good
+# for more information: https://vale.sh/docs/topics/styles/#substitution
+swap:
+  Material UI: Material UI
+  MUI X: MUI X
+  Base UI: Base UI
+  MUI Base: MUI Base
+  MUI System: MUI System
+  MUI Store: MUI Store
+  MUI Core: MUI Core
+  MUI Toolpad: Toolpad
+  MUI Toolpad: Toolpad
+  MUI Connect: MUI Connect
+  Pigment CSS: Pigment CSS

package/vale/styles/MUI/NoBritish.yml

@@ -0,0 +1,112 @@
+extends: substitution
+message: Use the US spelling '%s' instead of the British '%s'
+link: https://www.notion.so/mui-org/Writing-style-guide-2a957a4168a54d47b14bae026d06a24b?pvs=4#25755bff02764565b954631236ab183d
+level: error
+ignorecase: true
+swap:
+  aeon: eon
+  aeroplane: airplane
+  ageing: aging
+  aluminium: aluminum
+  anaemia: anemia
+  anaesthesia: anesthesia
+  analyse: analyze
+  annexe: annex
+  apologise: apologize
+  authorisation: authorization
+  authorise: authorize
+  authorised: authorized
+  authorising: authorizing
+  behaviour: behavior
+  bellow: below
+  busses: buses
+  calibre: caliber
+  categorise: categorize
+  categorised: categorized
+  categorises: categorizes
+  categorising: categorizing
+  centre: center
+  cheque: check
+  civilisation: civilization
+  civilise: civilize
+  colour: color
+  cosy: cozy
+  cypher: cipher
+  defence: defense
+  dependant: dependent
+  distil: distill
+  draught: draft
+  encyclopaedia: encyclopedia
+  enquiry: inquiry
+  enrol: enroll
+  enrolment: enrollment
+  enthral: enthrall
+  favourite: favorite
+  fibre: fiber
+  fillet: filet
+  flavour: flavor
+  fulfil: fulfill
+  furore: furor
+  gaol: jail
+  grey: gray
+  honour: honor
+  humour: humor
+  initialled: initialed
+  initialling: initialing
+  instil: instill
+  jewellery: jewelry
+  labelled: labeled
+  labelling: labeling
+  labour: labor
+  libellous: libelous
+  licence: license
+  likeable: likable
+  liveable: livable
+  lustre: luster
+  manoeuvre: maneuver
+  marvellous: marvelous
+  meagre: meager
+  metre: meter
+  modelling: modeling
+  moustache: mustache
+  neighbour: neighbor
+  normalise: normalize
+  offence: offense
+  optimise: optimize
+  optimised: optimized
+  optimising: optimizing
+  organise: organize
+  orientated: oriented
+  paralyse: paralyze
+  plough: plow
+  pretence: pretense
+  programme: program
+  pyjamas: pajamas
+  rateable: ratable
+  realise: realize
+  recognise: recognize
+  reconnoitre: reconnoiter
+  rumour: rumor
+  sabre: saber
+  saleable: salable
+  saltpetre: saltpeter
+  sceptic: skeptic
+  sepulchre: sepulcher
+  signalling: signaling
+  sizeable: sizable
+  skilful: skillful
+  smoulder: smolder
+  sombre: somber
+  speciality: specialty
+  spectre: specter
+  splendour: splendor
+  standardise: standardize
+  standardised: standardized
+  sulphur: sulfur
+  theatre: theater
+  travelled: traveled
+  traveller: traveler
+  travelling: traveling
+  unshakeable: unshakable
+  wilful: willful
+  yoghurt: yogurt

package/vale/styles/MUI/NoCompanyName.yml

@@ -0,0 +1,17 @@
+extends: existence
+message: We avoid referencing the company name '%s'. Instead you can reference a product or the team.
+level: warning
+ignorecase: false
+tokens:
+  - 'MUI \w+'
+exceptions:
+  - 'MUI X'
+  - 'MUI System'
+  - 'MUI Store'
+  - 'MUI Core'
+  - 'MUI Connect'
+  # valid use of a regular space
+  - 'MUI organization'
+  - 'MUI ecosystem'
+  - 'MUI products'
+  - 'MUI team'

package/build/markdownlint/duplicate-h1.d.mts

@@ -1,56 +0,0 @@
-/**
- * @typedef {[string, string]} Attr
- */
-export type Attr = [string, string];
-export type Token = {
-    type: string;
-    info: string;
-    tag: string;
-    content: string;
-    lineNumber: number;
-    attrs: Attr[];
-};
-export type OnErrorObj = {
-    lineNumber: number;
-    detail?: string;
-};
-export type OnError = (err: OnErrorObj) => void;
-export type MdParams = {
-    name: string;
-    lines: string[];
-    tokens: Token[];
-};
-/**
- * @typedef {Object} Token
- * @property {string} type
- * @property {string} info
- * @property {string} tag
- * @property {string} content
- * @property {number} lineNumber
- * @property {Attr[]} attrs
- */
-/**
- * @typedef {Object} OnErrorObj
- * @property {number} lineNumber
- * @property {string} [detail]
- */
-/**
- * @typedef {(err: OnErrorObj) => void} OnError
- */
-/**
- * @typedef {Object} MdParams
- * @property {string} name
- * @property {string[]} lines
- * @property {Token[]} tokens
- */
-declare const _default: {
-    names: string[];
-    description: string;
-    tags: string[];
-    /**
-     * @param {import('./duplicate-h1.mjs').MdParams} params
-     * @param {import('./duplicate-h1.mjs').OnError} onError
-     */
-    function: (params: MdParams, onError: OnError) => void;
-};
-export default _default;

package/build/markdownlint/git-diff.d.mts

@@ -1,11 +0,0 @@
-declare const _default: {
-    names: string[];
-    description: string;
-    tags: string[];
-    /**
-     * @param {import('./duplicate-h1.mjs').MdParams} params
-     * @param {import('./duplicate-h1.mjs').OnError} onError
-     */
-    function: (params: import("./duplicate-h1.mjs").MdParams, onError: import("./duplicate-h1.mjs").OnError) => void;
-};
-export default _default;

package/build/markdownlint/index.d.mts

@@ -1,52 +0,0 @@
-import straightQuotes from './straight-quotes.mjs';
-/**
- * Create a base configuration for markdownlint.
- * @param {Object} options
- * @param {(typeof straightQuotes)[]} [options.rules] - An array of custom rules to include.
- * @param {string[]} [options.ignores] - An array of glob patterns to ignore.
- * @returns
- */
-export declare function createBaseConfig(options?: {
-    rules?: (typeof straightQuotes)[];
-    ignores?: string[];
-}): {
-    config: {
-        default: boolean;
-        MD004: boolean;
-        MD009: {
-            br_spaces: number;
-            strict: boolean;
-            list_item_empty_lines: boolean;
-        };
-        MD013: boolean;
-        MD014: boolean;
-        MD024: {
-            siblings_only: boolean;
-        };
-        MD025: {
-            level: number;
-            front_matter_title: string;
-        };
-        MD033: boolean;
-        MD034: boolean;
-        MD028: boolean;
-        MD029: boolean;
-        MD031: boolean;
-        MD036: boolean;
-        MD051: boolean;
-        MD052: boolean;
-        MD059: boolean;
-        straightQuotes: boolean;
-        gitDiff: boolean;
-        tableAlignment: boolean;
-        terminalLanguage: boolean;
-        duplicateH1: boolean;
-    };
-    customRules: {
-        names: string[];
-        description: string;
-        tags: string[];
-        function: (params: import("./duplicate-h1.mjs").MdParams, onError: import("./duplicate-h1.mjs").OnError) => void;
-    }[];
-    ignores: string[];
-};

package/build/markdownlint/straight-quotes.d.mts

@@ -1,11 +0,0 @@
-declare const _default: {
-    names: string[];
-    description: string;
-    tags: string[];
-    /**
-     * @param {import('./duplicate-h1.mjs').MdParams} params
-     * @param {import('./duplicate-h1.mjs').OnError} onError
-     */
-    function: (params: import("./duplicate-h1.mjs").MdParams, onError: import("./duplicate-h1.mjs").OnError) => void;
-};
-export default _default;

package/build/markdownlint/table-alignment.d.mts

@@ -1,11 +0,0 @@
-declare const _default: {
-    names: string[];
-    description: string;
-    tags: string[];
-    /**
-     * @param {import('./duplicate-h1.mjs').MdParams} params
-     * @param {import('./duplicate-h1.mjs').OnError} onError
-     */
-    function: (params: import("./duplicate-h1.mjs").MdParams, onError: import("./duplicate-h1.mjs").OnError) => void;
-};
-export default _default;

package/build/markdownlint/terminal-language.d.mts

@@ -1,11 +0,0 @@
-declare const _default: {
-    names: string[];
-    description: string;
-    tags: string[];
-    /**
-     * @param {import('./duplicate-h1.mjs').MdParams} params
-     * @param {import('./duplicate-h1.mjs').OnError} onError
-     */
-    function: (params: import("./duplicate-h1.mjs").MdParams, onError: import("./duplicate-h1.mjs").OnError) => void;
-};
-export default _default;

package/src/brokenLinksChecker/__fixtures__/static-site/broken-links.html

@@ -1,20 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Page with Broken Links</title>
-  </head>
-  <body>
-    <h1>Page with Broken Links</h1>
-    <p>This page contains links to non-existent pages.</p>
-    <nav>
-      <ul>
-        <li><a href="/">Home (valid)</a></li>
-        <li><a href="/does-not-exist.html">This page does not exist</a></li>
-        <li><a href="/another-missing-page.html">Another missing page</a></li>
-        <li><a href="/valid.html">Valid link</a></li>
-      </ul>
-    </nav>
-  </body>
-</html>

package/src/brokenLinksChecker/__fixtures__/static-site/broken-targets.html

@@ -1,22 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Page with Broken Targets</title>
-  </head>
-  <body>
-    <h1>Page with Broken Targets</h1>
-    <p>This page contains links to valid pages but with invalid hash targets.</p>
-    <nav>
-      <ul>
-        <li><a href="/">Home (valid)</a></li>
-        <li><a href="/with-anchors.html#section1">Valid anchor</a></li>
-        <li><a href="/with-anchors.html#nonexistent">Non-existent anchor</a></li>
-        <li><a href="/valid.html#missing-target">Valid page, missing target</a></li>
-        <li><a href="/with-anchors.html#section2">Another valid anchor</a></li>
-        <li><a href="/with-anchors.html#also-missing">Also missing</a></li>
-      </ul>
-    </nav>
-  </body>
-</html>

package/src/brokenLinksChecker/__fixtures__/static-site/example.md

@@ -1,20 +0,0 @@
-# Example Markdown File
-
-This is a markdown file with links:
-
-- [Link to valid page](/valid.html)
-- [Link to page with anchors](/with-anchors.html#section1)
-- [Broken markdown link](/broken-from-markdown.html)
-- [Relative link to valid page](valid.html)
-- [Relative link with dot-slash](./with-anchors.html)
-- [Relative broken link](broken-relative.html)
-
-## Markdown Section
-
-This section has an anchor target (`#markdown-section`) generated by rehype-slug.
-
-This is a code block with a link that should NOT be extracted:
-
-```html
-<a href="/this-should-not-be-checked.html">Link in code block</a>
-```

package/src/brokenLinksChecker/__fixtures__/static-site/external-links.html

@@ -1,21 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Page with External Links</title>
-  </head>
-  <body>
-    <h1>Page with External Links</h1>
-    <p>This page contains external links that should be ignored.</p>
-    <nav>
-      <ul>
-        <li><a href="/">Home (valid internal)</a></li>
-        <li><a href="https://example.com">External link 1</a></li>
-        <li><a href="https://github.com/mui">External link 2</a></li>
-        <li><a href="http://localhost:9999/fake">External localhost</a></li>
-        <li><a href="/valid.html">Valid internal link</a></li>
-      </ul>
-    </nav>
-  </body>
-</html>

package/src/brokenLinksChecker/__fixtures__/static-site/ignored-page.html

@@ -1,17 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Ignored Page</title>
-  </head>
-  <body>
-    <h1>Ignored Page</h1>
-    <p>This page should be ignored by the crawler.</p>
-    <nav>
-      <ul>
-        <li><a href="/this-link-should-not-be-checked.html">Should not be checked</a></li>
-      </ul>
-    </nav>
-  </body>
-</html>