feat(integration): added support for Obsidian Bases (#103)

saberzero1 · web-flow · commit 53911d0df071 · 2026-02-17T14:23:13.000+01:00
* feat(integration): added support for Obsidian Bases

* feat(integration): Added plugin categories
diff --git a/docs/Settings/Integrations/base.base b/docs/Settings/Integrations/base.base
@@ -1,6 +1,9 @@
 views:
   - type: table
     name: Table
+    filters:
+      not:
+        - file.name.startsWith("_")
   - type: cards
     name: Card View
     filters:
diff --git a/main.ts b/main.ts
@@ -106,6 +106,13 @@ const DEFAULT_SETTINGS: QuartzSyncerSettings = {
 	 * Fantasy Statblocks documentation: {@link https://plugins.javalent.com/statblocks}
 	 */
 	useFantasyStatblocks: false,
+	/**
+	 * Enable Bases integration.
+	 * This will allow the plugin to publish Obsidian Bases (.base files) to Quartz.
+	 *
+	 * Bases documentation: {@link https://help.obsidian.md/bases}
+	 */
+	useBases: false,
 
 	manageSyncerStyles: true,
 
diff --git a/src/compiler/SyncerPageCompiler.ts b/src/compiler/SyncerPageCompiler.ts
@@ -139,6 +139,10 @@ export class SyncerPageCompiler {
 	async generateMarkdown(file: PublishFile): Promise<TCompiledFile> {
 		const vaultFileText = await file.cachedRead();
 
+		if (file.getType() === "base") {
+			return [vaultFileText, { blobs: [] }];
+		}
+
 		if (this.settings.useExcalidraw) {
 			if (file.file.name.endsWith(".excalidraw.md")) {
 				console.warn("Excalidraw files are not supported yet.");
diff --git a/src/compiler/integrations/auto-card-link.ts b/src/compiler/integrations/auto-card-link.ts
@@ -243,6 +243,7 @@ export const AutoCardLinkIntegration: PluginIntegration = {
 	name: "Auto Card Link",
 	settingKey: "useAutoCardLink",
 	priority: 100,
+	category: "community",
 
 	assets: {
 		scss: autoCardLinkScss,
diff --git a/src/compiler/integrations/bases.ts b/src/compiler/integrations/bases.ts
@@ -0,0 +1,41 @@
+import {
+	PluginIntegration,
+	PatternDescriptor,
+	PatternMatch,
+	QuartzAssets,
+} from "./types";
+
+function isBasesPluginEnabled(): boolean {
+	// @ts-expect-error global app is available in Obsidian
+	const internalPlugins = app?.internalPlugins;
+
+	if (!internalPlugins) {
+		return false;
+	}
+
+	const basesPlugin = internalPlugins.getPluginById("bases");
+
+	return basesPlugin?.enabled ?? false;
+}
+
+export const BasesIntegration: PluginIntegration = {
+	id: "bases",
+	name: "Bases",
+	settingKey: "useBases",
+	priority: 200,
+	category: "core",
+
+	assets: {} as QuartzAssets,
+
+	isAvailable(): boolean {
+		return isBasesPluginEnabled();
+	},
+
+	getPatterns(): PatternDescriptor[] {
+		return [];
+	},
+
+	async compile(match: PatternMatch): Promise<string> {
+		return match.fullMatch;
+	},
+};
diff --git a/src/compiler/integrations/datacore.ts b/src/compiler/integrations/datacore.ts
@@ -538,6 +538,7 @@ export const DatacoreIntegration: PluginIntegration = {
 	name: "Datacore",
 	settingKey: "useDatacore",
 	priority: 100,
+	category: "community",
 
 	assets: {
 		scss: datacoreScss,
diff --git a/src/compiler/integrations/dataview.ts b/src/compiler/integrations/dataview.ts
@@ -73,6 +73,7 @@ export const DataviewIntegration: PluginIntegration = {
 	name: "Dataview",
 	settingKey: "useDataview",
 	priority: 100,
+	category: "community",
 
 	assets: {} as QuartzAssets,
 
diff --git a/src/compiler/integrations/excalidraw.ts b/src/compiler/integrations/excalidraw.ts
@@ -132,6 +132,7 @@ export const ExcalidrawIntegration: PluginIntegration = {
 	name: "Excalidraw",
 	settingKey: "useExcalidraw",
 	priority: 50,
+	category: "community",
 
 	assets: {
 		scss: excalidrawScss,
diff --git a/src/compiler/integrations/fantasy-statblocks.ts b/src/compiler/integrations/fantasy-statblocks.ts
@@ -459,6 +459,7 @@ export const FantasyStatblocksIntegration: PluginIntegration = {
 	name: "Fantasy Statblocks",
 	settingKey: "useFantasyStatblocks",
 	priority: 100,
+	category: "community",
 
 	assets: {
 		scss: fantasyStatblocksScss,
diff --git a/src/compiler/integrations/index.ts b/src/compiler/integrations/index.ts
@@ -8,17 +8,20 @@ import { DatacoreIntegration } from "./datacore";
 import { ExcalidrawIntegration } from "./excalidraw";
 import { FantasyStatblocksIntegration } from "./fantasy-statblocks";
 import { AutoCardLinkIntegration } from "./auto-card-link";
+import { BasesIntegration } from "./bases";
 
 export {
 	DataviewIntegration,
 	DatacoreIntegration,
 	ExcalidrawIntegration,
 	FantasyStatblocksIntegration,
 	AutoCardLinkIntegration,
+	BasesIntegration,
 };
 
 integrationRegistry.register(AutoCardLinkIntegration);
 integrationRegistry.register(DataviewIntegration);
 integrationRegistry.register(DatacoreIntegration);
 integrationRegistry.register(ExcalidrawIntegration);
 integrationRegistry.register(FantasyStatblocksIntegration);
+integrationRegistry.register(BasesIntegration);
diff --git a/src/compiler/integrations/registry.ts b/src/compiler/integrations/registry.ts
@@ -1,5 +1,10 @@
 import QuartzSyncerSettings from "src/models/settings";
-import { PluginIntegration, PatternDescriptor, QuartzAssets } from "./types";
+import {
+	PluginIntegration,
+	PatternDescriptor,
+	QuartzAssets,
+	IntegrationCategory,
+} from "./types";
 
 export class IntegrationRegistry {
 	private integrations: PluginIntegration[] = [];
@@ -12,6 +17,10 @@ export class IntegrationRegistry {
 		return [...this.integrations];
 	}
 
+	getByCategory(category: IntegrationCategory): PluginIntegration[] {
+		return this.integrations.filter((i) => i.category === category);
+	}
+
 	getEnabled(settings: QuartzSyncerSettings): PluginIntegration[] {
 		return this.integrations
 			.filter((i) => settings[i.settingKey] && i.isAvailable())
diff --git a/src/compiler/integrations/types.ts b/src/compiler/integrations/types.ts
@@ -47,31 +47,15 @@ export interface CompileContext {
 	file: PublishFile;
 }
 
-/**
- * Interface for plugin integrations.
- *
- * Each integration handles a specific Obsidian plugin's content,
- * converting it to Quartz-compatible output.
- */
+export type IntegrationCategory = "core" | "community";
+
 export interface PluginIntegration {
-	/** Unique identifier (e.g., 'dataview', 'excalidraw') */
 	readonly id: string;
-
-	/** Display name for settings UI (e.g., 'Dataview') */
 	readonly name: string;
-
-	/** Settings key that controls whether this integration is enabled */
 	readonly settingKey: keyof QuartzSyncerSettings;
-
-	/**
-	 * Execution priority. Lower numbers run first.
-	 * Default should be 100. Use lower values for patterns that might conflict
-	 * with other integrations.
-	 */
 	readonly priority: number;
-
-	/** Assets to inject into Quartz (SCSS styles) */
 	readonly assets: QuartzAssets;
+	readonly category: IntegrationCategory;
 
 	/**
 	 * Check if the underlying Obsidian plugin is installed and available.
diff --git a/src/models/TreeNode.ts b/src/models/TreeNode.ts
@@ -1,14 +1,18 @@
-/**
- * TreeNode type.
- * Model representing a node in a tree structure.
- */
+export type FileType =
+	| "markdown"
+	| "base"
+	| "excalidraw"
+	| "folder"
+	| "unknown";
+
 type TreeNode = {
 	name: string;
 	children?: TreeNode[];
 	isRoot: boolean;
 	path: string;
 	checked: boolean;
 	indeterminate: boolean;
+	fileType?: FileType;
 };
 
 export default TreeNode;
diff --git a/src/models/settings.ts b/src/models/settings.ts
@@ -148,6 +148,13 @@ export default interface QuartzSyncerSettings {
 	 * Fantasy Statblocks documentation: {@link https://plugins.javalent.com/statblocks}
 	 */
 	useFantasyStatblocks: boolean;
+	/**
+	 * Enable Bases integration.
+	 * This will allow the plugin to publish Obsidian Bases (.base files) to Quartz.
+	 *
+	 * Bases documentation: {@link https://help.obsidian.md/bases}
+	 */
+	useBases: boolean;
 
 	/** Manage integration styles in Quartz (writes SCSS files and updates custom.scss) */
 	manageSyncerStyles: boolean;
diff --git a/src/publishFile/PublishFile.ts b/src/publishFile/PublishFile.ts
@@ -142,13 +142,17 @@ export class PublishFile {
 	/**
 	 * Returns the type of the file based on its extension.
 	 *
-	 * @returns The file type: "excalidraw" or "markdown".
+	 * @returns The file type: "excalidraw", "base", or "markdown".
 	 */
-	getType(): "excalidraw" | "markdown" {
+	getType(): "excalidraw" | "base" | "markdown" {
 		if (this.file.name.endsWith(".excalidraw")) {
 			return "excalidraw";
 		}
 
+		if (this.file.extension === "base") {
+			return "base";
+		}
+
 		return "markdown";
 	}
 
@@ -158,6 +162,10 @@ export class PublishFile {
 	 * @returns true if the file should be published, false otherwise.
 	 */
 	shouldPublish(): boolean {
+		if (this.file.extension === "base") {
+			return this.settings.useBases;
+		}
+
 		return hasPublishFlag(
 			this.settings.publishFrontmatterKey,
 			this.frontmatter,
diff --git a/src/publisher/PublishStatusManager.ts b/src/publisher/PublishStatusManager.ts
@@ -108,7 +108,12 @@ export default class PublishStatusManager implements IPublishStatusManager {
 				const hash =
 					await this.publisher.datastore.loadRemoteHash(path);
 
-				if ((!hash || hash !== sha) && path.endsWith(".md")) {
+				const isPublishableFile =
+					path.endsWith(".md") ||
+					(this.publisher.settings.useBases &&
+						path.endsWith(".base"));
+
+				if ((!hash || hash !== sha) && isPublishableFile) {
 					if (controller) {
 						index++;
 
diff --git a/src/publisher/Publisher.ts b/src/publisher/Publisher.ts
@@ -72,6 +72,10 @@ export default class Publisher {
 	 * @returns true if the file should be published, false otherwise.
 	 */
 	shouldPublish(file: TFile): boolean {
+		if (file.extension === "base") {
+			return this.settings.useBases;
+		}
+
 		const frontMatter = this.metadataCache.getCache(file.path)?.frontmatter;
 
 		return hasPublishFlag(
@@ -89,15 +93,27 @@ export default class Publisher {
 	async getFilesMarkedForPublishing(): Promise<MarkedForPublishing> {
 		const vaultIsRoot = this.settings.vaultPath === "/";
 
-		// Only include files that are within the vaultPath
-		const files = this.vault
+		const markdownFiles = this.vault
 			.getMarkdownFiles()
 			.filter(
 				(file: TFile) =>
 					vaultIsRoot ||
 					file.path.startsWith(this.settings.vaultPath),
 			);
 
+		const baseFiles = this.settings.useBases
+			? this.vault
+					.getFiles()
+					.filter(
+						(file: TFile) =>
+							file.extension === "base" &&
+							(vaultIsRoot ||
+								file.path.startsWith(this.settings.vaultPath)),
+					)
+			: [];
+
+		const files = [...markdownFiles, ...baseFiles];
+
 		const notesToPublish: PublishFile[] = [];
 		const blobsToPublish: Set<string> = new Set();
 
@@ -166,13 +182,17 @@ export default class Publisher {
 	}
 
 	public async publishBatch(files: CompiledPublishFile[]): Promise<boolean> {
-		const filesToPublish = files.filter((f) =>
-			isPublishFrontmatterValid(
+		const filesToPublish = files.filter((f) => {
+			if (f.file.extension === "base") {
+				return this.settings.useBases;
+			}
+
+			return isPublishFrontmatterValid(
 				this.settings.publishFrontmatterKey,
 				f.frontmatter,
 				this.settings.allNotesPublishableByDefault,
-			),
-		);
+			);
+		});
 
 		if (filesToPublish.length === 0) {
 			return true;
diff --git a/src/repositoryConnection/QuartzSyncerSiteManager.ts b/src/repositoryConnection/QuartzSyncerSiteManager.ts
@@ -86,12 +86,16 @@ export default class QuartzSyncerSiteManager {
 	): Promise<Record<string, string>> {
 		const files = contentTree.tree;
 
+		const isPublishableFile = (path: string): boolean =>
+			path.endsWith(".md") ||
+			(this.settings.useBases && path.endsWith(".base"));
+
 		const notes = files.filter(
 			(x): x is ContentTreeItem =>
 				typeof x.path === "string" &&
 				x.path.startsWith(this.settings.contentFolder) &&
 				x.type === "blob" &&
-				x.path.endsWith(".md"),
+				isPublishableFile(x.path),
 		);
 		const hashes: Record<string, string> = {};
 
diff --git a/src/ui/TreeView/TreeNode.svelte b/src/ui/TreeView/TreeNode.svelte
@@ -141,6 +141,12 @@
 				{/if}
 				<!-- svelte-ignore a11y-click-events-have-key-events -->
 				<span on:click={toggleExpansion}>{tree.name}</span>
+				{#if tree.fileType === "base"}
+					<span
+						class="quartz-syncer-file-badge quartz-syncer-badge-base"
+						>BASE</span
+					>
+				{/if}
 				<!-- svelte-ignore a11y-click-events-have-key-events -->
 				{#if enableShowDiff}
 					<span
diff --git a/src/views/PublicationCenter/PublicationCenter.svelte b/src/views/PublicationCenter/PublicationCenter.svelte
diff --git a/src/views/SettingsView/Views/IntegrationSettings.ts b/src/views/SettingsView/Views/IntegrationSettings.ts
diff --git a/styles.css b/styles.css
