style: enforce @vitest/eslint-plugin (#38)

* docs: use consistent variable names

* style: remove unneeded template literal string

* test: prefer toEqual for strings over toBe

* test: enforce @vitest/eslint-plugin

Author: brianrodri

boundaries.config.js

@@ -15,7 +15,7 @@ export const ELEMENTS = [
         mode: "full",
     },
     {
-        type: `lib:scope`,
+        type: "lib:scope",
         pattern: [`src/*/*/${libDir}/*.*`, `src/*/*/${libDir}/*/**/*`],
         capture: ["scope", "elementName", "lib"],
         mode: "full",

eslint.config.js

@@ -10,6 +10,7 @@ import eslintPluginJsdoc from "eslint-plugin-jsdoc";
 import eslintPluginTsdoc from "eslint-plugin-tsdoc";
 import { ELEMENTS, ELEMENT_TYPE_RULES, EXTERNAL_RULES } from "./boundaries.config.js";
 import eslintJs from "@eslint/js";
+import vitestEslintPlugin from "@vitest/eslint-plugin";
 
 /** @type { import("eslint").Linter.Config[] } */
 export default [
@@ -75,6 +76,14 @@ export default [
         },
     },
 
+    {
+        files: ["src/**/*.test.{ts,tsx}"],
+        ...vitestEslintPlugin.configs.recommended,
+        rules: {
+            "vitest/expect-expect": ["off", { assertFunctionNames: ["expect", "expectTypeOf"] }],
+        },
+    },
+
     // Turns off all rules that are unnecessary or might conflict with Prettier.
     eslintConfigPrettier,
 

package-lock.json

@@ -49,6 +49,7 @@
         "@typescript-eslint/parser": "^8.26.0",
         "@typhonjs-typedoc/typedoc-theme-dmt": "^0.3.1",
         "@vitest/coverage-v8": "^3.0.7",
+        "@vitest/eslint-plugin": "^1.1.36",
         "eslint": "^9.21.0",
         "eslint-config-preact": "github:brianrodri/eslint-config-preact#eslint-v9",
         "eslint-config-prettier": "^10.0.2",

package.json

@@ -3,7 +3,7 @@ import { describe, expect, it } from "vitest";
 
 import { PeriodicNotes } from "../periodic-notes";
 
-describe(PeriodicNotes.name, () => {
+describe(`${PeriodicNotes.name}`, () => {
     describe("pre-conditions", () => {
         it("should throw when folder is empty", () => {
             expect(() => new PeriodicNotes("", "yyyy-MM-dd", { days: 1 })).toThrow();
@@ -34,6 +34,12 @@ describe(PeriodicNotes.name, () => {
         });
     });
 
+    describe("post-conditions", () => {
+        it("should strip trailing slashes from the folder", () => {
+            expect(new PeriodicNotes("/vault/", "yyyy-MM-dd", { days: 1 }).folder).toEqual("/vault");
+        });
+    });
+
     describe('given daily log in folder: "/vault"', () => {
         const log = new PeriodicNotes("/vault", "yyyy-MM-dd", { days: 1 });
 

src/model/collection/__tests__/periodic-notes.ts src/model/collection/__tests__/periodic-notes.test.ts

@@ -3,7 +3,7 @@ import { describe, expect, it, vi } from "vitest";
 
 import { DateBasedCollection } from "../schema";
 
-describe(DateBasedCollection.name, () => {
+describe(`${DateBasedCollection.name}`, () => {
     const getIntervalOf = vi.fn();
     class TestCollection extends DateBasedCollection {
         public override getIntervalOf = getIntervalOf;

src/model/collection/__tests__/schema.ts src/model/collection/__tests__/schema.test.ts

@@ -17,51 +17,48 @@ export class PeriodicNotes extends DateBasedCollection {
     /** The folder containing all of the notes. */
     public readonly folder: string;
 
-    /**
-     * Luxon format used to parse dates from the file's name.
-     * @see {@link https://moment.github.io/luxon/#/parsing?id=table-of-tokens}
-     */
+    /** @see {@link https://moment.github.io/luxon/#/parsing?id=table-of-tokens} */
     public readonly dateFormat: string;
 
-    /**
-     * Offset between the file's _parsed_ date and the corresponding {@link Interval}'s _start_ date. May be negative.
-     * @example a periodic sprint log using ISO weeks, which start on Monday, as its {@link dateFormat} when sprints
-     * _actually_ begin on Thursdays.
-     */
-    public readonly dateOffset: Duration<true>;
+    /** Luxon options used when parsing {@link DateTime}s from file names. */
+    public readonly dateOptions: DateTimeOptions;
 
     /**
      * The {@link Duration} of each file's corresponding {@link Interval}.
      * @example a daily log's duration would be `{ days: 1 }`.
      */
     public readonly intervalDuration: Duration<true>;
 
-    /** Luxon options used when parsing {@link DateTime}s from file names. */
-    public readonly dateOptions: DateTimeOptions;
+    /**
+     * Offset between the file's _parsed_ date and the corresponding {@link Interval}'s _start_ date. May be negative.
+     * @example a periodic sprint log using ISO weeks, which start on Monday, as its {@link dateFormat} when sprints
+     * _actually_ begin on Thursdays.
+     */
+    public readonly intervalOffset: Duration<true>;
 
     public constructor(
         folder: string,
         dateFormat: string,
         intervalDurationLike: DurationLike,
-        dateOffsetLike: DurationLike = 0,
+        intervalOffsetLike: DurationLike = 0,
         dateOptions: DateTimeOptions = {},
     ) {
         super();
 
-        folder = folder.trim();
-        const dateOffset = Duration.fromDurationLike(dateOffsetLike);
+        folder = folder.trim().replace(/\/$/, ""); // Ensure trailing slashes are removed.
+        const intervalOffset = Duration.fromDurationLike(intervalOffsetLike);
         const intervalDuration = Duration.fromDurationLike(intervalDurationLike);
 
         assert(folder.length > 0, "folder must be non-empty");
         assert(dateFormat.length > 0, "dateFormat must be non-empty");
-        assert(dateOffset.isValid, "dateOffset must be valid");
+        assert(intervalOffset.isValid, "dateOffset must be valid");
         assert(intervalDuration.isValid && intervalDuration.valueOf() !== 0, "intervalDuration must be non-zero");
 
         this.folder = folder;
         this.dateFormat = dateFormat;
-        this.dateOffset = dateOffset;
-        this.intervalDuration = intervalDuration;
         this.dateOptions = dateOptions;
+        this.intervalDuration = intervalDuration;
+        this.intervalOffset = intervalOffset;
     }
 
     /**
@@ -70,14 +67,14 @@ export class PeriodicNotes extends DateBasedCollection {
      * @returns the {@link Interval} corresponding to the file, otherwise an invalid interval.
      */
     public override getIntervalOf(filePath: string): IntervalMaybeValid {
-        const path = parse(filePath);
-        if (path.dir !== this.folder) {
-            return Interval.invalid(`invalid interval folder`, `"${filePath}" is not in "${this.folder}"`);
+        const parsedPath = parse(filePath);
+        if (parsedPath.dir !== this.folder) {
+            return Interval.invalid("invalid folder", `"${filePath}" is not in "${this.folder}"`);
         }
-        const date = DateTime.fromFormat(path.name, this.dateFormat, this.dateOptions);
-        if (!date.isValid) {
-            return Interval.invalid(`invalid interval filename`, `${date.invalidReason} ${date.invalidExplanation}`);
+        const parsedDate = DateTime.fromFormat(parsedPath.name, this.dateFormat, this.dateOptions);
+        if (!parsedDate.isValid) {
+            return Interval.invalid("invalid filename", `${parsedDate.invalidReason} ${parsedDate.invalidExplanation}`);
         }
-        return Interval.after(date.plus(this.dateOffset), this.intervalDuration);
+        return Interval.after(parsedDate.plus(this.intervalOffset), this.intervalDuration);
     }
 }

src/model/collection/periodic-notes.ts

@@ -4,7 +4,7 @@ import { afterEach, describe, expect, it, vi } from "vitest";
 import { adaptDataviewMarkdownTask } from "../obsidian-dataview";
 import { NULL_DATAVIEW_TASK } from "./obsidian-dataview.const";
 
-describe(adaptDataviewMarkdownTask.name, () => {
+describe(`${adaptDataviewMarkdownTask.name}`, () => {
     afterEach(() => vi.resetAllMocks());
 
     it.each([

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

@@ -3,7 +3,7 @@ import { describe, expect, it } from "vitest";
 
 import { parseTaskEmojiFormat } from "../obsidian-tasks";
 
-describe(parseTaskEmojiFormat.name, () => {
+describe(`${parseTaskEmojiFormat.name}`, () => {
     it.each([
         [{ description: "task text" }, " \t task text \t "],
         [{ priority: 0 }, "🔺"],

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

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

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

@@ -5,7 +5,7 @@ import { describe, expect, it } from "vitest";
 import { assertIntervalsDoNotIntersect, assertLuxonValidity } from "../luxon-utils";
 import { WITH_OVERLAPPING_INTERVALS, WITHOUT_OVERLAPPING_INTERVALS } from "./luxon-utils.const";
 
-describe(assertLuxonValidity.name, () => {
+describe(`${assertLuxonValidity.name}`, () => {
     const reason = "user-provided reason";
     const explanation = "user-provided explanation";
 
@@ -32,7 +32,7 @@ describe(assertLuxonValidity.name, () => {
     });
 });
 
-describe(assertIntervalsDoNotIntersect.name, () => {
+describe(`${assertIntervalsDoNotIntersect.name}`, () => {
     it.each(entriesIn(WITHOUT_OVERLAPPING_INTERVALS))("should accept %j", (_, intervals) => {
         expect(() => assertIntervalsDoNotIntersect(intervals)).not.toThrow();
     });

src/util/__tests__/__snapshots__/luxon-utils.ts.snap src/util/__tests__/__snapshots__/luxon-utils.test.ts.snap

@@ -35,12 +35,11 @@ export default defineConfig(({ mode }) => ({
     },
     test: {
         environment: "jsdom",
-        include: ["src/**/__tests__/*"],
-        exclude: ["**/*.const.{ts,tsx}"],
+        include: ["src/**/__tests__/**/*.test.{ts,tsx}"],
         coverage: {
             all: true,
             include: ["src/"],
-            exclude: ["src/main.tsx", "src/lib/"],
+            exclude: ["src/main.tsx", "src/lib"],
             thresholds: { 100: true },
             reporter: ["text", "html", "clover", "json", "lcov"],
         },