js-beautify 1.7.4 → 1.7.5

package/CHANGELOG.md

@@ -1,4 +1,15 @@
 # Changelog
+## v1.7.5
+
+### Description
+
+
+### Closed Issues
+* Strict mode: js_source_text is not defined [CSS] ([#1286](https://github.com/beautify-web/js-beautify/issues/1286))
+* Made brace_style option more inclusive ([#1277](https://github.com/beautify-web/js-beautify/pull/1277))
+* White space before"!important" tag missing in CSS beautify ([#1273](https://github.com/beautify-web/js-beautify/issues/1273))
+
+
 ## v1.7.4
 
 ### Description
@@ -32,6 +43,7 @@ Lessons learned:
 
 
 ### Closed Issues
+* undindent-chained-methods option. Resolves #482 ([#1240](https://github.com/beautify-web/js-beautify/pull/1240))
 * Add test and tools folder to npmignore ([#1239](https://github.com/beautify-web/js-beautify/issues/1239))
 * incorrect new-line insertion after "yield" ([#1206](https://github.com/beautify-web/js-beautify/issues/1206))
 * Do not modify built-in objects ([#1205](https://github.com/beautify-web/js-beautify/issues/1205))

package/CONTRIBUTING.md

@@ -2,59 +2,59 @@
 
 
 ## Report Issues and Request Changes
-If you find a bug, please report it, including environment and examples of current behavior and what you believe to be the correct behavior.  The clearer your description and information, the more likely it is someone will be able to make progress on it.  The default issue template will help guide you through this. 
+If you find a bug, please report it, including environment and examples of current behavior and what you believe to be the correct behavior.  The clearer your description and information, the more likely it is someone will be able to make progress on it.  The default issue template will help guide you through this.
 
-## How to Make Changes (Implement Fixes and New Features) 
+## How to Make Changes (Implement Fixes and New Features)
 Fixes and enhancements are totally welcome.  We prefer if you file an issue before filing a PR, as this gives us chance to discuss design details, but fee free to dive right in.
 
 ### 1. Build and Test Locally
-While developing, you may build and test locally in JavaScript or Python implementation.  The HTML beautifier is only implemented in JavaScript.  
+While developing, you may build and test locally in JavaScript or Python implementation.  The HTML beautifier is only implemented in JavaScript.
 
-* Familiarize yourself with the folder structure and code style before you dive in.  
-* Make changes to the implemnation of your choice
-* Add tests to `/test/data/*/test.js`. 
-* Run `./build jstest` or `./build pytest` to run style checks, and to generate and run tests. 
+* Familiarize yourself with the folder structure and code style before you dive in.
+* Make changes to the implementation of your choice
+* Add tests to `/test/data/*/test.js`.
+* Run `./build jstest` or `./build pytest` to run style checks, and to generate and run tests.
 * Include all changed files in your commit - The generated test files are checked in along with changes to the test data files.
 
 ### 2. Ensure Feature Parity
-You must port changes to the other implementation.  **This is required**.  Every time we make an exception to this requirement the project becomes harder to maintain.  If you find yourself making changes and find you cannot port them to the other implementation due to implmentations being out of sync, you will begin to understand why this is required. We made this a requirement several years ago and there are still a open issues for changes that people at the time promised to port "in the next week or two".  The entire HTML beautifier is an example of this. :(
+You must port changes to the other implementation.  **This is required**.  Every time we make an exception to this requirement the project becomes harder to maintain.  If you find yourself making changes and find you cannot port them to the other implementation due to implementations being out of sync, you will begin to understand why this is required. We made this a requirement several years ago and there are still a open issues for changes that people at the time promised to port "in the next week or two".  The entire HTML beautifier is an example of this. :(
 
 The implementations are already very similar and neither Python nor JavaScript are that hard to understand.  Take the plunge, it is easier than you think.  If you get stuck, move on to filing a Pull Request and we can discuss how to move forward.
 
-* Run `./build` (with no parameters) to run style checks, and to generate and run tests on both implementations. 
+* Run `./build` (with no parameters) to run style checks, and to generate and run tests on both implementations.
 * Include all changed files in your commit - The generated test files are checked in along with changes to the test data files.
 
 ### 3. Update Documentation and Tools
 Update documentation as needed.  This such as the README.md, internal command-line help, and file comments.
-Also, check your change needs any tooling updates.  For example, the CDN urls required added scripting to update automatically for new releases. 
+Also, check your change needs any tooling updates.  For example, the CDN URLs required added scripting to update automatically for new releases.
 
-### 4. Submit a Pull Request 
+### 4. Submit a Pull Request
 
 * Run `./build full` locally after commit but before creation of Pull Request.  You may start a Pull Request if this does not succeed, but the PR will not be accepted without additional changes.
-* Include description of changes. Include examples of input and expected output if possible. 
-* Pull requests must pass build checks on all platforms before being accepted. We use travis-ci and appveyor to run tests on Linux and Windows, across multiple versions of Node.js and Python.
+* Include description of changes. Include examples of input and expected output if possible.
+* Pull requests must pass build checks on all platforms before being accepted. We use Travis CI and AppVeyor to run tests on Linux and Windows, across multiple versions of Node.js and Python.
 
 # Folders
 
 ## Root
-Some files related to specific implementations or platforms are found in the root folder, but most are cross-project tools and configuration.  
+Some files related to specific implementations or platforms are found in the root folder, but most are cross-project tools and configuration.
 
-## js
-Files related to the JavaScript implmentations of the beautifiers. 
+## `js`
+Files related to the JavaScript implementations of the beautifiers.
 
-## python
-Files related to the Python implmentations of the beautifiers. 
+## `python`
+Files related to the Python implementations of the beautifiers.
 
 
-## web
-Files related to http://jsbeautifier.org/.  
+## `web`
+Files related to http://jsbeautifier.org/.
 
-## test
-Test data files and support files used to generate implmentation-specific test files from them.
+## `test`
+Test data files and support files used to generate implementation-specific test files from them.
 
 
 # Branches
-We use the `master` branch as the primrary development branch.
+We use the `master` branch as the primary development branch.
 
 ## Releases
 Each platform has a branch that tracks to the latest release of that platform.
@@ -64,7 +64,7 @@ Each platform has a branch that tracks to the latest release of that platform.
 * `gh-pages`
 
 ## Functional Parity
-Keeping the platforms in some semblance of functional parity is one of the key features of this project.  As such, there branches for the last time synchronization occured and when it stablized.
+Keeping the platforms in some semblance of functional parity is one of the key features of this project.  As such, there branches for the last time synchronization occurred and when it stabilized.
 
 * `sync`
 * `sync-stable`
@@ -91,21 +91,20 @@ it on this separate branch to keep it from hurting the other children.
 # Publishing a Release
 Each platform has it's own release process.
 
-NOTE: Before you do any of these make sure the latest changes have passed the travis-ci build!
+NOTE: Before you do any of these make sure the latest changes have passed the Travis CI build!
 
 ## Web
 Merge changes from `master` to `gh-pages` branch.  This is very low cost and can be done whenever is convenient.
 
 ## Python
-NOTE: For now, we'd like to keep python and node version numbers synchronized,
-so if you publish a python release, you should publish a node release as well.
+NOTE: For now, we'd like to keep Python and Node version numbers synchronized,
+so if you publish a Python release, you should publish a Node release as well.
 
 To perform these steps you will need:
-1. A pypi user account from https://pypi.python.org/pypi?%3Aaction=register_form .
-2. Permissions to the jsbeautifier package.  File an issue here on github and the appropriate person will help you.
-
-We basically follow the simplest release path found at http://docs.python.org/2/distutils/packageindex.html . :
+1. A PyPI user account from https://pypi.python.org/pypi?%3Aaction=register_form.
+2. Permissions to the jsbeautifier package.  File an issue here on GitHub and the appropriate person will help you.
 
+We basically follow the simplest release path found at http://docs.python.org/2/distutils/packageindex.html:
 ```bash
 git clean -xfd
 # replace 0.0.1 with the actual version number you want to use
@@ -119,15 +118,15 @@ git push
 ```
 
 ## Node
-NOTE: For now, we'd like to keep python and node version numbers synchronized,
-so if you plan to publish a node release, you should publish a python release *first*,
+NOTE: For now, we'd like to keep Python and Node version numbers synchronized,
+so if you plan to publish a Node release, you should publish a Python release *first*,
 then perform the steps below.
 
 To perform these steps you will need:
-1. An npmjs.org user account from https://npmjs.org/signup .
-2. Permissions to the js-beautify module on npmjs.org.  File an issue here on github and the appropriate person will help you.
+1. An npmjs.org user account from https://npmjs.org/signup.
+2. Permissions to the js-beautify module on npmjs.org.  File an issue here on GitHub and the appropriate person will help you.
 
-Npm makes this process even simpler than python's and creates a tag for the release as well.
+Npm makes this process even simpler than Python's and creates a tag for the release as well.
 
 ```bash
 git clean -xfd

package/README.md

@@ -8,6 +8,7 @@
 [![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)
+[![Twitter Follow](https://img.shields.io/twitter/follow/js_beautifier.svg?style=social&label=Follow)](https://twitter.com/intent/user?screen_name=js_beautifier)
 
 [![NPM stats](https://nodei.co/npm/js-beautify.svg?downloadRank=true&downloads=true)](https://www.npmjs.org/package/js-beautify)
 
@@ -24,17 +25,17 @@ JS Beautifier is hosted on two CDN services: [cdnjs](https://cdnjs.com/libraries
 
 To pull from one of these services include one set of the script tags below in your document:
 ```html
-<script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.4/beautify.js"></script>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.4/beautify-css.js"></script>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.4/beautify-html.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.5/beautify.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.5/beautify-css.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.5/beautify-html.js"></script>
 
-<script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.4/beautify.min.js"></script>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.4/beautify-css.min.js"></script>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.4/beautify-html.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.5/beautify.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.5/beautify-css.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/js-beautify/1.7.5/beautify-html.min.js"></script>
 
-<script src="https://cdn.rawgit.com/beautify-web/js-beautify/v1.7.4/js/lib/beautify.js"></script>
-<script src="https://cdn.rawgit.com/beautify-web/js-beautify/v1.7.4/js/lib/beautify-css.js"></script>
-<script src="https://cdn.rawgit.com/beautify-web/js-beautify/v1.7.4/js/lib/beautify-html.js"></script>
+<script src="https://cdn.rawgit.com/beautify-web/js-beautify/v1.7.5/js/lib/beautify.js"></script>
+<script src="https://cdn.rawgit.com/beautify-web/js-beautify/v1.7.5/js/lib/beautify-css.js"></script>
+<script src="https://cdn.rawgit.com/beautify-web/js-beautify/v1.7.5/js/lib/beautify-html.js"></script>
 ```
 Disclaimer: These are free services, so there are [no uptime or support guarantees](https://github.com/rgrove/rawgit/wiki/Frequently-Asked-Questions#i-need-guaranteed-100-uptime-should-i-use-cdnrawgitcom).
 
@@ -321,4 +322,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.
 
-(README.md: js-beautify@1.7.4)
+(README.md: js-beautify@1.7.5)

package/js/lib/beautify-css.js

@@ -335,7 +335,7 @@ function Beautifier(source_text, options) {
             preindent_index += 1;
         }
         baseIndentString = source_text.substring(0, preindent_index);
-        js_source_text = source_text.substring(preindent_index);
+        source_text = source_text.substring(preindent_index);
     }
 
 
@@ -584,7 +584,9 @@ function Beautifier(source_text, options) {
                 if (whiteRe.test(ch)) {
                     ch = '';
                 }
-
+            } else if (ch === '!') { // !important
+                print_string(' ');
+                print_string(ch);
             } else {
                 preserveSingleSpace(isAfterSpace);
                 print_string(ch);

package/js/lib/beautify.js

@@ -425,15 +425,22 @@ function Beautifier(js_source_text, options) {
         options.brace_style = "collapse,preserve-inline";
     } else if (options.braces_on_own_line !== undefined) { //graceful handling of deprecated option
         options.brace_style = options.braces_on_own_line ? "expand" : "collapse";
-    } else if (!options.brace_style) //Nothing exists to set it
-    {
+    } else if (!options.brace_style) { //Nothing exists to set it
         options.brace_style = "collapse";
     }
 
-
+    //preserve-inline in delimited string will trigger brace_preserve_inline, everything
+    //else is considered a brace_style and the last one only will have an effect
     var brace_style_split = options.brace_style.split(/[^a-zA-Z0-9_\-]+/);
-    opt.brace_style = brace_style_split[0];
-    opt.brace_preserve_inline = brace_style_split[1] ? brace_style_split[1] : false;
+    opt.brace_preserve_inline = false; //Defaults in case one or other was not specified in meta-option
+    opt.brace_style = "collapse";
+    for (var bs = 0; bs < brace_style_split.length; bs++) {
+        if (brace_style_split[bs] === "preserve-inline") {
+            opt.brace_preserve_inline = true;
+        } else {
+            opt.brace_style = brace_style_split[bs];
+        }
+    }
 
     opt.indent_size = options.indent_size ? parseInt(options.indent_size, 10) : 4;
     opt.indent_char = options.indent_char ? options.indent_char : ' ';

package/js/lib/cli.js

@@ -41,20 +41,23 @@ var fs = require('fs'),
     beautify = require('../index'),
     mkdirp = require('mkdirp'),
     nopt = require('nopt');
+nopt.invalidHandler = function(key, val, types) {
+    throw new Error(key + " was invalid with value \"" + val + "\"");
+}
 nopt.typeDefs.brace_style = {
     type: "brace_style",
     validate: function(data, key, val) {
         data[key] = val;
         // TODO: expand-strict is obsolete, now identical to expand.  Remove in future version
         // TODO: collapse-preserve-inline is obselete, now identical to collapse,preserve-inline = true. Remove in future version
-        var validVals = ["collapse", "collapse-preserve-inline", "expand", "end-expand", "expand-strict", "none"];
-        var valSplit = val.split(/[^a-zA-Z0-9_\-]+/);
-        for (var i = 0; i < validVals.length; i++) {
-            if (validVals[i] === val || validVals[i] === valSplit[0] && valSplit[1] === "preserve-inline") {
-                return true;
+        var validVals = ["collapse", "collapse-preserve-inline", "expand", "end-expand", "expand-strict", "none", "preserve-inline"];
+        var valSplit = val.split(/[^a-zA-Z0-9_\-]+/); //Split will always return at least one parameter
+        for (var i = 0; i < valSplit.length; i++) {
+            if (validVals.indexOf(valSplit[i]) === -1) {
+                return false;
             }
         }
-        return false;
+        return true;
     }
 };
 var path = require('path'),
@@ -235,7 +238,16 @@ function set_file_editorconfig_opts(file, config) {
 
 // var cli = require('js-beautify/cli'); cli.interpret();
 var interpret = exports.interpret = function(argv, slice) {
-    var parsed = nopt(knownOpts, shortHands, argv, slice);
+    var parsed;
+    try {
+        parsed = nopt(knownOpts, shortHands, argv, slice);
+    } catch (ex) {
+        usage(ex);
+        // console.error(ex);
+        // console.error('Run `' + getScriptName() + ' -h` for help.');
+        process.exit(1);
+    }
+
 
     if (parsed.version) {
         console.log(require('../../package.json').version);

package/js/src/css/beautifier.js

@@ -196,7 +196,7 @@ function Beautifier(source_text, options) {
             preindent_index += 1;
         }
         baseIndentString = source_text.substring(0, preindent_index);
-        js_source_text = source_text.substring(preindent_index);
+        source_text = source_text.substring(preindent_index);
     }
 
 
@@ -445,7 +445,9 @@ function Beautifier(source_text, options) {
                 if (whiteRe.test(ch)) {
                     ch = '';
                 }
-
+            } else if (ch === '!') { // !important
+                print_string(' ');
+                print_string(ch);
             } else {
                 preserveSingleSpace(isAfterSpace);
                 print_string(ch);

package/js/src/javascript/beautifier.js

@@ -193,15 +193,22 @@ function Beautifier(js_source_text, options) {
         options.brace_style = "collapse,preserve-inline";
     } else if (options.braces_on_own_line !== undefined) { //graceful handling of deprecated option
         options.brace_style = options.braces_on_own_line ? "expand" : "collapse";
-    } else if (!options.brace_style) //Nothing exists to set it
-    {
+    } else if (!options.brace_style) { //Nothing exists to set it
         options.brace_style = "collapse";
     }
 
-
+    //preserve-inline in delimited string will trigger brace_preserve_inline, everything
+    //else is considered a brace_style and the last one only will have an effect
     var brace_style_split = options.brace_style.split(/[^a-zA-Z0-9_\-]+/);
-    opt.brace_style = brace_style_split[0];
-    opt.brace_preserve_inline = brace_style_split[1] ? brace_style_split[1] : false;
+    opt.brace_preserve_inline = false; //Defaults in case one or other was not specified in meta-option
+    opt.brace_style = "collapse";
+    for (var bs = 0; bs < brace_style_split.length; bs++) {
+        if (brace_style_split[bs] === "preserve-inline") {
+            opt.brace_preserve_inline = true;
+        } else {
+            opt.brace_style = brace_style_split[bs];
+        }
+    }
 
     opt.indent_size = options.indent_size ? parseInt(options.indent_size, 10) : 4;
     opt.indent_char = options.indent_char ? options.indent_char : ' ';

package/js/test/generated/beautify-css-tests.js

@@ -569,6 +569,10 @@ function run_css_tests(test_obj, Urlencoded, js_beautify, html_beautify, css_bea
             '.div {}\n' +
             '\n' +
             '.span {}');
+        t(
+            'html {}\n' +
+            '\n' +
+            '/*this is a comment*/');
         t(
             '.div {\n' +
             '\ta: 1;\n' +
@@ -1251,6 +1255,31 @@ function run_css_tests(test_obj, Urlencoded, js_beautify, html_beautify, css_bea
             '}');
 
 
+        //============================================================
+        // Important 
+        reset_options();
+        t(
+            'a {\n' +
+            '\tcolor: blue  !important;\n' +
+            '}',
+            //  -- output --
+            'a {\n' +
+            '\tcolor: blue !important;\n' +
+            '}');
+        t(
+            'a {\n' +
+            '\tcolor: blue!important;\n' +
+            '}',
+            //  -- output --
+            'a {\n' +
+            '\tcolor: blue !important;\n' +
+            '}');
+        t(
+            'a {\n' +
+            '\tcolor: blue !important;\n' +
+            '}');
+
+
         //============================================================
         // 
         reset_options();

package/js/test/shell-smoke-test.sh

@@ -55,7 +55,6 @@ test_cli_common()
       echo "[$CLI_SCRIPT_NAME $MISSING_FILE] Stdout should have no text."
       exit 1
   fi
-
 }
 
 setup_temp()
@@ -341,6 +340,20 @@ test_cli_js_beautify()
       cleanup 1
   }
 
+  #meta-parameter brace_style
+  $CLI_SCRIPT -b 'invalid' $TEST_TEMP/example1-default.js > /dev/null && {
+    echo "[$CLI_SCRIPT_NAME -b 'invalid' $TEST_TEMP/example1-default.js] Return code for invalid brace_style meta-parameter should be error."
+    cleanup 1
+  }
+  $CLI_SCRIPT -b 'expand,preserve-inline,invalid' $TEST_TEMP/example1-default.js > /dev/null && {
+    echo "[$CLI_SCRIPT_NAME -b 'expand,preserve-inline,invalid' $TEST_TEMP/example1-default.js] Return code for invalid brace_style meta-parameter should be error."
+    cleanup 1
+  }
+  $CLI_SCRIPT -b 'preserve-inline' $TEST_TEMP/example1-default.js > /dev/null || {
+    echo "[$CLI_SCRIPT_NAME -b 'preserve-inline' $TEST_TEMP/example1-default.js] Return code for only one part of valid brace_style meta-parameter should be success (uses default where it can)."
+    cleanup 1
+  }
+
   cleanup
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-beautify",
-  "version": "1.7.4",
+  "version": "1.7.5",
   "description": "jsbeautifier.org for node",
   "main": "js/index.js",
   "bin": {