inconsistent handling of commented CSS rules

[8ctopus]

$input = <<<CSS
a {
    /* margin: 10px 10px 10px 0; */
    outline: none;
}

CSS;

$document = (new \Sabberworm\CSS\Parser($input))
    ->parse();

$format = OutputFormat::createPretty();

echo $document->render($format);

becomes:

a {
        /* margin: 10px 10px 10px 0; */
        outline: none;
}

while if you update the input to remove the outline property,

a {
    /* margin: 10px 10px 10px 0; */
}

it becomes:

a {}

so any commented rule(s) not followed by a CSS rule are removed from the resulting rule set.

Problem occurs here because getRules() returns an empty array

PHP-CSS-Parser/src/RuleSet/RuleSet.php

Line 308 in 0ae1fde

foreach ($this->getRules() as $rule) {

[JakeQZ]

The current behaviour is sort-of by design, but I agree should be improved. It assumes that a comment preceding a Rule is commenting that Rule (and is not a commented-out Rule), so it becomes associated with that Rule. Thus, when the Rule is removed, the comment that goes with it is also removed.

Looking at the code, I think a comment in the following would also be dropped at the parsing stage:

a {
    /* This has no properties yet. */
}

To resolve these issues, I think we would need to modify RuleSet so that the list of Rules can be a list of Rule|Comments. And give the removeRule() method and option to keep the comment (which will effectively replace the Rule with the Comment(s) it had, if any).

[oliverklee]

To resolve these issues, I think we would need to modify RuleSet so that the list of Rules can be a list of Rule|Comments.

I'd prefer we replace the union type with a shared interface. That would allow us to use native type declarations and make it clear in the interface which methods are relevant.

[JakeQZ]

I'd prefer we replace the union type with a shared interface.

I was thinking that. I just wrote the union as shorthand.

[8ctopus]

Honestly, I reported it but don't need it fixed, especially if it adds a lot of complexity to the code.