refactor(domains): flatten plugins and restore dist config path

- Flatten lint domain engine and plugin modules into top level domain folders.

- Consolidate shared domain types and utilities and update domain tests.

- Restore ESLint default config resolution to compiled eslint.js path.

Author: CMCDragonkai

src/LintDomainPluginBase.ts

@@ -0,0 +1,33 @@
+import type {
+  LintDomain,
+  LintDomainDetection,
+  LintDomainEngineContext,
+  LintDomainPlugin,
+  LintDomainPluginResult,
+} from './types.js';
+
+function normalizeLogDetail(value: unknown): string {
+  return String(value)
+    .replace(/\r?\n+/g, ' | ')
+    .trim();
+}
+
+abstract class LintDomainPluginBase implements LintDomainPlugin {
+  public abstract readonly domain: LintDomain;
+  public abstract readonly description: string;
+
+  public abstract detect(
+    context: LintDomainEngineContext,
+  ): Promise<LintDomainDetection> | LintDomainDetection;
+
+  public abstract run(
+    context: LintDomainEngineContext,
+    detection: LintDomainDetection,
+  ): Promise<LintDomainPluginResult> | LintDomainPluginResult;
+
+  protected normalizeLogDetail(value: unknown): string {
+    return normalizeLogDetail(value);
+  }
+}
+
+export default LintDomainPluginBase;

src/bin/matrixai-lint.ts

@@ -14,7 +14,8 @@ import {
   evaluateLintDomains,
   runLintDomainDecisions,
   type LintDomainDecision,
-} from '../domains/index.js';
+} from '../domains.js';
+import * as eslintUtils from '../eslint/utils.js';
 import * as utils from '../utils.js';
 
 const program = new Command();
