Merge branch 'next' into next

Author: kanadgupta

__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/docs/upload.test.ts

@@ -45,6 +45,7 @@ describe('rdme docs upload', () => {
         .reply(201, {});
 
       const result = await run(['__tests__/__fixtures__/docs/new-docs/new-doc.md', '--key', key]);
+
       expect(result).toMatchSnapshot();
       expect(fs.writeFileSync).not.toHaveBeenCalled();
 
@@ -64,6 +65,7 @@ describe('rdme docs upload', () => {
         .reply(201, {});
 
       const result = await run(['__tests__/__fixtures__/docs/new-docs/new-doc.md', '--key', key, '--version', '1.2.3']);
+
       expect(result).toMatchSnapshot();
       expect(fs.writeFileSync).not.toHaveBeenCalled();
 
@@ -75,6 +77,7 @@ describe('rdme docs upload', () => {
         const mock = getAPIv2Mock({ authorization }).head('/versions/stable/guides/new-doc').reply(404);
 
         const result = await run(['__tests__/__fixtures__/docs/new-docs/new-doc.md', '--key', key, '--dry-run']);
+
         expect(result).toMatchSnapshot();
         expect(fs.writeFileSync).not.toHaveBeenCalled();
 
@@ -85,6 +88,7 @@ describe('rdme docs upload', () => {
         const mock = getAPIv2Mock({ authorization }).head('/versions/stable/guides/some-slug').reply(200);
 
         const result = await run(['__tests__/__fixtures__/docs/slug-docs/new-doc-slug.md', '--key', key, '--dry-run']);
+
         expect(result).toMatchSnapshot();
         expect(fs.writeFileSync).not.toHaveBeenCalled();
 
@@ -95,6 +99,7 @@ describe('rdme docs upload', () => {
         const mock = getAPIv2Mock({ authorization }).head('/versions/stable/guides/some-slug').reply(500);
 
         const result = await run(['__tests__/__fixtures__/docs/slug-docs/new-doc-slug.md', '--key', key, '--dry-run']);
+
         expect(result).toMatchSnapshot();
         expect(fs.writeFileSync).not.toHaveBeenCalled();
 
@@ -116,6 +121,7 @@ describe('rdme docs upload', () => {
           .reply(201, {});
 
         const result = await run(['__tests__/__fixtures__/docs/slug-docs/new-doc-slug.md', '--key', key]);
+
         expect(result).toMatchSnapshot();
         expect(fs.writeFileSync).not.toHaveBeenCalled();
 
@@ -134,6 +140,7 @@ describe('rdme docs upload', () => {
           .reply(201, {});
 
         const result = await run(['__tests__/__fixtures__/docs/slug-docs/new-doc-slug.md', '--key', key]);
+
         expect(result).toMatchSnapshot();
         expect(fs.writeFileSync).not.toHaveBeenCalled();
 
@@ -157,6 +164,7 @@ describe('rdme docs upload', () => {
         prompts.inject([true]);
 
         const result = await run(['__tests__/__fixtures__/docs/mixed-docs/legacy-category.md', '--key', key]);
+
         expect(result).toMatchSnapshot();
         expect(fs.writeFileSync).toHaveBeenCalledWith(
           '__tests__/__fixtures__/docs/mixed-docs/legacy-category.md',
@@ -190,6 +198,7 @@ describe('rdme docs upload', () => {
         prompts.inject([true]);
 
         const result = await run(['__tests__/__fixtures__/docs/mixed-docs/legacy-category.md', '--key', key]);
+
         expect(result).toMatchSnapshot();
         expect(fs.writeFileSync).toHaveBeenCalledWith(
           '__tests__/__fixtures__/docs/mixed-docs/legacy-category.md',
@@ -205,6 +214,7 @@ describe('rdme docs upload', () => {
         prompts.inject([false]);
 
         const result = await run(['__tests__/__fixtures__/docs/mixed-docs/legacy-category.md', '--key', key]);
+
         expect(result).toMatchSnapshot();
         expect(fs.writeFileSync).not.toHaveBeenCalled();
       });
@@ -227,6 +237,7 @@ describe('rdme docs upload', () => {
           key,
           '--skip-validation',
         ]);
+
         expect(result).toMatchSnapshot();
         expect(fs.writeFileSync).not.toHaveBeenCalled();
 
@@ -249,6 +260,7 @@ describe('rdme docs upload', () => {
           .reply(201, {});
 
         const result = await run(['__tests__/__fixtures__/docs/mixed-docs/invalid-attributes.md', '--key', key]);
+
         expect(result).toMatchSnapshot();
         expect(fs.writeFileSync).not.toHaveBeenCalled();
 
@@ -278,6 +290,7 @@ describe('rdme docs upload', () => {
           .reply(201, {});
 
         const result = await run(['__tests__/__fixtures__/docs/new-docs/new-doc.md', '--key', key]);
+
         expect(result).toMatchSnapshot();
         expect(fs.writeFileSync).not.toHaveBeenCalled();
 
@@ -287,6 +300,7 @@ describe('rdme docs upload', () => {
 
       it('should error out if the file has validation errors', async () => {
         const result = await run(['__tests__/__fixtures__/docs/mixed-docs/legacy-category.md', '--key', key]);
+
         expect(result).toMatchSnapshot();
         expect(fs.writeFileSync).not.toHaveBeenCalled();
       });
@@ -296,6 +310,7 @@ describe('rdme docs upload', () => {
       const mock = getAPIv2Mock({ authorization }).head('/versions/stable/guides/new-doc').reply(500);
 
       const result = await run(['__tests__/__fixtures__/docs/new-docs/new-doc.md', '--key', key]);
+
       expect(result).toMatchSnapshot();
       expect(fs.writeFileSync).not.toHaveBeenCalled();
 
@@ -304,12 +319,14 @@ describe('rdme docs upload', () => {
 
     it('should error out if the file does not exist', async () => {
       const result = await run(['non-existent-file', '--key', key]);
+
       expect(result).toMatchSnapshot();
       expect(fs.writeFileSync).not.toHaveBeenCalled();
     });
 
     it('should error out if the file has an invalid file extension', async () => {
       const result = await run(['package.json', '--key', key]);
+
       expect(result).toMatchSnapshot();
       expect(fs.writeFileSync).not.toHaveBeenCalled();
     });
@@ -337,6 +354,7 @@ describe('rdme docs upload', () => {
         .reply(201, {});
 
       const result = await run(['__tests__/__fixtures__/docs/existing-docs', '--key', key]);
+
       expect(result).toMatchSnapshot();
       expect(fs.writeFileSync).not.toHaveBeenCalled();
 
@@ -362,6 +380,7 @@ describe('rdme docs upload', () => {
         .reply(201, {});
 
       const result = await run(['__tests__/__fixtures__/docs/existing-docs', '--key', key]);
+
       expect(result).toMatchSnapshot();
       expect(fs.writeFileSync).not.toHaveBeenCalled();
 
@@ -407,6 +426,7 @@ describe('rdme docs upload', () => {
           .reply(201, {});
 
         const result = await run(['__tests__/__fixtures__/docs/multiple-docs', '--key', key]);
+
         expect(result).toMatchSnapshot();
         expect(fs.writeFileSync).not.toHaveBeenCalled();
 
@@ -416,6 +436,7 @@ describe('rdme docs upload', () => {
 
     it('should error out if the directory does not contain any Markdown files', async () => {
       const result = await run(['__tests__/__fixtures__/ref-oas', '--key', key]);
+
       expect(result).toMatchSnapshot();
     });
 
@@ -459,6 +480,7 @@ describe('rdme docs upload', () => {
       prompts.inject([true]);
 
       const result = await run(['__tests__/__fixtures__/docs/mixed-docs', '--key', key]);
+
       expect(result).toMatchSnapshot();
       expect(fs.writeFileSync).toHaveBeenCalledTimes(5);
 
@@ -479,6 +501,7 @@ describe('rdme docs upload', () => {
       prompts.inject([true]);
 
       const result = await run(['__tests__/__fixtures__/docs/mixed-docs', '--key', key, '--dry-run']);
+
       expect(result).toMatchSnapshot();
       expect(fs.writeFileSync).toHaveBeenCalledTimes(5);
 

__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));