Merge pull request #24 from badsyntax/logging-readme

Update README & improve logging

Author: badsyntax

README.md

@@ -4,7 +4,7 @@
 
 A VS Code extension to manage Entity Framework migrations.
 
-![Entity Framework Migrations](images/treeview-screenshot.png)
+<img src="./images/treeview-screenshot.png" style="max-width:460px" alt="Entity Framework Migrations" />
 
 ## Features
 

images/treeview-screenshot.png

@@ -37,6 +37,13 @@ export class CLI {
     );
   }
 
+  public static removeInfoPrefixFromStdErr(stdErr: string): string {
+    return stdErr
+      .split(NEWLINE_SEPARATOR)
+      .filter(line => !line.startsWith('info:'))
+      .join('\n');
+  }
+
   public static removePrefixFromStdOut(output: string): string {
     return output
       .split(NEWLINE_SEPARATOR)
@@ -88,8 +95,7 @@ export class CLI {
         cmd?.on('exit', async code => {
           const error = stderr || CLI.getErrorsFromStdOut(stdout);
           if (error || code !== 0) {
-            const finalError = error || stdout;
-            this.logger.error(finalError);
+            const finalError = CLI.removeInfoPrefixFromStdErr(error || stdout);
             rej(new Error(finalError));
           } else {
             res(stdout);

src/cli/CLI.ts

@@ -19,7 +19,7 @@ export async function activate(_context: vscode.ExtensionContext) {
   const textDocumentProvider = new TextDocumentProvider();
   const migrationTreeItemDecorationProvider =
     new MigrationTreeItemDecorationProvider();
-  const treeDataProvider = new TreeDataProvider(projectFiles, cli);
+  const treeDataProvider = new TreeDataProvider(logger, projectFiles, cli);
   const terminalProvider = new TerminalProvider(new Terminal(cli));
   const commandProvider = new CommandProvider(
     treeDataProvider,
@@ -32,6 +32,7 @@ export async function activate(_context: vscode.ExtensionContext) {
     terminalProvider,
     textDocumentProvider,
   );
+  logger.info(`extension activated`);
 }
 
 export function deactivate() {

src/extension.ts

@@ -8,13 +8,15 @@ import { TreeItemCache } from './TreeItemCache';
 import { ContextValues } from './ContextValues';
 import type { ProjectFile } from '../types/ProjectFile';
 import { getCommandsConfig } from '../config/config';
+import type { Logger } from '../util/Logger';
 
 export const dbContextsCache = new TreeItemCache<MigrationTreeItem[]>();
 
 export class DbContextTreeItem extends TreeItem {
   private readonly cacheId: string;
 
   constructor(
+    private readonly logger: Logger,
     public readonly label: string,
     private readonly projectFile: ProjectFile,
     public readonly project: string,
@@ -72,9 +74,9 @@ export class DbContextTreeItem extends TreeItem {
       dbContextsCache.set(this.cacheId, children);
       return children;
     } catch (e) {
-      await vscode.window.showErrorMessage(
-        `Unable to get migrations: ${(e as Error).message}`,
-      );
+      const msg = `Unable to get migrations: ${(e as Error).message}`.trim();
+      this.logger.error(msg);
+      await vscode.window.showErrorMessage(msg, 'OK');
       return [];
     }
   }

src/treeView/DbContextTreeItem.ts

@@ -9,12 +9,14 @@ import { CLI } from '../cli/CLI';
 import { TreeItemCache } from './TreeItemCache';
 import type { ProjectFile } from '../types/ProjectFile';
 import { getCommandsConfig } from '../config/config';
+import type { Logger } from '../util/Logger';
 
 export const projectsCache = new TreeItemCache<DbContextTreeItem[]>();
 
 export class ProjectTreeItem extends TreeItem {
   private readonly cacheId: string;
   constructor(
+    private readonly logger: Logger,
     public readonly label: string,
     private readonly projectFile: ProjectFile,
     private readonly cli: CLI,
@@ -59,6 +61,7 @@ export class ProjectTreeItem extends TreeItem {
       const children = dbContexts.map(
         dbContext =>
           new DbContextTreeItem(
+            this.logger,
             dbContext.name,
             this.projectFile,
             project,
@@ -69,9 +72,9 @@ export class ProjectTreeItem extends TreeItem {
       projectsCache.set(this.cacheId, children);
       return children;
     } catch (e) {
-      await vscode.window.showErrorMessage(
-        `Unable to get dbContexts: ${(e as Error).message}`,
-      );
+      const msg = `Unable to get dbContexts: ${(e as Error).message}`.trim();
+      this.logger.error(msg);
+      await vscode.window.showErrorMessage(msg, 'OK');
       return [];
     }
   }

src/treeView/ProjectTreeItem.ts

@@ -8,6 +8,7 @@ import type { CLI } from '../cli/CLI';
 import { MigrationTreeItem } from './MigrationTreeItem';
 import { CommandProvider } from '../commands/CommandProvider';
 import { OpenMigrationFileCommand } from '../commands/OpenMigrationFileCommand';
+import type { Logger } from '../util/Logger';
 
 export class TreeDataProvider
   extends Disposable
@@ -22,6 +23,7 @@ export class TreeDataProvider
   > = this._onDidChangeTreeData.event;
 
   constructor(
+    private readonly logger: Logger,
     private readonly projectFiles: ProjectFile[],
     private readonly cli: CLI,
   ) {
@@ -61,7 +63,12 @@ export class TreeDataProvider
     } else {
       return this.projectFiles.map(
         projectFile =>
-          new ProjectTreeItem(projectFile.name, projectFile, this.cli),
+          new ProjectTreeItem(
+            this.logger,
+            projectFile.name,
+            projectFile,
+            this.cli,
+          ),
       );
     }
   }

src/treeView/TreeDataProvider.ts

@@ -16,7 +16,7 @@ export class Logger {
   }
 
   public format(message: string, type: LogType): string {
-    return `[${type}] ${message}`;
+    return `${new Date().toLocaleDateString()} ${new Date().toLocaleTimeString()} [${type}] ${message}`;
   }
 
   public info(...messages: string[]): void {