Expose publicationDate in FileNameTemplateVariables

src/fileManager/index.ts

@@ -1,6 +1,6 @@
 import { MetadataCache, normalizePath, TAbstractFile, TFile, TFolder, Vault } from 'obsidian';
 
-import type { Book, KindleFile, KindleFrontmatter } from '~/models';
+import type { Book, BookMetadata, KindleFile, KindleFrontmatter } from '~/models';
 import { mergeFrontmatter } from '~/utils';
 
 import { bookFilePath, bookToFrontMatter, frontMatterToBook } from './mappers';
@@ -52,10 +52,11 @@ export default class FileManager {
 
   public async createFile(
     book: Book,
+    metadata: BookMetadata,
     content: string,
     highlightsCount: number
   ): Promise<void> {
-    const filePath = this.generateUniqueFilePath(book);
+    const filePath = this.generateUniqueFilePath(book, metadata);
     const frontmatterContent = this.generateBookContent(book, content, highlightsCount);
 
     try {
@@ -92,8 +93,8 @@ export default class FileManager {
     });
   }
 
-  private generateUniqueFilePath(book: Book): string {
-    const filePath = bookFilePath(book);
+  private generateUniqueFilePath(book: Book, metadata: BookMetadata): string {
+    const filePath = bookFilePath(book, metadata);
 
     const isDuplicate = this.vault
       .getMarkdownFiles()

src/fileManager/mappers.ts

@@ -2,16 +2,16 @@ import moment from 'moment';
 import path from 'path';
 import { get } from 'svelte/store';
 
-import type { Book, KindleFrontmatter } from '~/models';
+import type { Book, BookMetadata, KindleFrontmatter } from '~/models';
 import { getRenderers } from '~/rendering';
 import { settingsStore } from '~/store';
 
 /**
  * Returns a file path for a given book relative to the current Obsidian
  * vault directory.
  */
-export const bookFilePath = (book: Book): string => {
-  const fileName = getRenderers().fileNameRenderer.render(book);
+export const bookFilePath = (book: Book, metadata: BookMetadata): string => {
+  const fileName = getRenderers().fileNameRenderer.render(book, metadata);
   return path.join(get(settingsStore).highlightsFolder, fileName);
 };
 

src/rendering/renderer/fileNameRenderer.spec.ts

@@ -1,4 +1,4 @@
-import type { Book } from '~/models';
+import type { Book, BookMetadata } from '~/models';
 
 import FileNameRenderer from './fileNameRenderer';
 
@@ -25,28 +25,50 @@ describe('FileNameRenderer', () => {
       const book: Partial<Book> = {
         title: 'Immunity to change: How to overcome it',
       };
+      const metadata: Partial<BookMetadata> = {
+        publicationDate: '2010'
+      };
 
       const renderer = new FileNameRenderer('{{shortTitle}}');
-      expect(renderer.render(book)).toBe('Immunity to change.md');
+      expect(renderer.render(book, metadata)).toBe('Immunity to change.md');
     });
 
     it('File name with book title as is', () => {
       const book: Partial<Book> = {
         title: 'Immunity to change: How to overcome it',
       };
+      const metadata: Partial<BookMetadata> = {
+        publicationDate: '2010'
+      };
 
       const renderer = new FileNameRenderer('{{longTitle}}');
-      expect(renderer.render(book)).toBe('Immunity to change How to overcome it.md');
+      expect(renderer.render(book, metadata)).toBe('Immunity to change How to overcome it.md');
     });
 
     it('File name with author', () => {
       const book: Partial<Book> = {
         title: 'Immunity to change: How to overcome it',
         author: 'John Doe',
       };
+      const metadata: Partial<BookMetadata> = {
+        publicationDate: '2010'
+      };
 
       const renderer = new FileNameRenderer('{{author}}');
-      expect(renderer.render(book)).toBe('John Doe.md');
+      expect(renderer.render(book, metadata)).toBe('John Doe.md');
+    });
+
+    it('File name with publication date', () => {
+      const book: Partial<Book> = {
+        title: 'Immunity to change: How to overcome it',
+        author: 'John Doe',
+      };
+      const metadata: Partial<BookMetadata> = {
+        publicationDate: '2010'
+      };
+
+      const renderer = new FileNameRenderer('{{publicationDate}} - {{author}}');
+      expect(renderer.render(book, metadata)).toBe('2010 - John Doe.md');
     });
   });
 });

