Document full configs for secondary option examples

[IAMtheIAM]

Clearly describe the bug

The selector-pseudo-element-no-unknown rule needs to accept true and false so it can be overridden when extending from a predefined config which has it set to true.

Which rule, if any, is the bug related to?

selector-pseudo-element-no-unknown

What code is needed to reproduce the bug?

No code

What stylelint configuration is needed to reproduce the bug?

    "selector-pseudo-element-no-unknown": false,

Which version of stylelint are you using?

    "stylelint": "13.5.0",

How are you running stylelint: CLI, PostCSS plugin, Node.js API?

CLI

Does the bug relate to non-standard syntax (e.g. SCSS, Less etc.)?

"Yes, it's related to SCSS nested properties."

What did you expect to happen?

"No error."

What actually happened (e.g. what warnings or errors did you get)?

Results in error: Invalid Option: Unexpected option value "false" for rule "selector-pseudo-element-no-unknown"

[IAMtheIAM]

I found that I can do this:

        "selector-pseudo-element-no-unknown": [true, {
            "ignorePseudoElements": ["ng-deep"]
        }],

But I did not understand this clearly from the documentation. It would be really helpful if the rules showed the full config in the options and secondary options, just an idea.

[hudochenkov]

The selector-pseudo-element-no-unknown rule needs to accept true and false so it can be overridden when extending from a predefined config which has it set to true.

Use null to turn off a rule:

"selector-pseudo-element-no-unknown": null

But I did not understand this clearly from the documentation. It would be really helpful if the rules showed the full config in the options and secondary options, just an idea.

I would agree with you. Style of configuration examples in rule description are rather not user-friendly, and require quite some knowledge about how stylelint works and how it's configured.

E. g. this is what we have in selector-pseudo-element-no-unknown:

Given:

["/^my-/", "pseudo-element"]

This would be much more helpful for users:

Given:

[true, { "ignorePseudoElements": ["/^my-/", "pseudo-element"] }]

[jeddy3]

This would be much more helpful for users:

Agreed. I'll label the issue as ready to go.

@IAMtheIAM Please consider contributing these changes if you have time.

[Mouvedia]

The initial issue is covered by #5091.

[ybiquitous]

I agree with @Mouvedia.

If PR #6250 is merged, users will receive a more helpful message, and we've already provided the doc for turning off a rule. I think these are sufficient.

[ybiquitous]

I've closed merged PR #6250, so I've also completed this issue. Feel free to reopen it if anyone has objections.

[hudochenkov]

@ybiquitous I think this issue is not about disabling rules, but documentation of configuration in general.

ESLint for every example shows full config value for a rule. Stylelint docs show only part of a value. See my comment above for an example. #4808 (comment)

[ybiquitous]

Ah, I misunderstood it. Thanks for letting me know, @hudochenkov!

[Mouvedia]

Given:

["/^my-/", "pseudo-element"]

This would be much more helpful for users:

Given:

[true, { "ignorePseudoElements": ["/^my-/", "pseudo-element"] }]

That would require to edit many more markdown files other than this one.
e.g. alpha-value-notation, selector-pseudo-class-no-unknown, at-rule-no-unknown, selector-type-no-unknown, media-feature-name-no-unknown, annotation-no-unknown, etc.

I don't think this is necessary or the priority should be very low.

[github-actions]

This issue is older than one month. Please ask before opening a pull request, as it may no longer be relevant.