Make js-beautifier kinder to templateing

Related to #490, #417
beautifier · Jun 16, 2015 · 13b8031 · 13b8031
1 parent b7b5f89
commit 13b8031
Show file tree

Hide file tree

Showing 7 changed files with 67 additions and 12 deletions.
diff --git a/js/lib/beautify.js b/js/lib/beautify.js
@@ -1543,6 +1543,8 @@
         var directives_pattern = /\/\*\sbeautify\s(\w+[:]\w+)+\s\*\//g;
         var directives_end_ignore_pattern = /([\s\S]*?)((?:\/\*\sbeautify\signore:end\s\*\/)|$)/g;
 
+        var template_pattern = /((<\?php|<\?=)[\s\S]*?\?>)|(<%[\s\S]*?%>)/g
+
         var n_newlines, whitespace_before_token, in_html_comment, tokens, parser_pos;
         var input_length;
 
@@ -1929,6 +1931,16 @@
                 }
             }
 
+            if (c === '<' && (input.charAt(parser_pos) === '?' || input.charAt(parser_pos) === '%')) {
+                template_pattern.lastIndex = parser_pos - 1;
+                var template_match = template_pattern.exec(input);
+                if(template_match) {
+                    c = template_match[0];
+                    parser_pos += c.length - 1;
+                    return [c, 'TK_STRING'];
+                }
+            }
+
             if (c === '<' && input.substring(parser_pos - 1, parser_pos + 3) === '<!--') {
                 parser_pos += 3;
                 c = '<!--';

diff --git a/js/test/beautify-javascript-tests.js b/js/test/beautify-javascript-tests.js
@@ -716,6 +716,20 @@ function run_javascript_tests(test_obj, Urlencoded, js_beautify, html_beautify,
             '};');
 
 
+
+        // Template Formatting
+        bt('<?=$view["name"]; ?>');
+        bt('a = <?= external() ?>;');
+        bt(
+            '<?php\n' +
+            'for($i = 1; $i <= 100; $i++;) {\n' +
+            '    #count to 100!\n' +
+            '    echo($i . "</br>");\n' +
+            '}\n' +
+            '?>');
+        bt('a = <%= external() %>;');
+
+
         // jslint and space after anon function - (f = " ", c = "")
         opts.jslint_happy = true;
         opts.space_after_anon_function = true;
@@ -1621,9 +1635,6 @@ function run_javascript_tests(test_obj, Urlencoded, js_beautify, html_beautify,
         beautify_brace_tests('end-expand');
         beautify_brace_tests('none');
 
-        bt('a = <?= external() ?> ;'); // not the most perfect thing in the world, but you're the weirdo beaufifying php mix-ins with javascript beautifier
-        bt('a = <%= external() %> ;');
-
         bt('// func-comment\n\nfunction foo() {}\n\n// end-func-comment');
 
         test_fragment('roo = {\n    /*\n    ****\n      FOO\n    ****\n    */\n    BAR: 0\n};');

diff --git a/python/jsbeautifier/__init__.py b/python/jsbeautifier/__init__.py
@@ -1396,6 +1396,7 @@ def __init__ (self, input, opts, indent_string):
         self.directives_pattern = re.compile('\/\*\sbeautify\s(\w+[:]\w+)+\s\*\/')
         self.directives_end_ignore_pattern = re.compile('([\s\S]*?)((?:\/\*\sbeautify\signore:end\s\*\/)|$)')
 
+        self.template_pattern = re.compile('((<\?php|<\?=)[\s\S]*?\?>)|(<%[\s\S]*?%>)')
 
     def tokenize(self):
         self.in_html_comment = False
@@ -1732,6 +1733,14 @@ def __tokenize_next(self):
                 self.parser_pos += 2
             return sharp, 'TK_WORD'
 
+        if c == '<' and self.input[self.parser_pos] in ['?', '%']:
+            template_match = self.template_pattern.match(self.input, self.parser_pos - 1);
+            if template_match:
+                c = template_match.group(0)
+                self.parser_pos += len(c) - 1
+                return c, 'TK_STRING'
+
+
         if c == '<' and self.input[self.parser_pos - 1 : self.parser_pos + 3] == '<!--':
             self.parser_pos += 3
             c = '<!--'

diff --git a/python/jsbeautifier/tests/testjsbeautifier.py b/python/jsbeautifier/tests/testjsbeautifier.py
@@ -499,6 +499,18 @@ def unicode_char(value):
             '/* beautify ignore:end */\n' +
             '};')
 
+        # Template Formatting
+        bt('<?=$view["name"]; ?>')
+        bt('a = <?= external() ?>;')
+        bt(
+            '<?php\n' +
+            'for($i = 1; $i <= 100; $i++;) {\n' +
+            '    #count to 100!\n' +
+            '    echo($i . "</br>");\n' +
+            '}\n' +
+            '?>')
+        bt('a = <%= external() %>;')
+
         # jslint and space after anon function - (f = " ", c = "")
         self.options.jslint_happy = true
         self.options.space_after_anon_function = true
@@ -1769,9 +1781,6 @@ def unicode_char(value):
 
         self.options.brace_style = 'collapse';
 
-        bt('a = <?= external() ?> ;') # not the most perfect thing in the world, but you're the weirdo beaufifying php mix-ins with javascript beautifier
-        bt('a = <%= external() %> ;')
-
         test_fragment('roo = {\n    /*\n    ****\n      FOO\n    ****\n    */\n    BAR: 0\n};')
         test_fragment("if (zz) {\n    // ....\n}\n(function")
 

diff --git a/test/data/javascript.js b/test/data/javascript.js
@@ -598,6 +598,26 @@ exports.test_data = {
             }
         ]
     },
