Feature request: parse validator values

[afontcu]

Hi! And thank you for this amazing tool. I was wondering if it would be possible to parse validator values, instead of having to set a @type JSDoc comment? That would be amazing, because we'd have a single source of truth. vue-styleguidist seems to be able to do so.

Thanks! 🙌

[mesqueeb]

Can you give a more concrete example ? I'm having a hard time understanding exactly what you mean :S

[afontcu]

Hey! Sure :)

If I'm not mistaken, vue-intellisense requires user to define valid values for a prop:

    /**
     * The position of the action buttons.
     * @type {'top' | 'bottom' | 'right' | 'left'}  <--- this
     */
    actionButtonsPosition: {
      type: String,
      default: 'top',
      validator: (prop) => ['top', 'bottom', 'right', 'left'].includes(prop),
    },

Notice that the list of valid values is duplicated in @type and validator.

I was wondering if we could infer the options the prop from the validator array, so the following snippet would yield the same vetur config as the one above:

    /**
     * The position of the action buttons.
     */
    actionButtonsPosition: {
      type: String,
      default: 'top',
      validator: (prop) => validValues.includes(prop), // @type is inferred from here
    },

[afontcu]

Hi! I checked and noticed that this works:

    /**
     * The position of the action buttons.
     */
    actionButtonsPosition: {
      type: String,
      default: 'top',
      validator: (prop) => ['top', 'bottom', 'right', 'left'].includes(prop),
    },

so I assume the limitation is with using a variable to set the array?

[afontcu]

I'll go ahead and close this issue since this looks like an upstream limitation :) Tracked here: vue-styleguidist/vue-styleguidist#1049

[mesqueeb]

@afontcu I'm so sorry I never replied. I got super busy and always forgot to come back to this.

this looks like an upstream limitation :)

this is exactly right!! : ) Under the hood I use the vue-styleguidist API : )

even though it's upstream, let's keep this issue open so I don't forget ;)