interface-name-prefix.test.ts

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

describe('interface-name-prefix', () => {
  it('parseOptions', () => {
    expect(parseOptions(['never'])).toStrictEqual({
      prefixWithI: 'never',
      allowedPrefixes: [],
    });
    expect(parseOptions(['always'])).toStrictEqual({
      prefixWithI: 'always',
      allowUnderscorePrefix: false,
    });
    expect(parseOptions([{}])).toStrictEqual({
      prefixWithI: 'never',
      allowedPrefixes: [],
    });
    expect(parseOptions([{ prefixWithI: 'never' }])).toStrictEqual({
      prefixWithI: 'never',
      allowedPrefixes: [],
    });
    expect(parseOptions([{ allowedPrefixes: ['IAM'] }])).toStrictEqual({
      prefixWithI: 'never',
      allowedPrefixes: ['IAM'],
    });
    expect(
      parseOptions([{ prefixWithI: 'never', allowedPrefixes: [] }]),
    ).toStrictEqual({
      prefixWithI: 'never',
      allowedPrefixes: [],
    });
    expect(parseOptions([{ prefixWithI: 'always' }])).toStrictEqual({
      prefixWithI: 'always',
      allowUnderscorePrefix: false,
    });
    expect(
      parseOptions([{ prefixWithI: 'always', allowUnderscorePrefix: true }]),
    ).toStrictEqual({ prefixWithI: 'always', allowUnderscorePrefix: true });
  });
});

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 IAMUser {
    name: string;
}
            `,
      options: [{ allowedPrefixes: ['IAM'] }],
    },
  ],
  invalid: [
    {
      code: `
interface IAnimal {
    name: string;
}
            `,
      errors: [
        {
          messageId: 'noPrefix',
          line: 2,
          column: 11,
        },
      ],
    },
    {
      code: `
interface IAMUser {
    name: string;
}
            `,
      options: [{ allowedPrefixes: ['IPM'] }],
      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,
        },
      ],
    },
  ],
});