0

0

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

碧海醫心

碧海醫心

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

|

799人浏览过

|

来源于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 组装 → 标题
    始终前置插入,与 Shiki 输出解耦

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

    import { parse } from 'node-html-parser';
    import { getHighlighter } from 'shiki';
    
    const THEME = 'github-dark';
    
    function escapeHtml(code) {
        return code.replace(/[{}]/g, (c) => ({ '{': '{', '}': '}' })[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工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

698

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

219

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1561

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

645

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

1128

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

1102

2024.04.29

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

187

2025.07.29

c++字符串相关教程
c++字符串相关教程

本专题整合了c++字符串相关教程,阅读专题下面的文章了解更多详细内容。

91

2025.08.07

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

4

2026.03.04

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号