Merge pull request #7205 from adobe/randy/soft-tabs-pref

Add preference for soft tabs

Author: TomMalbran

src/editor/Editor.js

@@ -64,53 +64,56 @@
 define(function (require, exports, module) {
     "use strict";
 
-    var CodeMirror         = require("thirdparty/CodeMirror2/lib/codemirror"),
+    var AnimationUtils     = require("utils/AnimationUtils"),
+        Async              = require("utils/Async"),
+        CodeMirror         = require("thirdparty/CodeMirror2/lib/codemirror"),
         Menus              = require("command/Menus"),
         PerfUtils          = require("utils/PerfUtils"),
         PreferencesManager = require("preferences/PreferencesManager"),
         Strings            = require("strings"),
         TextRange          = require("document/TextRange").TextRange,
         TokenUtils         = require("utils/TokenUtils"),
         ViewUtils          = require("utils/ViewUtils"),
-        Async              = require("utils/Async"),
-        AnimationUtils     = require("utils/AnimationUtils"),
         _                  = require("thirdparty/lodash");
 
     /** Editor preferences */
-    var SMART_INDENT      = "smartIndent",
-        USE_TAB_CHAR      = "useTabChar",
-        TAB_SIZE          = "tabSize",
-        SPACE_UNITS       = "spaceUnits",
-        CLOSE_BRACKETS    = "closeBrackets",
+    var CLOSE_BRACKETS    = "closeBrackets",
+        CLOSE_TAGS        = "closeTags",
+        SCROLL_PAST_END   = "scrollPastEnd",
         SHOW_LINE_NUMBERS = "showLineNumbers",
+        SMART_INDENT      = "smartIndent",
+        SOFT_TABS         = "softTabs",
+        SPACE_UNITS       = "spaceUnits",
         STYLE_ACTIVE_LINE = "styleActiveLine",
+        TAB_SIZE          = "tabSize",
         WORD_WRAP         = "wordWrap",
-        CLOSE_TAGS        = "closeTags",
-        SCROLL_PAST_END   = "scrollPastEnd",
-        cmOptions         = {};
+        USE_TAB_CHAR      = "useTabChar";
+    
+    var cmOptions         = {};
 
     // Mappings from Brackets preferences to CodeMirror options
-    cmOptions[SMART_INDENT]       = "smartIndent";
-    cmOptions[USE_TAB_CHAR]       = "indentWithTabs";
-    cmOptions[TAB_SIZE]           = "indentUnit";
-    cmOptions[SPACE_UNITS]        = "indentUnit";
     cmOptions[CLOSE_BRACKETS]     = "autoCloseBrackets";
+    cmOptions[CLOSE_TAGS]         = "autoCloseTags";
+    cmOptions[SCROLL_PAST_END]    = "scrollPastEnd";
     cmOptions[SHOW_LINE_NUMBERS]  = "lineNumbers";
+    cmOptions[SMART_INDENT]       = "smartIndent";
+    cmOptions[SPACE_UNITS]        = "indentUnit";
     cmOptions[STYLE_ACTIVE_LINE]  = "styleActiveLine";
+    cmOptions[TAB_SIZE]           = "indentUnit";
+    cmOptions[USE_TAB_CHAR]       = "indentWithTabs";
     cmOptions[WORD_WRAP]          = "lineWrapping";
-    cmOptions[CLOSE_TAGS]         = "autoCloseTags";
-    cmOptions[SCROLL_PAST_END]    = "scrollPastEnd";
 
-    PreferencesManager.definePreference(SMART_INDENT, "boolean", true);
-    PreferencesManager.definePreference(USE_TAB_CHAR, "boolean", false);
-    PreferencesManager.definePreference(TAB_SIZE, "number", 4);
-    PreferencesManager.definePreference(SPACE_UNITS, "number", 4);
-    PreferencesManager.definePreference(CLOSE_BRACKETS, "boolean", false);
+    PreferencesManager.definePreference(CLOSE_BRACKETS,    "boolean", false);
+    PreferencesManager.definePreference(CLOSE_TAGS,        "Object", { whenOpening: true, whenClosing: true, indentTags: [] });
+    PreferencesManager.definePreference(SCROLL_PAST_END,   "boolean", false);
     PreferencesManager.definePreference(SHOW_LINE_NUMBERS, "boolean", true);
+    PreferencesManager.definePreference(SMART_INDENT,      "boolean", true);
+    PreferencesManager.definePreference(SOFT_TABS,         "boolean", true);
+    PreferencesManager.definePreference(SPACE_UNITS,       "number",  4);
     PreferencesManager.definePreference(STYLE_ACTIVE_LINE, "boolean", false);
-    PreferencesManager.definePreference(WORD_WRAP, "boolean", true);
-    PreferencesManager.definePreference(CLOSE_TAGS, "Object", { whenOpening: true, whenClosing: true, indentTags: [] });
-    PreferencesManager.definePreference(SCROLL_PAST_END, "boolean", false);
+    PreferencesManager.definePreference(TAB_SIZE,          "number",  4);
+    PreferencesManager.definePreference(USE_TAB_CHAR,      "boolean", false);
+    PreferencesManager.definePreference(WORD_WRAP,         "boolean", true);
 
     var editorOptions = Object.keys(cmOptions);
 
@@ -516,7 +519,7 @@ define(function (require, exports, module) {
         var instance = this._codeMirror,
             overallJump = null;
 
-        if (!instance.getOption("indentWithTabs")) {
+        if (!instance.getOption("indentWithTabs") && PreferencesManager.get(SOFT_TABS)) {
             var indentUnit = instance.getOption("indentUnit");
 
             _.each(this.getSelections(), function (sel) {

test/spec/Editor-test.js

@@ -28,11 +28,12 @@
 define(function (require, exports, module) {
     'use strict';
 
-    var Editor          = require("editor/Editor").Editor,
-        EditorManager   = require("editor/EditorManager"),
-        SpecRunnerUtils = require("spec/SpecRunnerUtils"),
-        LanguageManager = require("language/LanguageManager"),
-        KeyEvent        = require("utils/KeyEvent");
+    var Editor              = require("editor/Editor").Editor,
+        EditorManager       = require("editor/EditorManager"),
+        KeyEvent            = require("utils/KeyEvent"),
+        LanguageManager     = require("language/LanguageManager"),
+        PreferencesManager  = require("preferences/PreferencesManager"),
+        SpecRunnerUtils     = require("spec/SpecRunnerUtils");
 
     var langNames = {
         css:        {mode: "css",           langName: "CSS"},
@@ -1077,7 +1078,35 @@ define(function (require, exports, module) {
                 myEditor.document.setText("   four  ");
                 checkSoftTab({line: 0, ch: 8}, 1, "moveH", {line: 0, ch: 9});
             });
-            
+
+            describe("with soft tabs preference off", function () {
+                beforeEach(function () {
+                    // Disable soft tabs
+                    PreferencesManager.set("softTabs", false);
+                });
+                afterEach(function () {
+                    // Re-enable soft tabs
+                    PreferencesManager.set("softTabs", true);
+                });
+
+                it("should move left by 1 space if cursor is immediately after 1 indent level worth of spaces at beginning of line", function () {
+                    myEditor.document.setText("    content");
+                    checkSoftTab({line: 0, ch: 4}, -1, "moveH", {line: 0, ch: 3});
+                });
+                it("should backspace by 1 space if cursor is immediately after 1 indent level worth of spaces at beginning of line", function () {
+                    myEditor.document.setText("    content");
+                    checkSoftTab({line: 0, ch: 4}, -1, "deleteH", {line: 0, ch: 3}, "   content");
+                });
+                it("should move right by 1 space if cursor is immediately before 1 indent level worth of spaces at beginning of line", function () {
+                    myEditor.document.setText("    content");
+                    checkSoftTab({line: 0, ch: 0}, 1, "moveH", {line: 0, ch: 1});
+                });
+                it("should delete right by 1 space if cursor is immediately before 1 indent level worth of spaces at beginning of line", function () {
+                    myEditor.document.setText("    content");
+                    checkSoftTab({line: 0, ch: 0}, 1, "deleteH", {line: 0, ch: 0}, "   content");
+                });
+            });
+
             describe("with multiple selections", function () {
                 it("should move left over a soft tab from multiple aligned cursors", function () {
                     myEditor.document.setText("    one\n    two\n    three\n");