carany build warning

Author: mProjectsCode

esbuild.config.mjs

@@ -48,6 +48,9 @@ esbuild
 		treeShaking: true,
 		outfile: 'main.js',
 		minify: true,
+		define: {
+			MB_GLOBAL_CONFIG_DEV_BUILD: 'false',
+		},
 		plugins: [
 			esbuildSvelte({
 				compilerOptions: { css: 'injected' },

esbuild.dev.config.mjs

@@ -49,6 +49,9 @@ const context = await esbuild
 		treeShaking: true,
 		outdir: `exampleVault/.obsidian/plugins/${manifest.id}/`,
 		outbase: 'src',
+		define: {
+			MB_GLOBAL_CONFIG_DEV_BUILD: 'true',
+		},
 		plugins: [
 			copy({
 				paths: [

esbuild.publish.config.mjs

@@ -58,6 +58,9 @@ esbuild
 		sourcemap: false,
 		treeShaking: true,
 		outfile: './Publish.js',
+		define: {
+			MB_GLOBAL_CONFIG_DEV_BUILD: 'false',
+		},
 		plugins: [
 			esbuildSvelte({
 				compilerOptions: { css: 'injected' },

extraTypes/obsidian-ex.d.ts

@@ -1,4 +1,5 @@
 import { type Plugin, type PluginManifest } from 'obsidian';
+import { getUUID } from '../src/utils/Utils';
 
 declare module 'obsidian' {
 	interface App {
@@ -58,4 +59,8 @@ declare module 'obsidian' {
 	}
 }
 
+declare global {
+	const MB_GLOBAL_CONFIG_DEV_BUILD: boolean;
+}
+
 export {};

src/main.ts

@@ -18,25 +18,36 @@ import { ButtonMDRC } from './renderChildren/ButtonMDRC';
 import { InlineButtonMDRC } from './renderChildren/InlineButtonMDRC';
 import { ButtonBuilderModal } from './fields/button/ButtonBuilderModal';
 
+export enum MetaBindBuild {
+	DEV = 'dev',
+	CANARY = 'canary',
+	RELEASE = 'release',
+}
+
 export default class MetaBindPlugin extends Plugin implements IPlugin {
-	// @ts-ignore defined in `onload`
+	// @ts-expect-error TS2564
 	settings: MetaBindPluginSettings;
 
-	// @ts-ignore defined in `onload`
+	// @ts-expect-error TS2564
 	mdrcManager: MDRCManager;
 
-	// @ts-ignore defined in `onload`
+	// @ts-expect-error TS2564
 	metadataManager: MetadataManager;
 
-	// @ts-ignore defined in `onload`
+	// @ts-expect-error TS2564
 	api: API;
 
-	// @ts-ignore defined in `onload`
+	// @ts-expect-error TS2564
 	internal: ObsidianAPIAdapter;
 
+	// @ts-expect-error TS2564
+	build: MetaBindBuild;
+
 	async onload(): Promise<void> {
 		console.log(`meta-bind | Main >> load`);
 
+		this.build = this.determineBuild();
+
 		// load and immediately save settings to apply migrations
 		await this.loadSettings();
 		await this.saveSettings();
@@ -144,15 +155,6 @@ export default class MetaBindPlugin extends Plugin implements IPlugin {
 		// LP editor extension
 		this.registerEditorExtension(createMarkdownRenderChildWidgetEditorPlugin(this));
 
-		// this.addCommand({
-		// 	id: 'mb-debugger-command',
-		// 	name: 'debugger',
-		// 	callback: () => {
-		// 		// eslint-disable-next-line no-debugger
-		// 		debugger;
-		// 	},
-		// });
-
 		// register commands
 		this.addCommand({
 			id: 'open-docs',
@@ -195,6 +197,9 @@ export default class MetaBindPlugin extends Plugin implements IPlugin {
 
 		// register settings tab
 		this.addSettingTab(new MetaBindSettingTab(this.app, this));
+
+		// add indicator for dev and canary builds
+		this.addStatusBarBuildIndicator();
 	}
 
 	onunload(): void {
@@ -203,6 +208,32 @@ export default class MetaBindPlugin extends Plugin implements IPlugin {
 		this.metadataManager.unload();
 	}
 
+	determineBuild(): MetaBindBuild {
+		if (MB_GLOBAL_CONFIG_DEV_BUILD) {
+			return MetaBindBuild.DEV;
+		} else if (this.manifest.version.includes('canary')) {
+			return MetaBindBuild.CANARY;
+		} else {
+			return MetaBindBuild.RELEASE;
+		}
+	}
+
+	addStatusBarBuildIndicator(): void {
+		if (this.build === MetaBindBuild.DEV) {
+			const item = this.addStatusBarItem();
+			item.setText('Meta Bind Dev Build');
+			item.addClass('mb-error');
+			this.register(() => item.remove());
+		}
+
+		if (this.build === MetaBindBuild.CANARY) {
+			const item = this.addStatusBarItem();
+			item.setText(`Meta Bind Canary Build (${this.manifest.version})`);
+			item.addClass('mb-error');
+			this.register(() => item.remove());
+		}
+	}
+
 	isFilePathExcluded(path: string): boolean {
 		for (const excludedFolder of this.settings.excludedFolders) {
 			if (path.startsWith(excludedFolder)) {

src/settings/SettingsTab.ts

@@ -1,10 +1,11 @@
-import { type App, PluginSettingTab, Setting } from 'obsidian';
+import { type App, ButtonComponent, PluginSettingTab, Setting } from 'obsidian';
 import type MetaBindPlugin from '../main';
 import { DEFAULT_SETTINGS, weekdays } from './Settings';
 import { ExcludedFoldersSettingModal } from './excludedFoldersSetting/ExcludedFoldersSettingModal';
 import { InputFieldTemplatesSettingModal } from './inputFieldTemplateSetting/InputFieldTemplatesSettingModal';
 import { DocsHelper } from '../utils/DocsHelper';
 import { MB_FAQ_VIEW_TYPE } from '../faq/FaqView';
+import { MetaBindBuild } from '../main';
 
 export class MetaBindSettingTab extends PluginSettingTab {
 	plugin: MetaBindPlugin;
@@ -19,6 +20,19 @@ export class MetaBindSettingTab extends PluginSettingTab {
 
 		containerEl.empty();
 
+		if (this.plugin.build === MetaBindBuild.DEV || this.plugin.build === MetaBindBuild.CANARY) {
+			containerEl.createEl('p', {
+				text: `You are using a ${this.plugin.build} build (${this.plugin.manifest.version}). This build is not intended for production use. Use at your own risk.`,
+				cls: 'mb-error',
+			});
+			const button = new ButtonComponent(containerEl);
+			button.setButtonText('Learn About Canary Builds');
+			button.setCta();
+			button.onClick(() => {
+				DocsHelper.open(DocsHelper.linkToCanaryBuilds());
+			});
+		}
+
 		new Setting(containerEl)
 			.setName('Quick access')
 			.addButton(cb => {

src/utils/DocsHelper.ts

@@ -7,35 +7,35 @@ import {
 
 export class DocsHelper {
 	static linkToInputField(type: InputFieldType): string {
-		return `https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs/reference/inputfields/${type.toLowerCase()}/`;
+		return `https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfields/${type.toLowerCase()}/`;
 	}
 
 	static linkToInputFieldArgument(type: InputFieldArgumentType): string {
-		return `https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/${type.toLowerCase()}/`;
+		return `https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/inputfieldarguments/${type.toLowerCase()}/`;
 	}
 
 	static linkToViewField(type: ViewFieldType): string {
-		return `https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs/reference/viewfields/${type.toLowerCase()}/`;
+		return `https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/viewfields/${type.toLowerCase()}/`;
 	}
 
 	static linkToViewFieldArgument(type: ViewFieldArgumentType): string {
-		return `https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs/reference/viewfieldarguments/${type.toLowerCase()}/`;
+		return `https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/reference/viewfieldarguments/${type.toLowerCase()}/`;
 	}
 
 	static linkToInputFields(): string {
-		return `https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs/guides/inputfields/`;
+		return `https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/inputfields/`;
 	}
 
 	static linkToViewFields(): string {
-		return `https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs/guides/viewfields/`;
+		return `https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/viewfields/`;
 	}
 
 	static linkToSearch(search: string): string {
-		return `https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs/?s=${encodeURIComponent(search)}`;
+		return `https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/?s=${encodeURIComponent(search)}`;
 	}
 
 	static linkToHome(): string {
-		return `https://mprojectscode.github.io/obsidian-meta-bind-plugin-docs/`;
+		return `https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/`;
 	}
 
 	static linkToGithub(): string {
@@ -46,6 +46,10 @@ export class DocsHelper {
 		return `https://github.com/mProjectsCode/obsidian-meta-bind-plugin/issues`;
 	}
 
+	static linkToCanaryBuilds(): string {
+		return `https://www.moritzjung.dev/obsidian-meta-bind-plugin-docs/guides/installation/#canary-builds`;
+	}
+
 	static open(link: string): void {
 		window.open(link, '_blank');
 	}