Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: disable empty-lines yamllint rule #42036

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Mesteery
Copy link
Member

@Mesteery Mesteery commented Feb 17, 2022

@tniessen
Copy link
Member

Do you have an example where the current setting is not a good fit?

@Mesteery
Copy link
Member Author

#41981 (comment)

@tniessen
Copy link
Member

Thanks. Is there a reason to use multiple empty lines? I am no expert when it comes to YAML but it seems like there should be a way to avoid that.

@Mesteery
Copy link
Member Author

Here is a site that can explain better than me: https://yaml-multiline.info.
In this example,

  CLOSE_MESSAGE: >
    There has been no activity on this feature request
    and it is being closed. If you feel closing this issue is not the
    right thing to do, please leave a comment.


    For more information on how the project manages
    feature requests, please consult the
    [feature request management document](https://github.com/nodejs/node/blob/HEAD/doc/guides/feature-request-management.md).

becomes:

There has been no activity on this feature request and it is being closed. If you feel closing this issue is not the right thing to do, please leave a comment.

For more information on how the project manages feature requests, please consult the feature request management document.

@aduh95
Copy link
Contributor

aduh95 commented Feb 17, 2022

I don't think build: is the correct subsystem here – tools: would be a better fit imo.

Copy link
Member

@tniessen tniessen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should disable the rule entirely because of a single case in which it is a false positive. If no option is added to yamllint, then we should probably just keep the yamllint disable rule:empty-lines for the few valid use cases of multiple empty lines.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants