misc(eslint): add auto-sort for imports/exports

.eslintrc.js

@@ -1,7 +1,7 @@
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint', 'jsdoc', 'jest'],
+  plugins: ['@typescript-eslint', 'jsdoc', 'jest', 'simple-import-sort'],
   extends: [
     'plugin:jest/recommended',
     // including prettier here ensures that we don't set any rules which will conflict
@@ -77,6 +77,8 @@ module.exports = {
     'no-var': 'error',
     'prefer-rest-params': 'error',
     'prefer-spread': 'error',
+    'simple-import-sort/imports': 'error',
+    'simple-import-sort/exports': 'error',
   },
   // inform ESLint about the global variables defined in a Jest context
   // see https://github.com/jest-community/eslint-plugin-jest/#usage

.github/workflows/lint-and-format.yml

@@ -16,9 +16,9 @@ jobs:
       - name: Get Core Dependencies
         uses: ./.github/workflows/actions/get-core-dependencies
 
+      - name: ESLint
+        run: npm run lint
+
       - name: Prettier Check
         run: npm run prettier.dry-run
         shell: bash
-
-      - name: ESLint
-        run: npm run lint

package.json

@@ -99,6 +99,7 @@
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-jest": "^26.5.3",
     "eslint-plugin-jsdoc": "^39.3.1",
+    "eslint-plugin-simple-import-sort": "^8.0.0",
     "execa": "4.1.0",
     "exit": "^0.1.2",
     "fast-deep-equal": "3.1.3",

src/cli/check-version.ts

@@ -1,6 +1,7 @@
-import type { ValidatedConfig } from '../declarations';
 import { isFunction } from '@utils';
 
+import type { ValidatedConfig } from '../declarations';
+
 export const startCheckVersion = async (config: ValidatedConfig, currentVersion: string) => {
   if (config.devMode && !config.flags.ci && !currentVersion.includes('-dev.') && isFunction(config.sys.checkVersion)) {
     return config.sys.checkVersion(config.logger, currentVersion);

src/cli/find-config.ts

@@ -1,5 +1,6 @@
+import { buildError, isString, normalizePath } from '@utils';
+
 import type { CompilerSystem, Diagnostic } from '../declarations';
-import { isString, normalizePath, buildError } from '@utils';
 
 /**
  * An object containing the {@link CompilerSystem} used to find the configuration file, as well as the location on disk

src/cli/index.ts

@@ -1,3 +1,3 @@
+export { ConfigFlags } from './config-flags';
 export { parseFlags } from './parse-flags';
 export { run, runTask } from './run';
-export { ConfigFlags } from './config-flags';

src/cli/ionic-config.ts

@@ -1,5 +1,5 @@
 import type * as d from '../declarations';
-import { readJson, uuidv4, UUID_REGEX } from './telemetry/helpers';
+import { readJson, UUID_REGEX, uuidv4 } from './telemetry/helpers';
 
 export const isTest = () => process.env.JEST_WORKER_ID !== undefined;
 

src/cli/logs.ts

@@ -1,4 +1,4 @@
-import type { Logger, CompilerSystem, TaskCommand, ValidatedConfig } from '../declarations';
+import type { CompilerSystem, Logger, TaskCommand, ValidatedConfig } from '../declarations';
 import type { ConfigFlags } from './config-flags';
 import type { CoreCompiler } from './load-compiler';
 

src/cli/parse-flags.ts

@@ -1,10 +1,12 @@
-import { CompilerSystem, LogLevel, LOG_LEVELS, TaskCommand } from '../declarations';
 import { dashToPascalCase, toDashCase } from '@utils';
+
+import { CompilerSystem, LOG_LEVELS, LogLevel, TaskCommand } from '../declarations';
 import {
   BOOLEAN_CLI_ARGS,
   BooleanCLIArg,
   CLI_ARG_ALIASES,
   ConfigFlags,
+  createConfigFlags,
   LOG_LEVEL_CLI_ARGS,
   LogCLIArg,
   NUMBER_CLI_ARGS,
@@ -13,7 +15,6 @@ import {
   STRING_NUMBER_CLI_ARGS,
   StringCLIArg,
   StringNumberCLIArg,
-  createConfigFlags,
 } from './config-flags';
 
 /**

src/cli/public.ts

@@ -1,4 +1,5 @@
 import type { CliInitOptions, CompilerSystem, Config, Logger, TaskCommand } from '@stencil/core/internal';
+
 import type { ConfigFlags } from './config-flags';
 
 /**

src/cli/run.ts

@@ -1,8 +1,12 @@
-import type * as d from '../declarations';
+import { hasError, isFunction, shouldIgnoreError } from '@utils';
+
 import { dependencies } from '../compiler/sys/dependencies.json';
+import { createLogger } from '../compiler/sys/logger/console-logger';
+import type * as d from '../declarations';
+import { ValidatedConfig } from '../declarations';
+import { createConfigFlags } from './config-flags';
 import { findConfig } from './find-config';
-import { hasError, isFunction, shouldIgnoreError } from '@utils';
-import { loadCoreCompiler, CoreCompiler } from './load-compiler';
+import { CoreCompiler, loadCoreCompiler } from './load-compiler';
 import { loadedCompilerLog, startupLog, startupLogVersion } from './logs';
 import { parseFlags } from './parse-flags';
 import { taskBuild } from './task-build';
@@ -12,12 +16,9 @@ import { taskHelp } from './task-help';
 import { taskInfo } from './task-info';
 import { taskPrerender } from './task-prerender';
 import { taskServe } from './task-serve';
-import { taskTest } from './task-test';
 import { taskTelemetry } from './task-telemetry';
+import { taskTest } from './task-test';
 import { telemetryAction } from './telemetry/telemetry';
-import { createLogger } from '../compiler/sys/logger/console-logger';
-import { ValidatedConfig } from '../declarations';
-import { createConfigFlags } from './config-flags';
 
 export const run = async (init: d.CliInitOptions) => {
   const { args, logger, sys } = init;

src/cli/task-build.ts

@@ -1,8 +1,8 @@
 import type * as d from '../declarations';
+import { printCheckVersionResults, startCheckVersion } from './check-version';
 import type { CoreCompiler } from './load-compiler';
-import { runPrerenderTask } from './task-prerender';
-import { startCheckVersion, printCheckVersionResults } from './check-version';
 import { startupCompilerLog } from './logs';
+import { runPrerenderTask } from './task-prerender';
 import { taskWatch } from './task-watch';
 import { telemetryBuildFinishedAction } from './telemetry/telemetry';
 

src/cli/task-docs.ts

@@ -1,6 +1,6 @@
+import { isOutputTargetDocs } from '../compiler/output-targets/output-utils';
 import type { ValidatedConfig } from '../declarations';
 import type { CoreCompiler } from './load-compiler';
-import { isOutputTargetDocs } from '../compiler/output-targets/output-utils';
 import { startupCompilerLog } from './logs';
 
 export const taskDocs = async (coreCompiler: CoreCompiler, config: ValidatedConfig) => {

src/cli/task-generate.ts

@@ -1,7 +1,8 @@
+import { validateComponentTag } from '@utils';
+
+import { IS_NODE_ENV } from '../compiler/sys/environment';
 import type { ValidatedConfig } from '../declarations';
 import type { CoreCompiler } from './load-compiler';
-import { IS_NODE_ENV } from '../compiler/sys/environment';
-import { validateComponentTag } from '@utils';
 
 /**
  * Task to generate component boilerplate and write it to disk. This task can

src/cli/task-prerender.ts

@@ -1,6 +1,7 @@
+import { catchError } from '@utils';
+
 import type { BuildResultsComponentGraph, Diagnostic, ValidatedConfig } from '../declarations';
 import type { CoreCompiler } from './load-compiler';
-import { catchError } from '@utils';
 import { startupCompilerLog } from './logs';
 
 export const taskPrerender = async (coreCompiler: CoreCompiler, config: ValidatedConfig) => {

src/cli/task-serve.ts

@@ -1,6 +1,7 @@
-import type { ValidatedConfig } from '../declarations';
 import { isString } from '@utils';
 
+import type { ValidatedConfig } from '../declarations';
+
 export const taskServe = async (config: ValidatedConfig) => {
   config.suppressLogs = true;
 

src/cli/task-test.ts

@@ -1,5 +1,5 @@
-import type { ValidatedConfig, TestingRunOptions } from '../declarations';
 import { IS_NODE_ENV } from '../compiler/sys/environment';
+import type { TestingRunOptions, ValidatedConfig } from '../declarations';
 
 /**
  * Entrypoint for any Stencil tests

src/cli/task-watch.ts

@@ -1,6 +1,6 @@
 import type { DevServer, ValidatedConfig } from '../declarations';
+import { printCheckVersionResults, startCheckVersion } from './check-version';
 import type { CoreCompiler } from './load-compiler';
-import { startCheckVersion, printCheckVersionResults } from './check-version';
 import { startupCompilerLog } from './logs';
 
 export const taskWatch = async (coreCompiler: CoreCompiler, config: ValidatedConfig) => {

src/cli/telemetry/telemetry.ts

@@ -1,9 +1,9 @@
-import { tryFn, hasDebug, readJson, hasVerbose, uuidv4 } from './helpers';
-import { shouldTrack } from './shouldTrack';
+import { isOutputTargetHydrate, WWW } from '../../compiler/output-targets/output-utils';
 import type * as d from '../../declarations';
 import { readConfig, updateConfig, writeConfig } from '../ionic-config';
 import { CoreCompiler } from '../load-compiler';
-import { isOutputTargetHydrate, WWW } from '../../compiler/output-targets/output-utils';
+import { hasDebug, hasVerbose, readJson, tryFn, uuidv4 } from './helpers';
+import { shouldTrack } from './shouldTrack';
 
 /**
  * Used to within taskBuild to provide the component_count property.

src/cli/telemetry/test/helpers.spec.ts

@@ -1,6 +1,6 @@
-import { isInteractive, tryFn, uuidv4, hasDebug, hasVerbose } from '../helpers';
 import { createSystem } from '../../../compiler/sys/stencil-sys';
 import { createConfigFlags } from '../../config-flags';
+import { hasDebug, hasVerbose, isInteractive, tryFn, uuidv4 } from '../helpers';
 
 describe('hasDebug', () => {
   it('Returns true when a flag is passed', () => {

src/cli/telemetry/test/telemetry.spec.ts

@@ -1,12 +1,13 @@
+import * as coreCompiler from '@stencil/core/compiler';
+import { mockValidatedConfig } from '@stencil/core/testing';
+
+import { createConfigFlags } from '../../../cli/config-flags';
+import { DIST, DIST_CUSTOM_ELEMENTS, DIST_HYDRATE_SCRIPT, WWW } from '../../../compiler/output-targets/output-utils';
+import { createSystem } from '../../../compiler/sys/stencil-sys';
 import type * as d from '../../../declarations';
-import * as telemetry from '../telemetry';
 import * as shouldTrack from '../shouldTrack';
-import { createSystem } from '../../../compiler/sys/stencil-sys';
-import { mockValidatedConfig } from '@stencil/core/testing';
-import * as coreCompiler from '@stencil/core/compiler';
+import * as telemetry from '../telemetry';
 import { anonymizeConfigForTelemetry } from '../telemetry';
-import { DIST, DIST_CUSTOM_ELEMENTS, DIST_HYDRATE_SCRIPT, WWW } from '../../../compiler/output-targets/output-utils';
-import { createConfigFlags } from '../../../cli/config-flags';
 
 describe('telemetryBuildFinishedAction', () => {
   let config: d.ValidatedConfig;

src/cli/test/ionic-config.spec.ts

@@ -1,7 +1,8 @@
-import { readConfig, writeConfig, updateConfig, defaultConfig } from '../ionic-config';
+import { mockCompilerSystem } from '@stencil/core/testing';
+
 import { createSystem } from '../../compiler/sys/stencil-sys';
+import { defaultConfig, readConfig, updateConfig, writeConfig } from '../ionic-config';
 import { UUID_REGEX } from '../telemetry/helpers';
-import { mockCompilerSystem } from '@stencil/core/testing';
 
 const UUID1 = '5588e0f0-02b5-4afa-8194-5d8f78683b36';
 const UUID2 = 'e5609819-5c24-4fa2-8817-e05ca10b8cae';

src/cli/test/parse-flags.spec.ts

@@ -1,7 +1,8 @@
+import { toDashCase } from '@utils';
+
 import { LogLevel } from '../../declarations';
-import { BOOLEAN_CLI_ARGS, STRING_CLI_ARGS, NUMBER_CLI_ARGS } from '../config-flags';
+import { BOOLEAN_CLI_ARGS, NUMBER_CLI_ARGS, STRING_CLI_ARGS } from '../config-flags';
 import { parseEqualsArg, parseFlags } from '../parse-flags';
-import { toDashCase } from '@utils';
 
 describe('parseFlags', () => {
   it('should get known and unknown args', () => {

src/cli/test/run.spec.ts

@@ -1,11 +1,14 @@
-import type * as d from '../../declarations';
 import * as coreCompiler from '@stencil/core/compiler';
 import {
   mockCompilerSystem,
   mockConfig,
   mockLogger as createMockLogger,
   mockValidatedConfig,
 } from '@stencil/core/testing';
+
+import type * as d from '../../declarations';
+import { createTestingSystem } from '../../testing/testing-sys';
+import { createConfigFlags } from '../config-flags';
 import * as ParseFlags from '../parse-flags';
 import { run, runTask } from '../run';
 import * as BuildTask from '../task-build';
@@ -16,8 +19,6 @@ import * as PrerenderTask from '../task-prerender';
 import * as ServeTask from '../task-serve';
 import * as TelemetryTask from '../task-telemetry';
 import * as TestTask from '../task-test';
-import { createTestingSystem } from '../../testing/testing-sys';
-import { createConfigFlags } from '../config-flags';
 
 describe('run', () => {
   describe('run()', () => {

src/cli/test/task-generate.spec.ts

@@ -1,11 +1,11 @@
+import * as coreCompiler from '@stencil/core/compiler';
+import { mockCompilerSystem, mockValidatedConfig } from '@stencil/core/testing';
+
 import type * as d from '../../declarations';
-import { taskGenerate, getBoilerplateByExtension, BoilerplateFile } from '../task-generate';
-import { mockValidatedConfig, mockCompilerSystem } from '@stencil/core/testing';
 import * as utils from '../../utils/validation';
-
-import * as coreCompiler from '@stencil/core/compiler';
-import { CoreCompiler } from '../load-compiler';
 import { createConfigFlags } from '../config-flags';
+import { CoreCompiler } from '../load-compiler';
+import { BoilerplateFile, getBoilerplateByExtension, taskGenerate } from '../task-generate';
 
 const promptMock = jest.fn().mockResolvedValue('my-component');
 

src/client/client-build.ts

@@ -1,6 +1,7 @@
-import type * as d from '../declarations';
 import { BUILD } from '@app-data';
 
+import type * as d from '../declarations';
+
 export const Build: d.UserBuildConditionals = {
   isDev: BUILD.isDev ? true : false,
   isBrowser: true,

src/client/client-host-ref.ts

@@ -1,6 +1,7 @@
-import type * as d from '../declarations';
-import { addHostEventListeners } from '@runtime';
 import { BUILD } from '@app-data';
+import { addHostEventListeners } from '@runtime';
+
+import type * as d from '../declarations';
 
 const hostRefs: WeakMap<d.RuntimeRef, d.HostRef> = /*@__PURE__*/ new WeakMap();
 

src/client/client-load-module.ts

@@ -1,6 +1,7 @@
-import type * as d from '../declarations';
 import { BUILD } from '@app-data';
-import { consoleError, consoleDevError } from './client-log';
+
+import type * as d from '../declarations';
+import { consoleDevError, consoleError } from './client-log';
 
 export const cmpModules = /*@__PURE__*/ new Map<string, { [exportName: string]: d.ComponentConstructor }>();
 

src/client/client-log.ts

@@ -1,6 +1,7 @@
-import type * as d from '../declarations';
 import { BUILD } from '@app-data';
 
+import type * as d from '../declarations';
+
 let customError: d.ErrorHandler;
 
 export const consoleError: d.ErrorHandler = (e: any, el?: any) => (customError || console.error)(e, el);

src/client/client-patch-browser.ts

@@ -1,8 +1,9 @@
-import type * as d from '../declarations';
 import { BUILD, NAMESPACE } from '@app-data';
-import { consoleDevInfo, H, doc, plt, promiseResolve, win } from '@platform';
+import { consoleDevInfo, doc, H, plt, promiseResolve, win } from '@platform';
 import { getDynamicImportFunction } from '@utils';
 
+import type * as d from '../declarations';
+
 export const patchBrowser = (): Promise<d.CustomElementsDefineOptions> => {
   // NOTE!! This fn cannot use async/await!
   if (BUILD.isDev && !BUILD.isTesting) {

src/client/client-task-queue.ts

@@ -1,8 +1,9 @@
+import { BUILD } from '@app-data';
+
 import type * as d from '../declarations';
+import { PLATFORM_FLAGS } from '../runtime/runtime-constants';
 import { consoleError } from './client-log';
 import { plt, promiseResolve } from './client-window';
-import { PLATFORM_FLAGS } from '../runtime/runtime-constants';
-import { BUILD } from '@app-data';
 
 let queueCongestion = 0;
 let queuePending = false;