refactored where preferences are read and added 'onopen' preferences to enable/disable sanitizing files when they are first open

Miguel Castillo · Miguel Castillo · commit 04c23651c04b · 2015-05-01T23:48:15.000-04:00
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,19 @@
+{
+  "env": {
+    "browser": true,
+    "es6":true,
+    "mocha":true
+  },
+  "ecmaFeatures": {
+    "modules": true,
+    "jsx": true
+  },
+  "rules": {
+    "semi": 2,
+    "global-strict": 0,
+    "quotes": [2, "single"],
+    "key-spacing": 0,
+    "no-trailing-spaces": 0,
+    "eol-last": 0
+  }
+}
diff --git a/.jshintrc b/.jshintrc
@@ -12,6 +12,7 @@
     "window": true,
     "_": true,
     "brackets": true,
-    "CodeMirror": true
+    "CodeMirror": true,
+    "setTimeout": true
   }
 }
diff --git a/main.js b/main.js
@@ -6,9 +6,11 @@
  * Based on https://github.com/dsbonev/whitespace-normalizer
  */
 
-define(function (require /*, exports, module*/) {
+define(function (require) {
   'use strict';
 
+  var AppInit            = brackets.getModule("utils/AppInit");
+  var EditorManager      = brackets.getModule("editor/EditorManager");
   var Commands           = brackets.getModule('command/Commands');
   var CommandManager     = brackets.getModule('command/CommandManager');
   var DocumentManager    = brackets.getModule('document/DocumentManager');
@@ -18,6 +20,11 @@ define(function (require /*, exports, module*/) {
   var PREFERENCES_KEY    = 'brackets-wsSanitizer';
   var prefs              = PreferencesManager.getExtensionPrefs(PREFERENCES_KEY);
 
+  var SPACE_UNITS        = "spaceUnits";
+  var TAB_SIZE           = "tabSize";
+  var USE_TAB_CHAR       = "useTabChar";
+
+
   var COMMAND_ID = PREFERENCES_KEY;
   var menu       = Menus.getMenu(Menus.AppMenuBar.EDIT_MENU);
   var command    = CommandManager.register('Whitespace Sanitizer', COMMAND_ID, cmdToggleEnabled);
@@ -26,7 +33,8 @@ define(function (require /*, exports, module*/) {
   menu.addMenuItem(COMMAND_ID);
 
   // Wire up preferences system
-  prefs.definePreference("enabled", "boolean", "true").on("change", checkEnabled);
+  prefs.definePreference("onopen",  "boolean", false);
+  prefs.definePreference("enabled", "boolean", true).on("change", checkEnabled);
   command.setChecked(prefs.get('enabled'));
   checkEnabled();
 
@@ -51,7 +59,8 @@ define(function (require /*, exports, module*/) {
 
     doc.__saving = true;
     doc.batchOperation(function () {
-      sanitize(doc);
+      var settings = getPreferences(doc);
+      sanitize(doc, settings.useTabChar, settings.size);
 
       setTimeout(function() {
         CommandManager.execute(Commands.FILE_SAVE, {doc: doc})
@@ -61,4 +70,33 @@ define(function (require /*, exports, module*/) {
       });
     });
   }
+
+
+  function setDocument(evt, editor) {
+    if (editor && prefs.get("onopen") === true) {
+      var doc = editor.document;
+      doc.batchOperation(function () {
+        var settings = getPreferences(doc);
+        sanitize(doc, settings.useTabChar, settings.size);
+      });
+    }
+  }
+
+
+  function getPreferences(doc) {
+    var preferencesContext = doc.file.fullPath;
+    var useTabChar         = PreferencesManager.get(USE_TAB_CHAR, preferencesContext);
+    var tabSize            = PreferencesManager.get(TAB_SIZE, preferencesContext);
+    var spaceUnit          = PreferencesManager.get(SPACE_UNITS, preferencesContext);
+    return {
+      useTabChar: useTabChar,
+      size: useTabChar ? tabSize : spaceUnit
+    };
+  }
+
+
+  AppInit.appReady(function() {
+    EditorManager.on("activeEditorChange.wsSanitizer", setDocument);
+    setDocument(null, EditorManager.getActiveEditor());
+  });
 });
diff --git a/src/sanitize.js b/src/sanitize.js
@@ -1,20 +1,12 @@
 define(function (require) {
   'use strict';
 
-  var PreferencesManager = brackets.getModule('preferences/PreferencesManager');
-  var SPACE_UNITS        = "spaceUnits";
-  var TAB_SIZE           = "tabSize";
-  var USE_TAB_CHAR       = "useTabChar";
-  var getReplacePattern  = require('./replacePatterns');
+  var getReplacePattern = require('./replacePatterns');
 
-  function sanitize(doc) {
+  function sanitize(doc, useTab, units) {
     var line, pattern, match;
-    var lineIndex          = 0;
-    var preferencesContext = doc.file.fullPath;
-    var useTabChar         = PreferencesManager.get(USE_TAB_CHAR, preferencesContext);
-    var tabSize            = PreferencesManager.get(TAB_SIZE, preferencesContext);
-    var spaceUnit          = PreferencesManager.get(SPACE_UNITS, preferencesContext);
-    var wsPattern          = getReplacePattern(useTabChar, useTabChar ? tabSize : spaceUnit);
+    var lineIndex = 0;
+    var wsPattern = getReplacePattern(useTab, units);
 
     while ((line = doc.getLine(lineIndex)) !== undefined) {
       //trim trailing whitespaces
@@ -41,7 +33,7 @@ define(function (require) {
           });
       }
 
-      lineIndex += 1;
+      lineIndex++;
     }
 
     //ensure newline at the end of file
@@ -55,5 +47,31 @@ define(function (require) {
     }
   }
 
+
+  sanitize.verify = function(doc, useTab, units) {
+    var line, pattern;
+    var lineIndex = 0;
+    var wsPattern = getReplacePattern(useTab, units);
+
+    while ((line = doc.getLine(lineIndex)) !== undefined) {
+      pattern = /[ \t]+$/g;
+
+      if ((!!pattern.exec(line)) || (!!wsPattern.exec(line).replaceWith)) {
+        return false;
+      }
+
+      lineIndex++;
+    }
+
+    //ensure newline at the end of file
+    line = doc.getLine(lineIndex - 1);
+    var lastN = line.slice(-1);
+    if (line !== undefined && line.length > 0 && lastN !== '\n') {
+      return false;
+    }
+
+    return true;
+  };
+
   return sanitize;
 });
diff --git a/test/config.js b/test/config.js
@@ -10,29 +10,12 @@ require = (function() {
       "mocha": {
         "exports": "mocha"
       }
-    },
-    "transforms": [{
-      name: "cantransform",
-      handler: cantransform,
-      ignore:["chai"]
-    }]
+    }
   });
 
-  /**
-   * Simple filter for excluding particular modules from being processed by the transformation pipeline.
-   */
-  function cantransform(moduleMeta) {
-    var ignoreList = this.ignore;
-    var i, length;
-
-    if (ignoreList && ignoreList.length) {
-      for (i = 0, length = ignoreList.length; i < length; i++) {
-        if (ignoreList[i].indexOf(moduleMeta.name) !== -1) {
-          return false;
-        }
-      }
-    }
-  }
+  importer.ignore({
+    match: ["chai"]
+  });
 
   return importer.require;
 })();
diff --git a/test/spec/replacePatterns.js b/test/spec/replacePatterns.js
@@ -13,7 +13,7 @@ describe("Pattern Suites", function() {
       beforeEach(function() {
         result = pattern.getIndentation(2, 1);
       });
-      
+
       it("then result is 2 tabs", function() {
         expect(result).to.equal('\t\t');
       });
@@ -24,7 +24,7 @@ describe("Pattern Suites", function() {
       beforeEach(function() {
         result = pattern.getIndentation(3, 1);
       });
-      
+
       it("then result is 2 tabs and 1 space", function() {
         expect(result).to.equal('\t\t ');
       });
@@ -35,7 +35,7 @@ describe("Pattern Suites", function() {
       beforeEach(function() {
         result = pattern.getIndentation(4, 1);
       });
-      
+
       it("then result is 3 tabs", function() {
         expect(result).to.equal('\t\t\t');
       });
@@ -46,7 +46,7 @@ describe("Pattern Suites", function() {
       beforeEach(function() {
         result = pattern.getIndentation(5, 1);
       });
-      
+
       it("then result is 3 tabs and 1 space", function() {
         expect(result).to.equal('\t\t\t ');
       });
@@ -64,7 +64,7 @@ describe("Pattern Suites", function() {
       beforeEach(function() {
         result = pattern.getIndentation(2, 1);
       });
-      
+
       it("then result is 1 tab and 2 spaces", function() {
         expect(result).to.equal('\t  ');
       });
@@ -75,7 +75,7 @@ describe("Pattern Suites", function() {
       beforeEach(function() {
         result = pattern.getIndentation(3, 1);
       });
-      
+
       it("then result is 1 tab and 3 spaces", function() {
         expect(result).to.equal('\t   ');
       });
@@ -86,7 +86,7 @@ describe("Pattern Suites", function() {
       beforeEach(function() {
         result = pattern.getIndentation(5, 1);
       });
-      
+
       it("then result is 2 tab and 1 spaces", function() {
         expect(result).to.equal('\t\t ');
       });

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`"window": true,`
`13`	`13`	`"_": true,`
`14`	`14`	`"brackets": true,`
`15`		`- "CodeMirror": true`
	`15`	`+ "CodeMirror": true,`
	`16`	`+ "setTimeout": true`
`16`	`17`	`}`
`17`	`18`	`}`