chore: another grab bag of changes from #1159

[kanadgupta]

🧰 Changes

chunks out a lot of PR feedback and random changes from #1159:

• renames all "front matter" to "frontmatter"
• better nock and fs setup/teardown
• cherry-picking over c871520
• various cleanups
• bumps deps:

before:

@readme/better-ajv-errors    2.0.0    2.1.2    2.1.2  node_modules/@readme/better-ajv-errors  rdme
eslint                      8.57.1   8.57.1   9.19.0  node_modules/eslint                     rdme
oclif                      4.17.20  4.17.21  4.17.21  node_modules/oclif                      rdme
semver                       7.6.3    7.7.0    7.7.0  node_modules/semver                     rdme
undici                      5.28.5   5.28.5    7.3.0  node_modules/undici                     rdme

after:

Package  Current  Wanted  Latest  Location             Depended by
eslint    8.57.1  8.57.1  9.19.0  node_modules/eslint  rdme
undici    5.28.5  5.28.5   7.3.0  node_modules/undici  rdme

🧬 QA & Testing

do tests still pass?

[erunion]

I was able to get this working with a test spy if you're interested.

diff --git a/__tests__/commands/openapi/convert.test.ts b/__tests__/commands/openapi/convert.test.ts
index 6fac324..2ba5928 100644
--- a/__tests__/commands/openapi/convert.test.ts
+++ b/__tests__/commands/openapi/convert.test.ts
@@ -3,7 +3,7 @@ import type { OASDocument } from 'oas/types';
 import fs from 'node:fs';
 
 import prompts from 'prompts';
-import { describe, it, expect, vi, beforeAll, beforeEach, afterEach } from 'vitest';
+import { describe, it, expect, vi, beforeAll, beforeEach, afterEach, type MockInstance } from 'vitest';
 
 import Command from '../../../src/commands/openapi/convert.js';
 import { runCommandAndReturnResult } from '../../helpers/oclif.js';
@@ -11,10 +11,10 @@ import { runCommandAndReturnResult } from '../../helpers/oclif.js';
 const successfulConversion = () => 'Your API definition has been converted and bundled and saved to output.json!';
 
 describe('rdme openapi convert', () => {
-  const fsWriteFileSync = fs.writeFileSync;
   let reducedSpec: OASDocument;
   let run: (args?: string[]) => Promise<string>;
   let testWorkingDir: string;
+  let fsWriteFileSyncSpy: MockInstance<typeof fs.writeFileSync>;
 
   beforeAll(() => {
     run = runCommandAndReturnResult(Command);
@@ -22,13 +22,13 @@ describe('rdme openapi convert', () => {
 
   beforeEach(() => {
     testWorkingDir = process.cwd();
-    fs.writeFileSync = vi.fn((fileName, data) => {
+
+    fsWriteFileSyncSpy = vi.spyOn(fs, 'writeFileSync').mockImplementationOnce((filename, data) => {
       reducedSpec = JSON.parse(data as string);
     });
   });
 
   afterEach(() => {
-    fs.writeFileSync = fsWriteFileSync;
     process.chdir(testWorkingDir);
     vi.clearAllMocks();
   });
@@ -44,7 +44,7 @@ describe('rdme openapi convert', () => {
 
       await expect(run([spec])).resolves.toBe(successfulConversion());
 
-      expect(fs.writeFileSync).toHaveBeenCalledWith('output.json', expect.any(String));
+      expect(fsWriteFileSyncSpy).toHaveBeenCalledWith('output.json', expect.any(String));
       expect(reducedSpec.tags).toHaveLength(1);
       expect(Object.keys(reducedSpec.paths)).toStrictEqual(['/pet/{petId}']);
       expect(Object.keys(reducedSpec.paths['/pet/{petId}'])).toStrictEqual(['get', 'post', 'delete']);
@@ -64,7 +64,7 @@ describe('rdme openapi convert', () => {
       ]),
     ).resolves.toBe(successfulConversion());
 
-    expect(fs.writeFileSync).toHaveBeenCalledWith('output.json', expect.any(String));
+    expect(fsWriteFileSyncSpy).toHaveBeenCalledWith('output.json', expect.any(String));
     expect(Object.keys(reducedSpec.paths)).toStrictEqual(['/pet/{petId}']);
     expect(Object.keys(reducedSpec.paths['/pet/{petId}'])).toStrictEqual(['get', 'post', 'delete']);
   });
@@ -79,7 +79,7 @@ describe('rdme openapi convert', () => {
 
       await expect(run([spec])).resolves.toBe(successfulConversion());
 
-      expect(fs.writeFileSync).toHaveBeenCalledWith('output.json', expect.any(String));
+      expect(fsWriteFileSyncSpy).toHaveBeenCalledWith('output.json', expect.any(String));
       expect(reducedSpec.tags).toHaveLength(3);
       expect(Object.keys(reducedSpec.paths)).toStrictEqual([
         '/pet',

[kanadgupta]

ah tysm

[kanadgupta]

🎉 This PR is included in version 10.1.2-next.1 🎉

The release is available on:

• npm package (@next dist-tag)
• v10.1.2-next.1
• GitHub release

Your semantic-release bot 📦🚀