Enabled eslint-plugin-simple-import-sort internally (#1102)

* Enabled eslint-plugin-simple-import-sort internally

* Added eslint-plugin-simple-import-sort

Enforces that exports and imports are sorted alphabetically, with a fixer for ESLint's `--fix`.

Precursor to #1089 to make it easier to insert lines into `ruleConverters.ts` automatically.

* Reset package-lock.json

* Autofix imports

Author: Josh Goldberg

.eslintrc.js

@@ -16,7 +16,7 @@ module.exports = {
     parserOptions: {
         project: "tsconfig.json",
     },
-    plugins: ["@typescript-eslint"],
+    plugins: ["simple-import-sort", "@typescript-eslint"],
     rules: {
         "@typescript-eslint/comma-dangle": [
             "error",
@@ -64,5 +64,7 @@ module.exports = {
         "@typescript-eslint/typedef": "off",
         "comma-dangle": "off",
         "no-else-return": "error",
+        "simple-import-sort/imports": "error",
+        "simple-import-sort/exports": "error",
     },
 };

package-lock.json

@@ -38,6 +38,7 @@
         "@typescript-eslint/parser": "4.25.0",
         "babel-jest": "27.0.1",
         "eslint": "7.27.0",
+        "eslint-plugin-simple-import-sort": "^7.0.0",
         "husky": "6.0.0",
         "jest": "27.0.1",
         "lint-staged": "11.0.0",

package.json

@@ -4,62 +4,75 @@ import { globAsync } from "../adapters/globAsync";
 import { nativeImporter } from "../adapters/nativeImporter";
 import { processLogger } from "../adapters/processLogger";
 import { bind } from "../binding";
+import { RunCliDependencies } from "../cli/runCli";
 import {
     collectCommentFileNames,
     CollectCommentFileNamesDependencies,
 } from "../comments/collectCommentFileNames";
 import {
-    ReportCommentResultsDependencies,
+    convertComments,
+    ConvertCommentsDependencies,
+} from "../converters/comments/convertComments";
+import {
+    convertFileComments,
+    ConvertFileCommentsDependencies,
+} from "../converters/comments/convertFileComments";
+import {
+    extractGlobPaths,
+    ExtractGlobPathsDependencies,
+} from "../converters/comments/extractGlobPaths";
+import {
     reportCommentResults,
+    ReportCommentResultsDependencies,
 } from "../converters/comments/reporting/reportCommentResults";
 import {
-    ConvertEditorConfigDependencies,
     convertEditorConfig,
+    ConvertEditorConfigDependencies,
 } from "../converters/editorConfigs/convertEditorConfig";
 import {
-    ConvertLintConfigDependencies,
+    convertEditorConfigs,
+    ConvertEditorConfigsDependencies,
+} from "../converters/editorConfigs/convertEditorConfigs";
+import { convertAtomConfig } from "../converters/editorConfigs/converters/convertAtomConfig";
+import { convertVSCodeConfig } from "../converters/editorConfigs/converters/convertVSCodeConfig";
+import { reportEditorConfigConversionResults } from "../converters/editorConfigs/reporting/reportEditorConfigConversionResults";
+import { EditorConfigDescriptor } from "../converters/editorConfigs/types";
+import {
     convertLintConfig,
+    ConvertLintConfigDependencies,
 } from "../converters/lintConfigs/convertLintConfig";
 import {
-    ReportConversionResultsDependencies,
-    reportConfigConversionResults,
-} from "../converters/lintConfigs/reporting/reportConfigConversionResults";
+    createESLintConfiguration,
+    CreateESLintConfigurationDependencies,
+} from "../converters/lintConfigs/createESLintConfiguration";
+import { removeExtendsDuplicatedRules } from "../converters/lintConfigs/pruning/removeExtendsDuplicatedRules";
 import {
-    ConvertCommentsDependencies,
-    convertComments,
-} from "../converters/comments/convertComments";
+    choosePackageManager,
+    ChoosePackageManagerDependencies,
+} from "../converters/lintConfigs/reporting/packages/choosePackageManager";
 import {
-    ConvertFileCommentsDependencies,
-    convertFileComments,
-} from "../converters/comments/convertFileComments";
+    logMissingPackages,
+    LogMissingPackagesDependencies,
+} from "../converters/lintConfigs/reporting/packages/logMissingPackages";
+import {
+    reportConfigConversionResults,
+    ReportConversionResultsDependencies,
+} from "../converters/lintConfigs/reporting/reportConfigConversionResults";
 import {
-    ConvertRulesDependencies,
     convertRules,
+    ConvertRulesDependencies,
 } from "../converters/lintConfigs/rules/convertRules";
 import { ruleConverters } from "../converters/lintConfigs/rules/ruleConverters";
