bears/hypertext: Add HTMLHintBear #1987

yash-nisar · 2017-08-10T07:22:15Z

Add HTMLHintBear that was worked upon by @AsnelChristian.
This PR is a continuation of @AsnelChristian's PR with some
modifications.

Closes #635

For short term contributors: we understand that getting your commits well
defined like we require is a hard task and takes some learning. If you
look to help without wanting to contribute long term there's no need
for you to learn this. Just drop us a message and we'll take care of brushing
up your stuff for merge!

Checklist

I read the commit guidelines and I've followed
them.
I ran coala over my code locally. (All commits have to pass
individually. It is not sufficient to have "fixup commits" on your PR,
our bot will still report the issues for the previous commit.) You will
likely receive a lot of bot comments and build failures if coala does not
pass on every single commit!

After you submit your pull request, DO NOT click the 'Update Branch' button.
When asked for a rebase, consult coala.io/rebase
instead.

Please consider helping us by reviewing other peoples pull requests as well:

pick up any PR at https://coala.io/review
review it (check https://coala.io/reviewing for more info)
if you are sure that it needs work, use cobot mark wip <URL> to get it out
of the review queue.

The more you review, the more your score will grow at coala.io and we will
review your PRs faster!

yash-nisar · 2017-08-10T07:22:40Z

CC @Makman2

Makman2 · 2017-08-11T19:30:59Z

bears/hypertext/HTMLHintBear.py

+@linter(executable='htmlhint',
+        output_format='regex',
+        output_regex=r'(?P<filename>.+):(?P<line>\d+):(?P<column>\d+):\s*'
+                     r'(?P<message>.+). \[(?P<severity>error|warning)')


you should add the closing \] to the regex ;)

Makman2 · 2017-08-11T19:31:19Z

bears/hypertext/HTMLHintBear.py

+@linter(executable='htmlhint',
+        output_format='regex',
+        output_regex=r'(?P<filename>.+):(?P<line>\d+):(?P<column>\d+):\s*'
+                     r'(?P<message>.+). \[(?P<severity>error|warning)')


What's the dot for after <message>?

That marks the end of the sentence after which the severity begins.
Example:

xyz.html:2:8: The attribute name of [ TYPE ] must be in lowercase. [error/attr-lowercase]

you need to escape it then with a \. Also match the whole string not just until error/warning

The current . represents any character

Does it look good now @SanketDG ?

Makman2 · 2017-08-11T19:35:24Z

bears/hypertext/HTMLHintBear.py

+                        disallow_inline_style: bool=True,
+                        enforce_relative_links_in_href: bool=None,
+                        prohibit_unsafe_characters: bool=True,
+                        disallow_inline_script: bool = False,


remove spaces around = operator

Makman2 · 2017-08-11T19:37:15Z

bears/hypertext/HTMLHintBear.py

+        :param allow_attribute_value_in_double_quotes:
+            Allow attribute values to be enclosed in double quotes.
+            For example: If set to ``True``, prefer ``<a href="" title="abc">``
+            over ``<a href='' title=abc>``.


allow sounds like both are allowed, single and double quotes.

Changed it to require_attribute_value_in_double_quotes

Makman2 · 2017-08-11T19:37:51Z

bears/hypertext/HTMLHintBear.py

+        :param prohibit_empty_attribute:
+            Disallow empty values for attributes.
+            For example: If set to ``True``, prefer
+            ``<input type="button" disabled="disabled">`` over


use a different attribute name, that's not the same as its value.

Changed it to prohibit_empty_value_for_attribute

Makman2 · 2017-08-11T19:38:32Z

bears/hypertext/HTMLHintBear.py

+            ``<input type="button" disabled="disabled">`` over
+            ``<input type="button" disabled>``.
+        :param prohibit_attribute_duplication:
+            Disallow the defining of the same attribute more than once in


--> Disallow defining the same attribute more than ...

Makman2 · 2017-08-11T19:41:13Z

bears/hypertext/HTMLHintBear.py

+        :param enforce_self_close_empty_tag:
+            Enforce the empty tag to be closed by self.
+            For example: If set to ``True``, prefer ``<br />`` over ``<br>``.
+        :param allow_escaped_special_characters:


again: You don't allow this case together with other cases, so you need to rename this too require_...

Makman2 · 2017-08-11T19:41:47Z

bears/hypertext/HTMLHintBear.py

