refactor(betterer 🔧): add .js extensions to imports

.eslintrc.js

@@ -4,35 +4,41 @@ const BASE_EXTENDS = [
   'eslint:recommended',
   'plugin:@typescript-eslint/recommended',
   'plugin:@typescript-eslint/recommended-requiring-type-checking',
-  'plugin:prettier/recommended'
+  'plugin:prettier/recommended',
+  'plugin:import/recommended',
+  'plugin:import/typescript',
+  'plugin:eslint-comments/recommended',
+  'plugin:require-extensions/recommended'
 ];
 
 const BASE_RULES = {
-  'eol-last': [2, 'always'],
-  '@typescript-eslint/return-await': [2, 'always']
+  'eol-last': ['error', 'always'],
+  '@typescript-eslint/return-await': ['error', 'always'],
+  '@typescript-eslint/no-use-before-define': ['error', { functions: false }],
+  '@typescript-eslint/member-ordering': 'error',
+  '@typescript-eslint/consistent-type-imports': ['error', { prefer: 'type-imports', disallowTypeAnnotations: false }],
+  'eslint-comments/require-description': ['error', { ignore: ['eslint-enable'] }],
+  'import/no-unresolved': 'off'
 };
 
 const OVERRIDE_RULES = {
   ...BASE_RULES,
-  'no-console': 2,
-  '@typescript-eslint/unbound-method': 0,
-  '@typescript-eslint/no-use-before-define': [2, { functions: false }],
-  '@typescript-eslint/member-ordering': 2,
-  '@typescript-eslint/consistent-type-imports': [2, { prefer: 'type-imports', disallowTypeAnnotations: false }]
+  'no-console': 'error',
+  '@typescript-eslint/unbound-method': 'off'
 };
 
 module.exports = {
   env: {
-    es6: true,
+    es2021: true,
     node: true
   },
   parser: '@typescript-eslint/parser',
   parserOptions: {
-    ecmaVersion: 2020,
+    ecmaVersion: 2021,
     project: path.resolve(__dirname, './tsconfig.eslint.json'),
     sourceType: 'module'
   },
-  plugins: ['@typescript-eslint'],
+  plugins: ['@typescript-eslint', 'require-extensions'],
   rules: {
     ...BASE_RULES
   },
@@ -57,5 +63,10 @@ module.exports = {
         browser: true
       }
     }
-  ]
+  ],
+  settings: {
+    'import/resolver': {
+      typescript: true
+    }
+  }
 };

.vscode/settings.json

@@ -14,6 +14,7 @@
     "GOLDENS",
     "hasher",
     "initialise",
+    "initialised",
     "Initialising",
     "Lifecycles",
     "loglevel",

package.json

@@ -68,6 +68,10 @@
     "dependency-check": "^4.1.0",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.1.0",
+    "eslint-import-resolver-typescript": "^3.5.5",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-require-extensions": "^0.1.3",
+    "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jest": "^24.4.0",
     "eslint-plugin-prettier": "^4.0.0",
     "husky": "^7.0.4",

packages/angular/src/index.ts

@@ -4,4 +4,4 @@
  * @packageDocumentation
  */
 
-export { angular } from './angular';
+export { angular } from './angular.js';

packages/betterer/src/betterer.ts

@@ -6,13 +6,13 @@ import type {
   BettererOptionsResults,
   BettererOptionsWatch,
   BettererOptionsMerge
-} from './config';
-import type { BettererRunner } from './runner';
-import type { BettererResultsSummary } from './results';
-import type { BettererSuiteSummary } from './suite';
+} from './config/index.js';
+import type { BettererRunner } from './runner/index.js';
+import type { BettererResultsSummary } from './results/index.js';
+import type { BettererSuiteSummary } from './suite/index.js';
 
