Merge pull request #9 from darkriszty/feature/CJKSupport

Feature/cjk support

Author: darkriszty

CHANGELOG.md

@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ## [Unreleased]
 
+## 1.1.0 - 2017-05-09
+- 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 issue #1 by improving the detection of header separator to avoid unintended table formatting failures.
 

README.md

@@ -10,6 +10,7 @@ Makes tables more readable for humans. Compatible with the Markdown writer plugi
 - Create missing ending table border if the beginning already has a border, so the table _will end_ with "|".
 - Save space by not right-padding the last column if the table has no border.
 - Support empty columns inside tables.
+- Support character lengths for Chinese, Japanese and Korean characters.
 
 ![feature X](assets/animation.gif)
 
@@ -19,4 +20,4 @@ The extension is available for markdown (_.md_) files. To format a table just se
 
 ## Known Issues
 
-- Formatting multiple tables at once and formatting an entire file is not supported.
+- Formatting multiple tables at once is not supported (issue #7).

demonstration.md

@@ -24,4 +24,10 @@ Support empty columns inside tables:
 Primitive Type||Size(bit)|Class
 -|-|-|-
 byte||8|Byte
-char||16|Character
+char||16|Character
+
+Support for CJK character lengths:
+Column 1 | Column 2 | Column 3
+-|-|-
+1|𠁻|a
+x|𣄿|a

package.json

@@ -2,7 +2,7 @@
   "name": "markdown-table-prettify",
   "displayName": "Markdown Table Prettifier",
   "description": "Transforms markdown tables to be more readable.",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "publisher": "darkriszty",
   "repository": {
     "type": "git",
@@ -22,9 +22,9 @@
     "onLanguage:markdown"
   ],
   "main": "./out/src/extension/extension",
-  "contributes": { },
+  "contributes": {},
   "capabilities": {
-    "documentFormattingProvider" : "true"
+    "documentFormattingProvider": "true"
   },
   "scripts": {
     "vscode:prepublish": "tsc -p ./",
@@ -37,8 +37,8 @@
     "@types/node": "^6.0.40",
     "mocha": "^2.3.3",
     "typemoq": "^1.4.1",
-    "typescript": "^2.0.3",
+    "typescript": "^2.3.2",
     "vscode": "^1.0.0"
   },
   "license": "MIT"
-}
+}

src/column/columnFactory.ts

@@ -1,7 +1,7 @@
 'use strict';
 import * as vscode from 'vscode';
 import { TableRangePrettyfier } from "./tableRangePrettyfier";
-import { TableFactory } from "../table/tableFactory";
+import { TableFactory } from "../models/tableFactory";
 import { VsWindowLogger } from "../diagnostics/logger";
 
 // This method is called when the extension is activated.

src/column/rawColumn.ts

@@ -1,6 +1,6 @@
 import * as vscode from "vscode";