+            ``<span>aaa&gt;bbb&lt;ccc</span>`` over
+            ``<span>aaa>bbb<ccc</span>``.
+        :param enforce_unique_attribute_id:
+            Require the ID attributes to be unique in the document.


why not call the setting require_... if you already meantion it inside the description?

Makman2 · 2017-08-11T19:42:01Z

bears/hypertext/HTMLHintBear.py

+            Disallow the defining of the same attribute more than once in
+            a tag. For example: If set to ``True``, prefer
+            ``<img src="a.png" />`` over ``<img src="a.png" src="b.png" />``.
+        :param use_doctype_at_beginning:


again you can use require

Makman2 · 2017-08-11T19:42:12Z

bears/hypertext/HTMLHintBear.py

+            ``<div id="id1"></div><div id="id1"></div>``.
+        :param require_title_tag:
+            Require the ``<title>`` to be present in the ``<head>`` tag.
+        :param disallow_script_in_head:


--> prohibit...

Makman2 · 2017-08-11T19:44:12Z

bears/hypertext/HTMLHintBear.py

+        :param disallow_script_in_head:
+            Prohibit the use of the ``<script>`` tag in the ``<head>`` tag.
+        :param require_alt_attribute:
+            Require alt attribute when using images(``img`` tag) and links


missing space before (

Makman2 · 2017-08-11T19:44:42Z

bears/hypertext/HTMLHintBear.py

+        :param disallow_script_in_head:
+            Prohibit the use of the ``<script>`` tag in the ``<head>`` tag.
+        :param require_alt_attribute:
+            Require alt attribute when using images(``img`` tag) and links


you should enclose alt in double quotes

Makman2 · 2017-08-11T19:45:50Z

bears/hypertext/HTMLHintBear.py

+
+        :param enforce_id_class_naming_convention:
+            Possible values are ``underline``, ``dash``, ``hump`` and ``false``
+            to disable the rule.


Don't mention false, not using the setting should disable it.

Makman2 · 2017-08-11T19:58:12Z

bears/hypertext/HTMLHintBear.py

+            For example: If set to ``underline``, prefer
+            ``<div id="aaa_bbb">``.
+            For example: If set to ``dash``, prefer ``<div id="aaa-bbb">``.
+        :param disallow_inline_style:


--> prohibit

Makman2 · 2017-08-11T19:58:31Z

bears/hypertext/HTMLHintBear.py

+            will raise a warning.
+        :param enforce_relative_links_in_href:
+            If ``True``, enforce relative links in the ``href`` attribute and
+            if ``False``, enforce absolute links.


--> require

Makman2 · 2017-08-11T19:59:24Z

bears/hypertext/HTMLHintBear.py

+            For example: If set to ``True``,
+            ``<li><a href="https://vimeo.com//56931059‎\u0009‎">2012</a></li>``
+            will raise a warning.
+        :param disallow_inline_script:


--> prohibit

SanketDG · 2017-08-12T17:21:22Z

@yash-nisar it should be '(?P<message>.+)\.

yash-nisar · 2017-08-12T18:08:50Z

Oh, missed that. Will fix it 👍 @Makman2 review possible ?

Makman2 · 2017-08-13T19:50:29Z

bears/hypertext/HTMLHintBear.py

+@linter(executable='htmlhint',
+        output_format='regex',
+        output_regex=r'(?P<filename>.+):(?P<line>\d+):(?P<column>\d+):\s*'
+                     r'(?P<message>.+)\. \[(?P<severity>error|warning).+\]')


actually I'm wondering why you don't match the period too for the message :)

Makman2 · 2017-08-13T20:08:49Z

bears/hypertext/HTMLHintBear.py

+            elif require_relative_links_in_href is False:
+                options['href-abs-or-rel'] = 'abs'
+            else:
+                options['href-abs-or-rel'] = 'false'


hm maybe inline it above doing like this:

'href-abs-or-rel': 'rel' if require_relative_links_in_href else 'abs' if require_relative_links_in_href is False else 'false'

As the assignment is repeated here, we should try to avoid that 👍

I would also maybe change the ifs to this to make it more intuitive (but optional, both do the same):

'false' if require_relative_links_in_href is None else 'rel' if require_relative_links_in_href else 'abs'

Makman2 · 2017-08-13T20:29:13Z

tests/hypertext/htmlhint_test_files/test_bad_lowercase_tagname.html

+<!DOCTYPE html>
+<SPAN>
+</SPAN>
+


this whitespacing on purpose?

Makman2 · 2017-08-13T20:29:18Z

