logger: add simple logger (#442)

main.ts

@@ -11,6 +11,7 @@ import { DigitalGardenSettingTab } from "./src/ui/DigitalGardenSettingTab";
 import { generateGardenSnapshot } from "./src/test/snapshot/generateGardenSnapshot";
 import { FRONTMATTER_KEYS } from "./src/models/frontMatter";
 import dotenv from "dotenv";
+import Logger from "js-logger";
 dotenv.config();
 
 const DEFAULT_SETTINGS: DigitalGardenSettings = {
@@ -58,8 +59,16 @@ const DEFAULT_SETTINGS: DigitalGardenSettings = {
 		dgLinkPreview: false,
 		dgShowTags: false,
 	},
+	logLevel: undefined,
 };
 
+Logger.useDefaults({
+	defaultLevel: Logger.WARN,
+	formatter: function (messages, _context) {
+		messages.unshift(new Date().toUTCString());
+		messages.unshift("DG: ");
+	},
+});
 export default class DigitalGarden extends Plugin {
 	settings!: DigitalGardenSettings;
 	appVersion!: string;
@@ -72,6 +81,11 @@ export default class DigitalGarden extends Plugin {
 		console.log("Initializing DigitalGarden plugin v" + this.appVersion);
 		await this.loadSettings();
 
+		this.settings.logLevel && Logger.setLevel(this.settings.logLevel);
+
+		Logger.info(
+			"Digital garden log level set to " + Logger.getLevel().name,
+		);
 		this.addSettingTab(new DigitalGardenSettingTab(this.app, this));
 
 		await this.addCommands();
@@ -141,6 +155,8 @@ export default class DigitalGarden extends Plugin {
 		});
 
 		if (this.settings["ENABLE_DEVELOPER_TOOLS"]) {
+			Logger.info("Developer tools enabled");
+
 			const publisher = new Publisher(
 				this.app.vault,
 				this.app.metadataCache,

package.json

@@ -56,6 +56,7 @@
 		"diff": "^5.1.0",
 		"eslint-plugin-svelte": "^2.33.2",
 		"js-base64": "^3.7.5",
+		"js-logger": "^1.6.1",
 		"luxon": "^3.4.3",
 		"lz-string": "^1.5.0",
 		"obsidian-dataview": "^0.5.56"

scripts/generateGardenSettings.mjs

@@ -2,6 +2,7 @@ import dotevnt from "dotenv";
 import fs from "fs";
 dotevnt.config();
 import copyfiles from "copyfiles";
+import Logger from "js-logger";
 
 const gardenSettings = {
 	githubRepo:
@@ -58,6 +59,7 @@ Path Rewriting/Subfolder:this-will-never-hit`,
 	},
 	ENABLE_DEVELOPER_TOOLS: true,
 	devPluginPath: `${process.cwd()}`,
+	logLevel: Logger.DEBUG,
 };
 
 const TEST_VAULT_PATH =

src/models/settings.ts

@@ -1,3 +1,5 @@
+import { ILogLevel } from "js-logger";
+
 /** Saved to data.json, changing requires a migration */
 export default interface DigitalGardenSettings {
 	githubToken: string;
@@ -50,4 +52,5 @@ export default interface DigitalGardenSettings {
 	};
 	ENABLE_DEVELOPER_TOOLS?: boolean;
 	devPluginPath?: string;
+	logLevel?: ILogLevel;
 }