Add verify_beautification option to fail when file

hasn't been beautified instead of mutating the file in place
vkadam · Jul 17, 2013 · ce62b4c · ce62b4c
1 parent 0702e0f
commit ce62b4c
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 10 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -3,7 +3,24 @@ module.exports = function(grunt) {
     // Project configuration.
     grunt.initConfig({
         jsbeautifier: {
-            files: ['package.json', '<%= jshint.files %>']
+            default: {
+                src: ['package.json', '<%= jshint.files %>']
+            },
+            has_not_been_beautified: {
+                src: ['test/fixtures/not-been-beautified.js'],
+                options: {
+                    verify_beautification: true
+                }
+            },
+            has_been_beautified: {
+                src: ['test/fixtures/been-beautified.js'],
+                options: {
+                    verify_beautification: true
+                }
+            },
+            options: {
+                indent_size: 4
+            }
         },
         nodeunit: {
             all: ['test/**/*.js']
@@ -35,6 +52,6 @@ module.exports = function(grunt) {
     grunt.loadNpmTasks('grunt-contrib-nodeunit');
 
     // By default, beautifiy, lint and run all tests.
-    grunt.registerTask('default', ['jsbeautifier', 'jshint', 'nodeunit']);
+    grunt.registerTask('default', ['jsbeautifier:default', 'jshint', 'nodeunit']);
 
 };
diff --git a/tasks/jsbeautifier.js b/tasks/jsbeautifier.js
@@ -24,9 +24,17 @@ module.exports = function(grunt) {
                 var result = beautify(original, params);
                 result += '\n';
                 grunt.verbose.ok();
-                if (original !== result) {
-                    grunt.file.write(src, result);
-                    changedFileCount++;
+                if (params.verify_beautification) {
+                    if (original !== result) {
+                        grunt.fail.warn(src.cyan + ' was not beautified');
+                    }
+
+                } else {
+                    if (original !== result) {
+                        grunt.file.write(src, result);
+                        changedFileCount++;
+                    }
+
                 }
                 fileCount++;
             });

diff --git a/test/fixtures/been-beautified.js b/test/fixtures/been-beautified.js
@@ -0,0 +1,4 @@
+var temp = {
+    hello: 1,
+    world: 2
+}
diff --git a/test/fixtures/not-been-beautified.js b/test/fixtures/not-been-beautified.js
@@ -0,0 +1,4 @@
+var temp = {
+ hello: 1,
+world: 2
+}
diff --git a/test/jsbeautifier_test.js b/test/jsbeautifier_test.js
@@ -1,5 +1,6 @@
 "use strict";
 var grunt = require('grunt');
+var exec = require('child_process').exec;
 
 /*
   ======== A Handy Little Nodeunit Reference ========
@@ -26,11 +27,26 @@ exports['jsbeautifier'] = {
         // setup here
         done();
     },
-    'helper': function(test) {
+    'Verify beautification with unbeautified file': function(test) {
         test.expect(1);
-        // tests here
-        // test.equal(grunt.helper('jsbeautifier'), 'jsbeautifier!!!', 'should return the correct value.');
-        test.equal(true, true);
-        test.done();
+        exec('grunt jsbeautifier:has_not_been_beautified', {
+                cwd: __dirname + '/../'
+            },
+            function(err, stdout, stderr) {
+                test.notEqual(err, null, 'Grunt fails because file has not been beautified');
+                test.done();
+            });
+
+    },
+    'Verify beautification with beautified file': function(test) {
+        test.expect(1);
+        exec('grunt jsbeautifier:has_been_beautified', {
+                cwd: __dirname + '/../'
+            },
+            function(err, stdout, stderr) {
+                test.equal(err, null, 'Grunt passes because file has been beautified');
+                test.done();
+            });
+
     }
 };