feat: add @oclif/plugin-not-found, other cleanups (#1074)

## 🧰 Changes

- [x] introduces
[`@oclif/plugin-not-found`](https://github.com/oclif/plugin-not-found/tree/main)
into the mix
- [x] shuffles around our `npm` scripts a tiny bit
- [x] stronger test assertions
- [x] various lint/test output cleanups

__tests__/commands/changelogs/index.test.ts

@@ -276,7 +276,7 @@ describe('rdme changelogs', () => {
         message: `Error uploading ${chalk.underline(`${fullDirectory}/${slug}.md`)}:\n\n${errorObject.message}`,
       };
 
-      await expect(run([`./${fullDirectory}`, '--key', key])).rejects.toThrow(new APIError(formattedErrorObject));
+      await expect(run([`./${fullDirectory}`, '--key', key])).rejects.toStrictEqual(new APIError(formattedErrorObject));
 
       getMocks.done();
       postMocks.done();

__tests__/commands/changelogs/single.test.ts

@@ -122,7 +122,7 @@ describe('rdme changelogs (single)', () => {
         message: `Error uploading ${chalk.underline(`${filePath}`)}:\n\n${errorObject.message}`,
       };
 
-      await expect(run([filePath, '--key', key])).rejects.toThrow(new APIError(formattedErrorObject));
+      await expect(run([filePath, '--key', key])).rejects.toStrictEqual(new APIError(formattedErrorObject));
 
       getMock.done();
     });

__tests__/commands/custompages/index.test.ts

@@ -308,7 +308,7 @@ describe('rdme custompages', () => {
         message: `Error uploading ${chalk.underline(`${fullDirectory}/${slug}.md`)}:\n\n${errorObject.message}`,
       };
 
-      await expect(run([`./${fullDirectory}`, '--key', key])).rejects.toThrow(new APIError(formattedErrorObject));
+      await expect(run([`./${fullDirectory}`, '--key', key])).rejects.toStrictEqual(new APIError(formattedErrorObject));
 
       getMocks.done();
       postMocks.done();

__tests__/commands/custompages/single.test.ts

@@ -151,7 +151,7 @@ describe('rdme custompages (single)', () => {
         message: `Error uploading ${chalk.underline(`${filePath}`)}:\n\n${errorObject.message}`,
       };
 
-      await expect(run([filePath, '--key', key])).rejects.toThrow(new APIError(formattedErrorObject));
+      await expect(run([filePath, '--key', key])).rejects.toStrictEqual(new APIError(formattedErrorObject));
 
       getMock.done();
     });

__tests__/commands/docs/__snapshots__/multiple.test.ts.snap

@@ -0,0 +1,3 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`rdme docs (multiple) > should return an error message when it encounters a cycle 1`] = `[Error: Cyclic dependency, node was:{"content":"\\n# Parent Body\\n","data":{"title":"Parent","parentDocSlug":"grandparent"},"filePath":"__tests__/__fixtures__/docs/multiple-docs-cycle/parent.md","hash":"0fc832371f8e240047bfc14bc8be9e37d50c8bb8","slug":"parent"}]`;

__tests__/commands/docs/index.test.ts

@@ -342,7 +342,7 @@ describe('rdme docs', () => {
         message: `Error uploading ${chalk.underline(`${fullDirectory}/${slug}.md`)}:\n\n${errorObject.message}`,
       };
 
-      await expect(run([`./${fullDirectory}`, '--key', key, '--version', version])).rejects.toThrow(
+      await expect(run([`./${fullDirectory}`, '--key', key, '--version', version])).rejects.toStrictEqual(
         new APIError(formattedErrorObject),
       );
 

__tests__/commands/docs/multiple.test.ts

@@ -162,7 +162,7 @@ describe('rdme docs (multiple)', () => {
 
     const promise = run([`./__tests__/${fixturesBaseDir}/${dir}`, '--key', key, '--version', version]);
 
-    await expect(promise).rejects.toThrow('Cyclic dependency');
+    await expect(promise).rejects.toMatchSnapshot();
     versionMock.done();
   });
 });

__tests__/commands/docs/prune.test.ts

@@ -30,8 +30,8 @@ describe('rdme docs:prune', () => {
   it('should error if the argument is not a folder', async () => {
     const versionMock = getAPIMock().get(`/api/v1/version/${version}`).basicAuth({ user: key }).reply(200, { version });
 
-    await expect(run(['--key', key, '--version', version, 'not-a-folder'])).rejects.toThrow(
-      "ENOENT: no such file or directory, scandir 'not-a-folder'",
+    await expect(run(['--key', key, '--version', version, 'not-a-folder'])).rejects.toStrictEqual(
+      new Error("ENOENT: no such file or directory, scandir 'not-a-folder'"),
     );
 
     versionMock.done();

__tests__/commands/docs/single.test.ts

@@ -163,7 +163,7 @@ describe('rdme docs (single)', () => {
         message: `Error uploading ${chalk.underline(`${filePath}`)}:\n\n${errorObject.message}`,
       };
 
-      await expect(run([filePath, '--key', key, '--version', version])).rejects.toThrow(
+      await expect(run([filePath, '--key', key, '--version', version])).rejects.toStrictEqual(
         new APIError(formattedErrorObject),
       );
 

__tests__/commands/login.test.ts

@@ -105,7 +105,7 @@ describe('rdme login', () => {
 
     const mock = getAPIMock().post('/api/v1/login', { email, password, project }).reply(401, errorResponse);
 
-    await expect(run()).rejects.toThrow(new APIError(errorResponse));
+    await expect(run()).rejects.toStrictEqual(new APIError(errorResponse));
     mock.done();
   });
 
@@ -147,7 +147,7 @@ describe('rdme login', () => {
       .post('/api/v1/login', { email, password, project: projectThatIsNotYours })
       .reply(404, errorResponse);
 
-    await expect(run()).rejects.toThrow(new APIError(errorResponse));
+    await expect(run()).rejects.toStrictEqual(new APIError(errorResponse));
     mock.done();
   });
 });

__tests__/commands/openapi/__snapshots__/index.test.ts.snap

@@ -287,6 +287,8 @@ jobs:
 "
 `;
 
+exports[`rdme openapi > error handling > should throw an error if an invalid OpenAPI 3.0 definition is supplied 1`] = `[MissingPointerError: Token "Error" does not exist.]`;
+
 exports[`rdme openapi > error handling > should throw an error if an invalid OpenAPI 3.1 definition is supplied 1`] = `
 [SyntaxError: OpenAPI schema validation failed.
 

__tests__/commands/openapi/__snapshots__/validate.test.ts.snap

@@ -172,6 +172,8 @@ ADDITIONAL PROPERTY must NOT have additional properties
   29 |         "summary": "Finds Pets by status",]
 `;
 
+exports[`rdme openapi:validate > error handling > should throw an error if an invalid OpenAPI 3.0 definition is supplied 1`] = `[MissingPointerError: Token "Error" does not exist.]`;
+
 exports[`rdme openapi:validate > error handling > should throw an error if an invalid OpenAPI 3.1 definition is supplied 1`] = `
 [SyntaxError: OpenAPI schema validation failed.
 

__tests__/commands/openapi/index.test.ts

@@ -762,7 +762,7 @@ describe('rdme openapi', () => {
           '--version',
           invalidVersion,
         ]),
-      ).rejects.toThrow(new APIError(errorObject));
+      ).rejects.toStrictEqual(new APIError(errorObject));
 
       return mock.done();
     });
@@ -824,15 +824,15 @@ describe('rdme openapi', () => {
 
       await expect(
         run([require.resolve('@readme/oas-examples/3.1/json/petstore.json'), '--key', 'key']),
-      ).rejects.toThrow(new APIError(errorObject));
+      ).rejects.toStrictEqual(new APIError(errorObject));
 
       return mock.done();
     });
 
     it('should throw an error if an invalid OpenAPI 3.0 definition is supplied', () => {
       return expect(
         run(['./__tests__/__fixtures__/invalid-oas.json', '--key', key, '--id', id, '--version', version]),
-      ).rejects.toThrow('Token "Error" does not exist.');
+      ).rejects.toMatchSnapshot();
     });
 
     it('should throw an error if an invalid OpenAPI 3.1 definition is supplied', () => {
@@ -874,7 +874,7 @@ describe('rdme openapi', () => {
 
       await expect(
         run(['./__tests__/__fixtures__/swagger-with-invalid-extensions.json', '--key', key, '--version', version]),
-      ).rejects.toThrow(new APIError(errorObject));
+      ).rejects.toStrictEqual(new APIError(errorObject));
 
       mockWithHeader.done();
       return mock.done();
@@ -909,7 +909,7 @@ describe('rdme openapi', () => {
           '--version',
           version,
         ]),
-      ).rejects.toThrow(new APIError(errorObject));
+      ).rejects.toStrictEqual(new APIError(errorObject));
 
       putMock.done();
       return mock.done();
@@ -932,7 +932,7 @@ describe('rdme openapi', () => {
 
       await expect(
         run(['./__tests__/__fixtures__/swagger-with-invalid-extensions.json', '--key', key, '--version', version]),
-      ).rejects.toThrow(new APIError(errorObject));
+      ).rejects.toStrictEqual(new APIError(errorObject));
 
       return mock.done();
     });
@@ -965,7 +965,7 @@ describe('rdme openapi', () => {
 
       await expect(
         run([require.resolve('@readme/oas-examples/2.0/json/petstore.json'), '--key', key, '--version', version]),
-      ).rejects.toThrow(new APIError(errorObject));
+      ).rejects.toStrictEqual(new APIError(errorObject));
 
       mockWithHeader.done();
       return mock.done();

__tests__/commands/openapi/validate.test.ts

@@ -83,14 +83,12 @@ describe('rdme openapi:validate', () => {
   describe('error handling', () => {
     it('should throw an error if invalid JSON is supplied', () => {
       return expect(run(['./__tests__/__fixtures__/invalid-json/yikes.json'])).rejects.toStrictEqual(
-        new Error('Unexpected end of JSON input'),
+        new SyntaxError('Unexpected end of JSON input'),
       );
     });
 
     it('should throw an error if an invalid OpenAPI 3.0 definition is supplied', () => {
-      return expect(run(['./__tests__/__fixtures__/invalid-oas.json'])).rejects.toThrow(
-        'Token "Error" does not exist.',
-      );
+      return expect(run(['./__tests__/__fixtures__/invalid-oas.json'])).rejects.toMatchSnapshot();
     });
 
     it('should throw an error if an invalid OpenAPI 3.1 definition is supplied', () => {

__tests__/commands/versions/create.test.ts

@@ -136,7 +136,7 @@ describe('rdme versions:create', () => {
 
     const mockRequest = getAPIMock().post('/api/v1/version').basicAuth({ user: key }).reply(400, errorResponse);
 
-    await expect(run(['--key', key, version, '--fork', '0.0.5'])).rejects.toThrow(new APIError(errorResponse));
+    await expect(run(['--key', key, version, '--fork', '0.0.5'])).rejects.toStrictEqual(new APIError(errorResponse));
     mockRequest.done();
   });
 

__tests__/commands/versions/delete.test.ts

@@ -49,7 +49,7 @@ describe('rdme versions:delete', () => {
       .basicAuth({ user: key })
       .reply(200, { version });
 
-    await expect(run(['--key', key, version])).rejects.toThrow(new APIError(errorResponse));
+    await expect(run(['--key', key, version])).rejects.toStrictEqual(new APIError(errorResponse));
     mockRequest.done();
   });
 });

__tests__/commands/versions/update.test.ts

@@ -348,7 +348,7 @@ describe('rdme versions:update', () => {
       .basicAuth({ user: key })
       .reply(400, errorResponse);
 
-    await expect(run(['--key', key, version])).rejects.toThrow(new APIError(errorResponse));
+    await expect(run(['--key', key, version])).rejects.toStrictEqual(new APIError(errorResponse));
     mockRequest.done();
   });
 

__tests__/helpers/setup-oclif-config.ts

@@ -31,9 +31,7 @@ export function runCommand<T extends typeof OclifCommand>(Command: T) {
     return captureOutput<string>(() => Command.run(args, oclifConfig), { testNodeEnv: 'rdme-test' }).then(
       ({ error, result }) => {
         if (error) {
-          const e = new Error(error.message);
-          if (error.name) e.name = error.name;
-          throw e;
+          throw error;
         }
         return result;
       },

knip.ts

@@ -4,7 +4,6 @@ const config: KnipConfig = {
   entry: ['src/index.ts', 'src/lib/help.ts', 'bin/*.js'],
   ignore: ['dist-gha/**'],
   ignoreBinaries: ['semantic-release'],
-  ignoreDependencies: ['oclif'],
 };
 
 export default config;