tests/hypertext/htmlhint_test_files/.htmlhintrc

+{
+    "inline-script-disabled": true,
+    "inline-style-disabled": true
+}


no newline on purpose?

I've faced this issue a lot of times. Should I open an issue for a NewlineBear or similar ?

SpaceConsistencyBear already supports this ;)

Maybe we should enable that feature on all the files ?

if you like ;) however sometimes test files shall contain such inconsistencies (not in your case though)

Makman2 · 2017-08-13T20:29:32Z

tests/hypertext/htmlhint_test_files/test_links_in_href.html

@@ -0,0 +1,3 @@
+<!DOCTYPE html>
+<a href="test.html">test1</a>
+<a href="http://www.alibaba.com/">test1</a>


also on purpose this missing newline?

yash-nisar · 2017-08-14T06:49:48Z

Updated @Makman2

Makman2 · 2017-08-14T13:42:07Z

tests/hypertext/htmlhint_test_files/test_attribute_duplication.html

@@ -0,0 +1,2 @@
+<!DOCTYPE html>
+ <input type="submit" value="Submit" type="submit1"/>


leading space on purpose?

Makman2 · 2017-08-14T13:42:13Z

tests/hypertext/htmlhint_test_files/test_bad_lowercase_attribute.html

@@ -0,0 +1,2 @@
+<!DOCTYPE html>
+ <input TYPE="submit" value="Submit"/>


leading space on purpose?


        bears/hypertext: Add HTMLHintBear

@AsnelChristian

Add `HTMLHintBear` that was worked upon by @AsnelChristian. This PR is a continuation of @AsnelChristian's PR with some modifications. Closes #635

yash-nisar · 2017-08-14T14:13:05Z

Done @Makman2

Makman2 · 2017-08-14T14:17:33Z

ack b49553a

Makman2 · 2017-08-14T14:36:34Z

@rultor merge

rultor · 2017-08-14T14:37:40Z

@rultor merge

@Makman2 OK, I'll try to merge now. You can check the progress of the merge here

rultor · 2017-08-14T14:39:29Z

@rultor merge

@Makman2 Done! FYI, the full log is here (took me 2min)

gitmate-bot added process/pending review size/XL labels Aug 10, 2017

yash-nisar changed the title ~~bears/hypertext: Add HTMLHintBear~~ WIP bears/hypertext: Add HTMLHintBear Aug 10, 2017

yash-nisar force-pushed the yash-nisar:htmlhint branch from 501a3bb to 38ff9b2 Aug 10, 2017

gitmate-bot added process/wip review carefully! and removed process/pending review labels Aug 10, 2017

yash-nisar changed the title ~~WIP bears/hypertext: Add HTMLHintBear~~ bears/hypertext: Add HTMLHintBear Aug 10, 2017

co-robo added process/pending review and removed process/wip labels Aug 10, 2017

Makman2 reviewed Aug 11, 2017

View changes

bears/hypertext/HTMLHintBear.py Outdated

For example: If set to ``True``,

``<li><a href="https://vimeo.com//56931059‎\u0009‎">2012</a></li>``

will raise a warning.

:param disallow_inline_script:

This comment has been minimized.

Sign in to view

Makman2 Aug 11, 2017 Member

--> prohibit

yash-nisar force-pushed the yash-nisar:htmlhint branch from 38ff9b2 to dadbc82 Aug 12, 2017

yash-nisar force-pushed the yash-nisar:htmlhint branch from dadbc82 to 4530f2c Aug 13, 2017

Makman2 reviewed Aug 13, 2017

View changes

tests/hypertext/htmlhint_test_files/test_bad_lowercase_tagname.html Outdated

<!DOCTYPE html>

<SPAN>

</SPAN>

This comment has been minimized.

Sign in to view

Makman2 Aug 13, 2017 Member

this whitespacing on purpose?

Makman2 reviewed Aug 13, 2017

View changes

tests/hypertext/htmlhint_test_files/test_links_in_href.html

@@ -0,0 +1,3 @@

<!DOCTYPE html>

<a href="test.html">test1</a>

<a href="http://www.alibaba.com/">test1</a>

This comment has been minimized.

Sign in to view

Makman2 Aug 13, 2017 Member

also on purpose this missing newline?

yash-nisar force-pushed the yash-nisar:htmlhint branch from 4530f2c to 87699d8 Aug 14, 2017

Makman2 reviewed Aug 14, 2017

View changes