+    {
+        name: "Template Formatting",
+        description: "Php (<?php ... ?>) and underscore.js templating treated as strings.",
+        options: [],
+        tests: [
+            { unchanged: '<?=$view["name"]; ?>' },
+            { unchanged: 'a = <?= external() ?>;' },
+            { unchanged:
+                [
+                    '<?php',
+                    'for($i = 1; $i <= 100; $i++;) {',
+                    '    #count to 100!',
+                    '    echo($i . "</br>");',
+                    '}',
+                    '?>'
+                ]
+            },
+            { unchanged: 'a = <%= external() %>;' }
+        ]
+    },
     {
         name: "jslint and space after anon function",
         description: "jslint_happy and space_after_anon_function tests",

diff --git a/test/template/node-javascript.mustache b/test/template/node-javascript.mustache
@@ -475,9 +475,6 @@ function run_javascript_tests(test_obj, Urlencoded, js_beautify, html_beautify,
         beautify_brace_tests('end-expand');
         beautify_brace_tests('none');
 
-        bt('a = <?= external() ?> ;'); // not the most perfect thing in the world, but you're the weirdo beaufifying php mix-ins with javascript beautifier
-        bt('a = <%= external() %> ;');
-
         bt('// func-comment\n\nfunction foo() {}\n\n// end-func-comment');
 
         test_fragment('roo = {\n    /*\n    ****\n      FOO\n    ****\n    */\n    BAR: 0\n};');

diff --git a/test/template/python-javascript.mustache b/test/template/python-javascript.mustache
@@ -648,9 +648,6 @@ class TestJSBeautifier(unittest.TestCase):
 
         self.options.brace_style = 'collapse';
 
-        bt('a = <?= external() ?> ;') # not the most perfect thing in the world, but you're the weirdo beaufifying php mix-ins with javascript beautifier
-        bt('a = <%= external() %> ;')
-
         test_fragment('roo = {\n    /*\n    ****\n      FOO\n    ****\n    */\n    BAR: 0\n};')
         test_fragment("if (zz) {\n    // ....\n}\n(function")