file: add comparator to file

src/publishFile/PublishFile.ts

@@ -95,6 +95,13 @@ export class PublishFile {
 		return this.metadataCache.getCache(this.file.path)?.frontmatter ?? {};
 	}
 
+	/** Add other possible sorting logic here, eg if we add dg-sortWeight
+	 * We might also want to sort by meta.getPath for rewritten garden path
+	 */
+	compare(other: PublishFile) {
+		return this.file.path.localeCompare(other.file.path);
+	}
+
 	getPath = () => this.file.path;
 	getCompiledFrontmatter() {
 		const frontmatterCompiler = new FrontmatterCompiler(this.settings);

src/publisher/PublishStatusManager.ts

@@ -89,10 +89,11 @@ export default class PublishStatusManager implements IPublishStatusManager {
 			remoteImageHashes,
 			marked.images,
 		);
-		unpublishedNotes.sort((a, b) => (a.getPath() > b.getPath() ? 1 : -1));
-		publishedNotes.sort((a, b) => (a.getPath() > b.getPath() ? 1 : -1));
-		changedNotes.sort((a, b) => (a.getPath() > b.getPath() ? 1 : -1));
-		deletedNotePaths.sort((a, b) => (a > b ? 1 : -1));
+		// These might already be sorted, as getFilesMarkedForPublishing sorts already
+		publishedNotes.sort((a, b) => a.compare(b));
+		publishedNotes.sort((a, b) => a.compare(b));
+		changedNotes.sort((a, b) => a.compare(b));
+		deletedNotePaths.sort((a, b) => a.path.localeCompare(b.path));
 
 		return {
 			unpublishedNotes,

src/publisher/Publisher.ts

@@ -82,7 +82,7 @@ export default class Publisher {
 		}
 
 		return {
-			notes: notesToPublish,
+			notes: notesToPublish.sort((a, b) => a.compare(b)),
 			images: Array.from(imagesToPublish),
 		};
 	}

src/test/snapshot/generateGardenSnapshot.ts

@@ -18,15 +18,12 @@ export const generateGardenSnapshot = async (
 	}
 
 	const marked = await publisher.getFilesMarkedForPublishing();
-	let fileString = "---\n";
-
-	const notesSortedByCreationDate = marked.notes.sort(
-		(note) => note.file.stat.ctime,
-	);
+	let fileString = "IMAGES: \n";
+	fileString += marked.images.map((path) => `${path}\n`);
 
 	const assetPaths = new Set<string>();
 
-	for (const file of notesSortedByCreationDate) {
+	for (const file of marked.notes) {
 		fileString += "==========\n";
 		fileString += `${file.getPath()}\n`;
 		fileString += "==========\n";
@@ -36,9 +33,9 @@ export const generateGardenSnapshot = async (
 		assets.images.map((image) => assetPaths.add(image.path));
 
 		fileString += `${content}\n`;
+		fileString += Array.from(assetPaths).map((path) => `${path}\n`);
 	}
 	fileString += "==========\n";
-	fileString += Array.from(assetPaths).map((path) => `${path}\n`);
 
 	const fullSnapshotPath = `${devPluginPath}/${SNAPSHOT_PATH}`;