Add MarkdownfmtBear #1896

naveentata · 2017-07-06T12:50:58Z

It suggests better formatting in markdown files.

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!

gitmate-bot · 2017-07-13T17:57:14Z

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

NiklasMM

Thank you for working on this. I think this is a great addition to coala.

Since your Bear can suggest patches for the issues it identifies, I'd ask you to add tests for that too. You can check out the tests for other Bears, e.g. PyImportSortBearTests to find out how that's done.

If you need help feel free to ask here or on Gitter.

NiklasMM · 2017-07-15T10:06:00Z

bears/markdown/MarkdownfmtBear.py

+
+    For more information visit
+    <https://github.com/shurcooL/markdownfmt>
+    Note that MarkdownfmtBear works with pure Markdown files


Does that mean "only with pure Markdown files"? If so, please add the word "only" for more clarity.

gitmate-bot · 2017-07-17T03:52:41Z

tests/markdown/MarkdownfmtBearTest.py

+    valid_files=(spacing_in_file2,),
+    invalid_files=(spacing_out_file2,),
+    settings={'checks_for_spacing' : 'true'})
+


W391 blank line at end of file'

PycodestyleBear (W391), severity NORMAL, section autopep8.

gitmate-bot · 2017-07-17T03:52:42Z

tests/markdown/MarkdownfmtBearTest.py

+    MarkdownfmtBear,
+    valid_files=(spacing_in_file2,),
+    invalid_files=(spacing_out_file2,),
+    settings={'checks_for_spacing' : 'true'})


E203 whitespace before ':''

PycodestyleBear (E203), severity NORMAL, section autopep8.

gitmate-bot · 2017-07-17T03:52:42Z

tests/markdown/MarkdownfmtBearTest.py

+    MarkdownfmtBear,
+    valid_files=(header_in_file1,),
+    invalid_files=(header_out_file1,),
+    settings={'checks_for_headers' : 'true'})


E203 whitespace before ':''

PycodestyleBear (E203), severity NORMAL, section autopep8.

gitmate-bot · 2017-07-17T03:52:43Z

tests/markdown/MarkdownfmtBearTest.py

+
+"""
+
+spacing_out_file2="""


E225 missing whitespace around operator'

PycodestyleBear (E225), severity NORMAL, section autopep8.

gitmate-bot · 2017-07-17T03:52:44Z

tests/markdown/MarkdownfmtBearTest.py

+
+"""
+
+spacing_in_file2="""


E225 missing whitespace around operator'

PycodestyleBear (E225), severity NORMAL, section autopep8.

gitmate-bot · 2017-07-17T03:52:44Z

tests/markdown/MarkdownfmtBearTest.py

+
+"""
+
+header_out_file1="""


E225 missing whitespace around operator'

PycodestyleBear (E225), severity NORMAL, section autopep8.

gitmate-bot · 2017-07-17T03:52:45Z

tests/markdown/MarkdownfmtBearTest.py

+from coalib.testing.LocalBearTestHelper import verify_local_bear
+
+
+header_in_file1="""


E225 missing whitespace around operator'

PycodestyleBear (E225), severity NORMAL, section autopep8.

gitmate-bot · 2017-07-17T03:52:46Z

tests/markdown/MarkdownfmtBearTest.py

+    MarkdownfmtBear,
+    valid_files=(spacing_in_file2,),
+    invalid_files=(spacing_out_file2,),
+    settings={'checks_for_spacing' : 'true'})


The code does not comply to PEP8.

PEP8Bear, severity NORMAL, section autopep8.

The issue can be fixed by applying the following patch:

--- a/tests/markdown/MarkdownfmtBearTest.py +++ b/tests/markdown/MarkdownfmtBearTest.py @@ -37,5 +37,4 @@ MarkdownfmtBear, valid_files=(spacing_in_file2,), invalid_files=(spacing_out_file2,), - settings={'checks_for_spacing' : 'true'}) - + settings={'checks_for_spacing': 'true'})

gitmate-bot · 2017-07-17T03:52:46Z

tests/markdown/MarkdownfmtBearTest.py

+    MarkdownfmtBear,
+    valid_files=(header_in_file1,),
+    invalid_files=(header_out_file1,),
+    settings={'checks_for_headers' : 'true'})


The code does not comply to PEP8.

PEP8Bear, severity NORMAL, section autopep8.

The issue can be fixed by applying the following patch:

--- a/tests/markdown/MarkdownfmtBearTest.py +++ b/tests/markdown/MarkdownfmtBearTest.py @@ -30,7 +30,7 @@ MarkdownfmtBear, valid_files=(header_in_file1,), invalid_files=(header_out_file1,), - settings={'checks_for_headers' : 'true'}) + settings={'checks_for_headers': 'true'}) MarkdownfmtBear = verify_local_bear(

gitmate-bot · 2017-07-17T03:52:47Z

tests/markdown/MarkdownfmtBearTest.py

+
+"""
+
+spacing_out_file2="""


The code does not comply to PEP8.

PEP8Bear, severity NORMAL, section autopep8.

The issue can be fixed by applying the following patch:

--- a/tests/markdown/MarkdownfmtBearTest.py +++ b/tests/markdown/MarkdownfmtBearTest.py @@ -20,7 +20,7 @@ """ -spacing_out_file2=""" +spacing_out_file2 = """ This is a test file.