tests/hypertext/htmlhint_test_files/test_attribute_duplication.html Outdated

@@ -0,0 +1,2 @@

<!DOCTYPE html>

<input type="submit" value="Submit" type="submit1"/>

This comment has been minimized.

Sign in to view

Makman2 Aug 14, 2017 Member

leading space on purpose?

Makman2 reviewed Aug 14, 2017

View changes

tests/hypertext/htmlhint_test_files/test_bad_lowercase_attribute.html Outdated

@@ -0,0 +1,2 @@

<!DOCTYPE html>

<input TYPE="submit" value="Submit"/>

This comment has been minimized.

Sign in to view

Makman2 Aug 14, 2017 Member

leading space on purpose?

bears/hypertext: Add HTMLHintBear

Loading status checks…

b49553a

Add `HTMLHintBear` that was worked upon by @AsnelChristian. This PR is a continuation of @AsnelChristian's PR with some modifications. Closes #635

yash-nisar force-pushed the yash-nisar:htmlhint branch from 87699d8 to b49553a Aug 14, 2017

Makman2 added process/approved and removed process/pending review labels Aug 14, 2017

yash-nisar deleted the yash-nisar:htmlhint branch Aug 14, 2017

		@@ -0,0 +1,2 @@
		<!DOCTYPE html>
		<input type="submit" value="Submit" type="submit1"/>

		@@ -0,0 +1,2 @@
		<!DOCTYPE html>
		<input TYPE="submit" value="Submit"/>

coala / coala-bears

Join GitHub today

bears/hypertext: Add HTMLHintBear #1987

bears/hypertext: Add HTMLHintBear #1987

Conversation

yash-nisar commented Aug 10, 2017 • edited

Checklist

yash-nisar commented Aug 10, 2017

This comment has been minimized.

Makman2 Aug 11, 2017 Member

This comment has been minimized.

Makman2 Aug 11, 2017 • edited Member

This comment has been minimized.

yash-nisar Aug 12, 2017 Author Member

This comment has been minimized.

SanketDG Aug 12, 2017 Member

This comment has been minimized.

SanketDG Aug 12, 2017 Member

This comment has been minimized.

yash-nisar Aug 12, 2017 Author Member

This comment has been minimized.

Makman2 Aug 11, 2017 Member

This comment has been minimized.

Makman2 Aug 11, 2017 Member

This comment has been minimized.

yash-nisar Aug 12, 2017 Author Member

This comment has been minimized.

Makman2 Aug 11, 2017 Member

This comment has been minimized.

yash-nisar Aug 12, 2017 Author Member

This comment has been minimized.

Makman2 Aug 11, 2017 Member

This comment has been minimized.

Makman2 Aug 11, 2017 Member

This comment has been minimized.

Makman2 Aug 11, 2017 Member

This comment has been minimized.

yash-nisar Aug 12, 2017 Author Member

This comment has been minimized.

Makman2 Aug 11, 2017 Member

This comment has been minimized.

Makman2 Aug 11, 2017 Member

This comment has been minimized.

Makman2 Aug 11, 2017 Member

This comment has been minimized.

Makman2 Aug 11, 2017 Member

This comment has been minimized.

Makman2 Aug 11, 2017 Member

This comment has been minimized.

Makman2 Aug 11, 2017 Member

This comment has been minimized.

Makman2 Aug 11, 2017 Member

This comment has been minimized.

Makman2 Aug 11, 2017 Member

SanketDG commented Aug 12, 2017

yash-nisar commented Aug 12, 2017

This comment has been minimized.

Makman2 Aug 13, 2017 Member

This comment has been minimized.

yash-nisar Aug 14, 2017 Author Member

This comment has been minimized.

yash-nisar Aug 14, 2017 Author Member

This comment has been minimized.

Makman2 Aug 13, 2017 Member

This comment has been minimized.

Makman2 Aug 13, 2017 Member

This comment has been minimized.

Makman2 Aug 13, 2017 Member

This comment has been minimized.

Makman2 Aug 13, 2017 Member

This comment has been minimized.

yash-nisar Aug 14, 2017 Author Member

This comment has been minimized.

Makman2 Aug 14, 2017 Member

This comment has been minimized.

yash-nisar Aug 14, 2017 Author Member

This comment has been minimized.

Makman2 Aug 14, 2017 Member

This comment has been minimized.

Makman2 Aug 13, 2017 Member

yash-nisar commented Aug 10, 2017 •

edited

Makman2 Aug 11, 2017 •

edited

Member