讲师中心 微信公众号
AI工具推荐 视频效率加速

Shiki 代码块中同时支持行高亮与标题显示的完整实现方案

浅涛君_9640

浅涛君_9640

发布时间:2026-03-04 18:12:25

|

819人浏览过

|

来源于php中文网

原创

Shiki 代码块中同时支持行高亮与标题显示的完整实现方案

本文详解如何在 Svelte 应用中基于 Shiki 实现 Markdown 代码块的双重自定义功能:既支持 {1-3,5} 格式的行号高亮,又兼容 (src/lib/utils/index.js) 形式的顶部标题显示,且两者可共存、互不干扰。

本文详解如何在 svelte 应用中基于 shiki 实现 markdown 代码块的双重自定义功能:既支持 `{1-3,5}` 格式的行号高亮,又兼容 `(src/lib/utils/index.js)` 形式的顶部标题显示,且两者可共存、互不干扰。

在使用 Shiki 进行代码高亮时,常需扩展其元信息(meta)解析能力以支持更丰富的语义表达。原始实现中,meta 字段仅能被用于行高亮(如 {1-3,5})或标题(如 (src/lib/utils/index.js))二者之一,原因在于对 meta 的解析逻辑是排他性的:一旦匹配到括号标题就清空 meta,导致后续无法提取花括号内的行号规则。

解决该问题的核心思路是 非破坏性元信息解析:即从 meta 中提取标题后,仅移除对应部分,保留其余内容(如行高亮指令),再交由 Shiki 原生处理逻辑消费。以下是关键优化点:

✅ 正确解析混合 meta 的正则策略

使用 meta.match(/\(([^)]+)\)/) 精准捕获最外层括号内的标题文本,并通过 meta.replace(metaMatch[0], '') 安全剥离该片段,避免误删嵌套内容(如 ({1-2}) (file.js) 中的花括号不受影响)。

✅ 清晰分离关注点

  • 标题提取 → 独立处理,不影响后续逻辑
  • 行高亮解析 → 仍复用原有 /{([\d,-]+)}/ 正则,但作用于清洗后的 meta
  • HTML 组装 → 标题 <div class="code-block-title"> 始终前置插入,与 Shiki 输出解耦

✅ 完整修复版 highlighter 函数(含注释)

import { parse } from 'node-html-parser';
import { getHighlighter } from 'shiki';

const THEME = 'github-dark';

function escapeHtml(code) {
    return code.replace(/[{}]/g, (c) => ({ '{': '&lbrace;', '}': '&rbrace;' })[c] || c);
}

function rangeParser(rangeString) {
    const result = [];
    for (const part of rangeString.split(',')) {
        const trimmed = part.trim();
        if (!trimmed) continue;
        if (!trimmed.includes('-')) {
            result.push(parseInt(trimmed, 10));
        } else {
            const [start, end] = trimmed.split('-').map(Number);
            for (let i = start; i <= end; i++) result.push(i);
        }
    }
    return result;
}

function makeFocussable(html) {
    const root = parse(html);
    const pre = root.querySelector('pre');
    if (pre) pre.setAttribute('tabIndex', '0');
    return root.toString();
}

async function highlighter(code, lang, meta) {
    const shikiHighlighter = await getHighlighter({ theme: THEME });

    let html;
    let title = null;

    // ? 提取并移除标题(如 `(src/lib/utils/index.js)`),保留其余 meta
    if (meta) {
        const titleMatch = meta.match(/\(([^)]+)\)/);
        if (titleMatch) {
            title = titleMatch[1].trim();
            meta = meta.replace(titleMatch[0], '').trim();
        }
    }

    // ? 根据剩余 meta 决定是否启用行高亮
    if (!meta) {
        html = shikiHighlighter.codeToHtml(code, { lang });
    } else {
        const highlightMatch = /{([\d,-]+)}/.exec(meta);
        if (highlightMatch) {
            const highlightLines = rangeParser(highlightMatch[1]);
            html = shikiHighlighter.codeToHtml(code, {
                lang,
                lineOptions: highlightLines.map(line => ({
                    line,
                    classes: ['highlight-line']
                }))
            });
        } else {
            html = shikiHighlighter.codeToHtml(code, { lang });
        }
    }

    // ⚙️ 增强可访问性
    html = makeFocussable(html);

    // ?️ 插入标题(若存在)
    if (title) {
        html = `<div class="code-block-title">${title}</div>${html}`;
    }

    return escapeHtml(html);
}

export default highlighter;

⚠️ 注意事项与最佳实践

  • Meta 顺序无关:js {1-3} (utils.js) 和 js (utils.js) {1-3} 均可正确解析(因正则全局匹配且剥离独立);
  • 空格容错:{1, 2-4} 和 ( file.js ) 中的空格会被 .trim() 自动处理;
  • CSS 样式需配套:确保为 .highlight-line 添加背景色(如 background-color: #2a2d3e;),并为 .code-block-title 设置字体、边框等视觉样式;
  • 安全转义增强:escapeHtml 已补充对未匹配字符的兜底返回,防止 undefined 注入;
  • 错误防御:在 rangeParser 中加入 !trimmed 判断,避免空字符串导致 NaN 入栈。

通过以上重构,你可在 Markdown 中自由组合使用:

```js {1-3,5} (src/lib/utils/index.js)
export function debounce(fn, delay) {
  let timeoutId;
  return (...args) => {
    clearTimeout(timeoutId);
    timeoutId = setTimeout(() => fn(...args), delay);
  };
}

最终渲染效果:顶部显示 src/lib/utils/index.js 标题,第 1–3 行与第 5 行带高亮背景,且整个代码块支持键盘聚焦 —— 功能完备、健壮可靠。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

4626

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

1149

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

4544

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

920

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

1816

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

3305

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

4293

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2800

2023.09.20

FrankenPHP集成Laravel详细教程
FrankenPHP集成Laravel详细教程

本专题提供FrankenPHP集成Laravel的详细配置指南,全面解析运行原理、开发环境搭建、Caddyfile配置、Octane工作模式、数据库连接、队列任务、定时任务和生产环境优化,解决部署过程中常见的报错与兼容性问题。

0

2026.10.08

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn