Merge pull request #23 from LonoxX/develop

feat: Global Settings should override pre-repository settings

Author: LonoxX

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "github-issues",
 	"name": "Github Issues",
-	"version": "1.3.0",
+	"version": "1.2.3",
 	"minAppVersion": "0.15.0",
 	"description": "Track Github Issues and pull requests directly in your vault",
 	"author": "LonoxX",

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "github-issues",
-	"version": "1.3.0",
+	"version": "1.2.3",
 	"description": "Track GitHub issues and pull requests in Obsidian",
 	"main": "main.js",
 	"scripts": {

src/file-manager.ts

@@ -14,6 +14,7 @@ import {
 	extractNumberFromFilename
 } from "./util/templateUtils";
 import { getEffectiveRepoSettings } from "./util/settingsUtils";
+import { extractPersistBlocks, mergePersistBlocks, shouldUpdateContent } from "./util/persistUtils";
 
 export class FileManager {
 	constructor(
@@ -430,12 +431,35 @@ export class FileManager {
 				const updateMode = repo.issueUpdateMode;
 
 				if (updateMode === "update") {
+					// Read existing content first
+					const existingContent = await this.app.vault.read(file);
+
+					// Check if content needs updating based on updated_at field
+					if (!shouldUpdateContent(existingContent, issue.updated_at)) {
+						this.noticeManager.debug(
+							`Skipped update for issue ${issue.number}: no changes detected (updated_at match)`
+						);
+						return;
+					}
+
+					// Extract persist blocks from existing content
+					const persistBlocks = extractPersistBlocks(existingContent);
+
 					// Create the complete new content with updated frontmatter
-					const updatedContent = await this.createIssueContent(
+					let updatedContent = await this.createIssueContent(
 						issue,
 						repo,
 						comments,
 					);
+
+					// Merge persist blocks back into new content
+					if (persistBlocks.size > 0) {
+						updatedContent = mergePersistBlocks(updatedContent, existingContent, persistBlocks);
+						this.noticeManager.debug(
+							`Restored ${persistBlocks.size} persist block(s) for issue ${issue.number}`
+						);
+					}
+
 					await this.app.vault.modify(file, updatedContent);
 					this.noticeManager.debug(`Updated issue ${issue.number}`);
 				} else if (updateMode === "append") {
@@ -527,12 +551,35 @@ export class FileManager {
 				const updateMode = repo.pullRequestUpdateMode;
 
 				if (updateMode === "update") {
+					// Read existing content first
+					const existingContent = await this.app.vault.read(file);
+
+					// Check if content needs updating based on updated_at field
+					if (!shouldUpdateContent(existingContent, pr.updated_at)) {
+						this.noticeManager.debug(
+							`Skipped update for PR ${pr.number}: no changes detected (updated_at match)`
+						);
+						return;
+					}
+
+					// Extract persist blocks from existing content
+					const persistBlocks = extractPersistBlocks(existingContent);
+
 					// Create the complete new content with updated frontmatter
-					const updatedContent = await this.createPullRequestContent(
+					let updatedContent = await this.createPullRequestContent(
 						pr,
 						repo,
 						comments,
 					);
+
+					// Merge persist blocks back into new content
+					if (persistBlocks.size > 0) {
+						updatedContent = mergePersistBlocks(updatedContent, existingContent, persistBlocks);
+						this.noticeManager.debug(
+							`Restored ${persistBlocks.size} persist block(s) for PR ${pr.number}`
+						);
+					}
+
 					await this.app.vault.modify(file, updatedContent);
 					this.noticeManager.debug(`Updated PR ${pr.number}`);
 				} else if (updateMode === "append") {
@@ -619,6 +666,11 @@ created: "${
 				? format(new Date(issue.created_at), this.settings.dateFormat)
 				: new Date(issue.created_at).toLocaleString()
 		}"
+updated: "${
+			this.settings.dateFormat !== ""
+				? format(new Date(issue.updated_at), this.settings.dateFormat)
+				: new Date(issue.updated_at).toLocaleString()
+		}"
 url: "${issue.html_url}"
 opened_by: "${issue.user?.login}"
 assignees: [${(
@@ -675,6 +727,11 @@ created: "${
 				? format(new Date(pr.created_at), this.settings.dateFormat)
 				: new Date(pr.created_at).toLocaleString()
 		}"
+updated: "${
+			this.settings.dateFormat !== ""
+				? format(new Date(pr.updated_at), this.settings.dateFormat)
+				: new Date(pr.updated_at).toLocaleString()
+		}"
 url: "${pr.html_url}"
 opened_by: "${pr.user?.login}"
 assignees: [${(

src/settings-tab.ts

@@ -338,6 +338,9 @@ export class GitHubTrackerSettingTab extends PluginSettingTab {
 		// Template variables help
 		this.addTemplateVariablesHelp(advancedContainer, 'issue');
 
+		// Persist blocks help
+		this.addPersistBlocksHelp(advancedContainer);
+
 		new Setting(advancedContainer)
 			.setName("Date format")
 			.setDesc("Format for dates in issue files (e.g., yyyy-MM-dd HH:mm:ss)")
@@ -3046,6 +3049,60 @@ export class GitHubTrackerSettingTab extends PluginSettingTab {
 		helpText.textContent = getTemplateHelp();
 	}
 
+	private addPersistBlocksHelp(container: HTMLElement): void {
+		const helpContainer = container.createDiv("github-issues-template-help");
+
+		const details = helpContainer.createEl("details");
+		const summary = details.createEl("summary");
+		summary.textContent = "Protect your custom notes with Persist Blocks";
+		summary.addClass("github-issues-template-help-summary");
+
+		const contentContainer = details.createDiv("github-issues-template-variables");
+
+		// Introduction
+		const intro = contentContainer.createEl("p");
+		intro.innerHTML = `<strong>Persist blocks</strong> allow you to add your own custom notes to GitHub issue and PR files without them being overwritten during sync.`;
+
+		// Basic usage
+		const usageTitle = contentContainer.createEl("h4");
+		usageTitle.textContent = "Basic Usage";
+
+		const usageExample = contentContainer.createEl("pre");
+		usageExample.textContent = `{% persist "notes" %}
+## My Notes
+- Your custom content here
+- Will never be overwritten!
+{% endpersist %}`;
+
+		// How it works
+		const howTitle = contentContainer.createEl("h4");
+		howTitle.textContent = "How It Works";
+
+		const howList = contentContainer.createEl("ul");
+		howList.innerHTML = `
+			<li><strong>Smart Updates:</strong> Files are only updated if GitHub data has changed (checks the <code>updated</code> field)</li>
+			<li><strong>Content Protection:</strong> Everything inside persist blocks is preserved during sync</li>
+			<li><strong>Position Preservation:</strong> Blocks stay exactly where you placed them using surrounding text as anchors</li>
+		`;
+
+		// Multiple blocks
+		const multipleTitle = contentContainer.createEl("h4");
+		multipleTitle.textContent = "Multiple Blocks";
+
+		const multipleDesc = contentContainer.createEl("p");
+		multipleDesc.textContent = "You can have multiple persist blocks in one file. Each needs a unique name:";
+
+		const multipleExample = contentContainer.createEl("pre");
+		multipleExample.textContent = `{% persist "notes" %}
+Your notes here...
+{% endpersist %}
+
+{% persist "todos" %}
+- [ ] Task 1
+- [ ] Task 2
+{% endpersist %}`;
+}
+
 	private async updateTokenBadge(container?: HTMLElement): Promise<void> {
 		const badgeContainer = container || this.containerEl.querySelector(".github-issues-token-badge-container") as HTMLElement;
 		if (!badgeContainer) return;