@@ -179,7 +180,7 @@ async function main(argv = process.argv) {
       chosenConfig = absolutePath;
     }
   } else if (useUserConfig) {
-    chosenConfig = utils.findUserESLintConfig();
+    chosenConfig = eslintUtils.findUserESLintConfig();
     if (chosenConfig === undefined) {
       logger.warn(
         '--user-config given but no local ESLint config was found. Falling back to built-in config.',

src/configs/eslint.ts

@@ -8,7 +8,7 @@ import tsParser from '@typescript-eslint/parser';
 import { FlatCompat } from '@eslint/eslintrc';
 import { fixupPluginRules } from '@eslint/compat';
 import prettierOptions from './prettier.config.js';
-import matrixaiPlugin from '../plugins/eslint-plugin-matrixai.js';
+import noAliasedImportsRule from '../eslint/rules/no-aliased-imports.js';
 import { resolveLintConfig } from '../config.js';
 
 const resolvedLintConfig = resolveLintConfig();
@@ -35,7 +35,11 @@ const config = [
   {
     plugins: {
       import: fixupPluginRules(_import),
-      '@matrixai': matrixaiPlugin,
+      '@matrixai': {
+        rules: {
+          'no-aliased-imports': noAliasedImportsRule,
+        },
+      },
     },
 
     settings: {

src/domains/engine.ts src/domainEngine.tssrc/domains/engine.ts renamed to src/domainEngine.ts

@@ -1,73 +1,16 @@
-import type { LintDomain } from '../types.js';
-import type Logger from '@matrixai/logger';
-
-type LintDomainEngineContext = {
-  fix: boolean;
-  logger: Logger;
-  chosenConfig?: string;
-  isConfigValid: boolean;
-  eslintPatterns?: string[];
-  shellPatterns?: string[];
-  markdownPatterns?: string[];
-  nixPatterns?: string[];
-};
-
-type LintDomainAvailabilityKind = 'required' | 'optional';
-
-type LintDomainDetection = {
-  relevant: boolean;
-  relevanceReason?: string;
-  available: boolean;
-  availabilityKind: LintDomainAvailabilityKind;
-  unavailableReason?: string;
-  matchedFiles?: string[];
-};
-
-type LintDomainPluginResult = {
-  hadFailure: boolean;
-};
-
-type LintDomainSelectionSource =
-  | 'default'
-  | 'domain-flag'
-  | 'target-flag'
-  | 'unselected';
-
-type LintDomainPlannedAction =
-  | 'run'
-  | 'skip-unselected'
-  | 'skip-not-relevant'
-  | 'skip-unavailable'
-  | 'fail-unavailable'
-  | 'fail-detection';
-
-type LintDomainDecision = {
-  domain: LintDomain;
-  description: string;
-  selected: boolean;
-  explicitlyRequested: boolean;
-  selectionSource: LintDomainSelectionSource;
-  detection: LintDomainDetection | null;
-  plannedAction: LintDomainPlannedAction;
-  detectionError?: string;
-};
-
-type LintDomainPlugin = {
-  domain: LintDomain;
-  description: string;
-  detect:
-    | ((context: LintDomainEngineContext) => Promise<LintDomainDetection>)
-    | ((context: LintDomainEngineContext) => LintDomainDetection);
-  run:
-    | ((
-        context: LintDomainEngineContext,
-        detection: LintDomainDetection,
-      ) => Promise<LintDomainPluginResult>)
-    | ((
-        context: LintDomainEngineContext,
-        detection: LintDomainDetection,
-      ) => LintDomainPluginResult);
-};
+import type {
+  LintDomainAvailabilityKind,
+  LintDomainDecision,
+  LintDomainDetect,
+  LintDomainDetection,
+  LintDomain,
+  LintDomainEngineContext,
+  LintDomainPlannedAction,
+  LintDomainPlugin,
+  LintDomainPluginResult,
+  LintDomainRun,
+  LintDomainSelectionSource,
+} from './types.js';
 
 function normalizeLogDetail(value: unknown): string {
   return String(value)
@@ -313,7 +256,9 @@ async function runLintDomains({
 }
 
 export type {
+  LintDomainDetect,
   LintDomainDecision,
+  LintDomainRun,
   LintDomainPlannedAction,
   LintDomainSelectionSource,
   LintDomainAvailabilityKind,

src/domains/index.ts src/domains.tssrc/domains/index.ts renamed to src/domains.ts

@@ -1,4 +1,4 @@
-import type { LintDomain, CLIOptions } from '../types.js';
+import type { LintDomain, CLIOptions } from './types.js';
 import {
   createLintDomainRegistry,
   listLintDomains,
@@ -10,11 +10,11 @@ import {
   type LintDomainDecision,
   type LintDomainEngineContext,
   type LintDomainSelectionSource,
-} from './engine.js';
-import { createESLintDomainPlugin } from './eslint.js';
-import { createShellDomainPlugin } from './shell.js';
-import { createMarkdownDomainPlugin } from './markdown.js';
-import { createNixDomainPlugin } from './nix.js';
+} from './domainEngine.js';
+import ESLintDomainPlugin from './eslint/ESLintDomainPlugin.js';
+import ShellDomainPlugin from './shell/ShellDomainPlugin.js';
+import MarkdownDomainPlugin from './markdown/MarkdownDomainPlugin.js';
+import NixDomainPlugin from './nix/NixDomainPlugin.js';
 
 const LINT_DOMAINS: LintDomain[] = ['eslint', 'shell', 'markdown', 'nix'];
 
@@ -116,16 +116,10 @@ function createBuiltInDomainRegistry({
   prettierConfigPath: string;
 }): Map<LintDomain, LintDomainPlugin> {
   return createLintDomainRegistry([
-    createESLintDomainPlugin(),
-    createShellDomainPlugin({
-      defaultSearchRoots: DEFAULT_SHELLCHECK_SEARCH_ROOTS,
-    }),
-    createMarkdownDomainPlugin({
-      prettierConfigPath,
-    }),
-    createNixDomainPlugin({
-      defaultSearchPatterns: DEFAULT_NIXFMT_SEARCH_PATTERNS,
-    }),
+    new ESLintDomainPlugin(),
+    new ShellDomainPlugin(DEFAULT_SHELLCHECK_SEARCH_ROOTS),
+    new MarkdownDomainPlugin(prettierConfigPath),
+    new NixDomainPlugin(DEFAULT_NIXFMT_SEARCH_PATTERNS),
   ]);
 }