build: configure import/order eslint rule (#2997)

.eslintrc.json

@@ -1,5 +1,5 @@
 {
-  "plugins": ["mocha"],
+  "plugins": ["mocha", "import"],
   "env": {
     "mocha": true
   },
@@ -17,7 +17,26 @@
         "vars": "all"
       }
     ],
-    "mocha/no-exclusive-tests": "error"
+    "mocha/no-exclusive-tests": "error",
+    "import/order": [
+      "error",
+      {
+        "groups": ["builtin", "external", "internal", "parent", "sibling", "index", "object", "type"],
+        "newlines-between": "always",
+        "alphabetize": {
+          "order": "asc",
+          "caseInsensitive": true
+        }
+      }
+    ],
+    "sort-imports": [
+      "error",
+      {
+        "ignoreDeclarationSort": true,
+        "allowSeparatedGroups": true,
+        "ignoreCase": true
+      }
+    ]
   },
   "overrides": [
     {

ci/fix-changelog.js

@@ -1,5 +1,6 @@
 const fs = require('fs');
 const path = require('path');
+
 const prettier = require('prettier');
 
 const changelogPath = path.resolve(__dirname, '..', 'CHANGELOG.md');

package.json

@@ -122,7 +122,7 @@
     "cross-env": "^7.0.2",
     "electron-installer-common": "^0.10.2",
     "eslint": "^8.0.1",
-    "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-mocha": "^9.0.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.0.0",

packages/api/cli/src/electron-forge-import.ts

@@ -1,8 +1,8 @@
-import { api } from '@electron-forge/core';
+import path from 'path';
 
-import fs from 'fs-extra';
+import { api } from '@electron-forge/core';
 import program from 'commander';
-import path from 'path';
+import fs from 'fs-extra';
 
 import './util/terminate';
 import workingDir from './util/working-dir';

packages/api/cli/src/electron-forge-init.ts

@@ -1,8 +1,8 @@
-import { api, InitOptions } from '@electron-forge/core';
+import path from 'path';
 
-import fs from 'fs-extra';
+import { api, InitOptions } from '@electron-forge/core';
 import program from 'commander';
-import path from 'path';
+import fs from 'fs-extra';
 
 import './util/terminate';
 import workingDir from './util/working-dir';

packages/api/cli/src/electron-forge-make.ts

@@ -1,9 +1,9 @@
-import { api, MakeOptions } from '@electron-forge/core';
+import path from 'path';
 
-import fs from 'fs-extra';
+import { api, MakeOptions } from '@electron-forge/core';
 import { initializeProxy } from '@electron/get';
 import program from 'commander';
-import path from 'path';
+import fs from 'fs-extra';
 
 import './util/terminate';
 import workingDir from './util/working-dir';

packages/api/cli/src/electron-forge-package.ts

@@ -1,9 +1,9 @@
-import { api, PackageOptions } from '@electron-forge/core';
+import path from 'path';
 
-import fs from 'fs-extra';
+import { api, PackageOptions } from '@electron-forge/core';
 import { initializeProxy } from '@electron/get';
 import program from 'commander';
-import path from 'path';
+import fs from 'fs-extra';
 
 import './util/terminate';
 import workingDir from './util/working-dir';

packages/api/cli/src/electron-forge-publish.ts

@@ -1,13 +1,13 @@
-import { api, PublishOptions } from '@electron-forge/core';
+import path from 'path';
 
-import fs from 'fs-extra';
+import { api, PublishOptions } from '@electron-forge/core';
 import { initializeProxy } from '@electron/get';
 import program from 'commander';
-import path from 'path';
+import fs from 'fs-extra';
 
 import './util/terminate';
-import workingDir from './util/working-dir';
 import { getMakeOptions } from './electron-forge-make';
+import workingDir from './util/working-dir';
 
 (async () => {
   let dir = process.cwd();

packages/api/cli/src/electron-forge-start.ts

@@ -1,8 +1,9 @@
+import path from 'path';
+
 import { api, StartOptions } from '@electron-forge/core';
 import { ElectronProcess } from '@electron-forge/shared-types';
-import fs from 'fs-extra';
-import path from 'path';
 import program from 'commander';
+import fs from 'fs-extra';
 
 import './util/terminate';
 import workingDir from './util/working-dir';

packages/api/cli/src/util/check-system.ts

@@ -1,12 +1,12 @@
 import { exec } from 'child_process';
-import debug from 'debug';
-import fs from 'fs-extra';
 import os from 'os';
 import path from 'path';
-import semver from 'semver';
 
-import { utils as forgeUtils } from '@electron-forge/core';
 import { OraImpl } from '@electron-forge/async-ora';
+import { utils as forgeUtils } from '@electron-forge/core';
+import debug from 'debug';
+import fs from 'fs-extra';
+import semver from 'semver';
 
 const d = debug('electron-forge:check-system');
 

packages/api/cli/src/util/working-dir.ts

@@ -1,6 +1,7 @@
-import fs from 'fs-extra';
 import path from 'path';
 
+import fs from 'fs-extra';
+
 export default function workingDir(dir: string, cwd: string, checkExisting = true): string {
   let finalDir = dir;
   if (cwd) {

packages/api/cli/test/cli_spec.ts

@@ -1,7 +1,8 @@
-import chai, { expect } from 'chai';
-import chaiAsPromised from 'chai-as-promised';
 import path from 'path';
+
 import { spawn } from '@malept/cross-spawn-promise';
+import chai, { expect } from 'chai';
+import chaiAsPromised from 'chai-as-promised';
 
 chai.use(chaiAsPromised);
 

packages/api/core/src/api/import.ts

@@ -1,21 +1,22 @@
+import path from 'path';
+
 import { asyncOra } from '@electron-forge/async-ora';
 import baseTemplate from '@electron-forge/template-base';
 import chalk from 'chalk';
 import debug from 'debug';
 import fs from 'fs-extra';
 import { merge } from 'lodash';
-import path from 'path';
-
-import initGit from './init-scripts/init-git';
-import { deps, devDeps, exactDevDeps } from './init-scripts/init-npm';
 
 import { updateElectronDependency } from '../util/electron-version';
 import { setInitialForgeConfig } from '../util/forge-config';
-import { info, warn } from '../util/messages';
 import installDepList, { DepType, DepVersionRestriction } from '../util/install-dependencies';
+import { info, warn } from '../util/messages';
 import { readRawPackageJson } from '../util/read-package-json';
 import upgradeForgeConfig, { updateUpgradedForgeDevDeps } from '../util/upgrade-forge-config';
 
+import initGit from './init-scripts/init-git';
+import { deps, devDeps, exactDevDeps } from './init-scripts/init-npm';
+
 const d = debug('electron-forge:import');
 
 export interface ImportOptions {

packages/api/core/src/api/index.ts

@@ -1,14 +1,14 @@
 import { ElectronProcess, ForgeMakeResult } from '@electron-forge/shared-types';
 
+import ForgeUtils from '../util';
+
 import _import, { ImportOptions } from './import';
 import init, { InitOptions } from './init';
 import make, { MakeOptions } from './make';
 import _package, { PackageOptions } from './package';
 import publish, { PublishOptions } from './publish';
 import start, { StartOptions } from './start';
 
-import ForgeUtils from '../util';
-
 export class ForgeAPI {
   /**
    * Attempt to import a given module directory to the Electron Forge standard.

packages/api/core/src/api/init-scripts/find-template.ts

@@ -1,8 +1,8 @@
 import { asyncOra } from '@electron-forge/async-ora';
+import { ForgeTemplate } from '@electron-forge/shared-types';
 import debug from 'debug';
 import resolvePackage from 'resolve-package';
 
-import { ForgeTemplate } from '@electron-forge/shared-types';
 import { PossibleModule } from '../../util/require-search';
 
 const d = debug('electron-forge:init:find-template');

packages/api/core/src/api/init-scripts/init-git.ts

@@ -1,5 +1,6 @@
-import { asyncOra } from '@electron-forge/async-ora';
 import { exec } from 'child_process';
+
+import { asyncOra } from '@electron-forge/async-ora';
 import debug from 'debug';
 
 const d = debug('electron-forge:init:git');

packages/api/core/src/api/init-scripts/init-npm.ts

@@ -1,7 +1,8 @@
+import path from 'path';
+
 import { asyncOra } from '@electron-forge/async-ora';
 import debug from 'debug';
 import fs from 'fs-extra';
-import path from 'path';
 
 import installDepList, { DepType, DepVersionRestriction } from '../../util/install-dependencies';
 

packages/api/core/src/api/init.ts

@@ -1,17 +1,19 @@
+import path from 'path';
+
 import { asyncOra } from '@electron-forge/async-ora';
-import debug from 'debug';
 import { ForgeTemplate } from '@electron-forge/shared-types';
+import debug from 'debug';
 import fs from 'fs-extra';
-import path from 'path';
 import semver from 'semver';
 
+import { setInitialForgeConfig } from '../util/forge-config';
+import installDepList, { DepType } from '../util/install-dependencies';
+import { readRawPackageJson } from '../util/read-package-json';
+
 import findTemplate from './init-scripts/find-template';
 import initDirectory from './init-scripts/init-directory';
 import initGit from './init-scripts/init-git';
 import initNPM from './init-scripts/init-npm';
-import installDepList, { DepType } from '../util/install-dependencies';
-import { readRawPackageJson } from '../util/read-package-json';
-import { setInitialForgeConfig } from '../util/forge-config';
 
 const d = debug('electron-forge:init');
 

packages/api/core/src/api/make.ts

@@ -1,21 +1,22 @@
+import path from 'path';
+
 import { asyncOra } from '@electron-forge/async-ora';
-import chalk from 'chalk';
-import { getHostArch } from '@electron/get';
-import { IForgeResolvableMaker, ForgeConfig, ForgeArch, ForgePlatform, ForgeMakeResult, ForgeConfigMaker } from '@electron-forge/shared-types';
 import MakerBase from '@electron-forge/maker-base';
-import fs from 'fs-extra';
-import path from 'path';
+import { ForgeArch, ForgeConfig, ForgeConfigMaker, ForgeMakeResult, ForgePlatform, IForgeResolvableMaker } from '@electron-forge/shared-types';
+import { getHostArch } from '@electron/get';
+import chalk from 'chalk';
 import filenamify from 'filenamify';
+import fs from 'fs-extra';
 
+import { getElectronVersion } from '../util/electron-version';
 import getForgeConfig from '../util/forge-config';
 import { runHook, runMutatingHook } from '../util/hook';
 import { info, warn } from '../util/messages';
+import getCurrentOutDir from '../util/out-dir';
 import parseArchs from '../util/parse-archs';
 import { readMutatedPackageJson } from '../util/read-package-json';
-import resolveDir from '../util/resolve-dir';
-import getCurrentOutDir from '../util/out-dir';
-import { getElectronVersion } from '../util/electron-version';
 import requireSearch from '../util/require-search';
+import resolveDir from '../util/resolve-dir';
 
 import packager from './package';
 

packages/api/core/src/api/package.ts

@@ -1,23 +1,24 @@
-import { ora as realOra, fakeOra, OraImpl } from '@electron-forge/async-ora';
+import path from 'path';
+import { promisify } from 'util';
+
+import { fakeOra, OraImpl, ora as realOra } from '@electron-forge/async-ora';
 import { ForgeArch, ForgePlatform } from '@electron-forge/shared-types';
+import { getHostArch } from '@electron/get';
 import chalk from 'chalk';
 import debug from 'debug';
-import fs from 'fs-extra';
-import { getHostArch } from '@electron/get';
-import glob from 'fast-glob';
 import packager, { HookFunction } from 'electron-packager';
-import path from 'path';
-import { promisify } from 'util';
+import glob from 'fast-glob';
+import fs from 'fs-extra';
 
+import { getElectronVersion } from '../util/electron-version';
 import getForgeConfig from '../util/forge-config';
 import { runHook } from '../util/hook';
 import { warn } from '../util/messages';
+import getCurrentOutDir from '../util/out-dir';
 import { readMutatedPackageJson } from '../util/read-package-json';
 import rebuildHook from '../util/rebuild';
 import requireSearch from '../util/require-search';
 import resolveDir from '../util/resolve-dir';
-import getCurrentOutDir from '../util/out-dir';
-import { getElectronVersion } from '../util/electron-version';
 
 const d = debug('electron-forge:packager');
 

packages/api/core/src/api/publish.ts

@@ -1,25 +1,25 @@
+import path from 'path';
+
 import { asyncOra } from '@electron-forge/async-ora';
+import PublisherBase from '@electron-forge/publisher-base';
 import {
-  IForgeResolvablePublisher,
-  IForgePublisher,
   ForgeConfigPublisher,
   ForgeMakeResult,
+  IForgePublisher,
+  IForgeResolvablePublisher,
   // ForgePlatform,
 } from '@electron-forge/shared-types';
-import PublisherBase from '@electron-forge/publisher-base';
-
 import chalk from 'chalk';
 import debug from 'debug';
 import fs from 'fs-extra';
-import path from 'path';
 
 import getForgeConfig from '../util/forge-config';
-import resolveDir from '../util/resolve-dir';
-import PublishState from '../util/publish-state';
 import getCurrentOutDir from '../util/out-dir';
+import PublishState from '../util/publish-state';
+import requireSearch from '../util/require-search';
+import resolveDir from '../util/resolve-dir';
 
 import make, { MakeOptions } from './make';
-import requireSearch from '../util/require-search';
 
 const d = debug('electron-forge:publish');
 

packages/api/core/src/api/start.ts

@@ -1,16 +1,17 @@
+import { spawn, SpawnOptions } from 'child_process';
+
 import { asyncOra } from '@electron-forge/async-ora';
+import { ElectronProcess, ForgeArch, ForgePlatform, StartOptions } from '@electron-forge/shared-types';
 import chalk from 'chalk';
 import debug from 'debug';
-import { ElectronProcess, ForgeArch, ForgePlatform, StartOptions } from '@electron-forge/shared-types';
-import { spawn, SpawnOptions } from 'child_process';
 
+import locateElectronExecutable from '../util/electron-executable';
 import { getElectronVersion } from '../util/electron-version';
 import getForgeConfig from '../util/forge-config';
-import locateElectronExecutable from '../util/electron-executable';
+import { runHook } from '../util/hook';
 import { readMutatedPackageJson } from '../util/read-package-json';
 import rebuild from '../util/rebuild';
 import resolveDir from '../util/resolve-dir';
-import { runHook } from '../util/hook';
 
 const d = debug('electron-forge:start');
 

packages/api/core/src/util/download-to-file.ts

@@ -1,6 +1,7 @@
+import * as path from 'path';
+
 import * as fs from 'fs-extra';
 import got, { HTTPError } from 'got';
-import * as path from 'path';
 import ProgressBar from 'progress';
 
 const PROGRESS_BAR_DELAY_IN_SECONDS = 30;