Merge pull request #160 from forketyfork/custom-metadata-field-names-e7a1

Add custom metadata field names

Author: forketyfork

README.md

@@ -222,6 +222,7 @@ Go to Settings > Food Tracker to configure:
   - `YYYY-MM-DD-[journal]` → `2025-11-12-journal`
   - `dddd YYYY-MM-DD` → `Wednesday 2025-11-12`
 - **Goals file**: Specify the path to your nutrition goals file (e.g., "nutrition-goals.md"). The field includes type-ahead file suggestions.
+- **Metadata field names**: Customize the frontmatter property names used for storing nutrition totals in daily notes. By default, the plugin uses `ft-` prefixed names (e.g., `ft-calories`, `ft-protein`). You can customize these to match your existing setup or personal preferences (e.g., just `calories` instead of `ft-calories`).
 
 > **Note**: When you change the food or workout tag settings, the plugin will only recognize the new tags. Existing entries will need to be updated if you want them included in calculations.
 

src/FoodTrackerPlugin.ts

@@ -8,7 +8,7 @@ import FoodHighlightExtension from "./FoodHighlightExtension";
 import FoodHighlightPostProcessor from "./FoodHighlightPostProcessor";
 import GoalsHighlightExtension from "./GoalsHighlightExtension";
 import DocumentTotalManager from "./DocumentTotalManager";
-import { SettingsService, FoodTrackerPluginSettings, DEFAULT_SETTINGS } from "./SettingsService";
+import { SettingsService, FoodTrackerPluginSettings, DEFAULT_SETTINGS, sanitizeSettings } from "./SettingsService";
 import GoalsService from "./GoalsService";
 import { FOOD_TRACKER_ICON_NAME, FOOD_TRACKER_SVG_CONTENT } from "./icon";
 import StatisticsModal from "./StatisticsModal";
@@ -275,7 +275,13 @@ export default class FoodTrackerPlugin extends Plugin {
 			totalDisplayMode: Platform.isMobile ? "document" : DEFAULT_SETTINGS.totalDisplayMode,
 		} as FoodTrackerPluginSettings;
 
