Skip to content

refactor/use shiki's transformerMetaHighlight() and add support for multi-key meta notation like add={1} remove={2} #4718

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.

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
38 changes: 2 additions & 36 deletions src/node/markdown/plugins/highlight.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import {
transformerCompactLineOptions,
transformerMetaHighlight,
transformerNotationDiff,
transformerNotationErrorLevel,
transformerNotationFocus,
transformerNotationHighlight,
type TransformerCompactLineOption
} from '@shikijs/transformers'
import { customAlphabet } from 'nanoid'
import c from 'picocolors'
Expand All @@ -15,38 +14,6 @@ import type { MarkdownOptions, ThemeOptions } from '../markdown'

const nanoid = customAlphabet('abcdefghijklmnopqrstuvwxyz', 10)

/**
* 2 steps:
*
* 1. convert attrs into line numbers:
* {4,7-13,16,23-27,40} -> [4,7,8,9,10,11,12,13,16,23,24,25,26,27,40]
* 2. convert line numbers into line options:
* [{ line: number, classes: string[] }]
*/
function attrsToLines(attrs: string): TransformerCompactLineOption[] {
attrs = attrs.replace(/^(?:\[.*?\])?.*?([\d,-]+).*/, '$1').trim()
const result: number[] = []
if (!attrs) {
return []
}
attrs
.split(',')
.map((v) => v.split('-').map((v) => parseInt(v, 10)))
.forEach(([start, end]) => {
if (start && end) {
result.push(
...Array.from({ length: end - start + 1 }, (_, i) => start + i)
)
} else {
result.push(start)
}
})
return result.map((v) => ({
line: v,
classes: ['highlighted']
}))
}

export async function highlight(
theme: ThemeOptions,
options: MarkdownOptions,
Expand Down Expand Up @@ -74,6 +41,7 @@ export async function highlight(
await options?.shikiSetup?.(highlighter)

const transformers: ShikiTransformer[] = [
transformerMetaHighlight(),
transformerNotationDiff(),
transformerNotationFocus({
classActiveLine: 'has-focus',
Expand Down Expand Up @@ -121,7 +89,6 @@ export async function highlight(
lang = defaultLang
}

const lineOptions = attrsToLines(attrs)
const mustaches = new Map<string, string>()

const removeMustache = (s: string) => {
Expand Down Expand Up @@ -152,7 +119,6 @@ export async function highlight(
lang,
transformers: [
...transformers,
transformerCompactLineOptions(lineOptions),
{
name: 'vitepress:v-pre',
pre(node) {
Expand Down
4 changes: 3 additions & 1 deletion src/node/markdown/plugins/highlightLines.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ export const highlightLinePlugin = (md: MarkdownItAsync) => {
}
}

token.info += ' ' + lines
token.info += '{' + lines + '}'
// ensure there is a space between the lang and the line numbers
token.info = token.info.replace(/(?<![=])\{/g, " {")
return fence(...args)
}
}