fix: escape < > symbols

[korifey91]

Description

In order to allow different tools to correctly show array|tuple types of properties in schema we need to escape special symbols - <, >.

Related issue(s)
Fixes #365

[korifey91]

/ptal

[asyncapi-bot]

@fmvilas @derberg @magicmatatjahu Please take a look at this PR. Thanks! 👋

[derberg]

that was fast

I think escaping work with one slash, not 2, cause then you see of of the slashes in rendered markdown

| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | array\\<string\\> | - | - | [ 1 .. 5 ] unique items | - |

renders below

why not choosing to simply add code block as the person that reported the issue wanted, so

| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | `array<string>` | - | - | [ 1 .. 5 ] unique items | - |

that renders event better

or

| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | array<string> | - | - | [ 1 .. 5 ] unique items | - |

that also works

[korifey91]

that was fast

I think escaping work with one slash, not 2, cause then you see of of the slashes in rendered markdown

| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | array\\<string\\> | - | - | [ 1 .. 5 ] unique items | - |

renders below

why not choosing to simply add code block as the person that reported the issue wanted, so

| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | `array<string>` | - | - | [ 1 .. 5 ] unique items | - |

that renders event better

or

| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | array<string> | - | - | [ 1 .. 5 ] unique items | - |

that also works

I think codeblocks is not the best choice, because we will have different visual formatting for types and lose consistency.

But < and > seems a good fit.

P.S. It seems me IDE problem. I tryied to use one escape, but md looked wrong(like I change nothing).

[korifey91]

that was fast

I think escaping work with one slash, not 2, cause then you see of of the slashes in rendered markdown

| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | array\\<string\\> | - | - | [ 1 .. 5 ] unique items | - |

renders below

why not choosing to simply add code block as the person that reported the issue wanted, so

| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | `array<string>` | - | - | [ 1 .. 5 ] unique items | - |

that renders event better

or

| Name | Type | Description | Value | Constraints | Notes |
|---|---|---|---|---|---|
| (root) | array<string> | - | - | [ 1 .. 5 ] unique items | - |

that also works

I think codeblocks is not the best choice, because we will have different visual formatting for types and lose consistency.

But < and > seems a good fit.

P.S. It seems me IDE problem. I tryied to use one escape, but md looked wrong(like I change nothing).

[derberg]

ok, then lets be on the safe side and use what works, which is < and >

[korifey91]

@derberg Could you take a look again?

[derberg]

perfect work, thanks a 💯 !

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

[derberg]

/rtm

[asyncapi-bot]

🎉 This PR is included in version 1.6.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