@mui/internal-code-infra 0.0.4-canary.9 → 0.0.4-canary.91

package/src/eslint/mui/rules/rules-of-use-theme-variants.test.mjs

@@ -1,149 +0,0 @@
-import eslint from 'eslint';
-import parser from '@typescript-eslint/parser';
-import rule from './rules-of-use-theme-variants.mjs';
-
-const ruleTester = new eslint.RuleTester({
-  languageOptions: {
-    parser,
-    parserOptions: {
-      ecmaFeatures: { jsx: true },
-    },
-  },
-});
-
-ruleTester.run('rules-of-use-theme-variants', rule, {
-  valid: [
-    // allowed but dangerous
-    {
-      name: 'custom useThemeVariants hook',
-      code: `
-{
-  const useCustomThemeVariants = props => useThemeVariants(props);
-}`,
-    },
-    {
-      name: 'basic useThemeVariants call',
-      code: `
-{
-  useThemeVariants(props);
-}
-`,
-    },
-    {
-      name: 'useThemeVariants with destructured props',
-      code: `
-{
-  const { className, value: valueProp, ...other } = props;
-  useThemeVariants(props);
-}
-`,
-    },
-    {
-      name: 'useThemeVariants with disabled prop override',
-      code: `
-{
-  const { className, disabled = false, value: valueProp, ...other } = props;
-  useThemeVariants({ ...props, disabled });
-}
-`,
-    },
-    {
-      name: 'useThemeVariants with state variables',
-      code: `
-{
-  const { className, value: valueProp, ...other } = props;
-  const [stateA, setStateA] = React.useState(0);
-  const [stateB, setStateB] = React.useState(0);
-  useThemeVariants({ stateA, ...props, stateB });
-}
-`,
-    },
-    // unnecessary spread but it's not the responsibility of this rule to catch "unnecessary" spread
-    {
-      name: 'useThemeVariants with unnecessary spread',
-      code: `
-{
-  const { className, value: valueProp, ...other } = props;
-  useThemeVariants({ ...props});
-}
-  `,
-    },
-  ],
-  invalid: [
-    {
-      name: 'disabled prop not passed to useThemeVariants',
-      code: `
-{
-  const { disabled = false, ...other } = props;
-  useThemeVariants({ ...props});
-}
-  `,
-      errors: [
-        {
-          message: 'Prop `disabled` is not passed to `useThemeVariants` props.',
-          line: 4,
-          column: 20,
-          endLine: 4,
-          endColumn: 31,
-        },
-      ],
-    },
-    {
-      name: 'variant prop not passed to useThemeVariants',
-      code: `
-{
-  const { disabled = false, variant = 'text', ...other } = props;
-  useThemeVariants({ ...props, disabled });
-}
-  `,
-      errors: [
-        {
-          message: 'Prop `variant` is not passed to `useThemeVariants` props.',
-          line: 4,
-          column: 20,
-          endLine: 4,
-          endColumn: 42,
-        },
-      ],
-    },
-    {
-      name: 'props spread must come first',
-      code: `
-{
-  const { disabled = false, ...other } = props;
-  useThemeVariants({ disabled, ...props });
-}
-  `,
-      errors: [
-        {
-          message:
-            'The props spread must come first in the `useThemeVariants` props. Otherwise destructured props with default values could be overridden.',
-          line: 4,
-          column: 32,
-          endLine: 4,
-          endColumn: 40,
-        },
-      ],
-    },
-    // this is valid code but not analyzable by this rule
-    {
-      name: 'cannot analyze identifier pattern',
-      code: `
-{
-  const { disabled = false, ...other } = props;
-  const themeVariantProps = { ...props, disabled };
-  useThemeVariants(themeVariantProps);
-}
-  `,
-      errors: [
-        {
-          message: "Can only analyze object patterns but found 'Identifier'. Prefer `{...props}`.",
-          line: 5,
-          column: 20,
-          endLine: 5,
-          endColumn: 37,
-        },
-      ],
-    },
-  ],
-});

package/src/eslint/mui/rules/straight-quotes.test.mjs

@@ -1,67 +0,0 @@
-import eslint from 'eslint';
-import parser from '@typescript-eslint/parser';
-import rule from './straight-quotes.mjs';
-
-const ruleTester = new eslint.RuleTester({
-  languageOptions: {
-    parser,
-  },
-});
-
-ruleTester.run('straight-quotes', rule, {
-  valid: [
-    `
-const values = [
-  {
-    title: 'Put community first 💙',
-  },
-];
-  `,
-  ],
-  invalid: [
-    {
-      code: `
-const values = [
-  {
-    title: 'Put community first 💙',
-    description: 'We never lose sight of who we’re serving and why.',
-  },
-];
-      `,
-      errors: [
-        {
-          messageId: 'wrongQuotes',
-          line: 5,
-        },
-      ],
-    },
-    {
-      code: `
-// reference ID (also known as “SHA” or “hash”) of the commit we're building.
-const values = 'foo';
-      `,
-      errors: [
-        {
-          line: 2,
-          column: 32,
-          messageId: 'wrongQuotes',
-        },
-        {
-          line: 2,
-          column: 36,
-          messageId: 'wrongQuotes',
-        },
-        {
-          line: 2,
-          column: 41,
-          messageId: 'wrongQuotes',
-        },
-        {
-          line: 2,
-          column: 46,
-          messageId: 'wrongQuotes',
-        },
-      ],
-    },
-  ],
-});

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".`,
-        });
-      }
-    });
-  },
-};