@mui/internal-code-infra 0.0.4-canary.7 → 0.0.4-canary.70

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/markdownlint/duplicate-h1.mjs

@@ -1,69 +0,0 @@
-/**
- * @typedef {[string, string]} Attr
- */
-
-/**
- * @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
- */
-
-// This rule is an extension of MD025/no-multiple-top-level-headings.
-// The rule is buggy https://github.com/DavidAnson/markdownlint/pull/1109
-// but also blog headers don't tell you that h1 is already injected.
-export default {
-  names: ['duplicateH1'],
-  description: 'Multiple top-level headings in the same document.',
-  tags: ['headings'],
-  /**
-   * @param {import('./duplicate-h1.mjs').MdParams} params
-   * @param {import('./duplicate-h1.mjs').OnError} onError
-   */
-  function: (params, onError) => {
-    /**
-     * @type {number|boolean}
-     */
-    let hasTopLevelHeading = false;
-    params.tokens.forEach((token) => {
-      if (token.type === 'heading_open' && token.tag === 'h1') {
-        // Avoid duplicate errors with MD025.
-        if (hasTopLevelHeading !== false && hasTopLevelHeading !== 1) {
-          onError({
-            lineNumber: token.lineNumber,
-          });
-        } else if (params.name.includes('/docs/pages/blog/')) {
-          onError({
-            lineNumber: token.lineNumber,
-            detail: 'In the blog, the h1 is already added using the markdown header.title value.',
-          });
-        }
-
-        // Store the first h1 of the page.
-        if (hasTopLevelHeading === false) {
-          hasTopLevelHeading = token.lineNumber;
-        }
-      }
-    });
-  },
-};

package/src/markdownlint/git-diff.mjs

@@ -1,31 +0,0 @@
-export default {
-  names: ['gitDiff'],
-  description: 'Respect the format output of git diff.',
-  tags: ['spaces'],
-  /**
-   * @param {import('./duplicate-h1.mjs').MdParams} params
-   * @param {import('./duplicate-h1.mjs').OnError} onError
-   */
-  function: (params, onError) => {
-    params.tokens.forEach((token) => {
-      if (token.type === 'fence' && token.info === 'diff') {
-        token.content.split('\n').forEach((line, index) => {
-          if (
-            line[0] !== ' ' &&
-            line[0] !== '-' &&
-            line[0] !== '+' &&
-            line !== '' &&
-            line.indexOf('@@ ') !== 0 &&
-            line.indexOf('diff --git ') !== 0 &&
-            line.indexOf('index ') !== 0
-          ) {
-            onError({
-              lineNumber: token.lineNumber + index + 1,
-              detail: `The line start with "+" or "-" or " ": ${line}`,
-            });
-          }
-        });
-      }
-    });
-  },
-};

package/src/markdownlint/index.mjs

@@ -1,62 +0,0 @@
-import straightQuotes from './straight-quotes.mjs';
-import gitDiff from './git-diff.mjs';
-import tableAlignment from './table-alignment.mjs';
-import terminalLanguage from './terminal-language.mjs';
-import duplicateH1 from './duplicate-h1.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 function createBaseConfig(options = {}) {
-  const { rules = [], ignores = [] } = options;
-  // https://github.com/DavidAnson/markdownlint#rules--aliases
-  return {
-    config: {
-      default: true,
-      MD004: false, // MD004/ul-style. Buggy
-      MD009: {
-        // MD009/no-trailing-spaces
-        br_spaces: 0,
-        strict: true,
-        list_item_empty_lines: false,
-      },
-      MD013: false, // MD013/line-length. Already handled by Prettier.
-      MD014: false, // MD014/commands-show-output. It's OK.
-      MD024: { siblings_only: true }, // MD024/no-duplicate-heading/no-duplicate-header
-      MD025: {
-        // Heading level
-        level: 1,
-        // RegExp for matching title in front matter
-        front_matter_title: '',
-      },
-      MD033: false, // MD033/no-inline-html. We use it from time to time, it's fine.
-      MD034: false, // MD034/no-bare-urls. Not a concern for us, our Markdown interpreter supports it.
-      MD028: false, // MD028/no-blanks-blockquote prevent double blockquote
-      MD029: false, // MD029/ol-prefix. Buggy
-      MD031: false, // MD031/blanks-around-fences Some code blocks inside li
-      MD036: false, // MD036/no-emphasis-as-heading/no-emphasis-as-header. It's OK.
-      MD051: false, // MD051/link-fragments. Many false positives in the changelog.
-      MD052: false, // MD052/reference-links-images. Many false positives in the changelog.
-      MD059: false, // MD059/descriptive-link-text. Does not allow links on text like "link", whereas we redirect to "Link" component.
-      straightQuotes: true,
-      gitDiff: true,
-      tableAlignment: true,
-      terminalLanguage: true,
-      duplicateH1: true,
-    },
-    customRules: [straightQuotes, gitDiff, tableAlignment, terminalLanguage, duplicateH1, ...rules],
-    ignores: [
-      'CHANGELOG.old.md',
-      '**/node_modules/**',
-      '**/build/**',
-      '.github/PULL_REQUEST_TEMPLATE.md',
-      'docs/public/**',
-      'docs/export/**',
-      ...ignores,
-    ],
-  };
-}

