@mui/internal-code-infra 0.0.4-canary.6 → 0.0.4-canary.61

package/src/remark/noSpaceInLinks.test.mjs

@@ -0,0 +1,22 @@
+import { describe, it, expect } from 'vitest';
+import { createLintTester } from './createLintTester.mjs';
+import plugin from './noSpaceInLinks.mjs';
+
+const lint = createLintTester(plugin);
+
+describe('remark-lint-mui-no-space-in-links', () => {
+  it('accepts links without surrounding whitespace', () => {
+    expect(lint(`[link text](https://example.com)\n`)).toEqual([]);
+    expect(lint(`Some [inline](https://example.com) text.\n`)).toEqual([]);
+  });
+
+  it('flags leading whitespace in link text', () => {
+    const messages = lint(`[ link text ](https://example.com)\n`);
+    expect(messages).toHaveLength(1);
+  });
+
+  it('flags trailing whitespace in link text', () => {
+    const messages = lint(`[trailing ](https://example.com)\n`);
+    expect(messages).toHaveLength(1);
+  });
+});

package/src/remark/straightQuotes.mjs

@@ -0,0 +1,31 @@
+import { lintRule } from 'unified-lint-rule';
+
+const curlyQuotes = new Set(['‘', '’', '“', '”']);
+
+const remarkLintMuiStraightQuotes = lintRule(
+  {
+    origin: 'remark-lint:mui-straight-quotes',
+    url: 'https://github.com/mui/mui-public',
+  },
+  /** @param {import('mdast').Root} _tree */
+  (_tree, file) => {
+    const text = String(file.value);
+    let line = 1;
+    let lineStart = 0;
+    for (let index = 0; index < text.length; index += 1) {
+      const char = text[index];
+      if (char === '\n') {
+        line += 1;
+        lineStart = index + 1;
+      } else if (curlyQuotes.has(char)) {
+        const column = index - lineStart + 1;
+        file.message('Use straight quotes instead of curly quotes.', {
+          start: { line, column },
+          end: { line, column: column + 1 },
+        });
+      }
+    }
+  },
+);
+
+export default remarkLintMuiStraightQuotes;

package/src/remark/straightQuotes.test.mjs

@@ -0,0 +1,25 @@
+import { describe, it, expect } from 'vitest';
+import { createLintTester } from './createLintTester.mjs';
+import plugin from './straightQuotes.mjs';
+
+const lint = createLintTester(plugin);
+
+describe('remark-lint-mui-straight-quotes', () => {
+  it('accepts straight quotes', () => {
+    expect(lint(`# Title\n\nA paragraph with "straight" and 'simple' quotes.\n`)).toEqual([]);
+  });
+
+  it('flags curly double quotes with correct location', () => {
+    const messages = lint(`# Title\n\nA paragraph with “curly” quotes.\n`);
+    expect(messages).toHaveLength(2);
+    expect(messages[0]).toMatchObject({ line: 3, column: 18 });
+    expect(messages[1]).toMatchObject({ line: 3, column: 24 });
+  });
+
+  it('flags curly single quotes', () => {
+    const messages = lint(`Use ‘single’ curly quotes too.\n`);
+    expect(messages).toHaveLength(2);
+    expect(messages[0]).toMatchObject({ line: 1, column: 5 });
+    expect(messages[1]).toMatchObject({ line: 1, column: 12 });
+  });
+});

package/src/remark/tableAlignment.mjs

@@ -0,0 +1,23 @@
+import { lintRule } from 'unified-lint-rule';
+import { visit } from 'unist-util-visit';
+
+const remarkLintMuiTableAlignment = lintRule(
+  {
+    origin: 'remark-lint:mui-table-alignment',
+    url: 'https://github.com/mui/mui-public',
+  },
+  /** @param {import('mdast').Root} tree */
+  (tree, file) => {
+    visit(tree, 'table', (node) => {
+      const align = node.align ?? [];
+      if (align.some((value) => value == null)) {
+        file.message(
+          'Table columns should declare an explicit alignment (`:---`, `---:`, or `:---:`).',
+          node,
+        );
+      }
+    });
+  },
+);
+
+export default remarkLintMuiTableAlignment;

package/src/remark/tableAlignment.test.mjs

@@ -0,0 +1,28 @@
+import { describe, it, expect } from 'vitest';
+import { createLintTester } from './createLintTester.mjs';
+import plugin from './tableAlignment.mjs';
+
+const lint = createLintTester(plugin);
+
+describe('remark-lint-mui-table-alignment', () => {
+  it('accepts tables with explicit alignment on every column', () => {
+    const input = `| A | B |\n| :- | -: |\n| 1 | 2 |\n`;
+    expect(lint(input)).toEqual([]);
+  });
+
+  it('flags tables with at least one column missing alignment', () => {
+    const input = `| A | B |\n| :- | -- |\n| 1 | 2 |\n`;
+    const messages = lint(input);
+    expect(messages).toHaveLength(1);
+  });
+
+  it('flags tables with no alignment at all', () => {
+    const input = `| A | B |\n| - | - |\n| 1 | 2 |\n`;
+    const messages = lint(input);
+    expect(messages).toHaveLength(1);
+  });
+
+  it('does not flag non-table content', () => {
+    expect(lint(`# Heading\n\nSome paragraph.\n`)).toEqual([]);
+  });
+});

