Merge pull request #3418 from VSCodeVim/logger

fix: validate configurations once, instead of every key press
VSCodeVim · Jan 30, 2019 · e7dd011 · e7dd011
2 parents f49c1e3 + 415852f
commit e7dd011
Show file tree

Hide file tree

Showing 31 changed files with 385 additions and 306 deletions.
diff --git a/extension.ts b/extension.ts
@@ -16,14 +16,13 @@ import { ModeHandler } from './src/mode/modeHandler';
 import { ModeHandlerMap } from './src/mode/modeHandlerMap';
 import { ModeName } from './src/mode/mode';
 import { Notation } from './src/configuration/notation';
+import { Logger } from './src/util/logger';
 import { Position } from './src/common/motion/position';
 import { StatusBar } from './src/statusBar';
 import { VsCodeContext } from './src/util/vscode-context';
 import { commandLine } from './src/cmd_line/commandLine';
 import { configuration } from './src/configuration/configuration';
-import { configurationValidator } from './src/configuration/configurationValidator';
 import { globalState } from './src/state/globalState';
-import { logger } from './src/util/logger';
 import { taskQueue } from './src/taskQueue';
 
 let extensionContext: vscode.ExtensionContext;
@@ -68,21 +67,40 @@ export async function getAndUpdateModeHandler(forceSyncAndUpdate = false): Promi
   return curHandler;
 }
 