-import { ITable } from "../table/table";
-import { ITableFactory } from "../table/tableFactory";
+import { ITable } from "../models/table";
+import { ITableFactory } from "../models/tableFactory";
 import { ILogger } from "../diagnostics/logger";
 
 export class TableRangePrettyfier implements vscode.DocumentRangeFormattingEditProvider {

src/extension/extension.ts

@@ -0,0 +1,35 @@
+export class Cell {
+    private _value: string;
+    private _length: number;
+
+    constructor(value: string) {
+        this._value = value;
+        this._length = this._getOccupiedLength(value);
+    }
+
+    public static Empty = new Cell(" ");
+
+    public getValue(): string {
+        return this._value;
+    }
+
+    public getLength(): number {
+        return this._length;
+    }
+
+    private _getOccupiedLength(value: string): number {
+        let length: number = 0;
+
+        for (let i = 0, n = value.length; i < n; i++)
+            length += this._getCharDisplayLength(value.charAt(i));
+
+        return length;
+    }
+
+    private _getCharDisplayLength(character: string): number {
+        // for the specified ranges use a length of 2, otherwise a length of 1
+        return /^(([\u{4E00}-\u{9FFF}])|([\u{3400}-\u{4DBF}])|([\u{20000}-\u{2A6DF}])|([\u{2A700}-\u{2B73F}])|([\u{2B740}-\u{2B81F}]))$/u.test(character)
+            ? 2
+            : 1;
+    }
+}

src/extension/tableRangePrettyfier.ts

@@ -1,21 +1,21 @@
-import { RawColumn } from "./rawColumn";
 import { ColumnPositioning } from "./columnPositioning";
+import { Cell } from "./cell";
 
 export class Column {
     private _normalizedColumnValues: string[] = [];
+    private _columnType: ColumnPositioning;
+    private _columnLength: number = 0;
 
-    constructor(
-        private _rawColumn: RawColumn,
-        private _columnType: ColumnPositioning) {
-            this._normalizeColumns();
+    constructor(private _cells: Cell[]) {
+        this._setColumnLength();
     }
 
-    public getSize(): number {
-        return this._normalizedColumnValues.length;
+    public getNumberOfRows(): number {
+        return this._cells.length + 1;
     }
 
     public isEmpty(): boolean {
-        return this._rawColumn.isEmpty();
+        return this._columnLength == 0;
     }
 
     public getValue(row: number): string {
@@ -26,24 +26,30 @@ export class Column {
         return this._columnType;
     }
 
+    public setPositioning(position: ColumnPositioning): void {
+        this._columnType = position;
+        this._normalizeColumns();
+    }
+
     private _normalizeColumns(): void {
-        for (let row = 0, rowCount = this._rawColumn.columnValues.length ; row < rowCount; row++) {
+        for (let row = 0, rowCount = this._cells.length ; row < rowCount; row++) {
             const currentRowValue = this.isEmpty() && this._columnType == ColumnPositioning.Middle
-                ? " " 
-                : this._rawColumn.columnValues[row];
+                ? Cell.Empty
+                : this._cells[row];
             this._addValueWithPadding(currentRowValue, " ");
             if (row == 0)
-                this._addValueWithPadding("-", "-");
+                this._addValueWithPadding(new Cell("-"), "-");
         }
     }
 
-    private _addValueWithPadding(value: string, padChar: string): void {
+    private _addValueWithPadding(cell: Cell, padChar: string): void {
         let newValue = "";
+        const cellValue = cell.getValue();
         if (!this.isEmpty() || this._columnType == ColumnPositioning.Middle) {
-            const left = this._getLeftPad(value, padChar);
-            const right = this._getRightPad(value, padChar);
+            const left = this._getLeftPad(cellValue, padChar);
+            const right = this._getRightPad(cell, padChar);
 
-            newValue = left + value + right;
+            newValue = left + cellValue + right;
         }
         this._normalizedColumnValues.push(newValue);
     }
@@ -63,16 +69,25 @@ export class Column {
         }
     }
 
-    private _getRightPad(value: string, rightPad: string): string {
+    private _getRightPad(cell: Cell, rightPad: string): string {
         const seperatorBeingAdded = this._oneRowExists();
         // only the separator has padding in the last column
         if (this._columnType == ColumnPositioning.Last && !seperatorBeingAdded)
             return "";
 
-        const extraPaddingCount = Math.max(this._rawColumn.cellLength - value.length + 2, 2);
+        const extraPaddingCount = Math.max(this._columnLength - cell.getLength() + 2, 2);
         return new Array(extraPaddingCount).join(rightPad);
     }
 
+    private _setColumnLength(): void {
+        const rowCount = this._cells.length;
+        for (let row = 0 ; row < rowCount; row++) {
+            const currentLength = this._cells[row].getLength();
+            if (currentLength > this._columnLength)
+               this._columnLength = currentLength;
+        }
+    }
+
     private _oneRowExists(): boolean {
         return this._normalizedColumnValues.length == 1;
     }