package/src/remark/terminalLanguage.mjs

@@ -0,0 +1,19 @@
+import { lintRule } from 'unified-lint-rule';
+import { visit } from 'unist-util-visit';
+
+const remarkLintMuiTerminalLanguage = lintRule(
+  {
+    origin: 'remark-lint:mui-terminal-language',
+    url: 'https://github.com/mui/mui-public',
+  },
+  /** @param {import('mdast').Root} tree */
+  (tree, file) => {
+    visit(tree, 'code', (node) => {
+      if (node.lang === 'sh' && node.position) {
+        file.message('Use `bash` instead of `sh` as the code block language.', node);
+      }
+    });
+  },
+);
+
+export default remarkLintMuiTerminalLanguage;

package/src/remark/terminalLanguage.test.mjs

@@ -0,0 +1,17 @@
+import { describe, it, expect } from 'vitest';
+import { createLintTester } from './createLintTester.mjs';
+import plugin from './terminalLanguage.mjs';
+
+const lint = createLintTester(plugin);
+
+describe('remark-lint-mui-terminal-language', () => {
+  it('accepts bash and other languages', () => {
+    expect(lint(`\`\`\`bash\necho hi\n\`\`\`\n`)).toEqual([]);
+    expect(lint(`\`\`\`js\nconst x = 1;\n\`\`\`\n`)).toEqual([]);
+  });
+
+  it('flags `sh` code fences', () => {
+    const messages = lint(`\`\`\`sh\necho hi\n\`\`\`\n`);
+    expect(messages).toHaveLength(1);
+  });
+});

package/src/untyped-plugins.d.ts

@@ -13,77 +13,77 @@ declare module 'eslint-config-airbnb' {
 }
 
 declare module 'eslint-config-airbnb-base/rules/best-practices' {
-  import { Linter } from 'eslint';
+  import { type Linter } from 'eslint';
 
   declare const config: Omit<Linter.LegacyConfig, 'extends' | 'plugins'>;
   export default config;
 }
 
 declare module 'eslint-config-airbnb-base/rules/errors' {
-  import { Linter } from 'eslint';
+  import { type Linter } from 'eslint';
 
   declare const config: Omit<Linter.LegacyConfig, 'extends' | 'plugins'>;
   export default config;
 }
 
 declare module 'eslint-config-airbnb-base/rules/es6' {
-  import { Linter } from 'eslint';
+  import { type Linter } from 'eslint';
 
   declare const config: Omit<Linter.LegacyConfig, 'extends' | 'plugins'>;
   export default config;
 }
 
 declare module 'eslint-config-airbnb-base/rules/imports' {
-  import { Linter } from 'eslint';
+  import { type Linter } from 'eslint';
 
   declare const config: Omit<Linter.LegacyConfig, 'extends' | 'plugins'>;
   export default config;
 }
 
 declare module 'eslint-config-airbnb-base/rules/node' {
-  import { Linter } from 'eslint';
+  import { type Linter } from 'eslint';
 
   declare const config: Omit<Linter.LegacyConfig, 'extends' | 'plugins'>;
   export default config;
 }
 
 declare module 'eslint-config-airbnb-base/rules/strict' {
-  import { Linter } from 'eslint';
+  import { type Linter } from 'eslint';
 
   declare const config: Omit<Linter.LegacyConfig, 'extends' | 'plugins'>;
   export default config;
 }
 
 declare module 'eslint-config-airbnb-base/rules/style' {
-  import { Linter } from 'eslint';
+  import { type Linter } from 'eslint';
 
   declare const config: Omit<Linter.LegacyConfig, 'extends' | 'plugins'>;
   export default config;
 }
 
 declare module 'eslint-config-airbnb-base/rules/variables' {
-  import { Linter } from 'eslint';
+  import { type Linter } from 'eslint';
 
   declare const config: Omit<Linter.LegacyConfig, 'extends' | 'plugins'>;
   export default config;
 }
 
 declare module 'eslint-config-airbnb/rules/react' {
-  import { Linter } from 'eslint';
+  import { type Linter } from 'eslint';
 
   declare const config: Omit<Linter.LegacyConfig, 'extends' | 'plugins'>;
   export default config;
 }
 
 declare module 'eslint-config-airbnb/rules/react-a11y' {
-  import { Linter } from 'eslint';
+  import { type Linter } from 'eslint';
 
   declare const config: Omit<Linter.LegacyConfig, 'extends' | 'plugins'>;
   export default config;
 }
 
 declare module '@next/eslint-plugin-next' {
-  import { Linter } from 'eslint';
+  import { type Linter } from 'eslint';
 
   interface NextEslintPluginConfig extends Linter.LegacyConfig {
     flatConfig: {