YAMLLintBear: Disable `document-start` rule by default #965

refeed · 2016-10-31T16:34:05Z

Disable YAMLLint rule document-start by default because
many YAML files have no need for start and end markers, but
user still can enable it by using document_start=true
setting.

Add unit tests for YAMLLintBear.

Closes #923

gitmate-bot · 2016-10-31T16:34:19Z

Thanks for your contribution!

Reviewing pull requests take really a lot of time and we're all volunteers. Please make sure you go through the following check list and complete them all before pinging someone for a review.

I have rebased properly. Please see this for a tutorial.
I have gone through the commit guidelines and I've followed them:
- I have followed the guidelines for the commit shortlog.
- I have followed the guidelines for the commit body.
- I have included the issue URL.
- I have used the Fixes keyword if the commit fixes a real bug and the Closes keyword if it adds a feature/enhancement. See more here.
I have run all the tests and they all pass. That includes that all CI (below) is green - if GitMate issues appear you will have to amend your commits, pushing new commits on top is not sufficient!

As you learn things over your Pull Request please help others on the chat and on PRs to get their stuff right as well!

gitmate-bot · 2016-10-31T16:34:33Z

Comment on 1751d74.

Shortlog of HEAD commit is 4 character(s) longer than the limit (54 > 50).

GitCommitBear, severity NORMAL, section commit.

gitmate-bot · 2016-10-31T16:34:34Z

bears/yml/YAMLLintBear.py

+        '''
+        :param document_start:
+        	Use this rule to require or forbid the use of document start
+        	marker (---).


Line contains following spacing inconsistencies:

Tabs used instead of spaces.

SpaceConsistencyBear, severity NORMAL, section python.

The issue can be fixed by applying the following patch:

--- a/bears/yml/YAMLLintBear.py +++ b/bears/yml/YAMLLintBear.py @@ -27,7 +27,7 @@ ''' :param document_start: Use this rule to require or forbid the use of document start - marker (---). + marker (---). ''' yamllint_configs = {'extends': 'default', 'rules':

gitmate-bot · 2016-10-31T16:34:35Z

bears/yml/YAMLLintBear.py

+                        document_start: bool=False):
+        '''
+        :param document_start:
+        	Use this rule to require or forbid the use of document start


Line contains following spacing inconsistencies:

Tabs used instead of spaces.

SpaceConsistencyBear, severity NORMAL, section python.

The issue can be fixed by applying the following patch:

--- a/bears/yml/YAMLLintBear.py +++ b/bears/yml/YAMLLintBear.py @@ -26,7 +26,7 @@ document_start: bool=False): ''' :param document_start: - Use this rule to require or forbid the use of document start + Use this rule to require or forbid the use of document start marker (---). ''' yamllint_configs = {'extends': 'default',

gitmate-bot · 2016-10-31T16:34:35Z

bears/yml/YAMLLintBear.py

+        yamllint_configs = {'extends': 'default',
+                            'rules':
+                                {'document-start':
+                                     {'present': False}


The code does not comply to PEP8.

PEP8Bear, severity NORMAL, section autopep8.

The issue can be fixed by applying the following patch:

--- a/bears/yml/YAMLLintBear.py +++ b/bears/yml/YAMLLintBear.py @@ -32,9 +32,9 @@ yamllint_configs = {'extends': 'default', 'rules': {'document-start': - {'present': False} - } - } + {'present': False} + } + } if document_start: yamllint_configs['rules']['document-start']['present'] = True

gitmate-bot · 2016-10-31T16:34:36Z

bears/yml/YAMLLintBear.py

+                        document_start: bool=False):
+        '''
+        :param document_start:
+        	Use this rule to require or forbid the use of document start


The code does not comply to PEP8.

PEP8Bear, severity NORMAL, section autopep8.

The issue can be fixed by applying the following patch:

--- a/bears/yml/YAMLLintBear.py +++ b/bears/yml/YAMLLintBear.py @@ -26,8 +26,8 @@ document_start: bool=False): ''' :param document_start: - Use this rule to require or forbid the use of document start - marker (---). + Use this rule to require or forbid the use of document start + marker (---). ''' yamllint_configs = {'extends': 'default', 'rules':

Adrianzatreanu · 2016-10-31T18:15:19Z

hey this is unreviewable with so many gitmate issues, could you fix them? simply running coala on your machine will fix everything for you :)

sils · 2016-11-05T09:10:34Z

Oy! I like this! b48311d is ready

sils · 2016-11-05T09:11:23Z

@rafidaslam if you rebase this we can merge it, here are the rebase instructions just in case you need them:

Hi,

it looks like your PR is out of date and needs a rebase. This page may help you to get started on this. (Do not press the update branch button. It's evil.)

Add the original coala repository as a remote:

git remote add upstream https://github.com/coala/coala-bears.git

Then go to your branch and rebase it onto our master:

git checkout <yourbranch>
git fetch upstream
git rebase --interactive upstream/master

Now push it up. You will need to do a force push because you change history here (do not do this on master branches :)):

git push --force

If you're just looking to fix an issue very quickly and not interested in contributing to coala long term, we can fix it up for you - just tell us :).

Ping us on our gitter channel if you need help!

Disable YAMLLint rule `document-start` by default because many YAML files have no need for start and end markers, but user still can enable it by using `document_start=true` setting. Closes coala#923

refeed · 2016-11-05T10:31:59Z

@sils rebased :)

AsnelChristian · 2016-11-05T10:47:17Z

ack 5c5a6e1

AsnelChristian · 2016-11-05T10:48:01Z

ack 5c5a6e1

AsnelChristian · 2016-11-05T10:48:37Z

@rultor merge

rultor · 2016-11-05T10:49:22Z

@rultor merge

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

rultor · 2016-11-05T10:50:47Z

@rultor merge

@AsnelChristian Done! FYI, the full log is here (took me 1min)

Some projects use documents starts (`---`) in YAML documents (for example Ansible, OpenStack, yamllint), others don't. Since these markers are required when declaring multiple documents in a single .yaml file (see the spec [1]), it is a bad idea to forbid them. This commit disables the `document-start` rule by default, instead of forcing / forbidding the use of these markers. [1]: http://yaml.org/spec/1.2/spec.html#id2800132 Closes: coala#1417 Fixes: coala#923 coala#965

Some projects use documents starts (`---`) in YAML documents (for example Ansible, OpenStack, yamllint), others don't. Since these markers are required when declaring multiple documents in a single .yaml file (see the spec [1]), it is a bad idea to forbid them. This commit disables the `document-start` rule by default, instead of forcing / forbidding the use of these markers. [1]: http://yaml.org/spec/1.2/spec.html#id2800132 Closes coala#1417 Fixes coala#923 coala#965

Some projects use documents starts (`---`) in YAML documents (for example Ansible, OpenStack, yamllint), others don't. Since these markers are required when declaring multiple documents in a single .yaml file (see the spec [1]), it is a bad idea to forbid them. This commit disables the `document-start` rule by default, instead of forcing / forbidding the use of these markers. [1]: http://yaml.org/spec/1.2/spec.html#id2800132 Closes coala#1417 Related to coala#923 and coala#965

gitmate-bot added process/pending review size/M labels Oct 31, 2016

gitmate-bot reviewed Oct 31, 2016

View reviewed changes

Adrianzatreanu added process/wip and removed process/pending review labels Oct 31, 2016

refeed force-pushed the disable-yamllint-documentstart branch from 1751d74 to 60a223f Compare November 5, 2016 06:43

gitmate-bot added process/pending review and removed process/wip labels Nov 5, 2016

refeed force-pushed the disable-yamllint-documentstart branch from 60a223f to b48311d Compare November 5, 2016 06:57

sils added process/approved and removed process/pending review labels Nov 5, 2016

YAMLLintBear: Make document-start rule disabled

5c5a6e1

Disable YAMLLint rule `document-start` by default because many YAML files have no need for start and end markers, but user still can enable it by using `document_start=true` setting. Closes coala#923

refeed force-pushed the disable-yamllint-documentstart branch from b48311d to 5c5a6e1 Compare November 5, 2016 10:14

gitmate-bot added the process/pending review label Nov 5, 2016

rultor merged commit 5c5a6e1 into coala:master Nov 5, 2016

adrienverge mentioned this pull request Feb 7, 2017

Most YAML documents use document starts (---) #1417

Closed

adrienverge mentioned this pull request Feb 8, 2017

yamllint: Disable document-start by default #1422

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

YAMLLintBear: Disable `document-start` rule by default #965

YAMLLintBear: Disable `document-start` rule by default #965

refeed commented Oct 31, 2016

gitmate-bot commented Oct 31, 2016

gitmate-bot commented Oct 31, 2016

gitmate-bot Oct 31, 2016

gitmate-bot Oct 31, 2016

gitmate-bot Oct 31, 2016

gitmate-bot Oct 31, 2016

Adrianzatreanu commented Oct 31, 2016

sils commented Nov 5, 2016

sils commented Nov 5, 2016

refeed commented Nov 5, 2016

AsnelChristian commented Nov 5, 2016

AsnelChristian commented Nov 5, 2016

AsnelChristian commented Nov 5, 2016

rultor commented Nov 5, 2016

rultor commented Nov 5, 2016

YAMLLintBear: Disable document-start rule by default #965

YAMLLintBear: Disable document-start rule by default #965

Conversation

refeed commented Oct 31, 2016

gitmate-bot commented Oct 31, 2016

gitmate-bot commented Oct 31, 2016

gitmate-bot Oct 31, 2016

Choose a reason for hiding this comment

gitmate-bot Oct 31, 2016

Choose a reason for hiding this comment

gitmate-bot Oct 31, 2016

Choose a reason for hiding this comment

gitmate-bot Oct 31, 2016

Choose a reason for hiding this comment

Adrianzatreanu commented Oct 31, 2016

sils commented Nov 5, 2016

sils commented Nov 5, 2016

refeed commented Nov 5, 2016

AsnelChristian commented Nov 5, 2016

AsnelChristian commented Nov 5, 2016

AsnelChristian commented Nov 5, 2016

rultor commented Nov 5, 2016

rultor commented Nov 5, 2016

YAMLLintBear: Disable `document-start` rule by default #965

YAMLLintBear: Disable `document-start` rule by default #965