Merge from master and refactor silent logging

Author: darkriszty

CHANGELOG.md

@@ -6,17 +6,20 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ## [Unreleased]
 
-## 1.1.0 - 2017-05-09
 
+## 1.1.1 - 2017-05-27
+### Fixed
+- Issue #10: Don't show format failure messages when using the `Format Document` from VsCode.
+
+## 1.1.0 - 2017-05-09
+### Added
 - Issue #6: Formatting when there's only a single table in the entire file.
 - Issue #4: Add support for CJK characters.
 
 ## 1.0.1 - 2017-04-08
-
+### Fixed
 - Fixed issue #1 by improving the detection of header separator to avoid unintended table formatting failures.
 
 ## 1.0.0 - 2017-04-03
-
 ### Added
-
-- Support to format individual tables with right click -> format selection.
+- Support to format individual tables with right click -> `Format Selection`.

package.json

@@ -2,7 +2,7 @@
   "name": "markdown-table-prettify",
   "displayName": "Markdown Table Prettifier",
   "description": "Transforms markdown tables to be more readable.",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "publisher": "darkriszty",
   "repository": {
     "type": "git",

src/diagnostics/baseLogger.ts

@@ -0,0 +1,17 @@
+import { ILogger } from "./logger";
+
+export abstract class BaseLogger implements ILogger {
+    private _enabled: boolean = true;
+
+    public setEnabled(enabled: boolean): void {
+        this._enabled = enabled;
+    }
+
+    public abstract logInfo(message: string): void;
+    public abstract logError(error: string | Error): void;
+
+    protected logIfEnabled(logFunc: (any) => void, param: string | Error): void {
+        if (!this._enabled) return;
+        logFunc(param);
+    }
+}

src/diagnostics/consoleLogger.ts

@@ -1,12 +1,13 @@
 import { ILogger } from "./logger";
+import { BaseLogger } from "./baseLogger";
 
-export class ConsoleLogger implements ILogger {
+export class ConsoleLogger extends BaseLogger implements ILogger {
 
-    logInfo(message: string): void {
-        console.log(message);
+    public logInfo(message: string): void {
+        super.logIfEnabled(console.log, message);
     }
 
-    logError(error: string | Error): void {
-        console.error(error);
+    public logError(error: string | Error): void {
+        super.logIfEnabled(console.error, error);
     }
 }

src/diagnostics/logger.ts

@@ -1,4 +1,5 @@
 export interface ILogger {
+    setEnabled(enabled: boolean): void;
     logInfo(message: string): void;
     logError(error: Error | string): void;
 }

src/diagnostics/selectionBasedLogToogler.ts

@@ -0,0 +1,27 @@
+import * as vscode from "vscode";
+import { ILogger } from "../diagnostics/logger";
+
+export class SelectionBasedLogToogler {
+    constructor(
+        private readonly _document: vscode.TextDocument, 
+        private readonly _range: vscode.Range) { }
+
+    public toogleLoggers(loggers: ILogger[]) {
+        const logEnabled = !this._isWholeDocumentFormatting();
+        for (const logger of loggers) {
+            logger.setEnabled(logEnabled);
+        }
+    }
+
+    private _isWholeDocumentFormatting(): boolean {
+        if (this._document.lineCount < 1)
+            return true;
+
+        const zeroPosition = new vscode.Position(0, 0);
+        const documentEndPosition = this._document.lineAt(this._document.lineCount - 1).range.end;
+        if (this._range.start.isEqual(zeroPosition) && this._range.end.isEqual(documentEndPosition))
+            return true;
+
+        return false;
+    }
+}

src/diagnostics/vsWindowLogger.ts

@@ -1,17 +1,17 @@
 import * as vscode from 'vscode';
 import { ILogger } from "./logger";
+import { BaseLogger } from './baseLogger';
 
-export class VsWindowLogger implements ILogger {
+export class VsWindowLogger extends BaseLogger implements ILogger {
 
-    logInfo(message: string): void {
-        vscode.window.showInformationMessage(message);
+    public logInfo(message: string): void {
+        super.logIfEnabled(vscode.window.showInformationMessage, message);
     }
 
-    logError(error: string | Error): void {
+    public logError(error: string | Error): void {
         const message: string = error instanceof Error
             ? (<Error>error).message
             : error;
-
-        vscode.window.showErrorMessage(message);
+        super.logIfEnabled(vscode.window.showErrorMessage, message);
     }
 }

src/extension/tableRangePrettyfier.ts

@@ -1,5 +1,6 @@
 import * as vscode from "vscode";
 import { ILogger } from "../diagnostics/logger";
+import { SelectionBasedLogToogler } from "../diagnostics/selectionBasedLogToogler";
 import { Table } from "../models/table";
 import { TableFactory } from "../modelFactory/tableFactory";
 import { TableValidator } from "../modelFactory/tableValidator";
@@ -17,14 +18,16 @@ export class TableRangePrettyfier implements vscode.DocumentRangeFormattingEditP
         private _loggers: ILogger[]
     ) { }
 
-    provideDocumentRangeFormattingEdits(
+    public provideDocumentRangeFormattingEdits(
         document: vscode.TextDocument, range: vscode.Range,
         options: vscode.FormattingOptions, token: vscode.CancellationToken) : vscode.TextEdit[]
     {
         const result: vscode.TextEdit[] = [];
         const selection = document.getText(range);
 
+        this.toogleLogging(document, range);
         let message: string = null;
+
         try {
             if (this._tableValidator.isValid(selection)) {
                 const table: Table = this._tableFactory.getModel(selection);
@@ -43,4 +46,9 @@ export class TableRangePrettyfier implements vscode.DocumentRangeFormattingEditP
 
         return result;
     }
+
+    private toogleLogging(document: vscode.TextDocument, range: vscode.Range) {
+        const toogler = new SelectionBasedLogToogler(document, range);
+        toogler.toogleLoggers(this._loggers);
+    }
 }

test/unitTests/diagnostics/selectionBasedLogToogler.test.ts

@@ -0,0 +1,31 @@
+import * as assert from "assert";
+import * as vscode from "vscode";
+import { IMock, Mock, It, Times } from "typemoq";
+import { SelectionBasedLogToogler } from "../../../src/diagnostics/selectionBasedLogToogler";
+import { MarkdownTextDocumentStub } from "../../stubs/markdownTextDocumentStub";
+import { ILogger } from "../../../src/diagnostics/logger";
+
+suite("SelectionBasedLogToogler tests", () => {
+
+    test("toogleLoggers() with entire document disables all loggers", () => {
+        const loggerMocks: IMock<ILogger>[] = [ Mock.ofType<ILogger>(), Mock.ofType<ILogger>() ];
+        const document = new MarkdownTextDocumentStub("test");
+        const sut = new SelectionBasedLogToogler(document, document.getFullRange());
+
+        sut.toogleLoggers(loggerMocks.map(_ => _.object));
+
+        loggerMocks.forEach(m => m.verify(_ => _.setEnabled(false), Times.once()));
+    });
+
+    test("toogleLoggers() with document fagment enables all loggers", () => {
+        const loggerMocks: IMock<ILogger>[] = [ Mock.ofType<ILogger>(), Mock.ofType<ILogger>() ];
+        const document = new MarkdownTextDocumentStub(
+        `test
+        test`);
+        const sut = new SelectionBasedLogToogler(document, document.getRangeForLines(1, 1));
+
+        sut.toogleLoggers(loggerMocks.map(_ => _.object));
+
+        loggerMocks.forEach(m => m.verify(_ => _.setEnabled(true), Times.once()));
+    });
+});