src/rendering/renderer/fileNameRenderer.ts

@@ -1,7 +1,7 @@
 import nunjucks, { Environment } from 'nunjucks';
 import sanitize from 'sanitize-filename';
 
-import type { Book } from '~/models';
+import type { Book, BookMetadata } from '~/models';
 
 import { fileNameTemplateVariables } from './templateVariables';
 
@@ -21,8 +21,8 @@ export default class FileNameRenderer {
     }
   }
 
-  public render(book: Partial<Book>): string {
-    const templateVariables = fileNameTemplateVariables(book);
+  public render(book: Partial<Book>, metadata: Partial<BookMetadata>): string {
+    const templateVariables = fileNameTemplateVariables(book, metadata);
 
     const fileName = this.nunjucks.renderString(this.template, templateVariables);
 

src/rendering/renderer/templateVariables.ts

@@ -1,6 +1,6 @@
 import moment from 'moment';
 
-import type { Book, BookHighlight, Highlight } from '~/models';
+import type { Book, BookHighlight, BookMetadata, Highlight } from '~/models';
 import { parseAuthors, shortenTitle } from '~/utils';
 
 import { generateAppLink } from './utils';
@@ -21,6 +21,7 @@ type CommonTemplateVariables = AuthorsTemplateVariables & {
 
 type FileNameTemplateVariables = CommonTemplateVariables & {
   shortTitle: string; // TODO: Eventually deprecate
+  publicationDate?: string;
 };
 
 type FileTemplateVariables = CommonTemplateVariables & {
@@ -79,8 +80,14 @@ export const commonTemplateVariables = (book: Partial<Book>): FileNameTemplateVa
   };
 };
 
-export const fileNameTemplateVariables = (book: Partial<Book>): FileNameTemplateVariables => {
-  return commonTemplateVariables(book);
+export const fileNameTemplateVariables = (
+  book: Partial<Book>,
+  metadata: Partial<BookMetadata>
+): FileNameTemplateVariables => {
+  return {
+    publicationDate: metadata?.publicationDate,
+    ...commonTemplateVariables(book),
+  };
 };
 
 export const highlightTemplateVariables = (

src/settings/templateEditorModal/components/TipsModal/Modal.svelte

@@ -12,6 +12,10 @@
     <table>
       <tbody>
         <CommonVariables />
+        <tr>
+          <td><Chip title={'publicationDate'} /></td>
+          <td>Publication date</td>
+        </tr>
       </tbody>
     </table>
   {:else if template === 'file'}

src/settings/templateEditorModal/data.ts

@@ -7,6 +7,9 @@ const data: BookHighlight[] = [
       title: 'Animal Farm (Classics To Go)',
       author: 'George Orwell',
     },
+    metadata: {
+      publicationDate: '1945',
+    },
     highlights: [
       {
         id: '1-A',
@@ -24,6 +27,9 @@ const data: BookHighlight[] = [
       title: 'An Everyone Culture',
       author: 'Robert Kegan and Lisa Laskow Lahey',
     },
+    metadata: {
+      publicationDate: '2016',
+    },
     highlights: [
       {
         id: '2-A',
@@ -45,6 +51,9 @@ const data: BookHighlight[] = [
       title: 'The Girl on the Train: A Novel',
       author: 'Paula Hawkins',
     },
+    metadata: {
+      publicationDate: '2015',
+    },
     highlights: [
       {
         id: '3-A',

src/settings/templateEditorModal/store.ts

@@ -51,7 +51,7 @@ export default (): TemplateEditorModalStore => {
       const fileNameTemplate = $fileNameTemplateField || DefaultFileNameTemplate;
       try {
         const renderer = new FileNameRenderer(fileNameTemplate);
-        return renderer.render($selectedBook.book);
+        return renderer.render($selectedBook.book, $selectedBook.metadata);
       } catch (error) {
         return InvalidRender;
       }

src/sync/syncManager/index.ts

@@ -62,7 +62,7 @@ export default class SyncManager {
 
     const content = getRenderers().fileRenderer.render({ book, highlights, metadata });
 
-    await this.fileManager.createFile(book, content, highlights.length);
+    await this.fileManager.createFile(book, metadata, content, highlights.length);
   }
 
   private async syncMetadata(book: Book): Promise<BookMetadata> {