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

Stylelint max-line-length should this apply to comments? #249

Open
mattheu opened this issue Feb 25, 2021 · 1 comment
Open

Stylelint max-line-length should this apply to comments? #249

mattheu opened this issue Feb 25, 2021 · 1 comment

Comments

@mattheu
Copy link
Member

mattheu commented Feb 25, 2021

The stylelint rule max-line-length is set to 100. But I have run into a case where this is longer. My specific situation is the comment at the top of the theme style.css file, for example the description. We can't break this line either as WP won't then pick up the full description.

We can change this rule to ignore comments, which would solve the problem. But also could lead to long comments elsewhere which is less desirable.

What do you think? Force short theme descriptions, ignore max line length for comments, perhaps I should be ignoring this file or maybe some other way?

@tfrommen
Copy link
Contributor

tfrommen commented Feb 25, 2021

Could you ignore this specific rule just for the documentation block?

/* stylelint-disable max-line-length */
/**
 * Your documentation goes here...
 */
/* stylelint-enable max-line-length */

I think that forcing short descriptions doesn't sound good, and I agree that we shouldn't allow arbitrary line lengths for all comments.

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

No branches or pull requests

2 participants