Skip to content

Compact document #5167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
pshao25 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Compact document #5167

pshao25 wants to merge 1 commit into from
+15,119 −45,101

Conversation

@pshao25
Copy link
Member

@pshao25 pshao25 commented Oct 11, 2025

github-advanced-security[bot]
github-advanced-security bot found potential problems Oct 11, 2025
View reviewed changes
packages/extensions/openapi-to-typespec/src/utils/docs.ts
for (let i = 0; i < wrapped.length; i++) {
if (wrapped[i].includes("@") || wrapped[i].includes("*/")) {
if (wrapped[i].includes("@")) {
wrapped[i] = wrapped[i].replace(/@/g, "\\@");

Check failure

Code scanning / CodeQL

Incomplete string escaping or encoding High

This does not escape backslash characters in the input.
Copy link
Member

@live1206 live1206 Oct 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

handled in L20

Copy link
Member

@timotheeguerin timotheeguerin Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that is what the codeql is warning you about. I think it tells you that you won't escape this correctly

\@

becomes

\\@

but I think for how doc comments are parsed its a false positive.

you might also be able to replace to .replaceAll("@", "\\@") instead of using regex and it might not flag

@pshao25 pshao25 mentioned this pull request Oct 11, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@timotheeguerin timotheeguerin timotheeguerin approved these changes

@live1206 live1206 live1206 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Generate doc comments instead of @doc

3 participants

@pshao25 @timotheeguerin @live1206