feat(test): moving unit tests over to vitest

.github/workflows/ci.yml

@@ -14,7 +14,6 @@ jobs:
     strategy:
       matrix:
         node-version:
-          - 14
           - 16
           - 18
           - 20

.npmignore

@@ -6,5 +6,5 @@ __tests__/
 .prettier*
 bin/*.js
 coverage/
-jest.*.js
 packages/
+vitest.*

__tests__/.eslintrc

@@ -1,3 +1,6 @@
 {
-  "extends": ["@readme/eslint-config/testing"]
+  "extends": "@readme/eslint-config/testing/vitest",
+  "rules": {
+    "@typescript-eslint/no-empty-function": "off"
+  }
 }

__tests__/__snapshots__/index.test.ts.snap

@@ -1,6 +1,6 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`cli --help should not surface args that are designated as hidden 1`] = `
+exports[`cli > --help > should not surface args that are designated as hidden 1`] = `
 "
 Upload, or resync, your OpenAPI/Swagger definition to ReadMe.
 
@@ -47,7 +47,7 @@ Related commands
 "
 `;
 
-exports[`cli --help should print usage for a given command 1`] = `
+exports[`cli > --help > should print usage for a given command 1`] = `
 "
 Upload, or resync, your OpenAPI/Swagger definition to ReadMe.
 
@@ -94,7 +94,7 @@ Related commands
 "
 `;
 
-exports[`cli --help should print usage for a given command if supplied as \`help <command>\` 1`] = `
+exports[`cli > --help > should print usage for a given command if supplied as \`help <command>\` 1`] = `
 "
 Upload, or resync, your OpenAPI/Swagger definition to ReadMe.
 
@@ -141,7 +141,7 @@ Related commands
 "
 `;
 
-exports[`cli --help should show related commands for a subcommands help menu 1`] = `
+exports[`cli > --help > should show related commands for a subcommands help menu 1`] = `
 "
 List versions available in your project or get a version by SemVer (https://semver.org/).
 

__tests__/bin.test.ts

@@ -1,5 +1,7 @@
 import { exec } from 'child_process';
 
+import { describe, it, expect } from 'vitest';
+
 describe('bin', () => {
   it('should show our help screen', async () => {
     expect.assertions(1);

__tests__/cmds/__snapshots__/whoami.test.ts.snap

@@ -1,3 +1,5 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`rdme whoami > should return the authenticated user 1`] = `"You are currently logged in as [email protected] to the subdomain project."`;
 
 exports[`rdme whoami should return the authenticated user 1`] = `"You are currently logged in as [email protected] to the subdomain project."`;

__tests__/cmds/categories/create.test.ts

@@ -1,5 +1,6 @@
 import nock from 'nock';
 import prompts from 'prompts';
+import { describe, beforeAll, afterEach, it, expect, vi } from 'vitest';
 
 import CategoriesCreateCommand from '../../../src/cmds/categories/create';
 import getAPIMock, { getAPIMockWithVersionHeader } from '../../helpers/get-api-mock';
@@ -15,7 +16,7 @@ describe('rdme categories:create', () => {
   afterEach(() => nock.cleanAll());
 
   it('should prompt for login if no API key provided', async () => {
-    const consoleInfoSpy = jest.spyOn(console, 'info').mockImplementation();
+    const consoleInfoSpy = vi.spyOn(console, 'info').mockImplementation(() => {});
     prompts.inject(['this-is-not-an-email', 'password', 'subdomain']);
     await expect(categoriesCreate.run({})).rejects.toStrictEqual(new Error('You must provide a valid email address.'));
     consoleInfoSpy.mockRestore();
@@ -24,27 +25,27 @@ describe('rdme categories:create', () => {
   it('should error in CI if no API key provided', async () => {
     process.env.TEST_RDME_CI = 'true';
     await expect(categoriesCreate.run({})).rejects.toStrictEqual(
-      new Error('No project API key provided. Please use `--key`.')
+      new Error('No project API key provided. Please use `--key`.'),
     );
     delete process.env.TEST_RDME_CI;
   });
 
   it('should error if no title provided', () => {
     return expect(categoriesCreate.run({ key: '123' })).rejects.toStrictEqual(
-      new Error('No title provided. Usage `rdme categories:create <title> [options]`.')
+      new Error('No title provided. Usage `rdme categories:create <title> [options]`.'),
     );
   });
 
   it('should error if categoryType is blank', () => {
     return expect(categoriesCreate.run({ key: '123', title: 'Test Title' })).rejects.toStrictEqual(
-      new Error('`categoryType` must be `guide` or `reference`.')
+      new Error('`categoryType` must be `guide` or `reference`.'),
     );
   });
 
   it('should error if categoryType is not `guide` or `reference`', () => {
     return expect(
       // @ts-expect-error Testing a CLI arg failure case.
-      categoriesCreate.run({ key: '123', title: 'Test Title', categoryType: 'test' })
+      categoriesCreate.run({ key: '123', title: 'Test Title', categoryType: 'test' }),
     ).rejects.toStrictEqual(new Error('`categoryType` must be `guide` or `reference`.'));
   });
 
@@ -71,7 +72,7 @@ describe('rdme categories:create', () => {
         key,
         version: '1.0.0',
         preventDuplicates: true,
-      })
+      }),
     ).resolves.toBe("🌱 successfully created 'New Category' with a type of 'guide' and an id of '123'");
 
     getMock.done();
@@ -102,7 +103,7 @@ describe('rdme categories:create', () => {
         key,
         version: '1.0.0',
         preventDuplicates: true,
-      })
+      }),
     ).resolves.toBe("🌱 successfully created 'Category' with a type of 'reference' and an id of '123'");
 
     getMock.done();
@@ -124,7 +125,7 @@ describe('rdme categories:create', () => {
         categoryType: 'guide',
         key,
         version: '1.0.0',
-      })
+      }),
     ).resolves.toBe("🌱 successfully created 'Category' with a type of 'reference' and an id of '123'");
 
     postMock.done();
@@ -149,11 +150,11 @@ describe('rdme categories:create', () => {
         key,
         version: '1.0.0',
         preventDuplicates: true,
-      })
+      }),
     ).rejects.toStrictEqual(
       new Error(
-        "The 'Category' category with a type of 'guide' already exists with an id of '123'. A new category was not created."
-      )
+        "The 'Category' category with a type of 'guide' already exists with an id of '123'. A new category was not created.",
+      ),
     );
 
     getMock.done();
@@ -178,11 +179,11 @@ describe('rdme categories:create', () => {
         key,
         version: '1.0.0',
         preventDuplicates: true,
-      })
+      }),
     ).rejects.toStrictEqual(
       new Error(
-        "The 'Category' category with a type of 'guide' already exists with an id of '123'. A new category was not created."
-      )
+        "The 'Category' category with a type of 'guide' already exists with an id of '123'. A new category was not created.",
+      ),
     );
 
     getMock.done();

__tests__/cmds/categories/index.test.ts

@@ -1,5 +1,6 @@
 import nock from 'nock';
 import prompts from 'prompts';
+import { describe, beforeAll, afterEach, it, expect, vi } from 'vitest';
 
 import CategoriesCommand from '../../../src/cmds/categories';
 import getAPIMock, { getAPIMockWithVersionHeader } from '../../helpers/get-api-mock';
@@ -15,7 +16,7 @@ describe('rdme categories', () => {
   afterEach(() => nock.cleanAll());
 
   it('should prompt for login if no API key provided', async () => {
-    const consoleInfoSpy = jest.spyOn(console, 'info').mockImplementation();
+    const consoleInfoSpy = vi.spyOn(console, 'info').mockImplementation(() => {});
     prompts.inject(['this-is-not-an-email', 'password', 'subdomain']);
     await expect(categories.run({})).rejects.toStrictEqual(new Error('You must provide a valid email address.'));
     consoleInfoSpy.mockRestore();
@@ -24,7 +25,7 @@ describe('rdme categories', () => {
   it('should error in CI if no API key provided', async () => {
     process.env.TEST_RDME_CI = 'true';
     await expect(categories.run({})).rejects.toStrictEqual(
-      new Error('No project API key provided. Please use `--key`.')
+      new Error('No project API key provided. Please use `--key`.'),
     );
     delete process.env.TEST_RDME_CI;
   });
@@ -41,7 +42,7 @@ describe('rdme categories', () => {
     const versionMock = getAPIMock().get(`/api/v1/version/${version}`).basicAuth({ user: key }).reply(200, { version });
 
     await expect(categories.run({ key, version: '1.0.0' })).resolves.toBe(
-      JSON.stringify([{ title: 'One Category', slug: 'one-category', type: 'guide' }], null, 2)
+      JSON.stringify([{ title: 'One Category', slug: 'one-category', type: 'guide' }], null, 2),
     );
 
     getMock.done();
@@ -71,8 +72,8 @@ describe('rdme categories', () => {
           { title: 'Another Category', slug: 'another-category', type: 'guide' },
         ],
         null,
-        2
-      )
+        2,
+      ),
     );
 
     getMock.done();

__tests__/cmds/changelogs/index.test.ts

@@ -5,6 +5,7 @@ import chalk from 'chalk';
 import frontMatter from 'gray-matter';
 import nock from 'nock';
 import prompts from 'prompts';
+import { describe, beforeAll, afterAll, beforeEach, it, expect, vi } from 'vitest';
 
 import ChangelogsCommand from '../../../src/cmds/changelogs';
 import APIError from '../../../src/lib/apiError';
@@ -23,7 +24,7 @@ describe('rdme changelogs', () => {
   afterAll(() => nock.cleanAll());
 
   it('should prompt for login if no API key provided', async () => {
-    const consoleInfoSpy = jest.spyOn(console, 'info').mockImplementation();
+    const consoleInfoSpy = vi.spyOn(console, 'info').mockImplementation(() => {});
     prompts.inject(['this-is-not-an-email', 'password', 'subdomain']);
     await expect(changelogs.run({})).rejects.toStrictEqual(new Error('You must provide a valid email address.'));
     consoleInfoSpy.mockRestore();
@@ -32,28 +33,28 @@ describe('rdme changelogs', () => {
   it('should error in CI if no API key provided', async () => {
     process.env.TEST_RDME_CI = 'true';
     await expect(changelogs.run({})).rejects.toStrictEqual(
-      new Error('No project API key provided. Please use `--key`.')
+      new Error('No project API key provided. Please use `--key`.'),
     );
     delete process.env.TEST_RDME_CI;
   });
 
   it('should error if no path provided', () => {
     return expect(changelogs.run({ key })).rejects.toStrictEqual(
-      new Error('No path provided. Usage `rdme changelogs <path> [options]`.')
+      new Error('No path provided. Usage `rdme changelogs <path> [options]`.'),
     );
   });
 
   it('should error if the argument is not a folder', () => {
     return expect(changelogs.run({ key, filePath: 'not-a-folder' })).rejects.toStrictEqual(
-      new Error("Oops! We couldn't locate a file or directory at the path you provided.")
+      new Error("Oops! We couldn't locate a file or directory at the path you provided."),
     );
   });
 
   it('should error if the folder contains no markdown files', () => {
     return expect(changelogs.run({ key, filePath: '.github/workflows' })).rejects.toStrictEqual(
       new Error(
-        "The directory you provided (.github/workflows) doesn't contain any of the following required files: .markdown, .md."
-      )
+        "The directory you provided (.github/workflows) doesn't contain any of the following required files: .markdown, .md.",
+      ),
     );
   });
 
@@ -114,7 +115,7 @@ describe('rdme changelogs', () => {
           [
             `✏️ successfully updated 'simple-doc' with contents from __tests__/${fixturesBaseDir}/existing-docs/simple-doc.md`,
             `✏️ successfully updated 'another-doc' with contents from __tests__/${fixturesBaseDir}/existing-docs/subdir/another-doc.md`,
-          ].join('\n')
+          ].join('\n'),
         );
 
         getMocks.done();
@@ -141,12 +142,12 @@ describe('rdme changelogs', () => {
           expect(updatedDocs).toBe(
             [
               `🎭 dry run! This will update 'simple-doc' with contents from __tests__/${fixturesBaseDir}/existing-docs/simple-doc.md with the following metadata: ${JSON.stringify(
-                simpleDoc.doc.data
+                simpleDoc.doc.data,
               )}`,
               `🎭 dry run! This will update 'another-doc' with contents from __tests__/${fixturesBaseDir}/existing-docs/subdir/another-doc.md with the following metadata: ${JSON.stringify(
-                anotherDoc.doc.data
+                anotherDoc.doc.data,
               )}`,
-            ].join('\n')
+            ].join('\n'),
           );
 
           getMocks.done();
@@ -169,7 +170,7 @@ describe('rdme changelogs', () => {
           [
             '`simple-doc` was not updated because there were no changes.',
             '`another-doc` was not updated because there were no changes.',
-          ].join('\n')
+          ].join('\n'),
         );
 
         getMocks.done();
@@ -194,7 +195,7 @@ describe('rdme changelogs', () => {
             [
               '🎭 dry run! `simple-doc` will not be updated because there were no changes.',
               '🎭 dry run! `another-doc` will not be updated because there were no changes.',
-            ].join('\n')
+            ].join('\n'),
           );
 
           getMocks.done();
@@ -225,7 +226,7 @@ describe('rdme changelogs', () => {
         .reply(201, { slug, _id: id, body: doc.content, ...doc.data, lastUpdatedHash: hash });
 
       await expect(changelogs.run({ filePath: `./__tests__/${fixturesBaseDir}/new-docs`, key })).resolves.toBe(
-        `🌱 successfully created 'new-doc' (ID: 1234) with contents from __tests__/${fixturesBaseDir}/new-docs/new-doc.md`
+        `🌱 successfully created 'new-doc' (ID: 1234) with contents from __tests__/${fixturesBaseDir}/new-docs/new-doc.md`,
       );
 
       getMock.done();
@@ -247,11 +248,11 @@ describe('rdme changelogs', () => {
         });
 
       await expect(
-        changelogs.run({ dryRun: true, filePath: `./__tests__/${fixturesBaseDir}/new-docs`, key })
+        changelogs.run({ dryRun: true, filePath: `./__tests__/${fixturesBaseDir}/new-docs`, key }),
       ).resolves.toBe(
         `🎭 dry run! This will create 'new-doc' with contents from __tests__/${fixturesBaseDir}/new-docs/new-doc.md with the following metadata: ${JSON.stringify(
-          doc.data
-        )}`
+          doc.data,
+        )}`,
       );
 
       getMock.done();
@@ -296,7 +297,7 @@ describe('rdme changelogs', () => {
       };
 
       await expect(changelogs.run({ filePath: `./${fullDirectory}`, key })).rejects.toStrictEqual(
-        new APIError(formattedErrorObject)
+        new APIError(formattedErrorObject),
       );
 
       getMocks.done();
@@ -327,7 +328,7 @@ describe('rdme changelogs', () => {
         .reply(201, { slug: doc.data.slug, _id: id, body: doc.content, ...doc.data, lastUpdatedHash: hash });
 
       await expect(changelogs.run({ filePath: `./__tests__/${fixturesBaseDir}/slug-docs`, key })).resolves.toBe(
-        `🌱 successfully created 'marc-actually-wrote-a-test' (ID: 1234) with contents from __tests__/${fixturesBaseDir}/slug-docs/new-doc-slug.md`
+        `🌱 successfully created 'marc-actually-wrote-a-test' (ID: 1234) with contents from __tests__/${fixturesBaseDir}/slug-docs/new-doc-slug.md`,
       );
 
       getMock.done();