package/src/markdownlint/straight-quotes.mjs

@@ -1,26 +0,0 @@
-const nonStraightQuotes = /[‘’“”]/;
-
-export default {
-  names: ['straightQuotes'],
-  description: 'Only allow straight quotes.',
-  tags: ['spelling'],
-  /**
-   * @param {import('./duplicate-h1.mjs').MdParams} params
-   * @param {import('./duplicate-h1.mjs').OnError} onError
-   */
-  function: (params, onError) => {
-    params.lines.forEach((line, lineNumber) => {
-      // It will match
-      // opening single quote: \xE2\x80\x98
-      // closing single quote: \xE2\x80\x99
-      // opening double quote: \xE2\x80\x9C
-      // closing double quote: \xE2\x80\x9D
-      if (nonStraightQuotes.test(line)) {
-        onError({
-          lineNumber: lineNumber + 1,
-          detail: `For line: ${line}`,
-        });
-      }
-    });
-  },
-};

package/src/markdownlint/table-alignment.mjs

@@ -1,42 +0,0 @@
-/**
- * @param {import('./duplicate-h1.mjs').Attr[]} attrs
- * @returns {Record<string, string>}
- */
-function attr(attrs) {
-  return (attrs || []).reduce((acc, item) => ({ ...acc, [item[0]]: item[1] }), {});
-}
-
-export default {
-  names: ['tableAlignment'],
-  description: 'Set table alignment.',
-  tags: ['table'],
-  /**
-   * @param {import('./duplicate-h1.mjs').MdParams} params
-   * @param {import('./duplicate-h1.mjs').OnError} onError
-   */
-  function: (params, onError) => {
-    params.tokens.forEach((token) => {
-      // This is wrong:
-      // | Version | Supported          |
-      // | ------- | ------------------ |
-      //
-      // The second column should be left aligned because it contains text:
-      // | Version | Supported          |
-      // | ------- | :----------------- |
-      //
-      // However, columns that includes numbers should be right aligned:
-      // | Version | Supported          |
-      // | ------: | :----------------- |
-      //
-      // More details: https://ux.stackexchange.com/questions/24066/what-is-the-best-practice-for-data-table-cell-content-alignment
-      //
-      // In this check we expect the style to be 'text-align:right' or equivalent.
-      if (token.type === 'th_open' && attr(token.attrs).style == null) {
-        onError({
-          lineNumber: token.lineNumber,
-          detail: `${params.lines[token.lineNumber - 1]}`,
-        });
-      }
-    });
-  },
-};

package/src/markdownlint/terminal-language.mjs

@@ -1,19 +0,0 @@
-export default {
-  names: ['terminalLanguage'],
-  description: 'Set the right language for terminal code.',
-  tags: ['code'],
-  /**
-   * @param {import('./duplicate-h1.mjs').MdParams} params
-   * @param {import('./duplicate-h1.mjs').OnError} onError
-   */
-  function: (params, onError) => {
-    params.tokens.forEach((token) => {
-      if (token.type === 'fence' && token.info === 'sh') {
-        onError({
-          lineNumber: token.lineNumber,
-          detail: `Use "bash" instead of "sh".`,
-        });
-      }
-    });
-  },
-};