Merge pull request #107 from ngdenterprise/logging-improvements

Log to VS Code output channel. Fixes #105

Author: djnicholson

CHANGELOG.md

@@ -9,6 +9,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 ### Changed
 
 - The invoke file editor now supports editing invocation files that use arrays or objects as contract parameters
+- Extension logs are now also shown in the VS Code Output Panel
 
 ## [2.1.49] - 2021-06-21
 

src/extension/activeConnection.ts

@@ -7,7 +7,7 @@ import BlockchainMonitorPool from "./blockchainMonitor/blockchainMonitorPool";
 import BlockchainType from "./blockchainType";
 import BlockchainsTreeDataProvider from "./vscodeProviders/blockchainsTreeDataProvider";
 import IoHelpers from "./util/ioHelpers";
-import Log from "../shared/log";
+import Log from "./util/log";
 
 const LOG_PREFIX = "ActiveConnection";
 const STATUS_PREFIX = "Neo:";
@@ -31,7 +31,8 @@ export default class ActiveConnection {
     private readonly blockchainMonitorPool: BlockchainMonitorPool
   ) {
     this.connection = null;
-    this.onChangeEmitter = new vscode.EventEmitter<BlockchainIdentifier | null>();
+    this.onChangeEmitter =
+      new vscode.EventEmitter<BlockchainIdentifier | null>();
     this.onChange = this.onChangeEmitter.event;
     this.statusBarItem = vscode.window.createStatusBarItem();
   }

src/extension/autoComplete.ts

@@ -8,11 +8,10 @@ import AutoCompleteData from "../shared/autoCompleteData";
 import BlockchainIdentifier from "./blockchainIdentifier";
 import ContractDetector from "./fileDetectors/contractDetector";
 import dedupeAndSort from "./util/dedupeAndSort";
-import Log from "../shared/log";
+import Log from "./util/log";
 import NeoExpress from "./neoExpress/neoExpress";
 import NeoExpressDetector from "./fileDetectors/neoExpressDetector";
 import NeoExpressIo from "./neoExpress/neoExpressIo";
-import reverseBytes from "../panel/components/tracker/reverseBytes";
 import WalletDetector from "./fileDetectors/walletDetector";
 
 const LOG_PREFIX = "AutoComplete";

src/extension/blockchainIdentifier.ts

@@ -5,7 +5,7 @@ import * as vscode from "vscode";
 import BlockchainType from "./blockchainType";
 import IoHelpers from "./util/ioHelpers";
 import JSONC from "./util/JSONC";
-import Log from "../shared/log";
+import Log from "./util/log";
 import posixPath from "./util/posixPath";
 
 const LOG_PREFIX = "BlockchainIdentifier";

src/extension/blockchainMonitor/blockchainMonitorInternal.ts

@@ -7,7 +7,7 @@ import * as vscode from "vscode";
 import AddressInfo from "../../shared/addressInfo";
 import ApplicationLog from "../../shared/applicationLog";
 import BlockchainState from "./blockchainState";
-import Log from "../../shared/log";
+import Log from "../util/log";
 
 const APP_LOG_CACHE_SIZE = 1024;
 const BLOCK_CACHE_SIZE = 1024;

src/extension/fileDetectors/contractDetector.ts

@@ -5,7 +5,7 @@ import * as neonSc from "@cityofzion/neon-core/lib/sc";
 import ActiveConnection from "../activeConnection";
 import DetectorBase from "./detectorBase";
 import JSONC from "../util/JSONC";
-import Log from "../../shared/log";
+import Log from "../util/log";
 
 const LOG_PREFIX = "ContractDetector";
 const SEARCH_PATTERN = "**/*.nef";

src/extension/fileDetectors/detectorBase.ts

@@ -1,6 +1,6 @@
 import * as vscode from "vscode";
 
-import Log from "../../shared/log";
+import Log from "../util/log";
 import posixPath from "../util/posixPath";
 
 const LOG_PREFIX = "DetectorBase";
@@ -28,9 +28,8 @@ export default abstract class DetectorBase {
     this.onChangeEmitter = new vscode.EventEmitter<void>();
     this.onChange = this.onChangeEmitter.event;
     this.refresh();
-    this.fileSystemWatcher = vscode.workspace.createFileSystemWatcher(
-      searchPattern
-    );
+    this.fileSystemWatcher =
+      vscode.workspace.createFileSystemWatcher(searchPattern);
     this.fileSystemWatcher.onDidChange(this.refresh, this);
     this.fileSystemWatcher.onDidCreate(this.refresh, this);
     this.fileSystemWatcher.onDidDelete(this.refresh, this);
@@ -46,9 +45,9 @@ export default abstract class DetectorBase {
 
   async refresh() {
     Log.log(LOG_PREFIX, "Refreshing file list...", this.searchPattern);
-    this.allFiles = (
-      await vscode.workspace.findFiles(this.searchPattern)
-    ).map((_) => posixPath(_.fsPath));
+    this.allFiles = (await vscode.workspace.findFiles(this.searchPattern)).map(
+      (_) => posixPath(_.fsPath)
+    );
     await this.processFiles();
     this.onChangeEmitter.fire();
   }

src/extension/fileDetectors/serverListDetector.ts

@@ -6,7 +6,7 @@ import BlockchainIdentifier from "../blockchainIdentifier";
 import DetectorBase from "./detectorBase";
 import IoHelpers from "../util/ioHelpers";
 import JSONC from "../util/JSONC";
-import Log from "../../shared/log";
+import Log from "../util/log";
 import posixPath from "../util/posixPath";
 
 const LOG_PREFIX = "ServerListDetector";

src/extension/index.ts

@@ -12,7 +12,7 @@ import {
 } from "./commands/commandArguments";
 import ContractDetector from "./fileDetectors/contractDetector";
 import ContractsTreeDataProvider from "./vscodeProviders/contractsTreeDataProvider";
-import Log from "../shared/log";
+import Log from "./util/log";
 import NeoCommands from "./commands/neoCommands";
 import NeoExpress from "./neoExpress/neoExpress";
 import NeoExpressCommands from "./commands/neoExpressCommands";
@@ -43,7 +43,8 @@ function registerCommand(
           commandArguments.path = (context as vscode.Uri).fsPath;
         } else if (context && !!(context as BlockchainIdentifier).name) {
           // Activation was by right-click on an item in the Blockchain explorer
-          commandArguments.blockchainIdentifier = context as BlockchainIdentifier;
+          commandArguments.blockchainIdentifier =
+            context as BlockchainIdentifier;
         } else if (context) {
           // Activation by command URI containing query string parameters
           commandArguments = await sanitizeCommandArguments(context);
@@ -365,4 +366,5 @@ export async function activate(context: vscode.ExtensionContext) {
 
 export function deactivate() {
   Log.log(LOG_PREFIX, "Deactivating extension...");
+  Log.close();
 }

src/extension/neoExpress/neoExpress.ts

@@ -2,7 +2,7 @@ import * as childProcess from "child_process";
 import * as vscode from "vscode";
 import * as which from "which";
 
-import Log from "../../shared/log";
+import Log from "../util/log";
 import NeoExpressTerminal from "./neoExpressTerminal";
 import posixPath from "../util/posixPath";