+import { ruleMergers } from "../converters/lintConfigs/rules/ruleMergers";
+import { checkPrettierExtension } from "../converters/lintConfigs/summarization/prettier/checkPrettierExtension";
 import {
-    RetrieveExtendsValuesDependencies,
     retrieveExtendsValues,
+    RetrieveExtendsValuesDependencies,
 } from "../converters/lintConfigs/summarization/retrieveExtendsValues";
 import {
-    SummarizePackageRulesDependencies,
     summarizePackageRules,
+    SummarizePackageRulesDependencies,
 } from "../converters/lintConfigs/summarization/summarizePackageRules";
-import {
-    ChoosePackageManagerDependencies,
-    choosePackageManager,
-} from "../converters/lintConfigs/reporting/packages/choosePackageManager";
-import {
-    LogMissingPackagesDependencies,
-    logMissingPackages,
-} from "../converters/lintConfigs/reporting/packages/logMissingPackages";
-import { RunCliDependencies } from "../cli/runCli";
-import { ruleMergers } from "../converters/lintConfigs/rules/ruleMergers";
-import { removeExtendsDuplicatedRules } from "../converters/lintConfigs/pruning/removeExtendsDuplicatedRules";
-import {
-    ExtractGlobPathsDependencies,
-    extractGlobPaths,
-} from "../converters/comments/extractGlobPaths";
 import { findESLintConfiguration } from "../input/findESLintConfiguration";
 import {
     findOriginalConfigurations,
@@ -70,19 +83,6 @@ import { findTSLintConfiguration } from "../input/findTSLintConfiguration";
 import { findTypeScriptConfiguration } from "../input/findTypeScriptConfiguration";
 import { importer, ImporterDependencies } from "../input/importer";
 import { mergeLintConfigurations } from "../input/mergeLintConfigurations";
-import {
-    createESLintConfiguration,
-    CreateESLintConfigurationDependencies,
-} from "../converters/lintConfigs/createESLintConfiguration";
-import { checkPrettierExtension } from "../converters/lintConfigs/summarization/prettier/checkPrettierExtension";
-import {
-    convertEditorConfigs,
-    ConvertEditorConfigsDependencies,
-} from "../converters/editorConfigs/convertEditorConfigs";
-import { reportEditorConfigConversionResults } from "../converters/editorConfigs/reporting/reportEditorConfigConversionResults";
-import { EditorConfigDescriptor } from "../converters/editorConfigs/types";
-import { convertAtomConfig } from "../converters/editorConfigs/converters/convertAtomConfig";
-import { convertVSCodeConfig } from "../converters/editorConfigs/converters/convertVSCodeConfig";
 export const convertFileCommentsDependencies: ConvertFileCommentsDependencies = {
     converters: ruleConverters,
     fileSystem: fsFileSystem,

src/api/dependencies.ts

@@ -1,7 +1,7 @@
 import { SansDependencies } from "../../binding";
 import { collectCommentFileNames } from "../../comments/collectCommentFileNames";
 import { AllOriginalConfigurations } from "../../input/findOriginalConfigurations";
-import { ResultWithDataStatus, ResultStatus, TSLintToESLintSettings } from "../../types";
+import { ResultStatus, ResultWithDataStatus, TSLintToESLintSettings } from "../../types";
 import { isError } from "../../utils";
 import { convertFileComments } from "./convertFileComments";
 import { extractGlobPaths } from "./extractGlobPaths";

src/converters/comments/convertComments.ts

@@ -1,8 +1,8 @@
 import { Logger } from "../../../adapters/logger";
 import {
-    logSuccessfulConversions,
     logFailedConversions,
     logMissingConversionTarget,
+    logSuccessfulConversions,
 } from "../../../reporting";
 import { EditorConfigsConversionResults } from "../types";
 

src/converters/editorConfigs/reporting/reportEditorConfigConversionResults.ts

@@ -1,7 +1,7 @@
 import { FileSystem } from "../../adapters/fileSystem";
 import { SansDependencies } from "../../binding";
 import { AllOriginalConfigurations } from "../../input/findOriginalConfigurations";
-import { TSLintToESLintSettings, ResultWithStatus, ResultStatus } from "../../types";
+import { ResultStatus, ResultWithStatus, TSLintToESLintSettings } from "../../types";
 import { createESLintConfiguration } from "./createESLintConfiguration";
 import { formatOutput } from "./formatting/formatOutput";
 import { joinConfigConversionResults } from "./joinConfigConversionResults";

src/converters/lintConfigs/convertLintConfig.ts

@@ -1,5 +1,5 @@
-import { createEnv } from "./createEnv";
 import { TypeScriptConfiguration } from "../../../input/findTypeScriptConfiguration";
+import { createEnv } from "./createEnv";
 
 const createTypeScriptCompilerOptions = (
     overrides: Partial<TypeScriptConfiguration["compilerOptions"]> = {},

src/converters/lintConfigs/eslint/createEnv.test.ts

@@ -1,7 +1,7 @@
 import { EOL } from "os";
 
-import { faqs } from "./formatters/faqs";
 import { formatOutput } from "./formatOutput";
+import { faqs } from "./formatters/faqs";
 
 describe("formatOutput", () => {
     it("formats output as JavaScript for a .js file path", () => {

src/converters/lintConfigs/formatting/formatOutput.test.ts

@@ -1,4 +1,4 @@
-import { RawESLintRuleSeverity, ESLintRuleSeverity } from "../rules/types";
+import { ESLintRuleSeverity, RawESLintRuleSeverity } from "../rules/types";
 
 export const normalizeRawESLintRuleSeverity = (
     rawSeverity: RawESLintRuleSeverity,

src/converters/lintConfigs/pruning/normalizeRawESLintRuleSeverity.ts

@@ -33,7 +33,10 @@ describe("removeExtendsDuplicatedRules", () => {
         });
 
         // Act
-        const { differentRules } = removeExtendsDuplicatedRules(allRules, new Map<string, ESLintRuleOptionsWithArguments>());
+        const { differentRules } = removeExtendsDuplicatedRules(
+            allRules,
+            new Map<string, ESLintRuleOptionsWithArguments>(),
+        );
 
         // Assert
         expect(differentRules.size).toBe(1);

src/converters/lintConfigs/pruning/removeExtendsDuplicatedRules.test.ts

@@ -1,5 +1,5 @@
 import { FileSystem } from "../../../../adapters/fileSystem";
-import { preferredLockfiles, PackageManager } from "./packageManagers";
+import { PackageManager, preferredLockfiles } from "./packageManagers";
 
 export type ChoosePackageManagerDependencies = {
     fileSystem: Pick<FileSystem, "fileExists">;

src/converters/lintConfigs/reporting/packages/choosePackageManager.ts

@@ -3,11 +3,11 @@ import { EOL } from "os";
 
 import { Logger } from "../../../adapters/logger";
 import {
-    logSuccessfulConversions,
     logFailedConversions,
     logMissingConversionTarget,
+    logSuccessfulConversions,
 } from "../../../reporting";
-import { TSLintRuleOptions, ESLintRuleOptions } from "../rules/types";
+import { ESLintRuleOptions, TSLintRuleOptions } from "../rules/types";
 import { SummarizedConfigResultsConfiguration } from "../summarization/types";
 
 export type ReportConversionResultsDependencies = {

src/converters/lintConfigs/reporting/reportConfigConversionResults.ts

@@ -1,7 +1,7 @@
 import { ConversionError } from "../../../errors/conversionError";
 import { convertRules } from "./convertRules";
+import { ConversionResult, RuleConverter } from "./ruleConverter";
 import { RuleMerger } from "./ruleMerger";
-import { RuleConverter, ConversionResult } from "./ruleConverter";
 import { TSLintRuleOptions, TSLintRuleSeverity } from "./types";
 
 describe("convertRules", () => {

src/converters/lintConfigs/rules/convertRules.test.ts

@@ -3,13 +3,13 @@ import { isEqual } from "lodash";
 import { ConversionError } from "../../../errors/conversionError";
 import { ErrorSummary } from "../../../errors/errorSummary";
 import { TSLintConfigurationRules } from "../../../input/findTSLintConfiguration";
+import { Entries, uniqueFromSources } from "../../../utils";
 import { convertRule } from "./convertRule";
 import { convertTSLintRuleSeverity } from "./formats/convertTSLintRuleSeverity";
 import { formatRawTslintRule } from "./formats/formatRawTslintRule";
-import { RuleMerger } from "./ruleMerger";
 import { RuleConverter } from "./ruleConverter";
-import { TSLintRuleOptions, ESLintRuleOptions } from "./types";
-import { Entries, uniqueFromSources } from "../../../utils";
+import { RuleMerger } from "./ruleMerger";
+import { ESLintRuleOptions, TSLintRuleOptions } from "./types";
 
 export type ConvertRulesDependencies = {
     ruleConverters: Map<string, RuleConverter>;
@@ -39,7 +39,9 @@ export const convertRules = (
     const plugins = new Set<string>();
 
     if (rawTslintRules !== undefined) {
-        for (const [ruleName, value] of Object.entries(rawTslintRules) as Entries<TSLintConfigurationRules>) {
+        for (const [ruleName, value] of Object.entries(
+            rawTslintRules,
+        ) as Entries<TSLintConfigurationRules>) {
             // 1. The raw TSLint rule is converted to a standardized format.
             const tslintRule = formatRawTslintRule(ruleName, value);
 

src/converters/lintConfigs/rules/convertRules.ts

@@ -1,5 +1,5 @@
-import { ESLintRuleSeverity, TSLintRuleOptions } from "./types";
 import { ConversionError } from "../../../errors/conversionError";
+import { ESLintRuleSeverity, TSLintRuleOptions } from "./types";
 
 /**
  * Section of a TSLint rule's options used for conversion.