triple-slash-reference.test.ts

import rule from '../../src/rules/triple-slash-reference';
import { RuleTester } from '../RuleTester';

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

ruleTester.run('triple-slash-reference', rule, {
  valid: [
    {
      code: `
        // <reference path="foo" />
        // <reference types="bar" />
        // <reference lib="baz" />
        import * as foo from 'foo';
        import * as bar from 'bar';
        import * as baz from 'baz';
      `,
      options: [{ path: 'never', types: 'never', lib: 'never' }],
    },
    {
      code: `
        // <reference path="foo" />
        // <reference types="bar" />
        // <reference lib="baz" />
        import foo = require('foo');
        import bar = require('bar');
        import baz = require('baz');
      `,
      options: [{ path: 'never', types: 'never', lib: 'never' }],
    },
    {
      code: `
        /// <reference path="foo" />
        /// <reference types="bar" />
        /// <reference lib="baz" />
        import * as foo from 'foo';
        import * as bar from 'bar';
        import * as baz from 'baz';
      `,
      options: [{ path: 'always', types: 'always', lib: 'always' }],
    },
    {
      code: `
        /// <reference path="foo" />
        /// <reference types="bar" />
        /// <reference lib="baz" />
        import foo = require('foo');
        import bar = require('bar');
        import baz = require('baz');
      `,
      options: [{ path: 'always', types: 'always', lib: 'always' }],
    },
    {
      code: `
        /// <reference path="foo" />
        /// <reference types="bar" />
        /// <reference lib="baz" />
        import foo = foo;
        import bar = bar;
        import baz = baz;
      `,
      options: [{ path: 'always', types: 'always', lib: 'always' }],
    },
    {
      code: `
        /// <reference path="foo" />
        /// <reference types="bar" />
        /// <reference lib="baz" />
        import foo = foo.foo;
        import bar = bar.bar.bar.bar;
        import baz = baz.baz;
      `,
      options: [{ path: 'always', types: 'always', lib: 'always' }],
    },
    {
      code: "import * as foo from 'foo';",
      options: [{ path: 'never' }],
    },
    {
      code: "import foo = require('foo');",
      options: [{ path: 'never' }],
    },
    {
      code: "import * as foo from 'foo';",
      options: [{ types: 'never' }],
    },
    {
      code: "import foo = require('foo');",
      options: [{ types: 'never' }],
    },
    {
      code: "import * as foo from 'foo';",
      options: [{ lib: 'never' }],
    },
    {
      code: "import foo = require('foo');",
      options: [{ lib: 'never' }],
    },
    {
      code: "import * as foo from 'foo';",
      options: [{ types: 'prefer-import' }],
    },
    {
      code: "import foo = require('foo');",
      options: [{ types: 'prefer-import' }],
    },
    {
      code: `
        /// <reference types="foo" />
        import * as bar from 'bar';
      `,
      options: [{ types: 'prefer-import' }],
    },
    {
      code: `
        /*
        /// <reference types="foo" />
        */
        import * as foo from 'foo';
      `,
      options: [{ path: 'never', types: 'never', lib: 'never' }],
    },
  ],
  invalid: [
    {
      code: `
/// <reference types="foo" />
import * as foo from 'foo';
      `,
      options: [{ types: 'prefer-import' }],
      errors: [
        {
          messageId: 'tripleSlashReference',
          line: 2,
          column: 1,
        },
      ],
    },
    {
      code: `
/// <reference types="foo" />
import foo = require('foo');
      `,
      options: [{ types: 'prefer-import' }],
      errors: [
        {
          messageId: 'tripleSlashReference',
          line: 2,
          column: 1,
        },
      ],
    },
    {
      code: '/// <reference path="foo" />',
      options: [{ path: 'never' }],
      errors: [
        {
          messageId: 'tripleSlashReference',
          line: 1,
          column: 1,
        },
      ],
    },
    {
      code: '/// <reference types="foo" />',
      options: [{ types: 'never' }],
      errors: [
        {
          messageId: 'tripleSlashReference',
          line: 1,
          column: 1,
        },
      ],
    },
    {
      code: '/// <reference lib="foo" />',
      options: [{ lib: 'never' }],
      errors: [
        {
          messageId: 'tripleSlashReference',
          line: 1,
          column: 1,
        },
      ],
    },
  ],
});