Add vitest unit tests

.github/workflows/ci.yml

@@ -48,3 +48,15 @@ jobs:
 
       - name: Run Check
         run: pnpm run lint:linkcheck
+  unitTest:
+    name: Check for code issues with Vitest
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Tools & Dependencies
+        uses: ./.github/actions/install
+
+      - name: Run Check
+        run: pnpm run test    

package.json

@@ -6,6 +6,7 @@
     "dev": "astro dev",
     "start": "astro dev",
     "build": "astro build",
+    "test": "vitest",
     "preview": "astro preview",
     "format": "pnpm run format:code",
     "format:ci": "pnpm run format:imports && pnpm run format:code",
@@ -77,7 +78,8 @@
     "typescript": "^4.7.4",
     "unified": "^10.1.2",
     "unist-util-remove": "^3.1.0",
-    "unist-util-visit": "^4.1.0"
+    "unist-util-visit": "^4.1.0",
+    "vitest": "^0.25.3"
   },
   "dependencies": {
     "@fontsource/ibm-plex-mono": "^4.5.10",

src/util/generateToc.test.ts

@@ -0,0 +1,80 @@
+import generateToc from './generateToc';
+import { describe, expect, test } from 'vitest';
+const overview = { depth: 2, slug: 'overview', text: 'Overview', children: [] };
+describe('generateToc', () => {
+	test('should include a default overview heading', () => {
+		expect(generateToc([])).toEqual([overview]);
+	});
+	test('should pass when heading 2 comes before heading 3', () => {
+		const toc = generateToc([
+			{
+				slug: 'heading 2',
+				text: 'heading 2',
+				depth: 2,
+			},
+			{
+				slug: 'heading 3',
+				text: 'heading 3',
+				depth: 3,
+			},
+		]);
+		expect(toc).toEqual([
+			overview,
+			{
+				slug: 'heading 2',
+				text: 'heading 2',
+				depth: 2,
+				children: [
+					{
+						slug: 'heading 3',
+						text: 'heading 3',
+						depth: 3,
+						children: [],
+					},
+				],
+			},
+		]);
+	});
+
+	test('should pass when heading 2 comes before heading 2', () => {
+		const toc = generateToc([
+			{
+				slug: 'heading 2',
+				text: 'heading 2',
+				depth: 2,
+			},
+			{
+				slug: 'heading 3',
+				text: 'heading 3',
+				depth: 3,
+			},
+			{
+				slug: 'heading 2',
+				text: 'heading 2',
+				depth: 2,
+			},
+		]);
+		expect(toc).toEqual([
+			overview,
+			{
+				slug: 'heading 2',
+				text: 'heading 2',
+				depth: 2,
+				children: [
+					{
+						slug: 'heading 3',
+						text: 'heading 3',
+						depth: 3,
+						children: [],
+					},
+				],
+			},
+			{
+				slug: 'heading 2',
+				text: 'heading 2',
+				depth: 2,
+				children: [],
+			},
+		]);
+	});
+});

src/util/generateToc.ts

@@ -26,7 +26,6 @@ export default function generateToc(headings: MarkdownHeading[], title = 'Overvi
 		} else {
 			const lastItemInToc = toc[toc.length - 1];
 			if (heading.depth < lastItemInToc.depth) {
-				console.log(headings);
 				throw new Error(`Orphan heading found: ${heading.text}.`);
 			}
 			if (heading.depth === lastItemInToc.depth) {