-import { BettererRunnerΩ } from './runner';
-import { BettererMergerΩ, BettererResultsSummaryΩ } from './results';
+import { BettererRunnerΩ } from './runner/index.js';
+import { BettererMergerΩ, BettererResultsSummaryΩ } from './results/index.js';
 
 /**
  * @public Run **Betterer** with the given options.

packages/betterer/src/config/config.ts

@@ -1,5 +1,5 @@
-import type { BettererVersionControlWorker } from '../fs';
-import type { BettererReporter } from '../reporters';
+import type { BettererVersionControlWorker } from '../fs/index.js';
+import type { BettererReporter } from '../reporters/index.js';
 import type {
   BettererConfig,
   BettererConfigBase,
@@ -12,17 +12,17 @@ import type {
   BettererOptionsStart,
   BettererOptionsWatch,
   BettererWorkerRunConfig
-} from './types';
+} from './types.js';
 
 import { BettererError } from '@betterer/errors';
-import assert from 'assert';
-import * as os from 'os';
-import * as path from 'path';
-
-import { read } from '../fs';
-import { registerExtensions } from './register';
-import { loadReporters, loadSilentReporter } from '../reporters';
-import { isBoolean, isNumber, isRegExp, isString, isUndefined } from '../utils';
+import assert from 'node:assert';
+import os from 'node:os';
+import path from 'node:path';
+
+import { read } from '../fs/index.js';
+import { registerExtensions } from './register.js';
+import { loadReporters, loadSilentReporter } from '../reporters/index.js';
+import { isBoolean, isNumber, isRegExp, isString, isUndefined } from '../utils.js';
 
 const TOTAL_CPUS = os.cpus().length;
 

packages/betterer/src/config/index.ts

@@ -1,4 +1,4 @@
-export { createConfig, createMergeConfig, createWorkerConfig, overrideConfig } from './config';
+export { createConfig, createMergeConfig, createWorkerConfig, overrideConfig } from './config.js';
 export {
   BettererConfig,
   BettererConfigBase,
@@ -30,4 +30,4 @@ export {
   BettererOptionsStart,
   BettererOptionsWatch,
   BettererWorkerRunConfig
-} from './types';
+} from './types.js';

packages/betterer/src/config/public.ts

@@ -27,4 +27,4 @@ export {
   BettererOptionsStartUpdate,
   BettererOptionsStart,
   BettererOptionsWatch
-} from './types';
+} from './types.js';

packages/betterer/src/config/types.ts

@@ -1,4 +1,4 @@
-import type { BettererReporter } from '../reporters';
+import type { BettererReporter } from '../reporters/index.js';
 
 /**
  * @public An array of {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions | Regular Expressions }

packages/betterer/src/context/context-summary.ts

@@ -1,6 +1,6 @@
-import type { BettererConfig } from '../config';
-import type { BettererSuiteSummariesΩ, BettererSuiteSummaryΩ } from '../suite';
-import type { BettererContextSummary } from './types';
+import type { BettererConfig } from '../config/index.js';
+import type { BettererSuiteSummariesΩ, BettererSuiteSummaryΩ } from '../suite/index.js';
+import type { BettererContextSummary } from './types.js';
 
 export class BettererContextSummaryΩ implements BettererContextSummary {
   constructor(public readonly config: BettererConfig, public readonly suites: BettererSuiteSummariesΩ) {}

packages/betterer/src/context/context.ts

@@ -1,21 +1,21 @@
 import type { BettererError } from '@betterer/errors';
 import type { FSWatcher } from 'chokidar';
 
-import type { BettererConfig, BettererOptionsOverride } from '../config';
-import type { BettererFilePaths, BettererVersionControlWorker } from '../fs';
-import type { BettererReporterΩ } from '../reporters';
-import type { BettererResultsFileΩ } from '../results';
-import type { BettererSuiteSummariesΩ, BettererSuiteSummary } from '../suite';
-import type { BettererGlobals } from '../types';
-import type { BettererContext, BettererContextStarted, BettererContextSummary } from './types';
-
-import { overrideConfig } from '../config';
-import { BettererFileResolverΩ } from '../fs';
-import { BettererRunWorkerPoolΩ, BettererRunΩ, createWorkerRunConfig } from '../run';
-import { BettererSuiteΩ } from '../suite';
-import { loadTestMeta } from '../test';
-import { defer } from '../utils';
-import { BettererContextSummaryΩ } from './context-summary';
+import type { BettererConfig, BettererOptionsOverride } from '../config/index.js';
+import type { BettererFilePaths, BettererVersionControlWorker } from '../fs/index.js';
+import type { BettererReporterΩ } from '../reporters/index.js';
+import type { BettererResultsFileΩ } from '../results/index.js';
+import type { BettererSuiteSummariesΩ, BettererSuiteSummary } from '../suite/index.js';
+import type { BettererGlobals } from '../types.js';
+import type { BettererContext, BettererContextStarted, BettererContextSummary } from './types.js';
+
+import { overrideConfig } from '../config/index.js';
+import { BettererFileResolverΩ } from '../fs/index.js';
+import { BettererRunWorkerPoolΩ, BettererRunΩ, createWorkerRunConfig } from '../run/index.js';
+import { BettererSuiteΩ } from '../suite/index.js';
+import { loadTestMeta } from '../test/index.js';
+import { defer } from '../utils.js';
+import { BettererContextSummaryΩ } from './context-summary.js';
 
 export class BettererContextΩ implements BettererContext {
   public readonly config: BettererConfig;
@@ -51,7 +51,7 @@ export class BettererContextΩ implements BettererContext {
     // Start everything again, and trigger a new reporter:
     this._started = this._start();
 
-    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises -- SIGTERM doesn't care about Promises
     process.on('SIGTERM', () => this.stop());
   }
 

packages/betterer/src/context/index.ts

@@ -1,2 +1,2 @@
-export { BettererContextΩ } from './context';
-export { BettererContext, BettererContextSummary } from './types';
+export { BettererContextΩ } from './context.js';
+export { BettererContext, BettererContextSummary } from './types.js';

packages/betterer/src/context/public.ts

@@ -1 +1 @@
-export { BettererContext, BettererContextSummary } from './types';
+export { BettererContext, BettererContextSummary } from './types.js';

packages/betterer/src/context/types.ts

@@ -1,7 +1,7 @@
 import type { BettererError } from '@betterer/errors';
 
-import type { BettererConfig, BettererOptionsOverride } from '../config';
-import type { BettererSuiteSummaries, BettererSuiteSummary } from '../suite';
+import type { BettererConfig, BettererOptionsOverride } from '../config/index.js';
+import type { BettererSuiteSummaries, BettererSuiteSummary } from '../suite/index.js';
 
 /**
  * @public The context of a set of test suite runs.

packages/betterer/src/fs/file-cache.ts

@@ -4,13 +4,13 @@ import type {
   BettererFileCache,
   BettererFileHashMap,
   BettererCacheFile
-} from './types';
+} from './types.js';
 
-import assert from 'assert';
-import path from 'path';
-import { normalisedPath } from '../utils';
-import { read } from './reader';
-import { write } from './writer';
+import assert from 'node:assert';
+import path from 'node:path';
+import { normalisedPath } from '../utils.js';
+import { read } from './reader.js';
+import { write } from './writer.js';
 
 const BETTERER_CACHE_VERSION = 2;
 

packages/betterer/src/fs/file-resolver.ts

@@ -4,13 +4,13 @@ import type {
   BettererFilePatterns,
   BettererFileResolver,
   BettererVersionControlWorker
-} from './types';
+} from './types.js';
 
-import assert from 'assert';
+import assert from 'node:assert';
 import minimatch from 'minimatch';
-import * as path from 'path';
+import path from 'node:path';
 
-import { flatten, normalisedPath } from '../utils';
+import { flatten, normalisedPath } from '../utils.js';
 
 export class BettererFileResolverΩ implements BettererFileResolver {
   private _excluded: Array<RegExp> = [];

packages/betterer/src/fs/git.ts

@@ -1,17 +1,17 @@
 import type { SimpleGit } from 'simple-git';
 
-import type { BettererFilePaths, BettererVersionControl } from './types';
+import type { BettererFilePaths, BettererVersionControl } from './types.js';
 
 import { BettererError } from '@betterer/errors';
-import assert from 'assert';
-import { promises as fs } from 'fs';
-import path from 'path';
-import simpleGit from 'simple-git';
-
-import { createHash } from '../hasher';
-import { normalisedPath } from '../utils';
-import { BettererFileCacheΩ } from './file-cache';
-import { read } from './reader';
+import assert from 'node:assert';
+import { promises as fs } from 'node:fs';
+import path from 'node:path';
+import { simpleGit } from 'simple-git';
+
+import { createHash } from '../hasher.js';
+import { normalisedPath } from '../utils.js';
+import { BettererFileCacheΩ } from './file-cache.js';
+import { read } from './reader.js';
 
 export class BettererGitΩ implements BettererVersionControl {
   private _cache: BettererFileCacheΩ | null = null;

packages/betterer/src/fs/index.ts

@@ -1,11 +1,11 @@
-export { BettererFileResolverΩ } from './file-resolver';
-export { read } from './reader';
+export { BettererFileResolverΩ } from './file-resolver.js';
+export { read } from './reader.js';
 export {
   BettererFileGlobs,
   BettererFilePaths,
   BettererFilePatterns,
   BettererFileResolver,
   BettererVersionControlWorker
-} from './types';
-export { createVersionControl } from './version-control';
-export { forceRelativePaths, write } from './writer';
+} from './types.js';
+export { createVersionControl } from './version-control.js';
+export { forceRelativePaths, write } from './writer.js';

packages/betterer/src/fs/public.ts

@@ -4,4 +4,4 @@ export {
   BettererFilePaths,
   BettererFilePatterns,
   BettererFileResolver
-} from './types';
+} from './types.js';

packages/betterer/src/fs/reader.ts

@@ -1,6 +1,6 @@
-import { promises as fs } from 'fs';
+import { promises as fs } from 'node:fs';
 
-import { normaliseNewlines } from '../utils';
+import { normaliseNewlines } from '../utils.js';
 
 const READ_CACHE: Record<string, string> = {};
 const READ_CACHE_TIME: Record<string, number> = {};

packages/betterer/src/fs/version-control-worker.ts

@@ -1,3 +1,3 @@
-import { BettererGitΩ } from './git';
+import { BettererGitΩ } from './git.js';
 
 export const versionControl = new BettererGitΩ();

packages/betterer/src/fs/version-control.ts

@@ -1,4 +1,4 @@
-import type { BettererVersionControlWorker, BettererVersionControlWorkerModule } from './types';
+import type { BettererVersionControlWorker, BettererVersionControlWorkerModule } from './types.js';
 
 import { workerRequire } from '@phenomnomnominal/worker-require';
 

packages/betterer/src/fs/writer.ts

@@ -1,8 +1,8 @@
 import { BettererError } from '@betterer/errors';
-import path from 'path';
-import { promises as fs } from 'fs';
+import path from 'node:path';
+import { promises as fs } from 'node:fs';
 
-import { normalisedPath } from '../utils';
+import { normalisedPath } from '../utils.js';
 
 export function forceRelativePaths(toWrite: string, basePath: string): string {
   const directory = `${normalisedPath(path.dirname(basePath))}/`;

packages/betterer/src/globals.ts

@@ -1,10 +1,10 @@
 import type { BettererError } from '@betterer/errors';
-import type { BettererGlobals } from './types';
+import type { BettererGlobals } from './types.js';
 
-import { createConfig } from './config';
-import { createVersionControl } from './fs';
-import { loadDefaultReporter } from './reporters';
-import { BettererResultsFileΩ } from './results';
+import { createConfig } from './config/index.js';
+import { createVersionControl } from './fs/index.js';
+import { loadDefaultReporter } from './reporters/index.js';
+import { BettererResultsFileΩ } from './results/index.js';
 
 export async function createGlobals(options: unknown = {}): Promise<BettererGlobals> {
   const reporter = loadDefaultReporter();

packages/betterer/src/hasher.ts

@@ -1,7 +1,7 @@
 import djb2a from 'djb2a';
 import memoize from 'fast-memoize';
 
-import { normaliseNewlines } from './utils';
+import { normaliseNewlines } from './utils.js';
 
 export const createHash = memoize(function createHash(value: string): string {
   return djb2a(normaliseNewlines(value)).toString();