Merge pull request #88 from omnivore-app/feature/filename-variable

feature/filename variable
omnivore-app · Jun 19, 2023 · c4ae042 · c4ae042
2 parents 8f46778 + 3f8fb56
commit c4ae042
Show file tree

Hide file tree

Showing 7 changed files with 61 additions and 79 deletions.
diff --git a/esbuild.config.mjs b/esbuild.config.mjs
@@ -31,7 +31,6 @@ esbuild.build({
 		'@lezer/common',
 		'@lezer/highlight',
 		'@lezer/lr',
-		'out-of-character',
 		...builtins],
 	format: 'cjs',
 	watch: !prod,

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -49,7 +49,6 @@
 		"luxon": "^3.1.1",
 		"markdown-escape": "^2.0.0",
 		"mustache": "^4.2.0",
-		"out-of-character": "^1.2.1",
 		"process": "^0.11.10"
 	},
 	"volta": {

diff --git a/src/main.ts b/src/main.ts
@@ -24,14 +24,12 @@ import { FolderSuggest } from "./settings/file-suggest";
 import {
   preParseTemplate,
   renderArticleContnet,
-  renderAttachmentFolder,
   renderFilename,
   renderFolderName,
 } from "./settings/template";
 import {
   DATE_FORMAT,
   findFrontMatterIndex,
-  formatDate,
   getQueryFromFilter,
   parseDateTime,
   parseFrontMatterFromContent,
@@ -139,7 +137,7 @@ export default class OmnivorePlugin extends Plugin {
       contentType: "application/pdf",
     });
     const folderName = normalizePath(
-      renderAttachmentFolder(
+      renderFolderName(
         article,
         this.settings.attachmentFolder,
         this.settings.folderDateFormat
@@ -172,7 +170,6 @@ export default class OmnivorePlugin extends Plugin {
       template,
       folder,
       filename,
-      folderDateFormat,
       isSingleFile,
       frontMatterVariables,
       frontMatterTemplate,
@@ -225,12 +222,8 @@ export default class OmnivorePlugin extends Plugin {
         );
 
         for (const article of articles) {
-          const folderDate = formatDate(
-            article.savedAt,
-            this.settings.folderDateFormat
-          );
           const folderName = normalizePath(
-            renderFolderName(folder, folderDate)
+            renderFolderName(article, folder, this.settings.folderDateFormat)
           );
           const omnivoreFolder =
             this.app.vault.getAbstractFileByPath(folderName);
@@ -254,7 +247,7 @@ export default class OmnivorePlugin extends Plugin {
           );
           // use the custom filename
           const customFilename = replaceIllegalChars(
-            renderFilename(article, filename, folderDateFormat)
+            renderFilename(article, filename, this.settings.filenameDateFormat)
           );
           const pageName = `${folderName}/${customFilename}.md`;
           const normalizedPath = normalizePath(pageName);
@@ -597,7 +590,7 @@ class OmnivoreSettingTab extends PluginSettingTab {
     new Setting(containerEl)
       .setName("Folder")
       .setDesc(
-        "Enter the folder where the data will be stored. {{{date}}} could be used in the folder name"
+        "Enter the folder where the data will be stored. {{{title}}}, {{{dateSaved}}} and {{{datePublished}}} could be used in the folder name"
       )
       .addSearch((search) => {
         new FolderSuggest(this.app, search.inputEl);
@@ -612,7 +605,7 @@ class OmnivoreSettingTab extends PluginSettingTab {
     new Setting(containerEl)
       .setName("Attachment Folder")
       .setDesc(
-        "Enter the folder where the attachment will be downloaded to. {{{date}}} could be used in the folder name"
+        "Enter the folder where the attachment will be downloaded to. {{{title}}}, {{{dateSaved}}} and {{{datePublished}}} could be used in the folder name"
       )
       .addSearch((search) => {
         new FolderSuggest(this.app, search.inputEl);
@@ -642,7 +635,7 @@ class OmnivoreSettingTab extends PluginSettingTab {
     new Setting(containerEl)
       .setName("Filename")
       .setDesc(
-        "Enter the filename where the data will be stored. {{{title}}} and {{{date}}} could be used in the filename"
+        "Enter the filename where the data will be stored. {{{title}}}, {{{dateSaved}}} and {{{datePublished}}} could be used in the filename"
       )
       .addText((text) =>
         text
@@ -653,12 +646,36 @@ class OmnivoreSettingTab extends PluginSettingTab {
             await this.plugin.saveSettings();
           })
       );
+
+    new Setting(containerEl)
+      .setName("Filename Date Format")
+      .setDesc(
+        createFragment((fragment) => {
+          fragment.append(
+            "Enter the format date for use in rendered filename. Format ",
+            fragment.createEl("a", {
+              text: "reference",
+              href: "https://moment.github.io/luxon/#/formatting?id=table-of-tokens",
+            })
+          );
+        })
+      )
+      .addText((text) =>
+        text
+          .setPlaceholder("yyyy-MM-dd")
+          .setValue(this.plugin.settings.filenameDateFormat)
+          .onChange(async (value) => {
+            this.plugin.settings.filenameDateFormat = value;
+            await this.plugin.saveSettings();
+          })
+      );
+
     new Setting(containerEl)
       .setName("Folder Date Format")
       .setDesc(
         createFragment((fragment) => {
           fragment.append(
-            "Enter the format date for use in rendered template. Format ",
+            "Enter the format date for use in rendered folder name. Format ",
             fragment.createEl("a", {
               text: "reference",
               href: "https://moment.github.io/luxon/#/formatting?id=table-of-tokens",

diff --git a/src/settings/index.ts b/src/settings/index.ts
@@ -33,6 +33,7 @@ export const DEFAULT_SETTINGS: OmnivoreSettings = {
   folderDateFormat: "yyyy-MM-dd",
   endpoint: "https://api-prod.omnivore.app/api/graphql",
   filename: "{{{title}}}",
+  filenameDateFormat: "yyyy-MM-dd",
   attachmentFolder: "Omnivore/attachments",
   version: "0.0.0",
   isSingleFile: false,
@@ -74,4 +75,5 @@ export interface OmnivoreSettings {
   intervalId: number;
   frontMatterVariables: string[];
   frontMatterTemplate: string;
+  filenameDateFormat: string;
 }
diff --git a/src/settings/template.ts b/src/settings/template.ts
@@ -124,12 +124,17 @@ const functionMap: FunctionMap = {
 export const renderFilename = (
   article: Article,
   filename: string,
-  folderDateFormat: string
+  dateFormat: string
 ) => {
-  const date = formatDate(article.savedAt, folderDateFormat);
+  const date = formatDate(article.savedAt, dateFormat);
+  const datePublished = article.publishedAt
+    ? formatDate(article.publishedAt, dateFormat).trim()
+    : undefined;
   const renderedFilename = Mustache.render(filename, {
     ...article,
     date,
+    dateSaved: date,
+    datePublished,
   });
 
   // truncate the filename to 100 characters
@@ -138,18 +143,6 @@ export const renderFilename = (
   });
 };
 
-export const renderAttachmentFolder = (
-  article: Article,
-  attachmentFolder: string,
-  folderDateFormat: string
-) => {
-  const date = formatDate(article.savedAt, folderDateFormat);
-  return Mustache.render(attachmentFolder, {
-    ...article,
-    date,
-  });
-};
-
 export const renderLabels = (labels?: LabelView[]) => {
   return labels?.map((l) => ({
     // replace spaces with underscores because Obsidian doesn't allow spaces in tags
@@ -321,9 +314,19 @@ export const renderArticleContnet = async (
   return `${frontMatterStr}\n\n${contentWithoutFrontMatter}`;
 };
 
-export const renderFolderName = (folder: string, folderDate: string) => {
-  return Mustache.render(folder, {
-    date: folderDate,
+export const renderFolderName = (
+  article: Article,
+  template: string,
+  dateFormat: string
+) => {
+  const date = formatDate(article.savedAt, dateFormat);
+  const datePublished = article.publishedAt
+    ? formatDate(article.publishedAt, dateFormat).trim()
+    : undefined;
+  return Mustache.render(template, {
+    date,
+    dateSaved: date,
+    datePublished,
   });
 };
 

diff --git a/src/util.ts b/src/util.ts
@@ -2,7 +2,6 @@ import { diff_match_patch } from "diff-match-patch";
 import { DateTime } from "luxon";
 import escape from "markdown-escape";
 import { parseYaml } from "obsidian";
-import { replace } from "out-of-character";
 import { Highlight } from "./api";
 
 export const DATE_FORMAT_W_OUT_SECONDS = "yyyy-MM-dd'T'HH:mm";
@@ -92,8 +91,9 @@ export const unicodeSlug = (str: string, savedAt: string) => {
 };
 
 export const replaceIllegalChars = (str: string): string => {
-  // remove invisible characters
-  return replace(str.replace(ILLEGAL_CHAR_REGEX, REPLACEMENT_CHAR));
+  return removeInvisibleChars(
+    str.replace(ILLEGAL_CHAR_REGEX, REPLACEMENT_CHAR)
+  );
 };
 
 export function formatDate(date: string, format: string): string {
@@ -167,3 +167,8 @@ export const removeFrontMatterFromContent = (content: string): string => {
 
 export const snakeToCamelCase = (str: string) =>
   str.replace(/(_[a-z])/g, (group) => group.toUpperCase().replace("_", ""));
+
+const removeInvisibleChars = (str: string): string => {
+  // eslint-disable-next-line no-control-regex
+  return str.replace(/[^\u0000-\u007E]/g, "");
+};