refactor: cut main.js by 1,739 gzip bytes without behavior change

src/API/API.test.ts

@@ -138,6 +138,19 @@ describe("API.getPodcastSegmentFormatted", () => {
 		);
 	});
 
+	test("formats the numeric strings that JavaScript workflows pass as times", () => {
+		const { api, player } = setup();
+		player.restore(feedEpisode);
+		const seconds = (value: string) => value as unknown as number;
+
+		expect(
+			api.getPodcastSegmentFormatted("HH:mm:ss", seconds("115"), seconds("125"), true),
+		).toBe("00:01:55-00:02:05");
+		expect(api.getPodcastSegmentFormatted("HH:mm:ss", 115, seconds("125"))).toBe(
+			"00:01:55-00:02:05",
+		);
+	});
+
 	test("seeking through the public API ends a segment link's stop", () => {
 		const { api, player, media } = setup();
 		player.play(feedEpisode, { time: 115, endTime: 125 });

src/TemplateEngine.ts

@@ -154,15 +154,28 @@ function addEpisodeFileNameTags(
 ): void {
 	addTag("title", legalizedNameTag(episode.title, sanitizeFileName));
 	addTag("podcast", legalizedNameTag(episode.podcastName, sanitizeFileName));
-	addTag("date", (format?: string) =>
-		episode.episodeDate ? formatDate(episode.episodeDate, format ?? "YYYY-MM-DD") : "",
+	addEpisodeDateTags(addTag, episode);
+}
+
+function addEpisodeDateTags(addTag: AddTagFn, episode: Episode): void {
+	addTag("date", (format = "YYYY-MM-DD") =>
+		episode.episodeDate ? formatDate(episode.episodeDate, format) : "",
 	);
-	addTag("currentdate", (format?: string) => formatDate(new Date(), format ?? "YYYY-MM-DD"));
+	// The current date the note is created on, distinct from {{date}} (the episode
+	// publish date). Supports the same Moment.js format arg. See issue #75.
+	addTag("currentdate", (format = "YYYY-MM-DD") => formatDate(new Date(), format));
+	// Episode number from <itunes:episode>, else best-effort from the title. See #34.
 	addTag("episodenumber", (pad?: string) =>
 		formatEpisodeNumber(resolveEpisodeNumber(episode), pad),
 	);
 }
 
+// Episode duration from <itunes:duration>. See issue #88.
+function durationTag(episode: Episode): TagValue {
+	return (format?: string) =>
+		episode.duration !== undefined ? formatDuration(episode.duration, format) : "";
+}
+
 function formatChapterTitle(title: string): string {
 	return title.replace(/\s+/g, " ").trim();
 }
@@ -270,6 +283,10 @@ function feedHtmlToMarkdown(html: string, source: object): string {
 	);
 }
 
+function joinLines(lines: string[], prependToLines?: string): string {
+	return (prependToLines ? lines.map((line) => `${prependToLines}${line}`) : lines).join("\n");
+}
+
 function formatTemplateChapters(chapters: Chapter[] | undefined, prependToLines?: string): string {
 	const lines = normalizeChapters(chapters ?? []).map((chapter) => {
 		const title = formatChapterTitle(chapter.title);
@@ -278,11 +295,7 @@ function formatTemplateChapters(chapters: Chapter[] | undefined, prependToLines?
 		return `- ${formatDuration(chapter.startTime)}${escapedTitle}`;
 	});
 
-	if (!prependToLines) {
-		return lines.join("\n");
-	}
-
-	return lines.map((line) => `${prependToLines}${line}`).join("\n");
+	return joinLines(lines, prependToLines);
 }
 
 /**
@@ -317,48 +330,23 @@ export function NoteTemplateEngine(
 	const episodeUrl = resolveEpisodeUrl(episode);
 
 	addTag("title", escapeMarkdownBodyText(episode.title));
-	addTag("description", (prependToLines?: string) => {
-		// reduce multiple new lines
-		const sanitizeDescription = feedHtmlToMarkdown(episode.description, liveEpisode).replace(
-			/\n{3,}/g,
-			"\n\n",
-		);
-		if (prependToLines) {
-			return sanitizeDescription
-				.split("\n")
-				.map((str) => `${prependToLines}${str}`)
-				.join("\n");
-		}
-
-		return sanitizeDescription;
-	});
-	addTag("content", (prependToLines?: string) => {
-		if (prependToLines) {
-			return feedHtmlToMarkdown(episode.content, liveEpisode)
-				.split("\n")
-				.map((str) => `${prependToLines}${str}`)
-				.join("\n");
-		}
-
-		return feedHtmlToMarkdown(episode.content, liveEpisode);
-	});
+	addTag("description", (prependToLines?: string) =>
+		joinLines(
+			// reduce multiple new lines
+			feedHtmlToMarkdown(episode.description, liveEpisode)
+				.replace(/\n{3,}/g, "\n\n")
+				.split("\n"),
+			prependToLines,
+		),
+	);
+	addTag("content", (prependToLines?: string) =>
+		joinLines(feedHtmlToMarkdown(episode.content, liveEpisode).split("\n"), prependToLines),
+	);
 	addTag("safetitle", replaceIllegalFileNameCharactersInString(episode.title));
 	addTag("stream", sanitizePortableResourceUrl(episode.streamUrl));
 	addTag("url", episodeUrl);
-	addTag("date", (format?: string) =>
-		episode.episodeDate ? formatDate(episode.episodeDate, format ?? "YYYY-MM-DD") : "",
-	);
-	// The current date the note is created on, distinct from {{date}} (the episode
-	// publish date). Supports the same Moment.js format arg. See issue #75.
-	addTag("currentdate", (format?: string) => formatDate(new Date(), format ?? "YYYY-MM-DD"));
-	// Episode number from <itunes:episode>, else best-effort from the title. See #34.
-	addTag("episodenumber", (pad?: string) =>
-		formatEpisodeNumber(resolveEpisodeNumber(episode), pad),
-	);
-	// Episode duration from <itunes:duration>. See issue #88.
-	addTag("duration", (format?: string) =>
-		episode.duration !== undefined ? formatDuration(episode.duration, format) : "",
-	);
+	addEpisodeDateTags(addTag, episode);
+	addTag("duration", durationTag(episode));
 	// Podcasting 2.0 chapters, fetched before note creation when the template
 	// asks for them. Empty when the feed has no chapters URL or fetching fails.
 	addTag("chapters", (prependToLines?: string) =>
@@ -401,36 +389,23 @@ export function TimestampTemplateEngine(
 	const { api, settings } = get(plugin);
 	const timestampOffset = settings.timestamp.offset ?? 0;
 
-	addTag("time", (format?: string) =>
-		api.getPodcastTimeFormatted(format ?? "HH:mm:ss", false, timestampOffset),
-	);
-	addTag("linktime", (format?: string) =>
-		api.getPodcastTimeFormatted(format ?? "HH:mm:ss", true, timestampOffset),
-	);
-	addTag("segment", (format?: string) => {
-		if (!options.segment) {
-			return api.getPodcastTimeFormatted(format ?? "HH:mm:ss", false, timestampOffset);
-		}
-
-		return api.getPodcastSegmentFormatted(
-			format ?? "HH:mm:ss",
-			options.segment.startTime,
-			options.segment.endTime,
-			false,
-		);
-	});
-	addTag("linksegment", (format?: string) => {
-		if (!options.segment) {
-			return api.getPodcastTimeFormatted(format ?? "HH:mm:ss", true, timestampOffset);
-		}
-
-		return api.getPodcastSegmentFormatted(
-			format ?? "HH:mm:ss",
-			options.segment.startTime,
-			options.segment.endTime,
-			true,
-		);
-	});
+	// Without a segment, {{segment}} renders the current time as {{time}} does.
+	const timeTag =
+		(linkify: boolean, segment?: PodcastSegmentTimes): TagValue =>
+		(format = "HH:mm:ss") =>
+			segment
+				? api.getPodcastSegmentFormatted(
+						format,
+						segment.startTime,
+						segment.endTime,
+						linkify,
+					)
+				: api.getPodcastTimeFormatted(format, linkify, timestampOffset);
+
+	addTag("time", timeTag(false));
+	addTag("linktime", timeTag(true));
+	addTag("segment", timeTag(false, options.segment));
+	addTag("linksegment", timeTag(true, options.segment));
 
 	return replacer(template);
 }
@@ -453,12 +428,10 @@ export function DownloadPathTemplateEngine(template: string, episode: Episode) {
 	// FIRST '.ext' followed by '?'/'#'/end, which need not be the trailing one, so
 	// a positional `.replace(ext, "")` could corrupt a folder name that happens to
 	// contain the same string earlier in the path (#DL-04).
+	// getUrlExtension returns letters and digits only, so the extension needs no escaping.
 	const templateExtension = getUrlExtension(template);
 	const templateWithoutExtension = templateExtension
-		? template.replace(
-				new RegExp(`\\.${templateExtension.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}$`, "i"),
-				"",
-			)
+		? template.replace(new RegExp(`\\.${templateExtension}$`, "i"), "")
 		: template;
 
 	const [replacer, addTag] = useTemplateEngine();
@@ -480,20 +453,11 @@ export function TranscriptTemplateEngine(
 	] as const);
 
 	addEpisodeFileNameTags(addTag, episode);
-	addTag("duration", (format?: string) =>
-		episode.duration !== undefined ? formatDuration(episode.duration, format) : "",
-	);
+	addTag("duration", durationTag(episode));
 	addTag("transcript", transcription);
-	addTag("description", (prependToLines?: string) => {
-		if (prependToLines) {
-			return feedHtmlToMarkdown(episode.description, liveEpisode)
-				.split("\n")
-				.map((str) => `${prependToLines}${str}`)
-				.join("\n");
-		}
-
-		return feedHtmlToMarkdown(episode.description, liveEpisode);
-	});
+	addTag("description", (prependToLines?: string) =>
+		joinLines(feedHtmlToMarkdown(episode.description, liveEpisode).split("\n"), prependToLines),
+	);
 	addTag("url", resolveEpisodeUrl(episode));
 	addTag("artwork", sanitizePortableResourceUrl(episode.artworkUrl ?? ""));
 
@@ -522,21 +486,15 @@ export function FeedNoteTemplateEngine(template: string, liveFeed: PodcastFeed)
 	addTag("artwork", sanitizePortableResourceUrl(feed.artworkUrl ?? ""));
 	addTag("feedartwork", sanitizePortableResourceUrl(feed.artworkUrl ?? ""));
 	addTag("author", escapeMarkdownBodyText(feed.author ?? ""));
-	addTag("description", (prependToLines?: string) => {
-		const sanitizeDescription = feedHtmlToMarkdown(feed.description ?? "", context).replace(
-			/\n{3,}/g,
-			"\n\n",
-		);
-		if (prependToLines) {
-			return sanitizeDescription
-				.split("\n")
-				.map((str) => `${prependToLines}${str}`)
-				.join("\n");
-		}
-
-		return sanitizeDescription;
-	});
-	addTag("date", (format?: string) => formatDate(new Date(), format ?? "YYYY-MM-DD"));
+	addTag("description", (prependToLines?: string) =>
+		joinLines(
+			feedHtmlToMarkdown(feed.description ?? "", context)
+				.replace(/\n{3,}/g, "\n\n")
+				.split("\n"),
+			prependToLines,
+		),
+	);
+	addTag("date", (format = "YYYY-MM-DD") => formatDate(new Date(), format));
 
 	return replacer(template);
 }
@@ -547,7 +505,7 @@ export function FeedFilePathTemplateEngine(template: string, feed: PodcastFeed)
 	const nameTag = legalizedNameTag(withoutFeedAddresses(feed).title);
 	addTag("title", nameTag);
 	addTag("podcast", nameTag);
-	addTag("date", (format?: string) => formatDate(new Date(), format ?? "YYYY-MM-DD"));
+	addTag("date", (format = "YYYY-MM-DD") => formatDate(new Date(), format));
 
 	return replacer(template);
 }

src/URIHandler.ts

@@ -110,7 +110,7 @@ export default async function podNotesURIHandler(
 			return;
 		}
 		// One guard ahead of both the segment and plain paths: a negative time is
-		// never valid (the segment path's own requestedTime < 0 check is now redundant).
+		// never valid.
 		if (requestedTime < 0) {
 			new Notice("Timestamp must be zero or greater");
 			return;
@@ -125,16 +125,16 @@ export default async function podNotesURIHandler(
 	if (requestedEndTime === null) return;
 
 	const nameCandidates = candidateValues(episodeName);
-	const player = get(plugin).player;
+	const { app, feedUrls, feeds, player } = get(plugin);
 	const playOptions = hasExplicitTime ? { time: requestedTime, endTime: requestedEndTime } : {};
 	const loaded = get(player.state).episode;
-	const { app, feedUrls } = get(plugin);
 	// A link carrying a saved private feed's secret URL opens as the feed's placeholder
 	// link, so the secret stays out of the episode.
 	const url =
 		Object.values(get(savedFeeds)).find((saved) => isSavedFeed(saved, linkUrl, feedUrls))
 			?.url ?? linkUrl;
-	const localFile = candidateValues(url)
+	const urlCandidates = candidateValues(url);
+	const localFile = urlCandidates
 		.map((path) => app.vault.getAbstractFileByPath(path))
 		.find((file) => file instanceof TFile);
 	// A link to the loaded episode names its feed, or its file for a local file, so a
@@ -155,7 +155,7 @@ export default async function podNotesURIHandler(
 		!!loaded &&
 		!!loadedLinkTarget &&
 		(!isLocalFile(loaded) || localFile?.path === loadedLinkTarget) &&
-		candidateValues(url).includes(loadedLinkTarget) &&
+		urlCandidates.includes(loadedLinkTarget) &&
 		(!guid || loaded.guid === guid) &&
 		(nameCandidates.includes(loaded.title) ||
 			nameCandidates.some((name) => titleTokenSimilarity(name, loaded.title) === 1));
@@ -188,8 +188,8 @@ export default async function podNotesURIHandler(
 				getUnambiguousMediaTypeFromPath(localFile.path) ??
 					(named ? getEpisodeMediaType(named) : "audio"),
 			);
-	} else if (!isPlaceholderLink && !candidateValues(url).some((u) => /^https?:\/\//i.test(u))) {
-		const { paths, name, files } = filesNamedLike(app.vault.getFiles(), candidateValues(url));
+	} else if (!isPlaceholderLink && !urlCandidates.some((u) => /^https?:\/\//i.test(u))) {
+		const { paths, name, files } = filesNamedLike(app.vault.getFiles(), urlCandidates);
 		if (files.length !== 1) {
 			new Notice(
 				files.length === 0
@@ -219,7 +219,6 @@ export default async function podNotesURIHandler(
 		// SecretStorage. An attacker-crafted placeholder link can therefore only
 		// make the user's own device fetch the user's own subscribed feed - and
 		// the resolved URL still passes the network fetchability gate.
-		const feeds = get(plugin).feeds;
 		const placeholderKey = parsePrivateFeedPlaceholder(url);
 		if (placeholderKey !== null) {
 			// Only a feed whose URL is on this device is fetched, and a newer link or play
@@ -229,7 +228,7 @@ export default async function podNotesURIHandler(
 			const saved = get(savedFeeds);
 			const fetches =
 				Object.prototype.hasOwnProperty.call(saved, placeholderKey) &&
-				resolveFeedUrl(saved[placeholderKey], get(plugin).feedUrls) !== null;
+				resolveFeedUrl(saved[placeholderKey], feedUrls) !== null;
 			const request = fetches ? ++latestRequest : latestRequest;
 			if (fetches) play = player.deferPlay();
 			// Fetch even a fresh feed so the link finds an episode published since.
@@ -302,11 +301,6 @@ function parseSegmentEndTime(
 		return null;
 	}
 
-	if (requestedTime < 0) {
-		new Notice("Segment start time must be zero or greater");
-		return null;
-	}
-
 	const parsed = parseSeconds(rawEndTime);
 	if (!Number.isFinite(parsed)) {
 		new Notice("Segment end time must be a valid number");

src/constants.ts

@@ -23,7 +23,7 @@ export const DEFAULT_EPISODE_LIST_LIMIT = 10;
  */
 export const MAX_EPISODE_LIST_LIMIT = 75;
 
-type PlaylistSettings = Pick<
+export type PlaylistSettings = Pick<
 	Playlist,
 	"icon" | "name" | "shouldEpisodeRemoveAfterPlay" | "shouldRepeat"
 >;