gitmate-bot · 2017-07-17T03:52:48Z

tests/markdown/MarkdownfmtBearTest.py

+
+"""
+
+spacing_in_file2="""


The code does not comply to PEP8.

PEP8Bear, severity NORMAL, section autopep8.

The issue can be fixed by applying the following patch:

--- a/tests/markdown/MarkdownfmtBearTest.py +++ b/tests/markdown/MarkdownfmtBearTest.py @@ -14,7 +14,7 @@ """ -spacing_in_file2=""" +spacing_in_file2 = """ This is a test file.

gitmate-bot · 2017-07-17T03:52:48Z

tests/markdown/MarkdownfmtBearTest.py

+
+"""
+
+header_out_file1="""


The code does not comply to PEP8.

PEP8Bear, severity NORMAL, section autopep8.

The issue can be fixed by applying the following patch:

--- a/tests/markdown/MarkdownfmtBearTest.py +++ b/tests/markdown/MarkdownfmtBearTest.py @@ -8,7 +8,7 @@ """ -header_out_file1=""" +header_out_file1 = """ MarkdownBear ============

gitmate-bot · 2017-07-17T03:52:49Z

tests/markdown/MarkdownfmtBearTest.py

+from coalib.testing.LocalBearTestHelper import verify_local_bear
+
+
+header_in_file1="""


The code does not comply to PEP8.

PEP8Bear, severity NORMAL, section autopep8.

The issue can be fixed by applying the following patch:

--- a/tests/markdown/MarkdownfmtBearTest.py +++ b/tests/markdown/MarkdownfmtBearTest.py @@ -2,7 +2,7 @@ from coalib.testing.LocalBearTestHelper import verify_local_bear -header_in_file1=""" +header_in_file1 = """ MarkdownBear =====

yash-nisar · 2017-07-18T11:45:12Z

bears/markdown/MarkdownfmtBear.py

+    like alignment, indendation are provided.
+
+    For more information visit
+    <https://github.com/shurcooL/markdownfmt>


Add this in the SEE_MORE attribute.

yash-nisar · 2017-07-18T11:45:48Z

bears/markdown/MarkdownfmtBear.py

+
+    @staticmethod
+    def create_arguments(filename, file, config_file):
+        return()


So we use stdin for the input and not the filename ?

yash-nisar · 2017-07-18T11:49:12Z

tests/markdown/MarkdownfmtBearTest.py

@@ -0,0 +1,37 @@
+from bears.markdown.MarkdownfmtBear import MarkdownfmtBear
+from coalib.testing.LocalBearTestHelper import verify_local_bear
+


Imports should be in the following order: (Note that I've left a line)

from coalib.testing.LocalBearTestHelper import verify_local_bear from bears.markdown.MarkdownfmtBear import MarkdownfmtBear

AsnelChristian · 2017-07-18T11:21:00Z

bears/markdown/MarkdownfmtBear.py

+    like alignment, indendation are provided.
+
+    For more information visit
+    <https://github.com/shurcooL/markdownfmt>


move this to SEE_MORE

AsnelChristian · 2017-07-18T11:30:28Z

bears/markdown/MarkdownfmtBear.py

+
+    @staticmethod
+    def create_arguments(filename, file, config_file):
+        return()


return list() just a preference though 😅

AsnelChristian · 2017-07-18T11:31:17Z

bears/markdown/MarkdownfmtBear.py

+
+    For more information visit
+    <https://github.com/shurcooL/markdownfmt>
+    Note that MarkdownfmtBear works only with pure Markdown files


clearly explain what you mean by "pure Markdown files"

Missing period.

AsnelChristian · 2017-07-18T11:49:31Z

bears/markdown/MarkdownfmtBear.py

+        use_stderr=True)
+class MarkdownfmtBear:
+    """
+    Suggests better formatting in Markdown files. Basic checks


how about:

Check and correct formatting of Markdown files using ``mardownfmt``.