+async function loadConfiguration() {
+  const configurationErrors = await configuration.load();
+  const logger = Logger.get('Configuration');
+
+  const numErrors = configurationErrors.filter(e => e.level === 'error').length;
+  logger.debug(`${numErrors} errors found with vim configuration`);
+
+  if (numErrors > 0) {
+    for (let configurationError of configurationErrors) {
+      switch (configurationError.level) {
+        case 'error':
+          logger.error(configurationError.message);
+          break;
+        case 'warning':
+          logger.warn(configurationError.message);
+          break;
+      }
+    }
+  }
+}
 export async function activate(context: vscode.ExtensionContext) {
-  logger.debug('Extension: activating vscodevim.');
+  // before we do anything else,
+  // we need to load the configuration first
+  await loadConfiguration();
 
   extensionContext = context;
   extensionContext.subscriptions.push(StatusBar);
 
-  logger.debug('Extension: registering event handlers.');
-
   // workspace events
   registerEventListener(
     context,
     vscode.workspace.onDidChangeConfiguration,
-    () => {
-      logger.debug('onDidChangeConfiguration: reloading configuration');
-      configuration.reload();
+    async () => {
+      await loadConfiguration();
     },
     false
   );
@@ -344,7 +362,6 @@ export async function activate(context: vscode.ExtensionContext) {
   await Promise.all([
     commandLine.load(),
     globalState.load(),
-    configurationValidator.initialize(),
     // This is called last because getAndUpdateModeHandler() will change cursor
     toggleExtension(configuration.disableExtension, compositionState),
   ]);

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -694,7 +694,7 @@
     "neovim": "4.2.1",
     "untildify": "3.0.3",
     "winston": "3.1.0",
-    "winston-console-for-electron": "0.0.5"
+    "winston-console-for-electron": "0.0.6"
   },
   "devDependencies": {
     "@types/diff": "3.5.2",

diff --git a/src/actions/motion.ts b/src/actions/motion.ts
@@ -663,14 +663,8 @@ class MoveFindForward extends BaseMovement {
       !this.isRepeat &&
       (!vimState.recordedState.operator || !(isIMovement(result) && result.failed))
     ) {
-      vimState.lastSemicolonRepeatableMovement = new MoveFindForward(
-        this.keysPressed,
-        true
-      );
-      vimState.lastCommaRepeatableMovement = new MoveFindBackward(
-        this.keysPressed,
-        true
-      );
+      vimState.lastSemicolonRepeatableMovement = new MoveFindForward(this.keysPressed, true);
+      vimState.lastCommaRepeatableMovement = new MoveFindBackward(this.keysPressed, true);
     }
 
     return result;
@@ -698,14 +692,8 @@ class MoveFindBackward extends BaseMovement {
       !this.isRepeat &&
       (!vimState.recordedState.operator || !(isIMovement(result) && result.failed))
     ) {
-      vimState.lastSemicolonRepeatableMovement = new MoveFindBackward(
-        this.keysPressed,
-        true
-      );
-      vimState.lastCommaRepeatableMovement = new MoveFindForward(
-        this.keysPressed,
-        true
-      );
+      vimState.lastSemicolonRepeatableMovement = new MoveFindBackward(this.keysPressed, true);
+      vimState.lastCommaRepeatableMovement = new MoveFindForward(this.keysPressed, true);
     }
 
     return result;
@@ -742,14 +730,8 @@ class MoveTilForward extends BaseMovement {
       !this.isRepeat &&
       (!vimState.recordedState.operator || !(isIMovement(result) && result.failed))
     ) {
-      vimState.lastSemicolonRepeatableMovement = new MoveTilForward(
-        this.keysPressed,
-        true
-      );
-      vimState.lastCommaRepeatableMovement = new MoveTilBackward(
-        this.keysPressed,
-        true
-      );
+      vimState.lastSemicolonRepeatableMovement = new MoveTilForward(this.keysPressed, true);
+      vimState.lastCommaRepeatableMovement = new MoveTilBackward(this.keysPressed, true);
     }
 
     return result;
@@ -782,10 +764,7 @@ class MoveTilBackward extends BaseMovement {
       !this.isRepeat &&
       (!vimState.recordedState.operator || !(isIMovement(result) && result.failed))
     ) {
-      vimState.lastSemicolonRepeatableMovement = new MoveTilBackward(
-        this.keysPressed,
-        true
-      );
+      vimState.lastSemicolonRepeatableMovement = new MoveTilBackward(this.keysPressed, true);
       vimState.lastCommaRepeatableMovement = new MoveTilForward(this.keysPressed, true);
     }
 

diff --git a/src/actions/plugins/imswitcher.ts b/src/actions/plugins/imswitcher.ts
@@ -3,7 +3,7 @@ import { Globals } from '../../globals';
 import { ModeName } from '../../mode/mode';
 import { configuration } from '../../configuration/configuration';
 import { exists } from 'fs';
-import { logger } from '../../util/logger';
+import { Logger } from '../../util/logger';
 import { promisify } from 'util';
 
 /**
@@ -14,8 +14,9 @@ export class InputMethodSwitcher {
     this.execute = execute;
   }
 
-  private savedIMKey = '';
   private execute: (cmd: string) => Promise<string>;
+  private readonly logger = Logger.get('IMSwitcher');
+  private savedIMKey = '';
 
   public async switchInputMethod(prevMode: ModeName, newMode: ModeName) {
     if (configuration.autoSwitchInputMethod.enable !== true) {
@@ -48,11 +49,11 @@ export class InputMethodSwitcher {
           this.savedIMKey = insertIMKey.trim();
         }
       } catch (e) {
-        logger.error(`IMSwitcher: Error switching to default IM. err=${e}`);
+        this.logger.error(`Error switching to default IM. err=${e}`);
       }
     } else {
-      logger.error(
-        `IMSwitcher: Unable to find ${rawObtainIMCmd}. Check your 'vim.autoSwitchInputMethod.obtainIMCmd' in VSCode setting.`
+      this.logger.error(
+        `Unable to find ${rawObtainIMCmd}. Check your 'vim.autoSwitchInputMethod.obtainIMCmd' in VSCode setting.`
       );
       this.disableIMSwitch();
     }
@@ -79,12 +80,12 @@ export class InputMethodSwitcher {
         try {
           await this.execute(switchIMCmd);
         } catch (e) {
-          logger.error(`IMSwitcher: Error switching to IM. err=${e}`);
+          this.logger.error(`Error switching to IM. err=${e}`);
         }
       }
     } else {
-      logger.error(
-        `IMSwitcher: Unable to find ${rawSwitchIMCmd}. Check your 'vim.autoSwitchInputMethod.switchIMCmd' in VSCode setting.`
+      this.logger.error(
+        `Unable to find ${rawSwitchIMCmd}. Check your 'vim.autoSwitchInputMethod.switchIMCmd' in VSCode setting.`
       );
       this.disableIMSwitch();
     }
@@ -104,27 +105,27 @@ export class InputMethodSwitcher {
   }
 
   private disableIMSwitch() {
-    logger.warn('IMSwitcher: disabling IMSwitch');
+    this.logger.warn('disabling IMSwitch');
     configuration.autoSwitchInputMethod.enable = false;
   }
 
   private isConfigurationValid(): boolean {
     let switchIMCmd = configuration.autoSwitchInputMethod.switchIMCmd;
     if (!switchIMCmd.includes('{im}')) {
-      logger.error(
-        'IMSwitcher: vim.autoSwitchInputMethod.switchIMCmd is incorrect, \
+      this.logger.error(
+        'vim.autoSwitchInputMethod.switchIMCmd is incorrect, \
         it should contain the placeholder {im}'
       );
       return false;
     }
     let obtainIMCmd = configuration.autoSwitchInputMethod.obtainIMCmd;
     if (obtainIMCmd === undefined || obtainIMCmd === '') {
-      logger.error('IMSwitcher: vim.autoSwitchInputMethod.obtainIMCmd is empty');
+      this.logger.error('vim.autoSwitchInputMethod.obtainIMCmd is empty');
       return false;
     }
     let defaultIMKey = configuration.autoSwitchInputMethod.defaultIM;
     if (defaultIMKey === undefined || defaultIMKey === '') {
-      logger.error('IMSwitcher: vim.autoSwitchInputMethod.defaultIM is empty');
+      this.logger.error('vim.autoSwitchInputMethod.defaultIM is empty');
       return false;
     }
     return true;

diff --git a/src/actions/plugins/sneak.ts b/src/actions/plugins/sneak.ts
@@ -21,10 +21,7 @@ class SneakForward extends BaseMovement {
 
   public async execAction(position: Position, vimState: VimState): Promise<Position | IMovement> {
     if (!this.isRepeat) {
-      vimState.lastSemicolonRepeatableMovement = new SneakForward(
-        this.keysPressed,
-        true
-      );
+      vimState.lastSemicolonRepeatableMovement = new SneakForward(this.keysPressed, true);
       vimState.lastCommaRepeatableMovement = new SneakBackward(this.keysPressed, true);
     }
 
@@ -79,10 +76,7 @@ class SneakBackward extends BaseMovement {
 
   public async execAction(position: Position, vimState: VimState): Promise<Position | IMovement> {
     if (!this.isRepeat) {
-      vimState.lastSemicolonRepeatableMovement = new SneakBackward(
-        this.keysPressed,
-        true
-      );
+      vimState.lastSemicolonRepeatableMovement = new SneakBackward(this.keysPressed, true);
       vimState.lastCommaRepeatableMovement = new SneakForward(this.keysPressed, true);
     }