chore(deps-dev): upgrading our eslint standards (#1174)

The owner of `eslint-plugin-vitest` lost their NPM access to it was
moved into `@vitest/eslint-plugin` a little over a year ago. This
upgrades our `@readme/eslint-config` package to pull that in.

Author: erunion

__tests__/.eslintrc

@@ -3,6 +3,8 @@
   "rules": {
     // vitest currently allows for __dirname, require, etc.
     // see https://github.com/vitest-dev/vitest/issues/2841
-    "unicorn/prefer-module": "off"
+    "unicorn/prefer-module": "off",
+
+    "@vitest/require-mock-type-parameters": "off",
   }
 }

__tests__/bin.test.ts

@@ -9,6 +9,7 @@ describe('bin', () => {
     await new Promise(resolve => {
       exec(`node ${__dirname}/../bin/run.js`, (error, stdout) => {
         expect(stdout).toContain("ReadMe's official CLI and GitHub Action");
+
         resolve(true);
       });
     });

__tests__/commands/login.test.ts

@@ -102,6 +102,7 @@ describe('rdme login', () => {
     const mock = getAPIv1Mock().post('/api/v1/login', { email, password, project }).reply(401, errorResponse);
 
     await expect(run()).rejects.toStrictEqual(new APIv1Error(errorResponse));
+
     mock.done();
   });
 
@@ -144,6 +145,7 @@ describe('rdme login', () => {
       .reply(404, errorResponse);
 
     await expect(run()).rejects.toStrictEqual(new APIv1Error(errorResponse));
+
     mock.done();
   });
 });

__tests__/commands/openapi/inspect.test.ts

@@ -1,4 +1,4 @@
-/* eslint-disable vitest/no-conditional-expect */
+/* eslint-disable @vitest/no-conditional-expect */
 import assert from 'node:assert';
 
 import { describe, it, expect, beforeAll } from 'vitest';
