Skip to content

Stop assuming comment annotations #97

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

Merged
merged 1 commit into from
Dec 18, 2021
Merged

Stop assuming comment annotations #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions packages/mdx/src/plugin/annotations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,30 +24,32 @@ export function extractAnnotationsFromCode(code: Code) {
const focusList = [] as string[]
while (lineNumber <= lines.length) {
const line = lines[lineNumber - 1]
const { key, focus, data } = getCommentData(
line,
lineNumber
)
const { key, focusString, data } = getCommentData(line)

const Component = annotationsMap[key!]

if (Component) {
const focus = relativeToAbsolute(
focusString,
lineNumber
)
lines.splice(lineNumber - 1, 1)
annotations.push({ Component, focus: focus!, data })
annotations.push({ Component, focus, data })
} else if (key === "focus") {
const focus = relativeToAbsolute(
focusString,
lineNumber
)
lines.splice(lineNumber - 1, 1)
focusList.push(focus!)
focusList.push(focus)
} else {
lineNumber++
}
}
return [annotations, focusList.join(",")] as const
}

function getCommentData(
line: Code["lines"][0],
lineNumber: number
) {
function getCommentData(line: Code["lines"][0]) {
const comment = line.tokens.find(t =>
t.content.startsWith("//")
)?.content
Expand All @@ -63,7 +65,7 @@ function getCommentData(

return {
key,
focus: relativeToAbsolute(focusString, lineNumber),
focusString,
data,
}
}
Expand Down
1 change: 1 addition & 0 deletions packages/playground/content/comment-annotations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ function lorem(ipsum, dolor = 1) {
return sit ? consectetur(ipsum) : []
}

// this comment isn't an annotation
function adipiscing(...elit) {
console.log(elit)
// box[19:36] aqua
Expand Down