added snwAPI

src/header-incoming-count.ts → src/headerImageCount.ts

@@ -12,7 +12,7 @@ export default function setHeaderWithReferenceCounts(thePlugin: ThePlugin) {
 
 function processHeader(thePlugin: ThePlugin, mdView: MarkdownView) {
     const allLinks: Link[] = thePlugin.app.fileManager.getAllLinkResolutions();
-    const incomingLinks = allLinks.filter(f=>f.resolvedFile.path===mdView.file.path);
+    const incomingLinks = allLinks.filter(f=>f?.resolvedFile.path===mdView.file.path);
 
     const containerTitleDiv: HTMLDivElement = mdView.containerEl.querySelector(".view-content");
     const fileList = (incomingLinks.map(link => link.sourceFile.path.replace(".md", ""))).slice(0,20).join("\n")

src/main.ts

@@ -3,12 +3,15 @@ import InlineReferenceExtension, {setPluginVariableForCM6} from "./references-cm
 import {buildLinksAndReferences} from "./indexer";
 import markdownPreviewProcessor from "./references-preview";
 import {SidePaneView, VIEW_TYPE_SNW} from "./sidepane";
-import setHeaderWithReferenceCounts from "./header-incoming-count";
+import setHeaderWithReferenceCounts from "./headerImageCount";
+import {SettingsTab, Settings, DEFAULT_SETTINGS} from "./settingsTab";
+import SnwAPI from "./snwApi";
 
 export default class ThePlugin extends Plugin {
     pluginInitialized = false;
     appName = "Obsidian42 - Strange New Worlds";
     appID = "obsidian42-strange-new-worlds";
+	settings: Settings;
     lastSelectedReferenceKey : string;
     lastSelectedReferenceType : string;
     lastSelectedReferenceLink : string;
@@ -20,8 +23,8 @@ export default class ThePlugin extends Plugin {
             buildLinksAndReferences(this.app)
         }, 3000, true);
 
-        const initializeEnvironment = () => {
-
+        const initializeEnvironment = async () => {
+            await this.loadSettings();
             setPluginVariableForCM6(this);
 
             this.registerEditorExtension([InlineReferenceExtension]); // enable the codemirror extensions
@@ -32,13 +35,19 @@ export default class ThePlugin extends Plugin {
             this.app.workspace.on("layout-change", async () => {
                 setHeaderWithReferenceCounts(this);
             });
+
+            this.addSettingTab(new SettingsTab(this.app, this));
+
+            //@ts-ignore
+            globalThis.snwAPI = new SnwAPI(this);
+
         }
 
         // managing state for debugging purpsoes
-        setTimeout(() => {
+        setTimeout(async () => {
             if (!this.pluginInitialized) {
                 this.pluginInitialized = true;
-                initializeEnvironment();
+                await initializeEnvironment();
             }
         }, 4000);
 
@@ -66,4 +75,8 @@ export default class ThePlugin extends Plugin {
         this.app.workspace.detachLeavesOfType(VIEW_TYPE_SNW);
         console.log("unloading " + this.appName)
     }
+
+    async loadSettings(): Promise<void> { this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData()) }
+
+	async saveSettings(): Promise<void> { await this.saveData(this.settings) }
 }

src/references-preview.ts

@@ -10,11 +10,6 @@ export default function markdownPreviewProcessor(el : HTMLElement, ctx : Markdow
     // check for incompatibility with other plugins
     if(app.metadataCache.getFileCache(currentFile)?.frontmatter?.["kanban-plugin"] ) return; //no support for kanban board
 
-    console.log("el", el)
-    console.log( "currentFile", currentFile)
-    console.log( app.metadataCache.getFileCache( currentFile )?.frontmatter?.["kanban-plugin"] );
-
-
     const currentFilePath = currentFile.path;
     const transformedCache = getCurrentPage(currentFile, thePlugin.app);
 

src/settingsTab.ts

@@ -0,0 +1,38 @@
+import { App, PluginSettingTab, Setting, ToggleComponent } from 'obsidian';
+import ThePlugin from './main';
+
+export interface Settings {
+	debugMode: boolean
+}
+
+export const DEFAULT_SETTINGS: Settings = {
+	debugMode: false
+}
+
+export class SettingsTab extends PluginSettingTab {
+	plugin: ThePlugin;
+
+	constructor(app: App, plugin: ThePlugin) {
+		super(app, plugin);
+		this.plugin = plugin;
+	}
+
+	display(): void {
+		const { containerEl } = this;
+		containerEl.empty();
+		containerEl.createEl('h2', { text: 'Obsidian42 - Strange New Worlds' });
+
+		new Setting(containerEl)
+			.setName('Developer Debugging Mode')
+			.setDesc('Enable Debugging Mode for troubleshooting in the console.')
+			.addToggle((cb: ToggleComponent) => {
+				cb.setValue(this.plugin.settings.debugMode);
+				cb.onChange(async (value: boolean) => {
+					this.plugin.settings.debugMode = value;
+					await this.plugin.saveSettings();
+				});
+			});
+
+
+	}
+}

src/snwApi.ts

@@ -0,0 +1,48 @@
+import { getCurrentPage } from "./indexer";
+import ThePlugin from "./main";
+
+/**
+ * Provide a simple API for use with Templater, Dataview and debugging the complexities of various pages.
+ * main.ts will attach this to window.snwAPI
+ *
+ * @export
+ * @class SnwAPI
+ */
+export default class SnwAPI {
+    plugin: ThePlugin;
+
+    constructor(plugin: ThePlugin) {
+        this.plugin = plugin    
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    console = (logDescription: string, ...outputs: any[]): void => {
+        if(this.plugin.settings.debugMode===true)
+            console.log(logDescription, outputs)
+    }
+
+    /**
+     * For active file return the meta information used by various components of SNW
+     *
+     * @return {*}  {Promise<any>} // Needs to be any since we might return just about anything
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    getMetaInfoByCurrentFile = async (): Promise<any> => {
+        return this.getMetaInfoByFileName(app.workspace.getActiveFile().path)
+    }
+
+    /**
+     * For given file name passed into the function, get the meta info for that file
+     *
+     * @param {string} fileName (or file name path)
+     * @memberof SnwAPI
+     */
+    getMetaInfoByFileName = async (fileName: string)=> {
+        const currentFile = app.metadataCache.getFirstLinkpathDest(fileName, "/")
+        return {
+            TFile: currentFile,
+            metadataCache: app.metadataCache.getFileCache(currentFile),
+            SnwTransformedCache: getCurrentPage(currentFile, this.plugin.app),
+        } 
+    }
+}

src/styles.css

@@ -33,26 +33,22 @@
 .snw-header-count-wrapper {
     position: absolute;  
     z-index:1000;
-    /* top: 10px; */
     margin-top: 10px;
     right: 20px;
-    /* width: 15px !important; */
     font-size: 8pt;
-    /* min-width: 20px !important; */
     height: 20px;
     border-radius: 5px;
     border: 1px dotted;
-    /* display: flex; */
-    /* justify-content: center; */
-    /* align-items: center; */
     opacity: 0.5;
 }
 
 .snw-header-count {
     text-align: center;
     min-width: 15px !important;
-    /* opacity: 0.5 !important; */
-    /* height: 20px; */
+    height: 0px;
+    padding-top: 3px;
+    /* padding: 5px; */
+    /* border: 1px solid red; */
 }
 
 .snw-sidepane-container {