Update ESLint config from v9 to v10 (#48)

Gudahtt · web-flow · commit 72d56101bca5 · 2022-11-08T11:48:01.000-03:30
The ESLint configuration has been updated from v9 to v10, and all
related packages has been updated. This resolves the console warning
that had been printed upon each run of `yarn lint` about how the
current TypeScript version is unsupported.

All lint changes were made with `yarn lint:fix` except one, which is
where we're using `interface` over `type` to allow for declaration
merging in `setupAfterEnv.ts`.
diff --git a/package.json b/package.json
@@ -37,33 +37,33 @@
   "devDependencies": {
     "@lavamoat/allow-scripts": "^2.0.3",
     "@metamask/auto-changelog": "^2.3.0",
-    "@metamask/eslint-config": "^9.0.0",
-    "@metamask/eslint-config-jest": "^9.0.0",
-    "@metamask/eslint-config-nodejs": "^9.0.0",
-    "@metamask/eslint-config-typescript": "^9.0.1",
+    "@metamask/eslint-config": "^10.0.0",
+    "@metamask/eslint-config-jest": "^10.0.0",
+    "@metamask/eslint-config-nodejs": "^10.0.0",
+    "@metamask/eslint-config-typescript": "^10.0.0",
     "@types/debug": "^4.1.7",
     "@types/jest": "^29.2.2",
     "@types/jest-when": "^3.5.2",
     "@types/node": "^17.0.23",
     "@types/rimraf": "^3.0.2",
     "@types/which": "^2.0.1",
     "@types/yargs": "^17.0.10",
-    "@typescript-eslint/eslint-plugin": "^4.21.0",
-    "@typescript-eslint/parser": "^4.21.0",
+    "@typescript-eslint/eslint-plugin": "^5.42.1",
+    "@typescript-eslint/parser": "^5.42.1",
     "deepmerge": "^4.2.2",
-    "eslint": "^7.23.0",
-    "eslint-config-prettier": "^8.1.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-jest": "^24.3.4",
-    "eslint-plugin-jsdoc": "^36.1.0",
+    "eslint": "^8.27.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jest": "^26.9.0",
+    "eslint-plugin-jsdoc": "^39.6.2",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.3.1",
+    "eslint-plugin-prettier": "^4.2.1",
     "jest": "^29.3.0",
     "jest-it-up": "^2.0.2",
     "jest-when": "^3.5.2",
     "nanoid": "^3.3.4",
     "prettier": "^2.2.1",
-    "prettier-plugin-packagejson": "^2.2.17",
+    "prettier-plugin-packagejson": "^2.3.0",
     "rimraf": "^3.0.2",
     "stdio-mock": "^1.2.0",
     "ts-jest": "^29.0.3",
diff --git a/src/command-line-arguments.ts b/src/command-line-arguments.ts
@@ -1,12 +1,12 @@
 import yargs from 'yargs/yargs';
 import { hideBin } from 'yargs/helpers';
 
-export interface CommandLineArguments {
+export type CommandLineArguments = {
   projectDirectory: string;
   tempDirectory: string | undefined;
   reset: boolean;
   backport: boolean;
-}
+};
 
 /**
  * Parses the arguments provided on the command line using `yargs`.
diff --git a/src/editor.ts b/src/editor.ts
@@ -8,10 +8,10 @@ import { debug, resolveExecutable } from './misc-utils';
  * @property args - Command-line arguments to pass to the executable when
  * calling it.
  */
-export interface Editor {
+export type Editor = {
   path: string;
   args: string[];
-}
+};
 
 /**
  * Looks for an executable that represents a code editor on your computer. Tries
diff --git a/src/env.ts b/src/env.ts
@@ -1,6 +1,6 @@
-interface Env {
+type Env = {
   EDITOR: string | undefined;
-}
+};
 
 /**
  * Returns all of the environment variables that this tool uses.
diff --git a/src/fs.test.ts b/src/fs.test.ts
@@ -27,7 +27,7 @@ describe('fs', () => {
 
         await fs.promises.writeFile(filePath, 'some content 😄');
 
-        expect(await readFile(filePath)).toStrictEqual('some content 😄');
+        expect(await readFile(filePath)).toBe('some content 😄');
       });
     });
 
@@ -54,7 +54,7 @@ describe('fs', () => {
 
         await writeFile(filePath, 'some content 😄');
 
-        expect(await fs.promises.readFile(filePath, 'utf8')).toStrictEqual(
+        expect(await fs.promises.readFile(filePath, 'utf8')).toBe(
           'some content 😄',
         );
       });
diff --git a/src/functional.test.ts b/src/functional.test.ts
@@ -377,7 +377,7 @@ describe('create-release-branch (functional)', () => {
               '--max-count=1',
             ])
           ).stdout;
-          expect(latestCommitSubject).toStrictEqual('Release 2.0.0');
+          expect(latestCommitSubject).toBe('Release 2.0.0');
           expect(latestCommitRevs).toContain('HEAD');
           expect(latestCommitRevs).toContain('release/2.0.0');
           expect(latestBranchCommitId).toStrictEqual(latestCommitId);
diff --git a/src/initial-parameters.test.ts b/src/initial-parameters.test.ts
@@ -112,9 +112,7 @@ describe('initial-parameters', () => {
         stderr,
       });
 
-      expect(initialParameters.tempDirectoryPath).toStrictEqual(
-        '/path/to/cwd/tmp',
-      );
+      expect(initialParameters.tempDirectoryPath).toBe('/path/to/cwd/tmp');
     });
 
     it('uses a default temporary directory based on the name of the package if no temporary directory was given', async () => {
diff --git a/src/initial-parameters.ts b/src/initial-parameters.ts
@@ -15,12 +15,12 @@ import { readProject, Project } from './project';
  */
 export type ReleaseType = 'ordinary' | 'backport';
 
-interface InitialParameters {
+type InitialParameters = {
   project: Project;
   tempDirectoryPath: string;
   reset: boolean;
   releaseType: ReleaseType;
-}
+};
 
 /**
  * Reads the inputs given to this tool via `process.argv` and uses them to
diff --git a/src/misc-utils.test.ts b/src/misc-utils.test.ts
@@ -86,7 +86,7 @@ describe('misc-utils', () => {
       const originalError = new Error('oops');
       const newError = wrapError('Some message', originalError);
 
-      expect(newError.message).toStrictEqual('Some message');
+      expect(newError.message).toBe('Some message');
       expect(newError.cause).toBe(originalError);
     });
 
@@ -95,7 +95,7 @@ describe('misc-utils', () => {
       originalError.code = 'CODE';
       const newError: any = wrapError('Some message', originalError);
 
-      expect(newError.code).toStrictEqual('CODE');
+      expect(newError.code).toBe('CODE');
     });
 
     it('returns a new Error which prefixes the given message', () => {
@@ -112,9 +112,7 @@ describe('misc-utils', () => {
         .spyOn(whichModule, 'default')
         .mockResolvedValue('/path/to/executable');
 
-      expect(await resolveExecutable('executable')).toStrictEqual(
-        '/path/to/executable',
-      );
+      expect(await resolveExecutable('executable')).toBe('/path/to/executable');
     });
 
     it('returns null if the given executable cannot be found', async () => {
@@ -170,7 +168,7 @@ describe('misc-utils', () => {
       expect(execaSpy).toHaveBeenCalledWith('some command', ['arg1', 'arg2'], {
         all: true,
       });
-      expect(output).toStrictEqual('some output');
+      expect(output).toBe('some output');
     });
   });
 
diff --git a/src/package-manifest.ts b/src/package-manifest.ts
@@ -24,12 +24,12 @@ export type UnvalidatedPackageManifest = Readonly<Record<string, any>>;
  * @property bundledDependencies - The set of packages that are expected to be
  * bundled when publishing the package.
  */
-export interface ValidatedPackageManifest {
+export type ValidatedPackageManifest = {
   readonly [PackageManifestFieldNames.Name]: string;
   readonly [PackageManifestFieldNames.Version]: SemVer;
   readonly [PackageManifestFieldNames.Private]: boolean;
   readonly [PackageManifestFieldNames.Workspaces]: string[];
-}
+};
 
 /**
  * Constructs a validation error message for a field within the manifest.
diff --git a/src/package.test.ts b/src/package.test.ts
@@ -484,7 +484,7 @@ describe('package', () => {
           changelogPath,
           'utf8',
         );
-        expect(newChangelogContent).toStrictEqual('new changelog');
+        expect(newChangelogContent).toBe('new changelog');
       });
     });
 
@@ -567,7 +567,7 @@ describe('package', () => {
           changelogPath,
           'utf8',
         );
-        expect(newChangelogContent).toStrictEqual('existing changelog');
+        expect(newChangelogContent).toBe('existing changelog');
       });
     });
 
@@ -604,7 +604,7 @@ describe('package', () => {
           changelogPath,
           'utf8',
         );
-        expect(newChangelogContent).toStrictEqual('existing changelog');
+        expect(newChangelogContent).toBe('existing changelog');
       });
     });
   });
diff --git a/src/package.ts b/src/package.ts
@@ -27,14 +27,14 @@ const CHANGELOG_FILE_NAME = 'CHANGELOG.md';
  * @property changelogPath - The path to the changelog file (which may or may
  * not exist).
  */
-export interface Package {
+export type Package = {
   directoryPath: string;
   manifestPath: string;
   unvalidatedManifest: UnvalidatedPackageManifest;
   validatedManifest: ValidatedPackageManifest;
   changelogPath: string;
   hasChangesSinceLatestRelease: boolean;
-}
+};
 
 /**
  * Generates the possible Git tag name for the root package of a monorepo. The
diff --git a/src/project.ts b/src/project.ts
@@ -23,10 +23,10 @@ import { SemVer } from './semver';
  * same ordinary release, starting from 1; it will be 0 if there aren't any
  * backport releases for the ordinary release yet.
  */
-interface ReleaseVersion {
+type ReleaseVersion = {
   ordinaryNumber: number;
   backportNumber: number;
-}
+};
 
 /**
  * Represents the entire codebase on which this tool is operating.
@@ -39,14 +39,14 @@ interface ReleaseVersion {
  * @property workspacePackages - Information about packages that are referenced
  * via workspaces (assuming that the project is a monorepo).
  */
-export interface Project {
+export type Project = {
   directoryPath: string;
   repositoryUrl: string;
   rootPackage: Package;
   workspacePackages: Record<string, Package>;
   isMonorepo: boolean;
   releaseVersion: ReleaseVersion;
-}
+};
 
 /**
  * A promisified version of `glob`.
diff --git a/src/release-plan.ts b/src/release-plan.ts
@@ -23,10 +23,10 @@ import { ReleaseSpecification } from './release-specification';
  * itself; for a monorepo package it will consist of the root package and any
  * workspace packages that will be included in the release.
  */
-export interface ReleasePlan {
+export type ReleasePlan = {
   newVersion: string;
   packages: PackageReleasePlan[];
-}
+};
 
 /**
  * Instructions for how to update a package within a project in order to prepare
@@ -40,11 +40,11 @@ export interface ReleasePlan {
  * monorepo, this will be true only for workspace packages (the root package
  * doesn't have a changelog, since it is a virtual package).
  */
-export interface PackageReleasePlan {
+export type PackageReleasePlan = {
   package: Package;
   newVersion: string;
   shouldUpdateChangelog: boolean;
-}
+};
 
 /**
  * Uses the release specification to calculate the final versions of all of the
diff --git a/src/release-specification.ts b/src/release-specification.ts
@@ -35,10 +35,10 @@ type VersionSpecifier = IncrementableVersionParts | SemVer;
  * @property packages - A mapping of package names to version specifiers.
  * @property path - The path to the original release specification file.
  */
-export interface ReleaseSpecification {
+export type ReleaseSpecification = {
   packages: Record<string, VersionSpecifier>;
   path: string;
-}
+};
 
 const SKIP_PACKAGE_DIRECTIVE = null;
 const INTENTIONALLY_SKIP_PACKAGE_DIRECTIVE = 'intentionally-skip';
diff --git a/src/repo.test.ts b/src/repo.test.ts
@@ -19,9 +19,9 @@ describe('repo', () => {
         })
         .mockResolvedValue('https://github.com/foo');
 
-      expect(
-        await getRepositoryHttpsUrl(repositoryDirectoryPath),
-      ).toStrictEqual('https://github.com/foo');
+      expect(await getRepositoryHttpsUrl(repositoryDirectoryPath)).toBe(
+        'https://github.com/foo',
+      );
     });
 
     it('converts an SSH GitHub repo URL into an HTTPS URL', async () => {
@@ -32,9 +32,9 @@ describe('repo', () => {
         })
         .mockResolvedValue('git@github.com:Foo/Bar.git');
 
-      expect(
-        await getRepositoryHttpsUrl(repositoryDirectoryPath),
-      ).toStrictEqual('https://github.com/Foo/Bar');
+      expect(await getRepositoryHttpsUrl(repositoryDirectoryPath)).toBe(
+        'https://github.com/Foo/Bar',
+      );
     });
 
     it('throws if the URL of the "origin" remote is in an invalid format', async () => {
diff --git a/tests/functional/helpers/environment.ts b/tests/functional/helpers/environment.ts
@@ -12,11 +12,11 @@ import Repo from './repo';
  * @property directory - The path relative to the repo's root directory that
  * holds this package.
  */
-export interface PackageSpecification {
+export type PackageSpecification = {
   name: string;
   version?: string;
   directoryPath: string;
-}
+};
 
 /**
  * A set of configuration options for an {@link Environment}.
@@ -28,10 +28,10 @@ export interface PackageSpecification {
  * this option to disable that if you need to create your own commits for
  * clarity.
  */
-export interface EnvironmentOptions {
+export type EnvironmentOptions = {
   directoryPath: string;
   createInitialCommit?: boolean;
-}
+};
 
 /**
  * This class sets up each test and acts as a facade to all of the actions that
diff --git a/tests/functional/helpers/local-monorepo.ts b/tests/functional/helpers/local-monorepo.ts
@@ -11,11 +11,10 @@ import { knownKeysOf } from './utils';
  * root).
  * @property workspaces - The known workspaces within this repo.
  */
-export interface LocalMonorepoOptions<WorkspacePackageNickname extends string>
-  extends LocalRepoOptions {
+export type LocalMonorepoOptions<WorkspacePackageNickname extends string> = {
   packages: Record<WorkspacePackageNickname, PackageSpecification>;
   workspaces: Record<string, string[]>;
-}
+} & LocalRepoOptions;
 
 /**
  * Represents the repo that the tool is run against, containing logic specific
diff --git a/tests/functional/helpers/local-repo.ts b/tests/functional/helpers/local-repo.ts
@@ -13,10 +13,10 @@ import { buildChangelog } from './utils';
  * use this option to disable that if you need to create your own commits for
  * clarity.
  */
-export interface LocalRepoOptions extends RepoOptions {
+export type LocalRepoOptions = {
   remoteRepoDirectoryPath: string;
   createInitialCommit: boolean;
-}
+} & RepoOptions;
 
 /**
  * A facade for the "local" repo, which is the repo with which the tool
diff --git a/tests/functional/helpers/monorepo-environment.ts b/tests/functional/helpers/monorepo-environment.ts
diff --git a/tests/functional/helpers/repo.ts b/tests/functional/helpers/repo.ts
diff --git a/tests/helpers.ts b/tests/helpers.ts
diff --git a/tests/setupAfterEnv.ts b/tests/setupAfterEnv.ts
diff --git a/yarn.lock b/yarn.lock