yash-nisar · 2017-07-18T11:50:59Z

tests/markdown/MarkdownfmtBearTest.py

+MarkdownfmtBear = verify_local_bear(
+    MarkdownfmtBear,
+    valid_files=(spacing_in_file2,),
+    invalid_files=(spacing_out_file2,))


You need to improve your tests 😉 . You can refer to any bear with code correcting capabilities. (e.g. MarkdownBear)

gitmate-bot · 2017-07-20T13:45:33Z

bears/markdown/MarkdownfmtBear.py

+    LICENSE = 'AGPL-3.0'
+    CAN_FIX = {'Formatting'}
+    ASCIINEMA_URL = 'https://asciinema.org/a/396jhuyw1j0c1l2i9p09wlhye'
+    SEE_MORE = 'https://github.com/shurcooL/markdownfmt' 


Line contains following spacing inconsistencies:

Trailing whitespaces.

SpaceConsistencyBear, severity NORMAL, section python.

The issue can be fixed by applying the following patch:

--- a/bears/markdown/MarkdownfmtBear.py +++ b/bears/markdown/MarkdownfmtBear.py @@ -21,7 +21,7 @@ LICENSE = 'AGPL-3.0' CAN_FIX = {'Formatting'} ASCIINEMA_URL = 'https://asciinema.org/a/396jhuyw1j0c1l2i9p09wlhye' - SEE_MORE = 'https://github.com/shurcooL/markdownfmt' + SEE_MORE = 'https://github.com/shurcooL/markdownfmt' @staticmethod def create_arguments(filename, file, config_file):

gitmate-bot · 2017-07-20T13:45:33Z

bears/markdown/MarkdownfmtBear.py

+    """
+    Check and correct formatting of Markdown files using ``mardownfmt``.
+    Basic checks like alignment, indendation are provided.
+


Line contains following spacing inconsistencies:

Trailing whitespaces.

SpaceConsistencyBear, severity NORMAL, section python.

The issue can be fixed by applying the following patch:

--- a/bears/markdown/MarkdownfmtBear.py +++ b/bears/markdown/MarkdownfmtBear.py @@ -10,7 +10,7 @@ """ Check and correct formatting of Markdown files using ``mardownfmt``. Basic checks like alignment, indendation are provided. - + Note that MarkdownfmtBear works only with pure Markdown files. """ LANGUAGES = {'Markdown'}

gitmate-bot · 2017-07-20T13:45:34Z

bears/markdown/MarkdownfmtBear.py

+    LICENSE = 'AGPL-3.0'
+    CAN_FIX = {'Formatting'}
+    ASCIINEMA_URL = 'https://asciinema.org/a/396jhuyw1j0c1l2i9p09wlhye'
+    SEE_MORE = 'https://github.com/shurcooL/markdownfmt' 


W291 trailing whitespace'

PycodestyleBear (W291), severity NORMAL, section autopep8.

gitmate-bot · 2017-07-20T13:45:35Z

bears/markdown/MarkdownfmtBear.py

+    """
+    Check and correct formatting of Markdown files using ``mardownfmt``.
+    Basic checks like alignment, indendation are provided.
+


W293 blank line contains whitespace'

PycodestyleBear (W293), severity NORMAL, section autopep8.

gitmate-bot · 2017-07-20T13:45:36Z

bears/markdown/MarkdownfmtBear.py

+    LICENSE = 'AGPL-3.0'
+    CAN_FIX = {'Formatting'}
+    ASCIINEMA_URL = 'https://asciinema.org/a/396jhuyw1j0c1l2i9p09wlhye'
+    SEE_MORE = 'https://github.com/shurcooL/markdownfmt' 


The code does not comply to PEP8.

PEP8Bear, severity NORMAL, section autopep8.

The issue can be fixed by applying the following patch:

--- a/bears/markdown/MarkdownfmtBear.py +++ b/bears/markdown/MarkdownfmtBear.py @@ -21,7 +21,7 @@ LICENSE = 'AGPL-3.0' CAN_FIX = {'Formatting'} ASCIINEMA_URL = 'https://asciinema.org/a/396jhuyw1j0c1l2i9p09wlhye' - SEE_MORE = 'https://github.com/shurcooL/markdownfmt' + SEE_MORE = 'https://github.com/shurcooL/markdownfmt' @staticmethod def create_arguments(filename, file, config_file):

gitmate-bot · 2017-07-20T13:45:36Z

bears/markdown/MarkdownfmtBear.py

