New Settings to filter note content based on regex (#166)

* Update NotePreview.tsx to remove code blocks

Code blocks often cause errors on "On This Day" page, hence strip them out

* feat: new setting to filter note content based on regex

* chore: version

* chore: prettier and remove deprecated .eslintignore

* chore: fix release workflow

---------

Co-authored-by: Dr. Tarique Sani <[email protected]>

.github/workflows/release.yml

@@ -20,6 +20,6 @@ jobs:
         uses: ncipollo/[email protected]
         with:
           artifacts: "dist/**/*"
-          generate_release_notes: true
+          generateReleaseNotes: true
           draft: true
           token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -20,8 +20,7 @@ main.js
 data.json
 workspace.json
 vault/**/*.md
-vault/.obsidian/plugins/*
-!vault/.obsidian/plugins/journal-review
+vault/.obsidian/plugins/
 
 # Exclude macOS Finder (System Explorer) View States
 .DS_Store

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "journal-review",
 	"name": "Journal Review",
-	"version": "2.4.0",
+	"version": "2.4.1",
 	"minAppVersion": "0.15.0",
 	"description": "Review your daily notes on their anniversaries, like \"what happened today last year\".",
 	"author": "Kageetai",

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "obsidian-plugin-journal-review",
-	"version": "2.4.0",
+	"version": "2.4.1",
 	"description": "Review your daily notes on their anniversaries, like \"what happened today last year\"\n\n",
 	"main": "main.js",
 	"scripts": {

src/components/NotePreview.tsx

@@ -15,6 +15,8 @@ const NotePreview = ({ note }: Props) => {
 		const slicedContent = (await app.vault.cachedRead(note))
 			// remove frontmatter
 			.replace(/---.*?---/s, "")
+			// remove custom regex
+			.replace(new RegExp(settings.noteMarkdownRegex, "sg"), "")
 			// restrict to chosen preview length
 			.substring(0, settings.previewLength);
 

src/constants.ts

@@ -52,6 +52,7 @@ export interface Settings {
 	useNotifications: boolean;
 	renderOnFileSwitch: boolean;
 	date: string;
+	noteMarkdownRegex: string;
 }
 
 export const DEFAULT_SETTINGS: Settings = {
@@ -66,6 +67,7 @@ export const DEFAULT_SETTINGS: Settings = {
 	useNotifications: true,
 	renderOnFileSwitch: false,
 	date: "",
+	noteMarkdownRegex: "",
 };
 
 export const getTimeSpanTitle = ({ number, unit, recurring }: TimeSpan) =>

src/settingsTab.ts

@@ -245,5 +245,19 @@ export class SettingsTab extends PluginSettingTab {
 						void this.plugin.saveSettings();
 					});
 			});
+
+		new Setting(containerEl)
+			.setName("Note filtering regex")
+			.setDesc(
+				"Use any string or regex (without `/` at beginning and end or flags) to filter the note content before rendering.",
+			)
+			.addText((text) =>
+				text
+					.setValue(this.plugin.settings.noteMarkdownRegex)
+					.onChange((value) => {
+						this.plugin.settings.noteMarkdownRegex = value;
+						void this.plugin.saveSettings();
+					}),
+			);
 	}
 }

versions.json

@@ -18,5 +18,6 @@
 	"2.3.0": "0.15.0",
 	"2.3.1": "0.15.0",
 	"2.3.2": "0.15.0",
-	"2.4.0": "0.15.0"
+	"2.4.0": "0.15.0",
+	"2.4.1": "0.15.0"
 }