interface-name-prefix.test.ts

import assert from 'assert';
import rule, { parseOptions } from '../../src/rules/interface-name-prefix';
import { RuleTester } from '../RuleTester';

describe('interface-name-prefix', () => {
  it('parseOptions', () => {
    assert.deepEqual(parseOptions(['never']), { prefixWithI: 'never' });
    assert.deepEqual(parseOptions(['always']), {
      prefixWithI: 'always',
      allowUnderscorePrefix: false,
      replacePrefixI: 'I',
    });
    assert.deepEqual(parseOptions([{}]), { prefixWithI: 'never' });
    assert.deepEqual(parseOptions([{ prefixWithI: 'never' }]), {
      prefixWithI: 'never',
    });
    assert.deepEqual(parseOptions([{ prefixWithI: 'always' }]), {
      prefixWithI: 'always',
      allowUnderscorePrefix: false,
      replacePrefixI: 'I',
    });
    assert.deepEqual(
      parseOptions([{ prefixWithI: 'always', allowUnderscorePrefix: true }]),
      {
        prefixWithI: 'always',
        allowUnderscorePrefix: true,
        replacePrefixI: 'I',
      },
    );
    assert.deepEqual(
      parseOptions([{ prefixWithI: 'always', replacePrefixI: 'T' }]),
      {
        prefixWithI: 'always',
        allowUnderscorePrefix: false,
        replacePrefixI: 'T',
      },
    );
  });
});

const ruleTester = new RuleTester({
  parser: '@typescript-eslint/parser',
});

ruleTester.run('interface-name-prefix', rule, {
  valid: [
    `
interface Animal {
    name: string;
}
        `,
    {
      code: `
interface IAnimal {
    name: string;
}
            `,
      options: ['always'],
    },
    {
      code: `
interface _IAnimal {
    name: string;
}
            `,
      options: [{ prefixWithI: 'always', allowUnderscorePrefix: true }],
    },
    {
      code: `
interface IIguana {
    name: string;
}
            `,
      options: ['always'],
    },
    {
      code: `
interface Iguana {
    name: string;
}
            `,
      options: ['never'],
    },
    {
      code: `
interface Animal {
    name: string;
}
            `,
      options: ['never'],
    },
    {
      code: `
interface I18n {
    name: string;
}
            `,
      options: ['never'],
    },
    {
      code: `
interface AAnimal {
    name: string;
}
            `,
      options: [{ prefixWithI: 'always', replacePrefixI: 'A' }],
    },
    {
      code: `
interface _AAnimal {
    name: string;
}
            `,
      options: [
        {
          prefixWithI: 'always',
          replacePrefixI: 'A',
          allowUnderscorePrefix: true,
        },
      ],
    },
  ],
  invalid: [
    {
      code: `
interface IAnimal {
    name: string;
}
            `,
      errors: [
        {
          messageId: 'noPrefix',
          line: 2,
          column: 11,
        },
      ],
    },
    {
      code: `
interface Animal {
    name: string;
}
            `,
      options: ['always'],
      errors: [
        {
          messageId: 'alwaysPrefix',
          line: 2,
          column: 11,
        },
      ],
    },
    {
      code: `
interface Animal {
    name: string;
}
            `,
      options: [{ prefixWithI: 'always', allowUnderscorePrefix: true }],
      errors: [
        {
          messageId: 'alwaysPrefix',
          line: 2,
          column: 11,
        },
      ],
    },
    {
      code: `
interface Iguana {
    name: string;
}
            `,
      options: ['always'],
      errors: [
        {
          messageId: 'alwaysPrefix',
          line: 2,
          column: 11,
        },
      ],
    },
    {
      code: `
interface IIguana {
    name: string;
}
            `,
      options: ['never'],
      errors: [
        {
          messageId: 'noPrefix',
          line: 2,
          column: 11,
        },
      ],
    },
    {
      code: `
interface IAnimal {
    name: string;
}
            `,
      options: ['never'],
      errors: [
        {
          messageId: 'noPrefix',
          line: 2,
          column: 11,
        },
      ],
    },
    {
      code: `
interface _IAnimal {
    name: string;
}
            `,
      options: ['never'],
      errors: [
        {
          messageId: 'noPrefix',
          line: 2,
          column: 11,
        },
      ],
    },
    {
      code: `
interface IAnimal {
    name: string;
}
            `,
      options: [
        {
          prefixWithI: 'always',
          allowUnderscorePrefix: true,
          replacePrefixI: 'A',
        },
      ],
      errors: [
        {
          messageId: 'alwaysPrefix',
          line: 2,
          column: 11,
        },
      ],
    },
  ],
});