materialuiupgraded/packages/eslint-plugin-material-ui/src/rules/docgen-ignore-before-comment.test.js

Material-UI's workspace package

const eslint = require('eslint');
const rule = require('./docgen-ignore-before-comment');

const ruleTester = new eslint.RuleTester();
ruleTester.run('ignore-before-comment', rule, {
  valid: [
    '\n/**\n * @ignore\n */\n',
    '\n/**\n * @ignore\n * Comment.\n */\n',
    '\n/**\n * @ignore\n * Multi-line\n * comment.\n */\n',
    '\n  /**\n   * @ignore\n   * Indented\n   * multi-line\n   * comment.\n   */\n',
  ],
  invalid: [
    {
      code: '\n/**\n * Comment.\n * @ignore\n */\n',
      errors: [
        { message: '@ignore should be at the beginning of a block comment.', type: 'Block' },
      ],
    },
    {
      code: '\n  /**\n   * Multi-line\n   * comment.\n   * @ignore\n   */\n',
      errors: [
        { message: '@ignore should be at the beginning of a block comment.', type: 'Block' },
      ],
    },
    {
      code: '\n  /**\n   * Multi-line\n   * @ignore\n   * comment.\n   */\n',
      errors: [
        { message: '@ignore should be at the beginning of a block comment.', type: 'Block' },
      ],
    },
    {
      code: '\n  /**\n   * Indented\n   * multi-line\n   * comment.\n   * @ignore\n   */\n',
      errors: [
        { message: '@ignore should be at the beginning of a block comment.', type: 'Block' },
      ],
    },
  ],
});