Merge pull request #12 from k--kato/wontfix/#10

fixed #10 Support for tabs indentation
kasecato · Jun 24, 2016 · 413ff1d · 413ff1d
2 parents d055d9c + 7de2346
commit 413ff1d
Show file tree

Hide file tree

Showing 13 changed files with 171 additions and 51 deletions.
diff --git a/README.md b/README.md
@@ -22,8 +22,12 @@ The menu under File > Preferences (Code > Preferences on Mac) provides entries t
 
 ```json
 {
-    // Press the Enter key to activate a command
-    "docomment.activateOnEnter": true
+	// Press the Enter key to activate a command (Default: false)
+	"docomment.activateOnEnter": true,
+	// Insert spaces when pressing Tab.
+	"editor.insertSpaces": true,
+	// The number of spaces a tab is equal to.
+	"editor.tabSize": 4
 }
 ```
 

diff --git a/package.json b/package.json
@@ -30,7 +30,7 @@
                 "docomment.activateOnEnter": {
                     "type": "boolean",
                     "default": false,
-                    "description": "Activating the Enter key."
+                    "description": "Press the Enter key to activate a command."
                 }
             }
         }

diff --git a/src/Controller/DocommentController.ts b/src/Controller/DocommentController.ts
@@ -62,10 +62,13 @@ export class DocommentController implements IDocommentController {
      * Private Method
      *-----------------------------------------------------------------------*/
     private loadConfig() {
-        const conf: WorkspaceConfiguration = workspace.getConfiguration(Configuration.KEY);
+        const confDocomment: WorkspaceConfiguration = workspace.getConfiguration(Configuration.KEY_DOCOMMENT);
+        const confEditor: WorkspaceConfiguration = workspace.getConfiguration(Configuration.KEY_EDITOR);
 
         this._config = new Configuration();
-        this._config.activateOnEnter = conf.get<boolean>(Configuration.ACTIVATE_ON_ENTER, false);
+        this._config.activateOnEnter = confDocomment.get<boolean>(Configuration.ACTIVATE_ON_ENTER, false);
+        this._config.insertSpaces = confEditor.get<boolean>(Configuration.INSERT_SPACES, false);
+        this._config.tabSize = confEditor.get<number>(Configuration.TAB_SIZE, 4);
     }
 
     /*-------------------------------------------------------------------------

diff --git a/src/Domain/DocommentDomain.ts b/src/Domain/DocommentDomain.ts
@@ -99,5 +99,4 @@ export class DocommentDomain implements IDocommentDomain {
         // NOP
     }
 
-
 }
diff --git a/src/Domain/Lang/DocommentDomainCSharp.ts b/src/Domain/Lang/DocommentDomainCSharp.ts
@@ -32,11 +32,14 @@ export class DocommentDomainCSharp extends DocommentDomain {
         const activeLine: string = this._vsCodeApi.ReadLineAtCurrent();
         if (activeLine == null) return false;
         if (isSlashKey) {
-            const isDocComment: boolean = SyntacticAnalysisCSharp.IsDocComment(activeLine); 
+            const isDocComment: boolean = SyntacticAnalysisCSharp.IsDocCommentStrict(activeLine);
             if (!isDocComment) return false;
+
+            // NG: '/' => Insert => Event => ' /// '
+            if (SyntacticAnalysisCSharp.IsDoubleDocComment(activeLine)) return false;
         }
         if (isEnterKey) {
-            const isDocComment: boolean = SyntacticAnalysisCSharp.IsDocComment(activeLine); 
+            const isDocComment: boolean = SyntacticAnalysisCSharp.IsDocComment(activeLine);
             if (!isDocComment) return false;
         }
 
@@ -151,8 +154,9 @@ export class DocommentDomainCSharp extends DocommentDomain {
         const position: Position = this._vsCodeApi.GetActivePosition();
 
         if (codeType === CodeType.Comment) {
-            const indentLen: number = StringUtil.GetIndent(code).length;
-            const insertPosition: Position = this._vsCodeApi.GetPosition(position.line + 1, indentLen);
+            const indent: string = StringUtil.GetIndent(code, this._config.insertSpaces, this._config.tabSize);
+            const indentLen: number = StringUtil.GetIndentLen(indent, this._config.insertSpaces, this._config.tabSize);
+            const insertPosition: Position = this._vsCodeApi.GetPosition(position.line + 1, indentLen - 1);
             this._vsCodeApi.InsertText(insertPosition, docommnet);
         } else {
             const insertPosition: Position = this._vsCodeApi.ShiftPositionChar(position, 1);
@@ -165,8 +169,9 @@ export class DocommentDomainCSharp extends DocommentDomain {
         const curPosition = this._vsCodeApi.GetActivePosition();
 
         if (codeType === CodeType.Comment) {
-            const indentLen: number = StringUtil.GetIndent(code).length;
-            this._vsCodeApi.MoveSelection(curPosition.line + 1, indentLen + docomment.length); 
+            const indent: string = StringUtil.GetIndent(code, this._config.insertSpaces, this._config.tabSize);
+            const indentLen: number = StringUtil.GetIndentLen(indent, this._config.insertSpaces, this._config.tabSize);
+            this._vsCodeApi.MoveSelection(curPosition.line + 1, indentLen - 1 + docomment.length); 
         } else {
             this._vsCodeApi.MoveSelection(curPosition.line + 1, curPosition.character + 2);
         }
@@ -199,7 +204,7 @@ export class DocommentDomainCSharp extends DocommentDomain {
         }
 
         // Format
-        const indent: string = StringUtil.GetIndent(code);
+        const indent: string = StringUtil.GetIndent(code, this._config.insertSpaces, this._config.tabSize);
         let docomment = ' ' + docommentList[0] + '\n';
         for (let i = 1; i < docommentList.length; i++) {
             docomment += indent + '/// ' + docommentList[i];

diff --git a/src/Entity/Config/Contributes/Configuration.ts b/src/Entity/Config/Contributes/Configuration.ts
@@ -1,15 +1,21 @@
 export class Configuration {
 
     /*-------------------------------------------------------------------------
-     * Const
+     * docomment
      *-----------------------------------------------------------------------*/
-    public static KEY: string = "docomment";
-
+    public static KEY_DOCOMMENT: string = "docomment";
     public static ACTIVATE_ON_ENTER: string = "activateOnEnter";
 
+    public activateOnEnter: boolean;
+
     /*-------------------------------------------------------------------------
-     * Field
+     * editor
      *-----------------------------------------------------------------------*/
-    public activateOnEnter: Boolean;
+    public static KEY_EDITOR: string = "editor";
+    public static INSERT_SPACES: string = "insertSpaces";
+    public static TAB_SIZE: string = "tabSize";
+
+    public insertSpaces: boolean;
+    public tabSize: number;
 
 }
