chore(docs): auto-generate api reference (VIV-2180) #1984
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| fs.readFileSync(`dist/libs/wrapper-gen/component-metadata.json`, 'utf-8') | ||
| ); | ||
|
|
||
| const escapeMarkdown = (text = '') => text.replace(/([<>{}])/gm, '\\$1'); |
Check failure
Code scanning / CodeQL
Incomplete string escaping or encoding High documentation
Show autofix suggestion
Hide autofix suggestion
Copilot Autofix AI 3 months ago
To fix the problem, we need to ensure that backslashes are also escaped in the escapeMarkdown function. This can be done by adding backslashes to the list of characters to be escaped. We will use a regular expression that includes backslashes and ensure that all occurrences are replaced.
- Modify the
escapeMarkdownfunction to include backslashes in the characters to be escaped. - Update the regular expression to handle backslashes properly.
| @@ -8,3 +8,3 @@ | ||
|
|
||
| const escapeMarkdown = (text = '') => text.replace(/([<>{}])/gm, '\\$1'); | ||
| const escapeMarkdown = (text = '') => text.replace(/([\\<>{}])/gm, '\\$1'); | ||
|
|
|
|
||
| const escapeMarkdown = (text = '') => text.replace(/([<>{}])/gm, '\\$1'); | ||
|
|
||
| const escapeType = (text = '') => text.replace(/([|])/gm, '\\$1'); |
Check failure
Code scanning / CodeQL
Incomplete string escaping or encoding High documentation
Show autofix suggestion
Hide autofix suggestion
Copilot Autofix AI 3 months ago
To fix the problem, we need to ensure that the escapeType function also escapes backslashes. This can be done by adding an additional replacement step to handle backslashes before escaping the pipe character. The best way to fix this without changing existing functionality is to use a regular expression to replace backslashes with double backslashes and then proceed with the existing replacement for the pipe character.
| @@ -10,3 +10,3 @@ | ||
|
|
||
| const escapeType = (text = '') => text.replace(/([|])/gm, '\\$1'); | ||
| const escapeType = (text = '') => text.replace(/\\/g, '\\\\').replace(/([|])/gm, '\\$1'); | ||
|
|
| (resolvedType.length === 1 | ||
| ? `\`${resolvedType[0].text}\`` | ||
| : `*Enum*:<br/>${generateEnumType(resolvedType)}` | ||
| ).replace(/\|/g, '\\|'), |
Check failure
Code scanning / CodeQL
Incomplete string escaping or encoding High documentation
Show autofix suggestion
Hide autofix suggestion
Copilot Autofix AI 3 months ago
To fix the problem, we need to ensure that backslashes are properly escaped in the input strings. This can be achieved by adding a replacement for backslashes before any other replacements. Additionally, we should ensure that all replacements use the global flag to replace all occurrences of the target characters.
The best way to fix the problem without changing existing functionality is to update the escapeMarkdown, escapeType, and escapeDescription functions to handle backslashes and use the global flag for all replacements. This involves modifying the regular expressions used in these functions.
| @@ -8,5 +8,5 @@ | ||
|
|
||
| const escapeMarkdown = (text = '') => text.replace(/([<>{}])/gm, '\\$1'); | ||
| const escapeMarkdown = (text = '') => text.replace(/\\/g, '\\\\').replace(/([<>{}])/g, '\\$1'); | ||
|
|
||
| const escapeType = (text = '') => text.replace(/([|])/gm, '\\$1'); | ||
| const escapeType = (text = '') => text.replace(/\\/g, '\\\\').replace(/([|])/g, '\\$1'); | ||
|
|
No description provided.