Bug with parenthesis inside default values

[ben-eb]

Given this example SCSS:

/**
 * Main colour palette.
 *
 * @prop {Color} main-background   (rgb(61, 75, 92))  - Deep, blueish gray
 *
 * @see {function} colour
 *
 * @type Map
 */
$colours: (
    "main-background": rgb(61, 75, 92)
);

I should expect that it outputs the colour correctly. However, I get an error:

[16:42:07] TypeError in plugin 'gulp-sassdoc'
Message:
    Cannot use 'in' operator to search for 'stack' in unknown color: rgb(61, 75, 92

Is it possible to add support for RGB(a) and HSL(a) values when documenting colours? 😄

[valeriangalliat]

I can't get the error with SassDoc CLI, but for sure there's a bug with parentheses in default values.

While (for me) the documentation is generated without errors, the default value is parsed as rgb(61, 75, 92 while the description is ) - Deep, blueish gray. I think we're reaching the limit of regex for decent parsing (and JavaScript don't support recursive regex).

[valeriangalliat]

While I think of it, it may not be the cleanest solution, but we can simply support square brackets to define the default value, so there's no ambiguity with nested parentheses (we can just match \[([^\]]*)\]).

Whatever fix we use, it should be ported to property, require and parameter.

[FWeinb]

👍 I like wrapping defaults in [].

[KittyGiraudel]

Let me consider this, but that might be a decent solution.

[KittyGiraudel]

This is a major break. All comments will have to be updated to fix this. This kinda sucks imo...

[valeriangalliat]

We can keep both, at least for 2.0. Though only [] will work properly for defaut values containing parentheses.