Add content_unformatted config to avoid formatting content of an element (fix #906) #1080

arai-a · 2016-12-25T09:39:09Z

This fixes #906

The issue is that unformatted config is applied to following 3 places:

newline before the element
content of the element
newline after the element

while it's useful for inline elements, when one want to disable formatting only the content of the content, keeping newlines before/after it, the config cannot be used.

I added new content_unformatted config, that does only "content of the element" part.
if content_unformatted one add "style" and "script" to this, their content is not formatted, while they still have newlines before/after them.

config file:

{
    "content_unformatted": [ "script", "style" ]
}

output

$ node ./js/bin/html-beautify.js   --config ~/Desktop/conf ~/Desktop/b.html
<body>
    <h1>Heading</h1>
    <script>var formatMe = function() { return false; };</script>
    <style>.format-disabled { display: none; } </style>
</body>

I also added commandline option --content_unformatted, or -T (the first character in 'content_unformatted' that wasn't used...), that can be used like --unformatted.

$ node ./js/bin/html-beautify.js -T script ~/Desktop/b.html
<body>
    <h1>Heading</h1>
    <script>var formatMe = function() { return false; };</script>
    <style>
        .format-disabled {
            display: none;
        }
    </style>
</body>

$ node ./js/bin/html-beautify.js -T style ~/Desktop/b.html
<body>
    <h1>Heading</h1>
    <script>
        var formatMe = function() {
            return false;
        };
    </script>
    <style>.format-disabled { display: none; } </style>
</body>

$ node ./js/bin/html-beautify.js -T script -T style ~/Desktop/b.html
<body>
    <h1>Heading</h1>
    <script>var formatMe = function() { return false; };</script>
    <style>.format-disabled { display: none; } </style>
</body>

bitwiseman · 2016-12-26T19:56:56Z

@arai-a - Thanks for submitting.
Please rebase the latest changes.
Also, look at the tests for #1081 and make sure you handle those inputs, as well.
Your change looks simpler than that one as well.

Finally, please format your multi-line test inputs or outputs like this to make them easier to understand:

        tests: [{
            fragment: true,
            input: '<html><body><h1>A</h1><script>if(1){f();}</script><style>.a{display:none;}</style></body></html>',
            output: [
                '<html>',
                '<body>',
                '    <h1>A</h1>',
                '    <script>if(1){f();}</script>',
                '    <style>.a{display:none;}</style>',
                '</body>',
                '',
                '</html>'
            ]
        }]

arai-a · 2016-12-26T21:18:07Z

rebased onto latest master and added tests from #1081 and it passed without any changes.
thank you!

bitwiseman

A few more tests needed and need to have pre as part of the default. Once that is done, this looks good.

bitwiseman · 2016-12-26T21:45:53Z

js/lib/beautify-html.js

@@ -161,6 +163,7 @@
            'acronym', 'address', 'big', 'dt', 'ins', 'strike', 'tt',
            'pre',
        ];
+        content_unformatted = options.content_unformatted || [];


Please move 'pre' from unformatted, into the default for content_unformatted and add some tests for it based on #928.

bitwiseman · 2016-12-26T21:48:58Z

test/data/html/tests.js

+        name: "content_unformatted to prevent formatting content",
+        description: "",
+        options: [
+            { name: 'content_unformatted', value: "['script', 'style', 'p', 'span', 'br']" }


Add some examples with <pre> tag (as mentioned above).
Then please do the same inputs with the default content_unformatted. It is important to understand how this changes the outputs.

…ent (fix beautifier#906)

arai-a · 2016-12-27T00:54:43Z

okay, moved pre to content_unformatted and added tests for pre and default options,
and also updated one pre-existing test to follow the change to pre

bitwiseman · 2016-12-27T01:26:23Z

Great, thanks.
There's been a question from #1081. I need to establish whether this issue raised there is valid or not before we merge. Other than that this looks good.

arai-a · 2016-12-27T03:21:58Z

I don't see the missing newline issue, on osx, node v6.9.1.
I get expected result with cli.

arai-a · 2016-12-27T04:50:04Z

tested also on debian, nodejs v4.6.1,
I get expected result.

bitwiseman · 2016-12-29T05:44:46Z

Thank you for your contributio. I hope you will continue to contribute beyond this one PR.

arai-a · 2016-12-29T06:06:29Z

thank you too for reviewing :)
It's my pleasure to be able to contribute to software I use daily.

arai-a changed the title ~~Add content_unformatted config to avoid formatting content of an elem…~~ Add content_unformatted config to avoid formatting content of an element (fix #906) Dec 25, 2016

bitwiseman mentioned this pull request Dec 26, 2016

Beautify script/style tags but ignore their inner JS/CSS content #906

Closed

bitwiseman mentioned this pull request Dec 26, 2016

fix #906. New unformatted_tag_content option. #1081

Closed

arai-a force-pushed the content_unformatted branch from c36213a to b3798f1 Compare December 26, 2016 21:14

bitwiseman requested changes Dec 26, 2016

View reviewed changes

Add content_unformatted config to avoid formatting content of an elem…

32c8e6e

…ent (fix beautifier#906)

arai-a force-pushed the content_unformatted branch from b3798f1 to 32c8e6e Compare December 27, 2016 00:51

bitwiseman approved these changes Dec 28, 2016

View reviewed changes

bitwiseman merged commit fb13bcb into beautifier:master Dec 28, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add content_unformatted config to avoid formatting content of an element (fix #906) #1080

Add content_unformatted config to avoid formatting content of an element (fix #906) #1080

arai-a commented Dec 25, 2016 •

edited

Loading

bitwiseman commented Dec 26, 2016

arai-a commented Dec 26, 2016

bitwiseman left a comment

bitwiseman Dec 26, 2016

bitwiseman Dec 26, 2016

arai-a commented Dec 27, 2016

bitwiseman commented Dec 27, 2016

arai-a commented Dec 27, 2016

arai-a commented Dec 27, 2016

bitwiseman commented Dec 29, 2016

arai-a commented Dec 29, 2016

Add content_unformatted config to avoid formatting content of an element (fix #906) #1080

Add content_unformatted config to avoid formatting content of an element (fix #906) #1080

Conversation

arai-a commented Dec 25, 2016 • edited Loading

bitwiseman commented Dec 26, 2016

arai-a commented Dec 26, 2016

bitwiseman left a comment

Choose a reason for hiding this comment

bitwiseman Dec 26, 2016

Choose a reason for hiding this comment

bitwiseman Dec 26, 2016

Choose a reason for hiding this comment

arai-a commented Dec 27, 2016

bitwiseman commented Dec 27, 2016

arai-a commented Dec 27, 2016

arai-a commented Dec 27, 2016

bitwiseman commented Dec 29, 2016

arai-a commented Dec 29, 2016

arai-a commented Dec 25, 2016 •

edited

Loading