diff --git a/src/SyntacticAnalysis/SyntacticAnalysisCSharp.ts b/src/SyntacticAnalysis/SyntacticAnalysisCSharp.ts
@@ -17,10 +17,18 @@ export class SyntacticAnalysisCSharp {
         return (activeChar === '/');
     }
 
-    public static IsDocComment(activeLine: string): boolean {
+    public static IsDocCommentStrict(activeLine: string): boolean {
         return activeLine.match(/(?:[^/]\/{3}[ \t]*$)|(?:^\/{3}[^/])|(?:^\/{3}[ \t]*$)/) !== null; // fixme: to simple
     }
 
+    public static IsDocComment(activeLine: string): boolean {
+        return activeLine.match(/\/{3}/) !== null;
+    }
+
+    public static IsDoubleDocComment(activeLine: string): boolean {
+        return activeLine.match(/^[ \t]+\/{3} $/) !== null;
+    }
+
     /*-------------------------------------------------------------------------
      * Public Method: Code Type
      *-----------------------------------------------------------------------*/
@@ -76,7 +84,7 @@ export class SyntacticAnalysisCSharp {
 
     public static IsComment(code: string): boolean {
         if (code === null) return false;
-        return code.match(/[ ]+/) !== null;
+        return code.match(/[ \t]+/) !== null;
     }
 
     public static GetMethodParamNameList(code: string): Array<string> {

diff --git a/src/Utility/StringUtil.ts b/src/Utility/StringUtil.ts
@@ -17,9 +17,24 @@ export class StringUtil {
         return line.replace(/\/\/.*/, '').replace(/\/\*.*\*\//, '');
     }
 
-    public static GetIndent(line: string): string {
+    public static GetIndent(line: string, insertSpaces: boolean, tabSize: number): string {
         if (line === null) return null;
-        return line.match(/([ \t]*)?/)[0];
+        const indent: string = line.match(/([ \t]*)?/)[0];
+        const spaces: string = ' '.repeat(tabSize);
+        if (insertSpaces) {
+            return indent.split('\t').join(spaces);
+        } else {
+            return indent.split(spaces).join('\t');
+        }
+    }
+
+    public static GetIndentLen(indent: string, insertSpaces: boolean, tabSize: number): number {
+        if (indent === null) return 0;
+        if (insertSpaces) {
+            return indent.split(' ').length;
+        } else {
+            return indent.split('\t').length * tabSize;
+        }
     }
 
 }
diff --git a/test/Entity/Config/Contributes/Configuration.test.ts b/test/Entity/Config/Contributes/Configuration.test.ts
@@ -0,0 +1,3 @@
+suite('Entity.Config.Contributes.Configuration Tests', () => {
+    // NOP
+});
diff --git a/test/TestData/.vscode/launch.json b/test/TestData/.vscode/launch.json
@@ -0,0 +1,45 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": ".NET Core Launch (console)",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "build",
+            "program": "${workspaceRoot}/bin/Debug/<target-framework>/<project-name.dll>",
+            "args": [],
+            "cwd": "${workspaceRoot}",
+            "stopAtEntry": false
+        },
+        {
+            "name": ".NET Core Launch (web)",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "build",
+            "program": "${workspaceRoot}/bin/Debug/<target-framework>/<project-name.dll>",
+            "args": [],
+            "cwd": "${workspaceRoot}",
+            "stopAtEntry": false,
+            "launchBrowser": {
+                "enabled": true,
+                "args": "${auto-detect-url}",
+                "windows": {
+                    "command": "cmd.exe",
+                    "args": "/C start ${auto-detect-url}"
+                },
+                "osx": {
+                    "command": "open"
+                },
+                "linux": {
+                    "command": "xdg-open"
+                }
+            }
+        },
+        {
+            "name": ".NET Core Attach",
+            "type": "coreclr",
+            "request": "attach",
+            "processName": "<example>"
+        }
+    ]
+}
diff --git a/test/TestData/.vscode/tasks.json b/test/TestData/.vscode/tasks.json
@@ -0,0 +1,14 @@
+{
+    "version": "0.1.0",
+    "command": "dotnet",
+    "isShellCommand": true,
+    "args": [],
+    "tasks": [
+        {
+            "taskName": "build",
+            "args": [],
+            "isBuildCommand": true,
+            "problemMatcher": "$msCompile"
+        }
+    ]
+}
diff --git a/test/TestData/X.cs b/test/TestData/X.cs
@@ -1,28 +1,28 @@
 using System;
 
 namespace N  // "N:N"
-{   
-   public unsafe class X    // "T:N.X"
-   {
-      public X(){}   // "M:N.X.#ctor"
-      public X(int i){}  // "M:N.X.#ctor(System.Int32)"
-      public string q;  // "F:N.X.q"
-      public const double PI = 3.14;  // "F:N.X.PI"
-      public int f(){return 1;}  // "M:N.X.f"
-      public int bb(string s, ref int y, void * z){return 1;} // "M:N.X.bb(System.String,System.Int32@,=System.Void*)"
-      public int gg(short[] array1, int[,] array){return 0;} // "M:N.X.gg(System.Int16[], System.Int32[0:,0:])"
-      public static X operator+(X x, X xx){return x;} // "M:N.X.op_Addition(N.X,N.X)"
-      public int prop {get{return 1;} set{}} // "P:N.X.prop"
-      public event D d; // "E:N.X.d"
-      public int this[string s]{get{return 1;}} // "P:N.X.Item(System.String)"
-      public class Nested{} // "T:N.X.Nested"
-      public delegate void D(int i); // "T:N.X.D"
-      public static explicit operator int(X x){return 1;} // "M:N.X.op_Explicit(N.X)~System.Int32"
-      public DbSet<Director> Directors { get; set; }
-      public List<int> bb<int>(string s, ref List<int> y, void * z){return 1;} // "M:N.X.bb(System.String,System.Int32@,=System.Void*)"
-      int bb(string s, ref int y, void * z){return 1;} // "M:N.X.bb(System.String,System.Int32@,=System.Void*)"
-      int Generate(int level);
-      public void Save(string data, Action<AchievementSavedResponse> onComplete = null);
-      Func<string, bool> FirstClassFunction(Func<bool, int> func);
+{
+    public unsafe class X    // "T:N.X"
+    {
+        public X(){}   // "M:N.X.#ctor"
+        public X(int i){}  // "M:N.X.#ctor(System.Int32)"
+        public string q;  // "F:N.X.q"
+        public const double PI = 3.14;  // "F:N.X.PI"
+        public int f(){return 1;}  // "M:N.X.f"
+        public int bb(string s, ref int y, void * z){return 1;} // "M:N.X.bb(System.String,System.Int32@,=System.Void*)"
+        public int gg(short[] array1, int[,] array){return 0;} // "M:N.X.gg(System.Int16[], System.Int32[0:,0:])"
+        public static X operator+(X x, X xx){return x;} // "M:N.X.op_Addition(N.X,N.X)"
+        public int prop {get{return 1;} set{}} // "P:N.X.prop"
+        public event D d; // "E:N.X.d"
+        public int this[string s]{get{return 1;}} // "P:N.X.Item(System.String)"
+        public class Nested{} // "T:N.X.Nested"
+        public delegate void D(int i); // "T:N.X.D"        
+        public static explicit operator int(X x){return 1;} // "M:N.X.op_Explicit(N.X)~System.Int32"
+        public DbSet<Director> Directors { get; set; }        
+        public List<int> bb<int>(string s, ref List<int> y, void * z){return 1;} // "M:N.X.bb(System.String,System.Int32@,=System.Void*)"
+        int bb(string s, ref int y, void * z){return 1;} // "M:N.X.bb(System.String,System.Int32@,=System.Void*)"
+        int Generate(int level);
+        public void Save(string data, Action<AchievementSavedResponse> onComplete = null);
+        Func<string, bool> FirstClassFunction(Func<bool, int> func);
    }
 }
diff --git a/test/Utility/StringUtil.test.ts b/test/Utility/StringUtil.test.ts
@@ -318,7 +318,7 @@ suite('Utility.StringUtil.GetIndent Tests', () => {
             const code: string = null;
 
             // act
-            const actual: string = StringUtil.GetIndent(code);
+            const actual: string = StringUtil.GetIndent(code, true, 4);
 
             // assert
             assert.equal(actual, null);
@@ -336,7 +336,7 @@ suite('Utility.StringUtil.GetIndent Tests', () => {
             const code = '';
 
             // act
-            const actual: string = StringUtil.GetIndent(code);
+            const actual: string = StringUtil.GetIndent(code, true, 4);
 
             // assert
             assert.equal(actual, '');
@@ -354,7 +354,7 @@ suite('Utility.StringUtil.GetIndent Tests', () => {
             const code = '  foo ';
 
             // act
-            const actual: string = StringUtil.GetIndent(code);
+            const actual: string = StringUtil.GetIndent(code, true, 4);
 
             // assert
             assert.equal(actual, '  ');
@@ -366,16 +366,34 @@ suite('Utility.StringUtil.GetIndent Tests', () => {
         Method  : GetIndent
         STATE   : -
         IN      : '	 	foo '
-        OUT     : '	 	'
+        OUT     : '         '
     `, () => {
             // arrange
             const code = '	 	foo ';
 
             // act
-            const actual: string = StringUtil.GetIndent(code);
+            const actual: string = StringUtil.GetIndent(code, true, 4);
 
             // assert
-            assert.equal(actual, '	 	');
+            assert.equal(actual, '         ');
+        });
+
+    test(`
+        Category: Black-box testing
+        Class   : Utility.StringUtil
+        Method  : GetIndent
+        STATE   : -
+        IN      : '	 	foo '
+        OUT     : '			'
+    `, () => {
+            // arrange
+            const code = '	    	foo ';
+
+            // act
+            const actual: string = StringUtil.GetIndent(code, false, 4);
+
+            // assert
+            assert.equal(actual, '			');
         });
 
 });