-		this.settings = Object.assign({}, mobileAwareDefaults, savedData);
+		const merged = Object.assign({}, mobileAwareDefaults, savedData);
+		merged.frontmatterFieldNames = {
+			...DEFAULT_SETTINGS.frontmatterFieldNames,
+			...(savedData.frontmatterFieldNames ?? {}),
+		};
+
+		this.settings = sanitizeSettings(merged);
 	}
 
 	async saveSettings() {

src/FoodTrackerSettingTab.ts

@@ -2,6 +2,7 @@ import { App, PluginSettingTab, Setting, moment, normalizePath } from "obsidian"
 import type FoodTrackerPlugin from "./FoodTrackerPlugin";
 import FolderSuggest from "./FolderSuggest";
 import FileSuggest from "./FileSuggest";
+import { DEFAULT_FRONTMATTER_FIELD_NAMES, type FrontmatterFieldNames } from "./SettingsService";
 
 const obsidianMoment = moment as unknown as typeof import("moment");
 /**
@@ -141,5 +142,60 @@ export default class FoodTrackerSettingTab extends PluginSettingTab {
 					});
 				new FileSuggest(this.app, text.inputEl);
 			});
+
+		this.addFrontmatterFieldNamesSection(containerEl);
+	}
+
+	private addFrontmatterFieldNamesSection(containerEl: HTMLElement): void {
+		const detailsEl = containerEl.createEl("details", {
+			cls: "food-tracker-settings-collapsible",
+		});
+		detailsEl.createEl("summary", {
+			text: "Metadata field names",
+			cls: "food-tracker-settings-collapsible-summary",
+		});
+
+		const descEl = detailsEl.createEl("p", {
+			cls: "food-tracker-settings-collapsible-desc setting-item-description",
+			text: "Customize the frontmatter field names used to store nutrition totals in daily notes.",
+		});
+		descEl.style.marginTop = "0.5em";
+		descEl.style.marginBottom = "1em";
+
+		const fieldConfigs: Array<{
+			key: keyof FrontmatterFieldNames;
+			name: string;
+			desc: string;
+		}> = [
+			{ key: "calories", name: "Calories field", desc: "Field name for total calories" },
+			{ key: "fats", name: "Fats field", desc: "Field name for total fats (g)" },
+			{ key: "saturated_fats", name: "Saturated fats field", desc: "Field name for saturated fats (g)" },
+			{ key: "protein", name: "Protein field", desc: "Field name for total protein (g)" },
+			{ key: "carbs", name: "Carbs field", desc: "Field name for total carbohydrates (g)" },
+			{ key: "fiber", name: "Fiber field", desc: "Field name for total fiber (g)" },
+			{ key: "sugar", name: "Sugar field", desc: "Field name for total sugar (g)" },
+			{ key: "sodium", name: "Sodium field", desc: "Field name for total sodium (mg)" },
+		];
+
+		for (const config of fieldConfigs) {
+			new Setting(detailsEl)
+				.setName(config.name)
+				.setDesc(config.desc)
+				.addText(text =>
+					text
+						.setPlaceholder(DEFAULT_FRONTMATTER_FIELD_NAMES[config.key])
+						.setValue(this.plugin.settings.frontmatterFieldNames[config.key])
+						.onChange(async value => {
+							const frontmatterFieldNames = this.plugin.settings.frontmatterFieldNames;
+							frontmatterFieldNames[config.key] = value;
+							this.plugin.settingsService.updateFrontmatterFieldNames(frontmatterFieldNames);
+							this.plugin.settings = {
+								...this.plugin.settings,
+								frontmatterFieldNames: this.plugin.settingsService.currentFrontmatterFieldNames,
+							};
+							await this.plugin.saveSettings();
+						})
+				);
+		}
 	}
 }

src/FrontmatterTotalsService.ts

@@ -1,24 +1,14 @@
 import { App, TFile } from "obsidian";
 import { NutrientData, calculateNutritionTotals } from "./NutritionCalculator";
 import NutrientCache from "./NutrientCache";
-import { SettingsService } from "./SettingsService";
+import { DEFAULT_FRONTMATTER_FIELD_NAMES, FrontmatterFieldNames, SettingsService } from "./SettingsService";
 import GoalsService from "./GoalsService";
 import DailyNoteLocator from "./DailyNoteLocator";
 
 export const FRONTMATTER_PREFIX = "ft-";
+export const FRONTMATTER_KEYS = DEFAULT_FRONTMATTER_FIELD_NAMES;
 
-export const FRONTMATTER_KEYS = {
-	calories: `${FRONTMATTER_PREFIX}calories`,
-	fats: `${FRONTMATTER_PREFIX}fats`,
-	saturated_fats: `${FRONTMATTER_PREFIX}saturated_fats`,
-	protein: `${FRONTMATTER_PREFIX}protein`,
-	carbs: `${FRONTMATTER_PREFIX}carbs`,
-	fiber: `${FRONTMATTER_PREFIX}fiber`,
-	sugar: `${FRONTMATTER_PREFIX}sugar`,
-	sodium: `${FRONTMATTER_PREFIX}sodium`,
-} as const;
-
-export type FrontmatterKey = keyof typeof FRONTMATTER_KEYS;
+export type FrontmatterKey = keyof FrontmatterFieldNames;
 
 export interface FrontmatterTotals {
 	calories?: number;
@@ -31,11 +21,16 @@ export interface FrontmatterTotals {
 	sodium?: number;
 }
 
-export function extractFrontmatterTotals(frontmatter: Record<string, unknown>): FrontmatterTotals | null {
+export function extractFrontmatterTotals(
+	frontmatter: Record<string, unknown>,
+	fieldNames: FrontmatterFieldNames = DEFAULT_FRONTMATTER_FIELD_NAMES
+): FrontmatterTotals | null {
 	const totals: FrontmatterTotals = {};
 	let hasAnyValue = false;
 
-	for (const [key, frontmatterKey] of Object.entries(FRONTMATTER_KEYS)) {
+	const keys = Object.keys(fieldNames) as FrontmatterKey[];
+	for (const key of keys) {
+		const frontmatterKey = fieldNames[key];
 		const value = frontmatter[frontmatterKey];
 		if (value !== undefined && value !== null) {
 			let numValue: number;
@@ -47,7 +42,7 @@ export function extractFrontmatterTotals(frontmatter: Record<string, unknown>):
 				continue;
 			}
 			if (!isNaN(numValue)) {
-				totals[key as FrontmatterKey] = numValue;
+				totals[key] = numValue;
 				hasAnyValue = true;
 			}
 		}
@@ -73,10 +68,14 @@ export function nutrientDataToFrontmatterTotals(data: NutrientData): Frontmatter
 
 export function applyNutrientTotalsToFrontmatter(
 	frontmatter: Record<string, unknown>,
-	totals: NutrientData | null
+	totals: NutrientData | null,
+	fieldNames: FrontmatterFieldNames = DEFAULT_FRONTMATTER_FIELD_NAMES
 ): void {
+	const keys = Object.keys(fieldNames) as FrontmatterKey[];
+
 	if (!totals || Object.keys(totals).length === 0) {
-		for (const frontmatterKey of Object.values(FRONTMATTER_KEYS)) {
+		for (const key of keys) {
+			const frontmatterKey = fieldNames[key];
 			if (frontmatterKey in frontmatter) {
 				frontmatter[frontmatterKey] = 0;
 			}
@@ -86,8 +85,9 @@ export function applyNutrientTotalsToFrontmatter(
 
 	const formattedTotals = nutrientDataToFrontmatterTotals(totals);
 
-	for (const [key, frontmatterKey] of Object.entries(FRONTMATTER_KEYS)) {
-		const value = formattedTotals[key as FrontmatterKey];
+	for (const key of keys) {
+		const frontmatterKey = fieldNames[key];
+		const value = formattedTotals[key];
 		if (value !== undefined) {
 			if (value !== 0) {
 				frontmatter[frontmatterKey] = value;
@@ -174,7 +174,7 @@ export default class FrontmatterTotalsService {
 	}
 
 	private updateFrontmatterValues(frontmatter: Record<string, unknown>, totals: NutrientData | null): void {
-		applyNutrientTotalsToFrontmatter(frontmatter, totals);
+		applyNutrientTotalsToFrontmatter(frontmatter, totals, this.settingsService.currentFrontmatterFieldNames);
 	}
 
 	cancelPendingUpdates(): void {

src/SettingsService.ts

@@ -2,6 +2,79 @@ import { BehaviorSubject, Observable } from "rxjs";
 import { map } from "rxjs/operators";
 import { SPECIAL_CHARS_REGEX } from "./constants";
 
+export interface FrontmatterFieldNames {
+	calories: string;
+	fats: string;
+	saturated_fats: string;
+	protein: string;
+	carbs: string;
+	fiber: string;
+	sugar: string;
+	sodium: string;
+}
+
+const FRONTMATTER_KEYS_ORDER: Array<keyof FrontmatterFieldNames> = [
+	"calories",
+	"fats",
+	"saturated_fats",
+	"protein",
+	"carbs",
+	"fiber",
+	"sugar",
+	"sodium",
+];
+
+export const DEFAULT_FRONTMATTER_FIELD_NAMES: FrontmatterFieldNames = Object.freeze({
+	calories: "ft-calories",
+	fats: "ft-fats",
+	saturated_fats: "ft-saturated_fats",
+	protein: "ft-protein",
+	carbs: "ft-carbs",
+	fiber: "ft-fiber",
+	sugar: "ft-sugar",
+	sodium: "ft-sodium",
+});
+
+export function cloneFrontmatterFieldNames(names: FrontmatterFieldNames): FrontmatterFieldNames {
+	return { ...names };
+}
+
+function sanitizeFrontmatterFieldNames(
+	fieldNames: Partial<FrontmatterFieldNames>,
+	base: FrontmatterFieldNames = DEFAULT_FRONTMATTER_FIELD_NAMES
+): FrontmatterFieldNames {
+	const merged: FrontmatterFieldNames = {
+		...base,
+		...fieldNames,
+	};
+
+	const sanitized: FrontmatterFieldNames = { ...merged } as FrontmatterFieldNames;
+	const seen = new Set<string>();
+
+	for (const key of FRONTMATTER_KEYS_ORDER) {
+		const rawValue = merged[key];
+		const trimmed = (rawValue ?? "").trim();
+		const value = trimmed || base[key];
+
+		if (seen.has(value)) {
+			sanitized[key] = base[key];
+			continue;
+		}
+
+		sanitized[key] = value;
+		seen.add(value);
+	}
+
+	return sanitized;
+}
+
+export function sanitizeSettings(settings: FoodTrackerPluginSettings): FoodTrackerPluginSettings {
+	return {
+		...settings,
+		frontmatterFieldNames: sanitizeFrontmatterFieldNames(settings.frontmatterFieldNames),
+	};
+}
+
 export interface FoodTrackerPluginSettings {
 	nutrientDirectory: string;
 	totalDisplayMode: "status-bar" | "document";
@@ -10,6 +83,7 @@ export interface FoodTrackerPluginSettings {
 	goalsFile: string;
 	showCalorieHints: boolean;
 	dailyNoteFormat: string;
+	frontmatterFieldNames: FrontmatterFieldNames;
 	linkType: "wikilink" | "markdown";
 }
 
@@ -21,6 +95,7 @@ export const DEFAULT_SETTINGS: FoodTrackerPluginSettings = {
 	goalsFile: "nutrition-goals.md",
 	showCalorieHints: true,
 	dailyNoteFormat: "YYYY-MM-DD",
+	frontmatterFieldNames: cloneFrontmatterFieldNames(DEFAULT_FRONTMATTER_FIELD_NAMES),
 	linkType: "wikilink",
 };
 
@@ -101,6 +176,13 @@ export class SettingsService {
 		return this.settings$.pipe(map(settings => settings.showCalorieHints));
 	}
 
+	/**
+	 * Observable stream of the frontmatter field names
+	 */
+	get frontmatterFieldNames$(): Observable<FrontmatterFieldNames> {
+		return this.settings$.pipe(map(settings => settings.frontmatterFieldNames));
+	}
+
 	/**
 	 * Get the current settings value synchronously
 	 */
@@ -171,6 +253,13 @@ export class SettingsService {
 		return this.currentSettings.showCalorieHints;
 	}
 
+	/**
+	 * Get the current frontmatter field names synchronously
+	 */
+	get currentFrontmatterFieldNames(): FrontmatterFieldNames {
+		return cloneFrontmatterFieldNames(this.currentSettings.frontmatterFieldNames);
+	}
+
 	/**
 	 * Get the current link type value synchronously
 	 */
@@ -182,7 +271,8 @@ export class SettingsService {
 	 * Updates all settings and notifies all subscribers
 	 */
 	updateSettings(newSettings: FoodTrackerPluginSettings): void {
-		this.settingsSubject.next(newSettings);
+		const sanitized = sanitizeSettings(newSettings);
+		this.settingsSubject.next(sanitized);
 	}
 
 	/**
@@ -245,6 +335,14 @@ export class SettingsService {
 		this.updateSetting("showCalorieHints", show);
 	}
 
+	/**
+	 * Updates frontmatter field names (partial update supported)
+	 */
+	updateFrontmatterFieldNames(fieldNames: Partial<FrontmatterFieldNames>): void {
+		const sanitized = sanitizeFrontmatterFieldNames(fieldNames, this.currentFrontmatterFieldNames);
+		this.updateSetting("frontmatterFieldNames", sanitized);
+	}
+
 	/**
 	 * Initialize the service with settings
 	 */