refactor: move log into main for dev options

package.json

@@ -26,6 +26,7 @@
 		"monkey-around": "^2.3.0",
 		"obsidian": "^1.4.0",
 		"obsidian-plugin-cli": "^0.9.0",
+		"ts-deepmerge": "^6.2.0",
 		"typescript": "^5.1.6"
 	},
 	"license": "GPL-3.0-only",

src/i18n/locales/en.json

@@ -30,6 +30,10 @@
     "remove": "Remove markup for all links",
     "title": "Links format"
   },
+  "debug": {
+    "desc": "Show debug log in console",
+    "title": "Debug information"
+  },
   "edit": {
     "desc": "Edit view settings",
     "title": "Edit"

src/i18n/locales/fr.json

@@ -30,6 +30,10 @@
     "remove": "Supprimer les balises pour tous les liens",
     "title": "Format des liens"
   },
+  "debug": {
+    "desc": "Affiche le journal de débogage dans la console",
+    "title": "Informations de débogage"
+  },
   "edit": {
     "desc": "Paramètre pour la vue d'édition",
     "title": "Édition"

src/interface.ts

@@ -77,6 +77,7 @@ export interface EnhancedCopySettings {
 	editing: GlobalSettings;
 	reading: GlobalSettings;
 	overrideCopy: boolean;
+	devMode: boolean;
 }
 
 /**
@@ -111,6 +112,7 @@ export const DEFAULT_SETTINGS: EnhancedCopySettings = {
 		replaceText: []
 	},
 	overrideCopy: false,
+	devMode: false
 };
 
 export interface GlobalSettings {

src/main.ts

@@ -1,13 +1,13 @@
 import {EditorView} from "@codemirror/view";
 import i18next from "i18next";
 import {around} from "monkey-around";
-import { ItemView, MarkdownView, Plugin, WorkspaceLeaf} from "obsidian";
+import { ItemView, MarkdownView, Platform, Plugin, WorkspaceLeaf} from "obsidian";
+import merge from "ts-deepmerge";
 
 import {resources, translationLanguage} from "./i18n/i18next";
 import {ApplyingToView, DEFAULT_SETTINGS,EnhancedCopySettings} from "./interface";
 import {EnhancedCopySettingTab} from "./settings";
 import {convertEditMarkdown, convertMarkdown,} from "./utils/conversion";
-import {devLog} from "./utils/log";
 import {removeDataBasePluginRelationShip} from "./utils/pluginFix";
 import {canvasSelectionText, copySelectionRange, getSelectionAsHTML} from "./utils/selection";
 
@@ -21,18 +21,18 @@ export default class EnhancedCopy extends Plugin {
 		let viewIn: ApplyingToView;
 		let selectedText: string;
 		if (activeView && activeView.getMode() !== "source") {
-			devLog(i18next.t("log.readingMode"));
+			this.devLog(i18next.t("log.readingMode"));
 			selectedText = getSelectionAsHTML(this.settings);
 			viewIn = ApplyingToView.reading;
 		} else if (activeView) {
-			devLog(i18next.t("log.editMode"));
+			this.devLog(i18next.t("log.editMode"));
 			const editor = activeView.editor;
-			selectedText = copySelectionRange(editor);
+			selectedText = copySelectionRange(editor, this);
 			viewIn = ApplyingToView.edit;
 		} else {
 			const leafType = this.app.workspace.getActiveViewOfType(ItemView)?.getViewType();
 			if (leafType === "canvas") {
-				selectedText = canvasSelectionText(this.app, this.settings);
+				selectedText = canvasSelectionText(this.app, this);
 				viewIn = this.app.workspace.activeEditor ? ApplyingToView.edit : ApplyingToView.reading;
 			} else {
 				selectedText = leafType === "database-plugin" ? removeDataBasePluginRelationShip() : activeWindow.getSelection()?.toString() ?? "";
@@ -46,8 +46,8 @@ export default class EnhancedCopy extends Plugin {
 			) {
 				selectedText = viewIn === ApplyingToView.edit
 					?
-					convertEditMarkdown(selectedText, this.settings.editing, this.settings) :
-					convertMarkdown(selectedText, this.settings, this.settings.reading);
+					convertEditMarkdown(selectedText, this.settings.editing, this) :
+					convertMarkdown(selectedText, this.settings.reading, this);
 			}
 			return selectedText;
 		} else if (viewIn === ApplyingToView.edit) {
@@ -64,7 +64,6 @@ export default class EnhancedCopy extends Plugin {
 					return (event: ClipboardEvent) => {
 						try {
 							const selectedText = this.enhancedCopy();
-							console.log(selectedText);
 							if (selectedText) {
 								event.preventDefault();
 								event.clipboardData?.setData("text/plain", selectedText);
@@ -135,9 +134,9 @@ export default class EnhancedCopy extends Plugin {
 				name: i18next.t("commands.editor"),
 				hotkeys: [],
 				editorCallback: (editor) => {
-					let selectedText = copySelectionRange(editor);
+					let selectedText = copySelectionRange(editor, this);
 					if (selectedText && selectedText.trim().length > 0) {
-						selectedText = convertEditMarkdown(selectedText, this.settings.editing, this.settings);
+						selectedText = convertEditMarkdown(selectedText, this.settings.editing, this);
 						navigator.clipboard.writeText(selectedText);
 					}
 				}
@@ -154,7 +153,7 @@ export default class EnhancedCopy extends Plugin {
 						if (!checking) {
 							let selectedText = getSelectionAsHTML(this.settings);
 							if (!this.settings.exportAsHTML) {
-								selectedText = convertMarkdown(selectedText, this.settings, this.settings.reading);
+								selectedText = convertMarkdown(selectedText, this.settings.reading, this);
 							}
 							navigator.clipboard.writeText(selectedText);
 						}
@@ -171,14 +170,14 @@ export default class EnhancedCopy extends Plugin {
 				checkCallback: (checking: boolean) => {
 					//everything not markdown view
 					const markdownView = this.app.workspace.getActiveViewOfType(MarkdownView);
-					devLog(!markdownView, checking);
+					this.devLog(!markdownView, checking);
 					if (!markdownView) {
 						if (!checking) {
 							const leafType = this.app.workspace.getActiveViewOfType(ItemView)?.getViewType();
 							let selectedText: string;
 							let viewIn: ApplyingToView;
 							if (leafType === "canvas") {
-								selectedText = canvasSelectionText(this.app, this.settings);
+								selectedText = canvasSelectionText(this.app, this);
 								viewIn = this.app.workspace.activeEditor ? ApplyingToView.edit : ApplyingToView.reading;
 							} else {
 								selectedText = leafType === "database-plugin" ? removeDataBasePluginRelationShip() : activeWindow.getSelection()?.toString() ?? "";
@@ -190,8 +189,8 @@ export default class EnhancedCopy extends Plugin {
 								) {
 									selectedText = viewIn === ApplyingToView.edit
 										?
-										convertEditMarkdown(selectedText, this.settings.editing, this.settings) :
-										convertMarkdown(selectedText, this.settings, this.settings.reading);
+										convertEditMarkdown(selectedText, this.settings.editing, this) :
+										convertMarkdown(selectedText, this.settings.reading, this);
 								}
 								navigator.clipboard.writeText(selectedText);
 							}
@@ -206,7 +205,6 @@ export default class EnhancedCopy extends Plugin {
 		if (this.settings.overrideCopy) {
 			this.registerEvent(this.app.workspace.on("active-leaf-change", async (leaf) => {
 				if (!leaf) {
-					console.log("No active leaf");
 					for (const monkey of Object.values(this.activeMonkeys)) {
 						monkey();
 					}
@@ -219,7 +217,7 @@ export default class EnhancedCopy extends Plugin {
 				if (leaf.view instanceof ItemView && leaf.view.getViewType() === "canvas") {
 					//no event listener in dom
 					leaf.view.containerEl.addEventListener("copy", (event) => {
-						const selectedText = canvasSelectionText(this.app, this.settings);
+						const selectedText = canvasSelectionText(this.app, this);
 						event.preventDefault();
 						event.clipboardData?.setData("text/plain", selectedText);
 					});
@@ -245,9 +243,26 @@ export default class EnhancedCopy extends Plugin {
 		}
 	}
 	async loadSettings() {
-		this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
+		const loadedData = await this.loadData();
+		try {
+			this.settings = merge(DEFAULT_SETTINGS, loadedData) as unknown as EnhancedCopySettings;
+		} catch (e) {
+			console.warn("[Enhanced copy] Error while deep merging settings, using default loading method");
+			this.settings = Object.assign({}, DEFAULT_SETTINGS, loadedData);
+		}
 	}
 	async saveSettings() {
 		await this.saveData(this.settings);
 	}
+	devLog(...args: unknown[]) {
+		if (!(Platform.isDesktop && this.settings.devMode)) {
+			return;
+		}
+		let callFunction = new Error().stack?.split("\n")[2].trim();
+		callFunction = callFunction?.substring(callFunction.indexOf("at ") + 3, callFunction.lastIndexOf(" ("));
+		callFunction = callFunction!.replace("Object.callback", "");
+		callFunction = callFunction.length > 0 ? callFunction : "main";
+		const date = new Date().toISOString().slice(11, 23);
+		console.log(`[${date}](${callFunction}):\n`, ...args);
+	}
 }

src/settings.ts

@@ -160,6 +160,17 @@ export class EnhancedCopySettingTab extends PluginSettingTab {
 						await this.plugin.saveSettings();
 					});
 			});
+		new Setting(this.settingsPage)
+			.setName(i18next.t("debug.title"))
+			.setDesc(i18next.t("debug.desc"))
+			.addToggle((toggle) => {
+				toggle
+					.setValue(this.settings.devMode)
+					.onChange(async (value) => {
+						this.settings.devMode = value;
+						await this.plugin.saveSettings();
+					});
+			});
 	}
 
 	renderReading() {

src/utils/NodesEdit.ts

@@ -44,7 +44,6 @@ export function replaceAllDivCalloutToBlockquote(
 	settings: GlobalSettings
 ): HTMLDivElement {
 	const allDivCallout = div.querySelectorAll("div[class*='callout']");
-	console.log(allDivCallout);
 	let calloutTitle = "";
 	for (const divCallout of allDivCallout) {
 		if (

src/utils/conversion.ts

@@ -6,7 +6,7 @@ import {
 	ConversionOfLinks,
 	EnhancedCopySettings, 		GlobalSettings
 } from "../interface";
-import {devLog} from "./log";
+import EnhancedCopy from "../main";
 
 /**
  * If a list is preceded by an empty line, remove the empty line
@@ -154,25 +154,24 @@ function removeHighlightMark(markdown: string, settings: GlobalSettings): string
  * @param settings {EnhancedCopySettings} Settings of the plugin
  * @returns {string} Markdown with hard breaks added if needed
  */
-function hardBreak(markdown: string, settings: GlobalSettings): string {
+function hardBreak(markdown: string, settings: GlobalSettings, plugin: EnhancedCopy): string {
 	if (settings.hardBreak) {
 		markdown = markdown.replace(/ *\n/g, "  \n");
 		markdown += "  ";
 	} else {
-		devLog(i18next.t("log.noHardBreaks"));
+		plugin.devLog(i18next.t("log.noHardBreaks"));
 		markdown = markdown.replace(/ *\n/g, "\n");
 	}
 	return markdown;
 }
 
-function convertCallout(markdown: string, overrides: GlobalSettings): string {
-	devLog(i18next.t("log.callout.title"), overrides.callout);
+function convertCallout(markdown: string, overrides: GlobalSettings, plugin: EnhancedCopy): string {
+	plugin.devLog(i18next.t("log.callout.title"), overrides.callout);
 	const calloutRegex = /^>* *\[!(\w+)\|?(.*)\] *(.*)$/gm;
 	if (overrides.callout === CalloutKeepType.removeKeepTitle || overrides.callout === CalloutKeepType.remove) {
-		devLog(i18next.t("log.callout.remove"));
+		plugin.devLog(i18next.t("log.callout.remove"));
 		//delete the type of the callout
 		markdown = markdown.replace(calloutRegex, (match, p1, p2, p3) => {
-			console.log("COUCOU");
 			if (p3 === "") {
 				//remove the line without adding a new line / space
 				return "undefined";
@@ -238,7 +237,8 @@ function textReplacement(markdown: string, settings: GlobalSettings) {
  * @param overrides
  * @returns {string} converted markdown
  */
-export function convertMarkdown(markdown: string, settings: EnhancedCopySettings, overrides: GlobalSettings):string {
+export function convertMarkdown(markdown: string, overrides: GlobalSettings, plugin: EnhancedCopy): string {
+	const settings = plugin.settings;
 	return removeEmptyLineBeforeList(
 		convertSpaceSize(convertCallout(
 			hardBreak(
@@ -251,23 +251,23 @@ export function convertMarkdown(markdown: string, settings: EnhancedCopySettings
 					),
 					overrides
 				),
-				overrides
+				overrides,plugin
 			),
-			overrides),
+			overrides, plugin),
 		settings)
 	);
 }
 
-export function convertEditMarkdown(markdown: string, overrides: GlobalSettings, settings: EnhancedCopySettings) {
+export function convertEditMarkdown(markdown: string, overrides: GlobalSettings, plugin: EnhancedCopy) {
+	const settings = plugin.settings;
 	if (settings.wikiToMarkdown) {
 		markdown = convertWikiToMarkdown(markdown);
 		markdown = removeLinksBracketsInMarkdown(markdown, overrides);
 	}
 	markdown = convertTabToSpace(markdown, settings);
 	markdown = removeMarkdownFootNotes(markdown, overrides);
-	markdown = convertCallout(markdown, overrides);
+	markdown = convertCallout(markdown, overrides, plugin);
 	markdown = removeHighlightMark(markdown, overrides);
-	markdown = hardBreak(markdown, overrides);
-	markdown = textReplacement(markdown, overrides);
-	return markdown;
+	markdown = hardBreak(markdown, overrides, plugin);
+	return textReplacement(markdown, overrides);
 }

src/utils/selection.ts

@@ -2,7 +2,7 @@ import i18next from "i18next";
 import {App, Editor, EditorPosition, htmlToMarkdown} from "obsidian";
 
 import {EnhancedCopySettings} from "../interface";
-import { devLog } from "./log";
+import EnhancedCopy from "../main";
 import {reNumerateList, replaceAllDivCalloutToBlockquote} from "./NodesEdit";
 
 /**
@@ -82,7 +82,7 @@ function getAnchor(head: EditorPosition, anchor: EditorPosition) {
  * @param editor {Editor} Editor of the activeView
  * @returns {string} The selected text (copying behavior of Obsidian)
  */
-export function copySelectionRange(editor: Editor):string {
+export function copySelectionRange(editor: Editor, plugin: EnhancedCopy):string {
 	let selectedText = "";
 	const selection = editor.listSelections();
 	for (const selected of selection) {
@@ -93,7 +93,7 @@ export function copySelectionRange(editor: Editor):string {
 	selectedText = selectedText.substring(0, selectedText.length - 1);
 	if (selectedText === "") {
 		const getSelection = activeWindow.getSelection();
-		devLog(	i18next.t("log.empty"));
+		plugin.devLog(	i18next.t("log.empty"));
 		return getSelection === null ? "" : getSelection.toString();
 	}
 	return selectedText;
@@ -106,11 +106,12 @@ export function copySelectionRange(editor: Editor):string {
  * @param settings {EnhancedCopySettings}
  * @returns {string}
  */
-export function canvasSelectionText(app: App, settings: EnhancedCopySettings): string {
+export function canvasSelectionText(app: App, plugin: EnhancedCopy): string {
+	const {settings} = plugin;
 	const editor = app.workspace.activeEditor;
 	if (editor) {
 		const editorMode = editor.editor as Editor;
-		return copySelectionRange(editorMode);
+		return copySelectionRange(editorMode, plugin);
 	} else {
 		return getSelectionAsHTML(settings);
 	}