js-beautify 1.5.6 → 1.5.10

package/CHANGELOG.md

@@ -1,4 +1,26 @@
 # Changelog
+## v1.5.7
+
+### Description
+* Beautifier does not break PHP and Underscore.js templates
+* Fix for SCSS pseudo classes and intperpolation/mixins
+* Alternative Newline Characters in CSS and HTML
+* Preserve formatting or completely ignore section of javascript using comments
+
+
+### Closed Issues
+* Support for legacy JavaScript versions (e.g. WSH+JScript & Co) ([#720](https://github.com/beautify-web/js-beautify/pull/720))
+* Is \\n hard coded into CSS Beautifier logic? ([#715](https://github.com/beautify-web/js-beautify/issues/715))
+* Spaces and linebreaks after # and around { } messing up interpolation/mixins (SASS/SCSS) ([#689](https://github.com/beautify-web/js-beautify/issues/689))
+* Calls to functions get completely messed up in Sass (*.scss) ([#675](https://github.com/beautify-web/js-beautify/issues/675))
+* No new line after selector in scss files ([#666](https://github.com/beautify-web/js-beautify/issues/666))
+* using html-beautify on handlebars template deletes unclosed tag if on second line ([#623](https://github.com/beautify-web/js-beautify/issues/623))
+* more Extra space after scss pseudo classes ([#557](https://github.com/beautify-web/js-beautify/issues/557))
+* Unnecessary spaces in PHP code ([#490](https://github.com/beautify-web/js-beautify/issues/490))
+* Some underscore.js template tags are broken ([#417](https://github.com/beautify-web/js-beautify/issues/417))
+* Selective ignore using comments (feature request) ([#384](https://github.com/beautify-web/js-beautify/issues/384))
+
+
 ## v1.5.6
 
 ### Description
@@ -45,6 +67,7 @@
 *  CSS: support add newline between rules ([#574](https://github.com/beautify-web/js-beautify/pull/574))
 * elem[array]++ changes to elem[array] ++ inserting unnecessary gap ([#570](https://github.com/beautify-web/js-beautify/issues/570))
 * add support to less functions paramters braces ([#568](https://github.com/beautify-web/js-beautify/pull/568))
+* selector_separator_newline: true for Sass doesn't work ([#563](https://github.com/beautify-web/js-beautify/issues/563))
 * yield statements are being beautified to their own newlines since 1.5.2 ([#560](https://github.com/beautify-web/js-beautify/issues/560))
 * HTML beautifier inserts extra newline into `<li>`s ending with `<code>` ([#524](https://github.com/beautify-web/js-beautify/issues/524))
 * Add wrap_attributes option ([#476](https://github.com/beautify-web/js-beautify/issues/476))
@@ -117,12 +140,14 @@ https://github.com/beautify-web/js-beautify/compare/v1.5.1...v1.5.2
 
 ### Closed Issues
 * Allow custom elements to be unformatted ([#540](https://github.com/beautify-web/js-beautify/pull/540))
+* Need option to ignore brace style ([#538](https://github.com/beautify-web/js-beautify/issues/538))
 * Refactor to Output and OutputLine classes ([#536](https://github.com/beautify-web/js-beautify/pull/536))
 * Recognize ObjectLiteral on open brace ([#535](https://github.com/beautify-web/js-beautify/pull/535))
 * Refactor to fully tokenize before formatting ([#530](https://github.com/beautify-web/js-beautify/pull/530))
 * Cleanup checked in six.py file ([#527](https://github.com/beautify-web/js-beautify/pull/527))
 * Changelog.md? ([#526](https://github.com/beautify-web/js-beautify/issues/526))
 * New line added between each css declaration ([#523](https://github.com/beautify-web/js-beautify/issues/523))
+* Kendo Template scripts get messed up! ([#516](https://github.com/beautify-web/js-beautify/issues/516))
 * SyntaxError: Unexpected token ++ ([#514](https://github.com/beautify-web/js-beautify/issues/514))
 * space appears before open square bracket when the object name is "set" ([#508](https://github.com/beautify-web/js-beautify/issues/508))
 * Unclosed string problem ([#505](https://github.com/beautify-web/js-beautify/issues/505))
@@ -144,8 +169,17 @@ https://github.com/beautify-web/js-beautify/compare/v1.5.1...v1.5.2
 * Cannot declare object literal properties with unquoted reserved words ([#440](https://github.com/beautify-web/js-beautify/issues/440))
 * Do not put a space within `function*` generator functions. ([#428](https://github.com/beautify-web/js-beautify/issues/428))
 * beautification of "nth-child" css fails csslint ([#418](https://github.com/beautify-web/js-beautify/issues/418))
-* comment breaks indent ([#413](https://github.com/beautify-web/js-beautify/issues/413))
-* AngularJS inline templates are being corrupted! ([#385](https://github.com/beautify-web/js-beautify/issues/385))
+
+
+## v1.5.10
+
+### Description
+Hotfix for directives
+Version jump due to release script tweaks
+
+
+### Closed Issues
+* Preserve directive doesn't work as intended ([#723](https://github.com/beautify-web/js-beautify/issues/723))
 
 
 ## v1.5.1

package/CONTRIBUTING.md

@@ -58,7 +58,6 @@ NOTE: Before you do any of these make sure the latest changes have passed the tr
 
 ##Web
 Merge changes from `master` to `gh-pages` branch.  This is very low cost and can be done whenever is convenient.
-If doing a general release, update the `bower.json` file to the new version and commit the change.
 
 ##Python
 NOTE: For now, we'd like to keep python and node version numbers synchronized,

package/README.md

@@ -2,6 +2,7 @@
 [![Build Status](https://img.shields.io/travis/beautify-web/js-beautify/master.svg)](http://travis-ci.org/beautify-web/js-beautify)
 [![NPM version](https://img.shields.io/npm/v/js-beautify.svg)](https://www.npmjs.com/package/js-beautify)
 [![Download stats](https://img.shields.io/npm/dm/js-beautify.svg)](https://www.npmjs.com/package/js-beautify)
+[![Join the chat at https://gitter.im/beautify-web/js-beautify](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/beautify-web/js-beautify?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 [![NPM stats](https://nodei.co/npm/js-beautify.svg?downloadRank=true&downloads=true)](https://www.npmjs.org/package/js-beautify)
 
@@ -144,6 +145,30 @@ Configuration sources provided earlier in this stack will override later ones.
 
 You might notice that the CLI options and defaults hash aren't 100% correlated. Historically, the Python and JS APIs have not been 100% identical. For example, `space_before_conditional` is currently JS-only, and not addressable from the CLI script. There are a few other additional cases keeping us from 100% API-compatibility. Patches welcome!
 
+## Directives to Ignore or Preserve sections (Javascript only) 
+
+Beautifier for  supports directives in comments inside the file.
+This allows you to tell the beautifier to preserve the formtatting of or completely ignore part of a file.  
+The example input below will remain changed after beautification
+
+```js
+// Use preserve when the content is not javascript, but you don't want it reformatted.
+/* beautify preserve:start */
+{
+    browserName: 'internet explorer',
+    platform:    'Windows 7',
+    version:     '8'
+}
+/* beautify preserve:end */
+
+// Use ignore when the content is not parsable as javascript.  
+var a =  1;
+/* beautify ignore:start */
+ {This is some strange{template language{using open-braces?
+/* beautify ignore:end */
+```
+
+
 ### CSS & HTML
 
 In addition to the `js-beautify` executable, `css-beautify` and `html-beautify` are also provided as an easy interface into those scripts. Alternatively, `js-beautify --css` or `js-beautify --html` will accomplish the same thing, respectively.
@@ -163,22 +188,27 @@ The CSS & HTML beautifiers are much simpler in scope, and possess far fewer opti
 CSS Beautifier Options:
   -s, --indent-size                  Indentation size [4]
   -c, --indent-char                  Indentation character [" "]
+  -t, --indent-with-tabs             Indent with tabs, overrides -s and -c
+  -e, --eol                          Character(s) to use as line terminators. (default newline - "\\n")
+  -n, --end-with-newline             End output with newline
   -L, --selector-separator-newline   Add a newline between multiple selectors
   -N, --newline-between-rules        Add a newline between CSS rules
 
 HTML Beautifier Options:
-  -I, --indent-inner-html            Indent <head> and <body> sections. Default is false.
   -s, --indent-size                  Indentation size [4]
   -c, --indent-char                  Indentation character [" "]
+  -t, --indent-with-tabs             Indent with tabs, overrides -s and -c
+  -e, --eol                          Character(s) to use as line terminators. (default newline - "\\n")
+  -n, --end-with-newline             End output with newline
+  -p, --preserve-newlines            Preserve existing line-breaks (--no-preserve-newlines disables)
+  -m, --max-preserve-newlines        Maximum number of line-breaks to be preserved in one chunk [10]
+  -I, --indent-inner-html            Indent <head> and <body> sections. Default is false.
   -b, --brace-style                  [collapse|expand|end-expand|none] ["collapse"]
   -S, --indent-scripts               [keep|separate|normal] ["normal"]
   -w, --wrap-line-length             Maximum characters per line (0 disables) [250]
   -A, --wrap-attributes              Wrap attributes to new lines [auto|force] ["auto"]
   -i, --wrap-attributes-indent-size  Indent wrapped attributes to after N characters [indent-size]
-  -p, --preserve-newlines            Preserve existing line-breaks (--no-preserve-newlines disables)
-  -m, --max-preserve-newlines        Maximum number of line-breaks to be preserved in one chunk [10]
   -U, --unformatted                  List of tags (defaults to inline) that should not be reformatted
-  -n, --end-with-newline             End output with newline
   -E, --extra_liners                 List of tags (defaults to [head,body,/html] that should have an extra newline before them.
 ```
 
@@ -198,4 +228,4 @@ Thanks also to Jason Diamond, Patrick Hof, Nochum Sossonko, Andreas Schneider, D
 Vasilevsky, Vital Batmanov, Ron Baldwin, Gabriel Harrison, Chris J. Shull,
 Mathias Bynens, Vittorio Gambaletta and others.
 
-js-beautify@1.5.5
+js-beautify@1.5.7

package/bower.json

@@ -1,6 +1,5 @@
 {
   "name": "js-beautify",
-  "version": "1.5.6",
   "main": [
     "./js/lib/beautify.js",
     "./js/lib/beautify-css.js",

package/js/lib/beautify-css.js

@@ -63,11 +63,16 @@
 (function() {
     function css_beautify(source_text, options) {
         options = options || {};
+        source_text = source_text || '';
+        // HACK: newline parsing inconsistent. This brute force normalizes the input.
+        source_text = source_text.replace(/\r\n|[\r\u2028\u2029]/g, '\n')
+
         var indentSize = options.indent_size || 4;
         var indentCharacter = options.indent_char || ' ';
         var selectorSeparatorNewline = (options.selector_separator_newline === undefined) ? true : options.selector_separator_newline;
         var end_with_newline = (options.end_with_newline === undefined) ? false : options.end_with_newline;
         var newline_between_rules = (options.newline_between_rules === undefined) ? true : options.newline_between_rules;
+        var eol = options.eol ? options.eol : '\n';
 
         // compatibility
         if (typeof indentSize === "string") {
@@ -79,6 +84,9 @@
             indentSize = 1;
         }
 
+        eol = eol.replace(/\\r/, '\r').replace(/\\n/, '\n')
+
+
         // tokenizer
         var whiteRe = /^\s+$/;
         var wordRe = /[\w$\-_]/;
@@ -172,11 +180,20 @@
         // and the next special character found opens
         // a new block
         function foundNestedPseudoClass() {
+            var openParen = 0;
             for (var i = pos + 1; i < source_text.length; i++) {
                 var ch = source_text.charAt(i);
                 if (ch === "{") {
                     return true;
-                } else if (ch === ";" || ch === "}" || ch === ")") {
+                } else if (ch === '(') {
+                    // pseudoclasses can contain ()
+                    openParen += 1;
+                } else if (ch === ')') {
+                    if (openParen == 0) {
+                        return false;
+                    }
+                    openParen -= 1;
+                } else if (ch === ";" || ch === "}") {
                     return false;
                 }
             }
@@ -234,6 +251,12 @@
             }
         };
 
+        print.preserveSingleSpace = function() {
+            if (isAfterSpace) {
+                print.singleSpace();
+            }
+        };
+
         print.trim = function() {
             while (print._lastCharWhitespace()) {
                 output.pop();
@@ -245,6 +268,7 @@
         /*_____________________--------------------_____________________*/
 
         var insideRule = false;
+        var insidePropertyValue = false;
         var enteringConditionalGroup = false;
         var top_ch = '';
         var last_top_ch = '';
@@ -278,10 +302,7 @@
                 output.push(eatComment());
                 print.newLine();
             } else if (ch === '@') {
-                // pass along the space we found as a separate item
-                if (isAfterSpace) {
-                    print.singleSpace();
-                }
+                print.preserveSingleSpace();
                 output.push(ch);
 
                 // strip trailing space, if present, for hash property checks
@@ -304,6 +325,9 @@
                         enteringConditionalGroup = true;
                     }
                 }
+            } else if (ch === '#' && peek() === '{') {
+              print.preserveSingleSpace();
+              output.push(eatString('}'));
             } else if (ch === '{') {
                 if (peek(true) === '}') {
                     eatWhitespace();
@@ -330,6 +354,7 @@
                 outdent();
                 print["}"](ch);
                 insideRule = false;
+                insidePropertyValue = false;
                 if (nestedLevel) {
                     nestedLevel--;
                 }
@@ -342,6 +367,7 @@
                     !(lookBack("&") || foundNestedPseudoClass())) {
                     // 'property: value' delimiter
                     // which could be in a conditional group query
+                    insidePropertyValue = true;
                     output.push(':');
                     print.singleSpace();
                 } else {
@@ -357,11 +383,10 @@
                     }
                 }
             } else if (ch === '"' || ch === '\'') {
-                if (isAfterSpace) {
-                    print.singleSpace();
-                }
+                print.preserveSingleSpace();
                 output.push(eatString(ch));
             } else if (ch === ';') {
+                insidePropertyValue = false;
                 output.push(ch);
                 print.newLine();
             } else if (ch === '(') { // may be a url
@@ -377,9 +402,7 @@
                     }
                 } else {
                     parenLevel++;
-                    if (isAfterSpace) {
-                        print.singleSpace();
-                    }
+                    print.preserveSingleSpace();
                     output.push(ch);
                     eatWhitespace();
                 }
@@ -389,7 +412,7 @@
             } else if (ch === ',') {
                 output.push(ch);
                 eatWhitespace();
-                if (!insideRule && selectorSeparatorNewline && parenLevel < 1) {
+                if (selectorSeparatorNewline && !insidePropertyValue && parenLevel < 1) {
                     print.newLine();
                 } else {
                     print.singleSpace();
@@ -397,19 +420,14 @@
             } else if (ch === ']') {
                 output.push(ch);
             } else if (ch === '[') {
-                if (isAfterSpace) {
-                    print.singleSpace();
-                }
+                print.preserveSingleSpace();
                 output.push(ch);
             } else if (ch === '=') { // no whitespace before or after
                 eatWhitespace()
                 ch = '=';
                 output.push(ch);
             } else {
-                if (isAfterSpace) {
-                    print.singleSpace();
-                }
-
+                print.preserveSingleSpace();
                 output.push(ch);
             }
         }
@@ -424,7 +442,11 @@
 
         // establish end_with_newline
         if (end_with_newline) {
-            sweetCode += "\n";
+            sweetCode += '\n';
+        }
+
+        if (eol != '\n') {
+            sweetCode = sweetCode.replace(/[\n]/g, eol);
         }
 
         return sweetCode;

package/js/lib/beautify-html.js

@@ -101,7 +101,8 @@
             wrap_attributes,
             wrap_attributes_indent_size,
             end_with_newline,
-            extra_liners;
+            extra_liners,
+            eol;
 
         options = options || {};
 
@@ -116,7 +117,9 @@
         indent_character = (options.indent_char === undefined) ? ' ' : options.indent_char;
         brace_style = (options.brace_style === undefined) ? 'collapse' : options.brace_style;
         wrap_line_length =  parseInt(options.wrap_line_length, 10) === 0 ? 32786 : parseInt(options.wrap_line_length || 250, 10);
-        unformatted = options.unformatted || ['a', 'span', 'img', 'bdo', 'em', 'strong', 'dfn', 'code', 'samp', 'kbd', 'var', 'cite', 'abbr', 'acronym', 'q', 'sub', 'sup', 'tt', 'i', 'b', 'big', 'small', 'u', 's', 'strike', 'font', 'ins', 'del', 'pre', 'address', 'dt', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
+        unformatted = options.unformatted || ['a', 'span', 'img', 'bdo', 'em', 'strong', 'dfn', 'code', 'samp', 'kbd',
+            'var', 'cite', 'abbr', 'acronym', 'q', 'sub', 'sup', 'tt', 'i', 'b', 'big', 'small', 'u', 's', 'strike',
+            'font', 'ins', 'del', 'pre', 'address', 'dt', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6'];
         preserve_newlines = (options.preserve_newlines === undefined) ? true : options.preserve_newlines;
         max_preserve_newlines = preserve_newlines ?
             (isNaN(parseInt(options.max_preserve_newlines, 10)) ? 32786 : parseInt(options.max_preserve_newlines, 10))
@@ -125,15 +128,18 @@
         wrap_attributes = (options.wrap_attributes === undefined) ? 'auto' : options.wrap_attributes;
         wrap_attributes_indent_size = (options.wrap_attributes_indent_size === undefined) ? indent_size : parseInt(options.wrap_attributes_indent_size, 10) || indent_size;
         end_with_newline = (options.end_with_newline === undefined) ? false : options.end_with_newline;
-        extra_liners = Array.isArray(options.extra_liners) ?
+        extra_liners = (typeof options.extra_liners == 'object') && options.extra_liners ?
             options.extra_liners.concat() : (typeof options.extra_liners === 'string') ?
             options.extra_liners.split(',') : 'head,body,/html'.split(',');
+        eol = options.eol ? options.eol : '\n';
 
         if(options.indent_with_tabs){
             indent_character = '\t';
             indent_size = 1;
         }
 
+        eol = eol.replace(/\\r/, '\r').replace(/\\n/, '\n')
+
         function Parser() {
 
             this.pos = 0; //Parser position
@@ -151,7 +157,7 @@
 
             this.Utils = { //Uilities made available to the various functions
                 whitespace: "\n\r\t ".split(''),
-                single_token: 'br,input,link,meta,source,!doctype,basefont,base,area,hr,wbr,param,img,isindex,?xml,embed,?php,?,?='.split(','), //all the single tags for HTML
+                single_token: 'br,input,link,meta,source,!doctype,basefont,base,area,hr,wbr,param,img,isindex,embed'.split(','), //all the single tags for HTML
                 extra_liners: extra_liners, //for tags that need a line of whitespace before them
                 in_array: function(what, arr) {
                     for (var i = 0; i < arr.length; i++) {
@@ -404,7 +410,7 @@
                     this.line_char_count++;
                     content.push(input_char); //inserts character at-a-time (or string)
 
-                    if (content[1] && content[1] === '!') { //if we're in a comment, do something special
+                    if (content[1] && (content[1] === '!' || content[1] === '?' || content[1] === '%')) { //if we're in a comment, do something special
                         // We treat all comments as literals, even more than preformatted tags
                         // we just look for the appropriate close tag
                         content = [this.get_comment(tag_start)];
@@ -429,15 +435,15 @@
 
                 if (tag_complete.indexOf(' ') !== -1) { //if there's whitespace, thats where the tag name ends
                     tag_index = tag_complete.indexOf(' ');
-                } else if (tag_complete[0] === '{') {
+                } else if (tag_complete.charAt(0) === '{') {
                     tag_index = tag_complete.indexOf('}');
                 } else { //otherwise go with the tag ending
                     tag_index = tag_complete.indexOf('>');
                 }
-                if (tag_complete[0] === '<' || !indent_handlebars) {
+                if (tag_complete.charAt(0) === '<' || !indent_handlebars) {
                     tag_offset = 1;
                 } else {
-                    tag_offset = tag_complete[2] === '#' ? 3 : 2;
+                    tag_offset = tag_complete.charAt(2) === '#' ? 3 : 2;
                 }
                 var tag_check = tag_complete.substring(tag_offset, tag_index).toLowerCase();
                 if (tag_complete.charAt(tag_complete.length - 2) === '/' ||
@@ -445,7 +451,7 @@
                     if (!peek) {
                         this.tag_type = 'SINGLE';
                     }
-                } else if (indent_handlebars && tag_complete[0] === '{' && tag_check === 'else') {
+                } else if (indent_handlebars && tag_complete.charAt(0) === '{' && tag_check === 'else') {
                     if (!peek) {
                         this.indent_to_tag('if');
                         this.tag_type = 'HANDLEBARS_ELSE';
@@ -525,7 +531,7 @@
                     comment += input_char;
 
                     // only need to check for the delimiter if the last chars match
-                    if (comment[comment.length - 1] === delimiter[delimiter.length - 1] &&
+                    if (comment.charAt(comment.length - 1) === delimiter.charAt(delimiter.length - 1) &&
                         comment.indexOf(delimiter) !== -1) {
                         break;
                     }
@@ -547,6 +553,12 @@
                         } else if (comment.indexOf('{{!') === 0) { // {{! handlebars comment
                             delimiter = '}}';
                             matched = true;
+                        } else if (comment.indexOf('<?') === 0) { // {{! handlebars comment
+                            delimiter = '?>';
+                            matched = true;
+                        } else if (comment.indexOf('<%') === 0) { // {{! handlebars comment
+                            delimiter = '%>';
+                            matched = true;
                         }
                     }
 
@@ -596,7 +608,7 @@
                     this.line_char_count++;
                     space = true;
 
-                    if (indent_handlebars && input_char === '{' && content.length && content[content.length - 2] === '{') {
+                    if (indent_handlebars && input_char === '{' && content.length && content.charAt(content.length - 2) === '{') {
                         // Handlebars expressions in strings should also be unformatted.
                         content += this.get_unformatted('}}');
                         // These expressions are opaque.  Ignore delimiters found in them.
@@ -676,6 +688,10 @@
             this.printer = function(js_source, indent_character, indent_size, wrap_line_length, brace_style) { //handles input/output and some other printing functions
 
                 this.input = js_source || ''; //gets the input for the Parser
+
+                // HACK: newline parsing inconsistent. This brute force normalizes the input.
+                this.input = this.input.replace(/\r\n|[\r\u2028\u2029]/g, '\n')
+
                 this.output = [];
                 this.indent_character = indent_character;
                 this.indent_string = '';
@@ -731,7 +747,7 @@
                     }
 
                     if (text && text !== '') {
-                        if (text.length > 1 && text[text.length - 1] === '\n') {
+                        if (text.length > 1 && text.charAt(text.length - 1) === '\n') {
                             // unformatted tags can grab newlines as their last character
                             this.output.push(text.slice(0, -1));
                             this.print_newline(false, this.output);
@@ -851,8 +867,14 @@
 
                         var indentation = multi_parser.get_full_indent(script_indent_level);
                         if (_beautifier) {
+
                             // call the Beautifier if avaliable
-                            text = _beautifier(text.replace(/^\s*/, indentation), options);
+                            var Child_options = function() {
+                                this.eol = '\n';
+                            };
+                            Child_options.prototype = options;
+                            var child_options = new Child_options();
+                            text = _beautifier(text.replace(/^\s*/, indentation), child_options);
                         } else {
                             // simply indent the string otherwise
                             var white = text.match(/^\s*/)[0];
@@ -881,9 +903,16 @@
             multi_parser.last_text = multi_parser.token_text;
         }
         var sweet_code = multi_parser.output.join('').replace(/[\r\n\t ]+$/, '');
+
+        // establish end_with_newline
         if (end_with_newline) {
             sweet_code += '\n';
         }
+
+        if (eol != '\n') {
+            sweet_code = sweet_code.replace(/[\n]/g, eol);
+        }
+
         return sweet_code;
     }