Move logging to centralized module

lib/client/sublime/LSP-custom-elements/LSP-custom-elements.sublime-settings

@@ -1,5 +1,5 @@
 {
     "command": ["${node_bin}", "${server_path}", "--stdio"],
-    "selector": "source.js, source.jsx, source.ts, source.tsx"
+    "selector": "text.html, source.js"
 }
 

lib/custom-elements-languageserver-core/src/cem/analyzer.ts

@@ -63,7 +63,7 @@ export async function analyzeLocalProject(basePath: string): Promise<AnalyzerOut
         normalizeManifest(basePath, manifest);
 
         const savePath = cacheCurrentCEM(basePath, manifest);
-        console.log("Manifest file written to ", savePath);
+        Logger.log({ message: `Manifest file written to ${savePath}`, level: LogLevel.WARN });
 
         return {
             manifest,

lib/custom-elements-languageserver-core/src/cem/cem-cache.ts

@@ -5,6 +5,7 @@ import { JavaScriptModule } from "custom-elements-manifest";
 import { addReferenceToModule, JavaScriptModuleWithRef } from "./cem-helpers.js";
 import tss from "typescript/lib/tsserverlibrary.js";
 import { CEMUpdatedEvent, LanguageServerEventHost } from "../export.js";
+import { Logger, LogLevel } from "../logger/logger.js";
 
 export class CEMCollection {
     public id: number = Date.now() + Math.floor(Math.random() * 999);
@@ -18,7 +19,7 @@ export class CEMCollection {
     }
 
     private async initializeCEMs() {
-        console.log("Initializing CEM's");
+        Logger.log({ message: "Initializing CEM's", level: LogLevel.INFO });
         const dependencyPackages = getDependencyPackagesWithCEMs(this.basePath + "/node_modules");
 
         const cemData = await CEMInstance.fromLocalPath(this.basePath);
@@ -31,7 +32,8 @@ export class CEMCollection {
         this._cems = dependencyCems.filter(cemIsNotUndefined);
 
         this.refresh(); // Initialize modules
-        console.log(`CEM Cache initialized. LocalCEM Present: ${this._localCEM !== undefined}. Dependency CEM Count: ${dependencyCems.length}`);
+
+        Logger.log({ message: `CEM Cache initialized. LocalCEM Present: ${this._localCEM !== undefined}. Dependency CEM Count: ${dependencyCems.length}`, level: LogLevel.INFO });
     }
 
     public get modules(): Array<JavaScriptModule> {
@@ -106,7 +108,7 @@ function setToCEMCache(projectBasePath: string, cemCollection: CEMCollection) {
 export function refreshCEMData(projectBasePath: string) {
     const existingCollection = getCEMFromCacheByPath(projectBasePath);
     if (!existingCollection) {
-        console.warn("Tried to refresh a non-existant cache. Attempted " + projectBasePath + ", but the only ones available are: ", [...CEM_COLLECTION_CACHE.keys()]);
+        Logger.log({ message: `Tried to refresh a non-existant cache. Attempted ${projectBasePath}, but the only ones available are: ${[...CEM_COLLECTION_CACHE.keys()]}`, level: LogLevel.WARN });
         return;
     }
     existingCollection?.refreshLocal();

lib/custom-elements-languageserver-core/src/logger/logger.ts

@@ -3,9 +3,11 @@ import fs from "fs";
 const DEBUG = true;
 
 export enum LogLevel {
-    INFO = 1,
+    OFF = 0,
+    ERROR = 1,
     WARN = 2,
-    ERROR = 3
+    INFO = 3,
+    DEBUG = 4
 }
 
 export interface LogMessage {
@@ -15,7 +17,7 @@ export interface LogMessage {
 
 export class Logger {
     private static _instance: Logger;
-    private level: LogLevel = LogLevel.INFO;
+    private level: LogLevel = LogLevel.OFF;
 
     public static getInstance(): Logger {
         if (!Logger._instance) {
@@ -24,6 +26,10 @@ export class Logger {
         return Logger._instance;
     }
 
+    public static log(message: LogMessage) {
+        this.getInstance().log(message);
+    }
+
     public async log(message: LogMessage) {
         // This function is set as async so that it doesn't block execution
         if (message.level < this.level) {

lib/server/src/connection.ts

@@ -5,12 +5,13 @@ import fs from "fs";
 import path from "path";
 import url from "url";
 import { refreshLanguageServiceForFile } from "./language-services/language-services";
+import { Logger, LogLevel } from "custom-elements-languageserver-core/src/logger/logger";
 
 // @ts-ignore
 export let connection = createConnection(ProposedFeatures.all);
 
 export function initConnection() {
-    console.log("Initializing connection");
+    Logger.log({ message: "Initializing connection", level: LogLevel.DEBUG });
     // @ts-ignore
     connection = createConnection(ProposedFeatures.all);
 
@@ -81,7 +82,7 @@ function onInitialize(params: InitializeParams) {
 }
 
 function onInitialized() {
-    console.log("Connection initialized");
+    Logger.log({ message: "Connection initialized", level: LogLevel.DEBUG });
     if (hasConfigurationCapability) {
         // Register for all configuration changes.
         connection.client.register(DidChangeConfigurationNotification.type, undefined);
@@ -110,12 +111,12 @@ interface PackageJsonLike {
 }
 
 async function initializeProjectsInWorkSpaceFolders(workspaceFolders: WorkspaceFolder[]) {
-    console.log("Initializing workspaces.");
+    Logger.log({ message: "Initializing workspaces.", level: LogLevel.DEBUG });
     workspaceFolders?.forEach(workSpaceFolder => {
-        console.log("Initializing workspace " + workSpaceFolder.name + " @ " + decodeURI(workSpaceFolder.uri));
+        Logger.log({ message: "Initializing workspace " + workSpaceFolder.name + " @ " + decodeURI(workSpaceFolder.uri), level: LogLevel.DEBUG });
         let fileName = url.fileURLToPath(workSpaceFolder.uri);
         const packageJsonPath = path.resolve(fileName, "package.json");
-        console.log("Package JSON path ", packageJsonPath);
+        Logger.log({ message: "Package JSON path " + packageJsonPath, level: LogLevel.DEBUG });
         if (fs.existsSync(packageJsonPath)) {
             try {
                 const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8")) as PackageJsonLike;
@@ -124,13 +125,13 @@ async function initializeProjectsInWorkSpaceFolders(workspaceFolders: WorkspaceF
                     const mainFilePath = path.resolve(fileName, mainFileName);
                     refreshLanguageServiceForFile(mainFilePath, undefined);
                 } else {
-                    console.warn("Could not find a main or module file");
+                    Logger.log({ message: "Could not find a main or module file", level: LogLevel.WARN });
                 }
             } catch (ex) {
-                console.warn("Couldn't open project " + fileName, ex);
+                Logger.log({ message: "Couldn't open project " + fileName + "\n" + ex, level: LogLevel.WARN });
             }
         } else {
-            console.warn("Did not find package.json for project");
+            Logger.log({ message: "Did not find package.json for project", level: LogLevel.WARN });
         }
     })
 }

lib/server/src/server.ts

@@ -2,8 +2,8 @@ import {
     DidChangeTextDocumentParams,
 } from "vscode-languageserver";
 
-console.log("NODE VERSION: ", process.version);
-console.log("Startup at ", new Date());
+Logger.log({ message: "NODE VERSION: " + process.version, level: LogLevel.INFO });
+Logger.log({ message: "Startup at " + new Date(), level: LogLevel.INFO });
 
 import { TextDocument } from "vscode-languageserver-textdocument";
 import { documents } from "./text-documents.js";
@@ -16,6 +16,7 @@ import { completionsHandler } from "./handlers/completions.js";
 import { codeActionHandler } from "./handlers/code-actions.js";
 import { codeActionResolveHandler } from "./handlers/code-action-resolve.js";
 import { hoverHandler } from "./handlers/hover.js";
+import { LogLevel, Logger } from "custom-elements-languageserver-core/src/logger/logger.js";
 
 initConnection();
 

lib/server/src/text-documents.ts

@@ -8,6 +8,7 @@ import { runDiagnostics } from "./diagnostics.js";
 import { connection } from "./connection.js";
 import { textDocumentDataToUsableDataFromUri, UsableTextDocumentData } from "./transformers.js";
 import { refreshCEMData } from "custom-elements-languageserver-core";
+import { Logger, LogLevel } from "custom-elements-languageserver-core/src/logger/logger.js";
 
 export const documentSettings = new Map<string, LanguageServerSettings>();
 export let documents: TextDocuments<TextDocument> = new TextDocuments(TextDocument);
@@ -22,7 +23,7 @@ function refreshCEM(usableData: UsableTextDocumentData) {
 }
 
 export function initDocuments() {
-    console.log("Initializing documents");
+    Logger.log({ message: "Initializing documents", level: LogLevel.DEBUG });
     documents = new TextDocuments(TextDocument);
     // Only keep settings for open documents
     documents.listen(connection);