test: use consistent naming conventions (#31)

Author: brianrodri

src/model/collection/__tests__/periodic-log.ts

@@ -3,7 +3,7 @@ import { describe, expect, it } from "vitest";
 
 import { PeriodicLog } from "../periodic-log";
 
-describe("PeriodicLog", () => {
+describe(PeriodicLog.name, () => {
     describe("pre-conditions", () => {
         it("should throw when folder is empty", () => {
             expect(() => new PeriodicLog("", "yyyy-MM-dd", { days: 1 })).toThrow();

src/model/collection/__tests__/schema.ts

@@ -3,12 +3,12 @@ import { describe, expect, it } from "vitest";
 
 import { Collection } from "../schema";
 
-class TestCollection extends Collection {
-    public override includes = constant(false);
-}
-
-describe("Collection default implementations", () => {
+describe(Collection.name, () => {
     it("returns invalid intervals", () => {
+        class TestCollection extends Collection {
+            public override includes = constant(false);
+        }
+
         expect(new TestCollection().getIntervalOf("path").isValid).toBe(false);
     });
 });

src/model/task/lib/__tests__/obsidian-dataview.const.ts

@@ -0,0 +1,33 @@
+import { constant } from "lodash";
+
+import { DataviewMarkdownTask } from "@/lib/obsidian-dataview/types";
+
+export const NULL_DATAVIEW_TASK: DataviewMarkdownTask = {
+    task: true,
+    status: " ",
+    checked: false,
+    completed: false,
+    fullyCompleted: false,
+    symbol: "",
+    link: undefined,
+    section: {
+        fileName: constant(undefined),
+        obsidianLink: constant(undefined),
+        subpath: undefined,
+    },
+    path: "",
+    line: 0,
+    lineCount: 0,
+    position: {
+        start: { line: 0, col: 0, offset: 0 },
+        end: { line: 0, col: 0, offset: 0 },
+    },
+    list: 0,
+    children: [],
+    outlinks: [],
+    text: "",
+    tags: [],
+    subtasks: [],
+    real: false,
+    header: undefined,
+} as const;

src/model/task/lib/__tests__/obsidian-dataview.ts

@@ -1,11 +1,10 @@
 import { constant } from "lodash";
 import { afterEach, describe, expect, it, vi } from "vitest";
 
-import { DataviewMarkdownTask } from "@/lib/obsidian-dataview/types";
-
 import { adaptDataviewMarkdownTask } from "../obsidian-dataview";
+import { NULL_DATAVIEW_TASK } from "./obsidian-dataview.const";
 
-describe("Converting dataview tasks into objo tasks", () => {
+describe(adaptDataviewMarkdownTask.name, () => {
     afterEach(() => vi.resetAllMocks());
 
     it.each([
@@ -27,33 +26,3 @@ describe("Converting dataview tasks into objo tasks", () => {
         expect(adaptDataviewMarkdownTask({ ...NULL_DATAVIEW_TASK, ...dataviewTaskPart })).toMatchObject(objoTaskPart);
     });
 });
-
-const NULL_DATAVIEW_TASK: DataviewMarkdownTask = {
-    task: true,
-    status: " ",
-    checked: false,
-    completed: false,
-    fullyCompleted: false,
-    symbol: "",
-    link: undefined,
-    section: {
-        fileName: constant(undefined),
-        obsidianLink: constant(undefined),
-        subpath: undefined,
-    },
-    path: "",
-    line: 0,
-    lineCount: 0,
-    position: {
-        start: { line: 0, col: 0, offset: 0 },
-        end: { line: 0, col: 0, offset: 0 },
-    },
-    list: 0,
-    children: [],
-    outlinks: [],
-    text: "",
-    tags: [],
-    subtasks: [],
-    real: false,
-    header: undefined,
-} as const;

src/model/task/lib/__tests__/obsidian-tasks.ts

@@ -3,9 +3,7 @@ import { describe, expect, it } from "vitest";
 
 import { parseTaskEmojiFormat } from "../obsidian-tasks";
 
-const isoDateTime = DateTime.fromISO;
-
-describe("Parsing task emojis", () => {
+describe(parseTaskEmojiFormat.name, () => {
     it.each([
         [{ description: "task text" }, " \t task text \t "],
         [{ priority: 0 }, "🔺"],
@@ -14,13 +12,13 @@ describe("Parsing task emojis", () => {
         [{ priority: 4 }, "🔽"],
         [{ priority: 5 }, "⏬"],
         [{ id: "due3rd", dependsOn: new Set(["due1st", "due2nd"]) }, "🆔 due3rd ⛔ due1st, due2nd"],
-        [{ dates: { cancelled: isoDateTime("2024-10-25") } }, "❌ 2024-10-25"],
-        [{ dates: { created: isoDateTime("2024-10-26") } }, "➕ 2024-10-26"],
-        [{ dates: { done: isoDateTime("2024-10-27") } }, "✅ 2024-10-27"],
-        [{ dates: { due: isoDateTime("2024-10-28") } }, "📅 2024-10-28"],
-        [{ dates: { scheduled: isoDateTime("2024-10-29") } }, "⏳ 2024-10-29"],
-        [{ dates: { scheduled: isoDateTime("2024-10-30") } }, "⏳ 2024-10-30"],
-        [{ dates: { start: isoDateTime("2024-10-31") } }, "🛫 2024-10-31"],
+        [{ dates: { cancelled: DateTime.fromISO("2024-10-25") } }, "❌ 2024-10-25"],
+        [{ dates: { created: DateTime.fromISO("2024-10-26") } }, "➕ 2024-10-26"],
+        [{ dates: { done: DateTime.fromISO("2024-10-27") } }, "✅ 2024-10-27"],
+        [{ dates: { due: DateTime.fromISO("2024-10-28") } }, "📅 2024-10-28"],
+        [{ dates: { scheduled: DateTime.fromISO("2024-10-29") } }, "⏳ 2024-10-29"],
+        [{ dates: { scheduled: DateTime.fromISO("2024-10-30") } }, "⏳ 2024-10-30"],
+        [{ dates: { start: DateTime.fromISO("2024-10-31") } }, "🛫 2024-10-31"],
     ])("parses %j from input=%j", (taskPart, text) => {
         expect(parseTaskEmojiFormat(text)).toMatchObject(taskPart);
     });
@@ -42,12 +40,12 @@ describe("Parsing task emojis", () => {
             id: "do3rd",
             dependsOn: new Set(["do1st", "do2nd"]),
             dates: {
-                cancelled: isoDateTime("2024-10-25"),
-                created: isoDateTime("2024-10-26"),
-                done: isoDateTime("2024-10-27"),
-                due: isoDateTime("2024-10-28"),
-                scheduled: isoDateTime("2024-10-29"),
-                start: isoDateTime("2024-10-30"),
+                cancelled: DateTime.fromISO("2024-10-25"),
+                created: DateTime.fromISO("2024-10-26"),
+                done: DateTime.fromISO("2024-10-27"),
+                due: DateTime.fromISO("2024-10-28"),
+                scheduled: DateTime.fromISO("2024-10-29"),
+                start: DateTime.fromISO("2024-10-30"),
             },
         });
     });

src/model/task/util/__tests__/merge.ts

@@ -3,7 +3,7 @@ import { describe, expect, it } from "vitest";
 
 import { mergeTaskParts } from "../merge";
 
-describe("Merging task parts", () => {
+describe(mergeTaskParts.name, () => {
     it("gives default values when called with nothing", () => {
         const task = mergeTaskParts();
 

src/util/__tests__/type-utils.ts

@@ -2,8 +2,10 @@ import { describe, expectTypeOf, it } from "vitest";
 
 import { PathsOf } from "../type-utils";
 
-describe("PathOf", () => {
+describe("PathsOf", () => {
     it("returns the type of the first property of an object", () => {
-        expectTypeOf<PathsOf<{ a: { b: { c: string } } }>>().toEqualTypeOf<"a" | "a.b" | "a.b.c">();
+        type Obj = { a: { b: { c: string } } };
+
+        expectTypeOf<PathsOf<Obj>>().toEqualTypeOf<"a" | "a.b" | "a.b.c">();
     });
 });