Support @example tsdoc tag

[hmil]

The current implementation supports adding examples using a dedicated tag @examples.

But the TSDoc spec recommends using @example instead.

While the TSDoc tag is mostly intended for documentation, and therefore does not always contain valid JSON data, the tag is still very much aligned with json-schema.

There are multiple levels of support which could be implemented:

Basic

Just support raw JSON data

/**
 * @example
 *     { "foo": 42 }
 * @example
 *     "baz"
 */

Yields:

{
    "examples": [
         { "foo": 42 },
        "baz"
    ]
}

An implementation of this is provided in #1200 .

Support example title

The title would be ignored

/**
 * @example Title of this example
 *     { "foo": 42 }
 */

Advanced

Would parse the markdown and extract the bits of code from the text. This is probably out of scope to be honest, but I'm including it here for the sake of completeness.

[github-actions]

🚀 Issue was released in v1.0.1-next.1 🚀