Files

475 lines
10 KiB
JavaScript

/**
* @fileoverview Tests for sort-imports rule.
* @author Christian Schuller
*/
"use strict";
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const rule = require("../../../lib/rules/sort-imports"),
RuleTester = require("../../../lib/rule-tester/rule-tester");
//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------
const ruleTester = new RuleTester({
languageOptions: { ecmaVersion: 6, sourceType: "module" },
}),
expectedError = {
messageId: "sortImportsAlphabetically",
},
ignoreCaseArgs = [{ ignoreCase: true }];
ruleTester.run("sort-imports", rule, {
valid: [
"import a from 'foo.js';\n" +
"import b from 'bar.js';\n" +
"import c from 'baz.js';\n",
"import * as B from 'foo.js';\n" + "import A from 'bar.js';",
"import * as B from 'foo.js';\n" + "import {a, b} from 'bar.js';",
"import {b, c} from 'bar.js';\n" + "import A from 'foo.js';",
{
code: "import A from 'bar.js';\n" + "import {b, c} from 'foo.js';",
options: [
{
memberSyntaxSortOrder: [
"single",
"multiple",
"none",
"all",
],
},
],
},
"import {a, b} from 'bar.js';\n" + "import {c, d} from 'foo.js';",
"import A from 'foo.js';\n" + "import B from 'bar.js';",
"import A from 'foo.js';\n" + "import a from 'bar.js';",
"import a, * as b from 'foo.js';\n" + "import c from 'bar.js';",
"import 'foo.js';\n" + " import a from 'bar.js';",
"import B from 'foo.js';\n" + "import a from 'bar.js';",
{
code: "import a from 'foo.js';\n" + "import B from 'bar.js';",
options: ignoreCaseArgs,
},
"import {a, b, c, d} from 'foo.js';",
{
code: "import a from 'foo.js';\n" + "import B from 'bar.js';",
options: [
{
ignoreDeclarationSort: true,
},
],
},
{
code: "import {b, A, C, d} from 'foo.js';",
options: [
{
ignoreMemberSort: true,
},
],
},
{
code: "import {B, a, C, d} from 'foo.js';",
options: [
{
ignoreMemberSort: true,
},
],
},
{
code: "import {a, B, c, D} from 'foo.js';",
options: ignoreCaseArgs,
},
"import a, * as b from 'foo.js';",
"import * as a from 'foo.js';\n" + "\n" + "import b from 'bar.js';",
"import * as bar from 'bar.js';\n" + "import * as foo from 'foo.js';",
// https://github.com/eslint/eslint/issues/5130
{
code: "import 'foo';\n" + "import bar from 'bar';",
options: ignoreCaseArgs,
},
// https://github.com/eslint/eslint/issues/5305
"import React, {Component} from 'react';",
// allowSeparatedGroups
{
code: "import b from 'b';\n\nimport a from 'a';",
options: [{ allowSeparatedGroups: true }],
},
{
code: "import a from 'a';\n\nimport 'b';",
options: [{ allowSeparatedGroups: true }],
},
{
code: "import { b } from 'b';\n\n\nimport { a } from 'a';",
options: [{ allowSeparatedGroups: true }],
},
{
code: "import b from 'b';\n// comment\nimport a from 'a';",
options: [{ allowSeparatedGroups: true }],
},
{
code: "import b from 'b';\nfoo();\nimport a from 'a';",
options: [{ allowSeparatedGroups: true }],
},
{
code: "import { b } from 'b';/*\n comment \n*/import { a } from 'a';",
options: [{ allowSeparatedGroups: true }],
},
{
code: "import b from\n'b';\n\nimport\n a from 'a';",
options: [{ allowSeparatedGroups: true }],
},
{
code: "import c from 'c';\n\nimport a from 'a';\nimport b from 'b';",
options: [{ allowSeparatedGroups: true }],
},
{
code: "import c from 'c';\n\nimport b from 'b';\n\nimport a from 'a';",
options: [{ allowSeparatedGroups: true }],
},
],
invalid: [
{
code: "import a from 'foo.js';\n" + "import A from 'bar.js';",
output: null,
errors: [expectedError],
},
{
code: "import b from 'foo.js';\n" + "import a from 'bar.js';",
output: null,
errors: [expectedError],
},
{
code:
"import {b, c} from 'foo.js';\n" +
"import {a, d} from 'bar.js';",
output: null,
errors: [expectedError],
},
{
code:
"import * as foo from 'foo.js';\n" +
"import * as bar from 'bar.js';",
output: null,
errors: [expectedError],
},
{
code: "import a from 'foo.js';\n" + "import {b, c} from 'bar.js';",
output: null,
errors: [
{
messageId: "unexpectedSyntaxOrder",
data: {
syntaxA: "multiple",
syntaxB: "single",
},
},
],
},
{
code: "import a from 'foo.js';\n" + "import * as b from 'bar.js';",
output: null,
errors: [
{
messageId: "unexpectedSyntaxOrder",
data: {
syntaxA: "all",
syntaxB: "single",
},
},
],
},
{
code: "import a from 'foo.js';\n" + "import 'bar.js';",
output: null,
errors: [
{
messageId: "unexpectedSyntaxOrder",
data: {
syntaxA: "none",
syntaxB: "single",
},
},
],
},
{
code: "import b from 'bar.js';\n" + "import * as a from 'foo.js';",
output: null,
options: [
{
memberSyntaxSortOrder: [
"all",
"single",
"multiple",
"none",
],
},
],
errors: [
{
messageId: "unexpectedSyntaxOrder",
data: {
syntaxA: "all",
syntaxB: "single",
},
},
],
},
{
code: "import {b, a, d, c} from 'foo.js';",
output: "import {a, b, c, d} from 'foo.js';",
errors: [
{
messageId: "sortMembersAlphabetically",
data: { memberName: "a" },
},
],
},
{
code:
"import {b, a, d, c} from 'foo.js';\n" +
"import {e, f, g, h} from 'bar.js';",
output:
"import {a, b, c, d} from 'foo.js';\n" +
"import {e, f, g, h} from 'bar.js';",
options: [
{
ignoreDeclarationSort: true,
},
],
errors: [
{
messageId: "sortMembersAlphabetically",
data: { memberName: "a" },
},
],
},
{
code: "import {a, B, c, D} from 'foo.js';",
output: "import {B, D, a, c} from 'foo.js';",
errors: [
{
messageId: "sortMembersAlphabetically",
data: { memberName: "B" },
},
],
},
{
code: "import {zzzzz, /* comment */ aaaaa} from 'foo.js';",
output: null, // not fixed due to comment
errors: [
{
messageId: "sortMembersAlphabetically",
data: { memberName: "aaaaa" },
},
],
},
{
code: "import {zzzzz /* comment */, aaaaa} from 'foo.js';",
output: null, // not fixed due to comment
errors: [
{
messageId: "sortMembersAlphabetically",
data: { memberName: "aaaaa" },
},
],
},
{
code: "import {/* comment */ zzzzz, aaaaa} from 'foo.js';",
output: null, // not fixed due to comment
errors: [
{
messageId: "sortMembersAlphabetically",
data: { memberName: "aaaaa" },
},
],
},
{
code: "import {zzzzz, aaaaa /* comment */} from 'foo.js';",
output: null, // not fixed due to comment
errors: [
{
messageId: "sortMembersAlphabetically",
data: { memberName: "aaaaa" },
},
],
},
{
code: `
import {
boop,
foo,
zoo,
baz as qux,
bar,
beep
} from 'foo.js';
`,
output: `
import {
bar,
beep,
boop,
foo,
baz as qux,
zoo
} from 'foo.js';
`,
errors: [
{
messageId: "sortMembersAlphabetically",
data: { memberName: "qux" },
},
],
},
// allowSeparatedGroups
{
code: "import b from 'b';\nimport a from 'a';",
output: null,
errors: [
{
messageId: "sortImportsAlphabetically",
},
],
},
{
code: "import b from 'b';\n\nimport a from 'a';",
output: null,
errors: [
{
messageId: "sortImportsAlphabetically",
},
],
},
{
code: "import b from 'b';\nimport a from 'a';",
output: null,
options: [{}],
errors: [
{
messageId: "sortImportsAlphabetically",
},
],
},
{
code: "import b from 'b';\nimport a from 'a';",
output: null,
options: [{ allowSeparatedGroups: false }],
errors: [
{
messageId: "sortImportsAlphabetically",
},
],
},
{
code: "import b from 'b';import a from 'a';",
output: null,
options: [{ allowSeparatedGroups: false }],
errors: [
{
messageId: "sortImportsAlphabetically",
},
],
},
{
code: "import b from 'b'; /* comment */ import a from 'a';",
output: null,
options: [{ allowSeparatedGroups: false }],
errors: [
{
messageId: "sortImportsAlphabetically",
},
],
},
{
code: "import b from 'b'; // comment\nimport a from 'a';",
output: null,
options: [{ allowSeparatedGroups: false }],
errors: [
{
messageId: "sortImportsAlphabetically",
},
],
},
{
code: "import b from 'b'; // comment 1\n/* comment 2 */import a from 'a';",
output: null,
options: [{ allowSeparatedGroups: false }],
errors: [
{
messageId: "sortImportsAlphabetically",
},
],
},
{
code: "import { b } from 'b'; /* comment line 1 \n comment line 2 */ import { a } from 'a';",
output: null,
options: [{ allowSeparatedGroups: false }],
errors: [
{
messageId: "sortImportsAlphabetically",
},
],
},
{
code: "import b\nfrom 'b'; import a\nfrom 'a';",
output: null,
options: [{ allowSeparatedGroups: false }],
errors: [
{
messageId: "sortImportsAlphabetically",
},
],
},
{
code: "import { b } from \n'b'; /* comment */ import\n { a } from 'a';",
output: null,
options: [{ allowSeparatedGroups: false }],
errors: [
{
messageId: "sortImportsAlphabetically",
},
],
},
{
code: "import { b } from \n'b';\nimport\n { a } from 'a';",
output: null,
options: [{ allowSeparatedGroups: false }],
errors: [
{
messageId: "sortImportsAlphabetically",
},
],
},
{
code: "import c from 'c';\n\nimport b from 'b';\nimport a from 'a';",
output: null,
options: [{ allowSeparatedGroups: true }],
errors: [
{
messageId: "sortImportsAlphabetically",
line: 4,
},
],
},
{
code: "import b from 'b';\n\nimport { c, a } from 'c';",
output: "import b from 'b';\n\nimport { a, c } from 'c';",
options: [{ allowSeparatedGroups: true }],
errors: [
{
messageId: "sortMembersAlphabetically",
},
],
},
],
});