+    """
+    Check and correct formatting of Markdown files using ``mardownfmt``.
+    Basic checks like alignment, indendation are provided.
+


The code does not comply to PEP8.

PEP8Bear, severity NORMAL, section autopep8.

The issue can be fixed by applying the following patch:

--- a/bears/markdown/MarkdownfmtBear.py +++ b/bears/markdown/MarkdownfmtBear.py @@ -10,7 +10,7 @@ """ Check and correct formatting of Markdown files using ``mardownfmt``. Basic checks like alignment, indendation are provided. - + Note that MarkdownfmtBear works only with pure Markdown files. """ LANGUAGES = {'Markdown'}

AsnelChristian · 2017-07-20T19:20:03Z

bears/markdown/MarkdownfmtBear.py

+    Check and correct formatting of Markdown files using ``mardownfmt``.
+    Basic checks like alignment, indendation are provided.
+
+    Note that MarkdownfmtBear works only with pure Markdown files.


is it still not clear what you mean by pure Markdown files

AsnelChristian · 2017-07-20T19:22:11Z

you should fix gitmate issues

yash-nisar · 2017-07-21T06:30:06Z

tests/markdown/MarkdownfmtBearTest.py

+from coalib.testing.LocalBearTestHelper import verify_local_bear
+
+from bears.markdown.MarkdownfmtBear import MarkdownfmtBear
+


We leave 2 lines before the code begins.

yash-nisar · 2017-07-21T06:46:26Z

Your tests seem to be failing. Can you fix and improve them if possible ?

It suggests better formatting in markdown files. Closes coala#1538

meetmangukiya · 2017-07-22T10:57:52Z

@naveentata please fix your tests

naveentata · 2017-07-27T12:43:21Z

@meetmangukiya I am not able to figure out what is wrong in the test, can you please help me? 😟

gitmate-bot added process/pending review size/S review carefully! labels Jul 6, 2017

naveentata force-pushed the test branch from cb8b35f to 571e169 Compare July 6, 2017 15:20

NiklasMM suggested changes Jul 15, 2017

View reviewed changes

coala-bot added process/wip and removed process/pending review labels Jul 15, 2017

naveentata force-pushed the test branch from 571e169 to 6ecd185 Compare July 17, 2017 03:51

gitmate-bot added process/pending review size/M and removed process/wip size/S labels Jul 17, 2017

gitmate-bot reviewed Jul 17, 2017

View reviewed changes

naveentata force-pushed the test branch 2 times, most recently from 87d1646 to e23d751 Compare July 17, 2017 12:47

yash-nisar reviewed Jul 18, 2017

View reviewed changes

AsnelChristian requested changes Jul 18, 2017

View reviewed changes

yash-nisar reviewed Jul 18, 2017

View reviewed changes

co-robo added process/wip and removed process/pending review labels Jul 18, 2017

naveentata force-pushed the test branch from e23d751 to 47b2e0d Compare July 20, 2017 13:44

gitmate-bot added process/pending review and removed process/wip labels Jul 20, 2017

gitmate-bot reviewed Jul 20, 2017

View reviewed changes

AsnelChristian reviewed Jul 20, 2017

View reviewed changes

AsnelChristian added process/wip and removed process/pending review labels Jul 20, 2017

yash-nisar reviewed Jul 21, 2017

View reviewed changes

Add MarkdownfmtBear

1a620ba

It suggests better formatting in markdown files. Closes coala#1538

naveentata force-pushed the test branch from 47b2e0d to 1a620ba Compare July 21, 2017 15:17

gitmate-bot added process/pending review and removed process/wip labels Jul 21, 2017

co-robo added process/wip and removed process/pending review labels Jul 22, 2017

gitmate-bot added the status/STALE label Aug 31, 2017

		from coalib.testing.LocalBearTestHelper import verify_local_bear


		header_in_file1="""

		@@ -0,0 +1,37 @@
		from bears.markdown.MarkdownfmtBear import MarkdownfmtBear
		from coalib.testing.LocalBearTestHelper import verify_local_bear


		"""

		spacing_out_file2="""


		"""

		spacing_in_file2="""


		"""

		header_out_file1="""


		"""

		spacing_out_file2="""

Add MarkdownfmtBear #1896

Are you sure you want to change the base?

Add MarkdownfmtBear #1896

Conversation

naveentata commented Jul 6, 2017

Checklist

gitmate-bot commented Jul 13, 2017

NiklasMM left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AsnelChristian commented Jul 20, 2017

Choose a reason for hiding this comment

yash-nisar commented Jul 21, 2017 • edited Loading

meetmangukiya commented Jul 22, 2017 • edited Loading

naveentata commented Jul 27, 2017

yash-nisar commented Jul 21, 2017 •

edited

Loading

meetmangukiya commented Jul 22, 2017 •

edited

Loading