@@ -69,6 +69,7 @@ describe('rdme openapi inspect', () => {
       const args = [require.resolve(spec)].concat(...feature.map(f => ['--feature', f]));
       if (!shouldSoftError) {
         await expect(run(args)).resolves.toMatchSnapshot();
+
         return;
       }
 

__tests__/commands/openapi/reduce.test.ts

@@ -76,6 +76,7 @@ describe('rdme openapi reduce', () => {
         expect(console.info).toHaveBeenCalledTimes(1);
 
         const output = getCommandOutput();
+
         expect(output).toBe(chalk.yellow(`ℹ️  We found ${spec} and are attempting to reduce it.`));
 
         expect(Object.keys(reducedSpec.paths)).toStrictEqual(['/user']);
@@ -98,6 +99,7 @@ describe('rdme openapi reduce', () => {
         expect(console.info).toHaveBeenCalledTimes(1);
 
         const output = getCommandOutput();
+
         expect(output).toBe(chalk.yellow(`ℹ️  We found ${spec} and are attempting to reduce it.`));
 
         expect(Object.keys(reducedSpec.paths)).toStrictEqual(['/user']);
@@ -147,6 +149,7 @@ describe('rdme openapi reduce', () => {
         expect(console.info).toHaveBeenCalledTimes(1);
 
         const output = getCommandOutput();
+
         expect(output).toBe(chalk.yellow(`ℹ️  We found ${spec} and are attempting to reduce it.`));
 
         expect(fsWriteFileSyncSpy).toHaveBeenCalledWith('output.json', expect.any(String));
@@ -181,6 +184,7 @@ describe('rdme openapi reduce', () => {
         expect(console.info).toHaveBeenCalledTimes(1);
 
         const output = getCommandOutput();
+
         expect(output).toBe(chalk.yellow(`ℹ️  We found ${spec} and are attempting to reduce it.`));
 
         expect(fsWriteFileSyncSpy).toHaveBeenCalledWith('output.json', expect.any(String));

__tests__/commands/openapi/validate.test.ts

@@ -44,6 +44,7 @@ describe('rdme openapi validate', () => {
     ['OpenAPI 3.1', 'yaml', '3.1'],
   ])('should support validating a %s definition (format: %s)', (_, format, specVersion) => {
     expect(console.info).toHaveBeenCalledTimes(0);
+
     return expect(
       run([require.resolve(`@readme/oas-examples/${specVersion}/${format}/petstore.${format}`)]),
     ).resolves.toContain(
@@ -59,6 +60,7 @@ describe('rdme openapi validate', () => {
     expect(console.info).toHaveBeenCalledTimes(1);
 
     const output = getCommandOutput();
+
     expect(output).toBe(chalk.yellow('ℹ️  We found petstore.json and are attempting to validate it.'));
   });
 
@@ -115,6 +117,7 @@ describe('rdme openapi validate', () => {
     it('should successfully validate prompt and not run GHA onboarding', async () => {
       vi.stubEnv('TEST_RDME_CREATEGHA', 'true');
       const spec = '__tests__/__fixtures__/petstore-simple-weird-version.json';
+
       await expect(run([spec])).resolves.toBe(chalk.green(`${spec} is a valid OpenAPI API definition!`));
     });
 
@@ -146,6 +149,7 @@ describe('rdme openapi validate', () => {
 
     it('should create GHA workflow if user passes in spec via prompts', async () => {
       expect.assertions(6);
+
       const spec = '__tests__/__fixtures__/petstore-simple-weird-version.json';
       const fileName = 'validate-test-file';
       prompts.inject([spec, true, 'validate-test-branch', fileName]);
@@ -155,13 +159,16 @@ describe('rdme openapi validate', () => {
       expect(yamlOutput).toMatchSnapshot();
       expect(fs.writeFileSync).toHaveBeenCalledWith(`.github/workflows/${fileName}.yml`, expect.any(String));
       expect(console.info).toHaveBeenCalledTimes(2);
+
       const output = getCommandOutput();
+
       expect(output).toMatch("Looks like you're running this command in a GitHub Repository!");
       expect(output).toMatch('is a valid OpenAPI API definition!');
     });
 
     it('should create GHA workflow if user passes in spec via opt', async () => {
       expect.assertions(3);
+
       const spec = '__tests__/__fixtures__/petstore-simple-weird-version.json';
       const fileName = 'validate-test-opt-spec-file';
       prompts.inject([true, 'validate-test-opt-spec-branch', fileName]);
@@ -174,6 +181,7 @@ describe('rdme openapi validate', () => {
 
     it('should create GHA workflow if user passes in spec via opt (including workingDirectory)', async () => {
       expect.assertions(3);
+
       const spec = 'petstore.json';
       const fileName = 'validate-test-opt-spec-workdir-file';
       prompts.inject([true, 'validate-test-opt-spec-github-branch', fileName]);
@@ -188,6 +196,7 @@ describe('rdme openapi validate', () => {
 
     it('should create GHA workflow if user passes in spec via opt (github flag enabled)', async () => {
       expect.assertions(3);
+
       const spec = '__tests__/__fixtures__/petstore-simple-weird-version.json';
       const fileName = 'validate-test-opt-spec-github-file';
       prompts.inject(['validate-test-opt-spec-github-branch', fileName]);

__tests__/lib/createGHA.test.ts

@@ -1,4 +1,4 @@
-/* eslint-disable vitest/no-disabled-tests */
+/* eslint-disable @vitest/no-disabled-tests */
 /* eslint-disable no-console */
 import type { Command, Config } from '@oclif/core';
 import type { Response } from 'simple-git';
@@ -89,22 +89,27 @@ describe('#createGHA', () => {
 
       it('should run GHA creation workflow and generate valid workflow file', async () => {
         expect.assertions(6);
+
         const fileName = `rdme-${cmd}`;
         prompts.inject([true, 'some-branch', fileName]);
 
         const res = await oclifConfig.runHook('createGHA', { command: CurrentCommand, parsedOpts: opts, result: '' });
+
         expect(res.successes[0].result).toMatchSnapshot();
 
         expect(yamlOutput).toBeValidSchema(ghaWorkflowSchema);
         expect(yamlOutput).toMatchSnapshot();
         expect(fs.writeFileSync).toHaveBeenCalledWith(getGHAFileName(fileName), expect.any(String));
         expect(console.info).toHaveBeenCalledTimes(1);
+
         const output = getCommandOutput();
+
         expect(output).toMatch("Looks like you're running this command in a GitHub Repository!");
       });
 
       it('should run GHA creation workflow with `--github` flag and messy file name and generate valid workflow file', async () => {
         expect.assertions(4);
+
         const fileName = `rdme-${cmd} with GitHub flag`;
         prompts.inject(['another-branch', fileName]);
 
@@ -113,6 +118,7 @@ describe('#createGHA', () => {
           parsedOpts: { ...opts, github: true },
           result: '',
         });
+
         expect(res.successes[0].result).toMatchSnapshot();
 
         expect(yamlOutput).toBeValidSchema(ghaWorkflowSchema);
@@ -123,6 +129,7 @@ describe('#createGHA', () => {
       // skipping because these mocks aren't playing nicely with oclif
       it.skip('should create workflow directory if it does not exist', async () => {
         expect.assertions(3);
+
         const repoRoot = '__tests__/__fixtures__';
 
         git.revparse = vi.fn(() => {
@@ -137,7 +144,8 @@ describe('#createGHA', () => {
         });
 
         const res = await oclifConfig.runHook('createGHA', { command: CurrentCommand, parsedOpts: opts, result: '' });
-        expect(res.successes[0].result).toBeTruthy();
+
+        expect(res.successes[0].result).toBe(true);
 
         expect(fs.mkdirSync).toHaveBeenCalledWith('.github/workflows', { recursive: true });
         expect(fs.writeFileSync).toHaveBeenCalledWith(getGHAFileName(fileName), expect.any(String));
@@ -157,6 +165,7 @@ describe('#createGHA', () => {
 
       it('should set config and exit if user does not want to set up GHA', async () => {
         expect.assertions(2);
+
         prompts.inject([false]);
 
         const repoRoot = process.cwd();
@@ -166,6 +175,7 @@ describe('#createGHA', () => {
         });
 
         const res = await oclifConfig.runHook('createGHA', { command: CurrentCommand, parsedOpts: opts, result: '' });
+
         expect(res.failures[0].error).toStrictEqual(
           new Error(
             'GitHub Actions workflow creation cancelled. If you ever change your mind, you can run this command again with the `--github` flag.',
@@ -239,9 +249,11 @@ describe('#createGHA', () => {
           parsedOpts: opts,
           result: 'success!',
         });
+
         expect(res.successes[0].result).toBe('success!');
         // asserts that git commands aren't run in CI
         expect(git.checkIsRepo).not.toHaveBeenCalled();
+
         delete process.env.TEST_RDME_CI;
       });
 
@@ -252,9 +264,11 @@ describe('#createGHA', () => {
           parsedOpts: opts,
           result: 'success!',
         });
+
         expect(res.successes[0].result).toBe('success!');
         // asserts that git commands aren't run in CI
         expect(git.checkIsRepo).not.toHaveBeenCalled();
+
         delete process.env.TEST_RDME_NPM_SCRIPT;
       });
 

__tests__/lib/fetch.test.ts

@@ -35,6 +35,7 @@ describe('#readmeAPIv1Fetch()', () => {
       expect(headers['x-github-run-number']).toBe('3');
       expect(headers['x-github-sha']).toBe('ffac537e6cbbf934b08745a378932722df287a53');
       expect(headers['x-rdme-ci']).toBe('GitHub Actions (test)');
+
       mock.done();
     });
 
@@ -61,6 +62,7 @@ describe('#readmeAPIv1Fetch()', () => {
         expect(headers['x-readme-source-url']).toBe(
           'https://github.com/octocat/Hello-World/blob/ffac537e6cbbf934b08745a378932722df287a53/openapi.json',
         );
+
         mock.done();
       });
 
@@ -86,6 +88,7 @@ describe('#readmeAPIv1Fetch()', () => {
         expect(headers['x-readme-source-url']).toBe(
           'https://github.com/octocat/Hello-World/blob/ffac537e6cbbf934b08745a378932722df287a53/%F0%9F%93%88%20Dashboard%20&%20Metrics/openapi.json',
         );
+
         mock.done();
       });
 
@@ -110,6 +113,7 @@ describe('#readmeAPIv1Fetch()', () => {
         ).then(handleAPIv1Res);
 
         expect(headers['x-readme-source-url']).toBeUndefined();
+
         mock.done();
       });
 
@@ -135,6 +139,7 @@ describe('#readmeAPIv1Fetch()', () => {
         expect(headers['x-readme-source-url']).toBe(
           'https://github.com/octocat/Hello-World/blob/ffac537e6cbbf934b08745a378932722df287a53/openapi.json',
         );
+
         mock.done();
       });
 
@@ -159,6 +164,7 @@ describe('#readmeAPIv1Fetch()', () => {
         ).then(handleAPIv1Res);
 
         expect(headers['x-readme-source-url']).toBe(filePath);
+
         mock.done();
       });
     });
@@ -186,6 +192,7 @@ describe('#readmeAPIv1Fetch()', () => {
     expect(headers['x-github-run-id']).toBeUndefined();
     expect(headers['x-github-run-number']).toBeUndefined();
     expect(headers['x-github-sha']).toBeUndefined();
+
     mock.done();
   });
 
@@ -205,6 +212,7 @@ describe('#readmeAPIv1Fetch()', () => {
     expect(headers['x-github-run-id']).toBeUndefined();
     expect(headers['x-github-run-number']).toBeUndefined();
     expect(headers['x-github-sha']).toBeUndefined();
+
     mock.done();
   });
 
@@ -297,7 +305,7 @@ describe('#readmeAPIv1Fetch()', () => {
 
       await readmeAPIv1Fetch('/api/v1/proxy');
 
-      mock.done();
+      expect(mock.isDone()).toBe(true);
     });
 
     it('should support proxies via https_proxy env variable', async () => {
@@ -309,7 +317,7 @@ describe('#readmeAPIv1Fetch()', () => {
 
       await readmeAPIv1Fetch('/api/v1/proxy');
 
-      mock.done();
+      expect(mock.isDone()).toBe(true);
     });
 
     it('should handle trailing slash in proxy URL', async () => {
@@ -321,7 +329,7 @@ describe('#readmeAPIv1Fetch()', () => {
 
       await readmeAPIv1Fetch('/api/v1/proxy');
 
-      mock.done();
+      expect(mock.isDone()).toBe(true);
     });
   });
 });

__tests__/lib/getPkgVersion.test.ts

@@ -9,6 +9,7 @@ describe('#getNodeVersion()', () => {
   it('should extract version that matches range in package.json', () => {
     const version = getNodeVersion();
     const cleanedVersion = semver.valid(semver.coerce(version));
+
     expect(semver.satisfies(cleanedVersion as string, pkg.engines.node)).toBe(true);
   });
 });

__tests__/lib/validatePromptInput.test.ts

@@ -15,6 +15,7 @@ describe('#validateFilePath', () => {
 
   it('should return error if path already exists', () => {
     expect.assertions(2);
+
     const testPath = 'path-that-already-exists';
 
     fs.existsSync = vi.fn(() => true);
@@ -25,6 +26,7 @@ describe('#validateFilePath', () => {
 
   it("should return true if the path doesn't exist", () => {
     expect.assertions(2);
+
     const testPath = 'path-that-does-not-exist';
 
     fs.existsSync = vi.fn(() => false);