feat: strip trailing slashes from folders when applicable (#39)

Author: brianrodri

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

@@ -0,0 +1,17 @@
+import { describe, expect, it } from "vitest";
+
+import { sanitizeFolder } from "../utils";
+
+describe(`${sanitizeFolder.name}`, () => {
+    it("should strip trailing slashes", () => {
+        expect(sanitizeFolder("foo/")).toEqual("foo");
+    });
+
+    it("should do nothing if there are no trailing slashes", () => {
+        expect(sanitizeFolder("foo")).toEqual("foo");
+    });
+
+    it("should do nothing when folder is the vault root", () => {
+        expect(sanitizeFolder("/")).toEqual("/");
+    });
+});

src/model/collection/periodic-notes.ts

@@ -2,7 +2,10 @@ import assert from "assert";
 import { DateTime, DateTimeOptions, Duration, DurationLike, Interval, IntervalMaybeValid } from "luxon";
 import { parse } from "path";
 
+import { assertLuxonValidity } from "@/util/luxon-utils";
+
 import { DateBasedCollection } from "./schema";
+import { sanitizeFolder } from "./utils";
 
 /**
  * @see {@link https://github.com/liamcain/obsidian-periodic-notes}
@@ -45,14 +48,15 @@ export class PeriodicNotes extends DateBasedCollection {
     ) {
         super();
 
-        folder = folder.trim().replace(/\/$/, ""); // Ensure trailing slashes are removed.
+        folder = sanitizeFolder(folder);
         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(intervalOffset.isValid, "dateOffset must be valid");
-        assert(intervalDuration.isValid && intervalDuration.valueOf() !== 0, "intervalDuration must be non-zero");
+        assertLuxonValidity(intervalDuration, "intervalDuration must be valid");
+        assert(intervalDuration.valueOf() !== 0, "intervalDuration must be non-zero");
+        assertLuxonValidity(intervalOffset, "intervalOffset must be valid");
 
         this.folder = folder;
         this.dateFormat = dateFormat;

src/model/collection/utils.ts

@@ -0,0 +1,8 @@
+/**
+ * @param folder - the folder to sanitize.
+ * @returns sanitized value with trailing slashes removed, if applicable.
+ */
+export function sanitizeFolder(folder: string): string {
+    folder = folder.trim();
+    return folder === "/" ? folder : folder.replace(/\/$/, "");
+}