Expressive Code 示例

这里，我们将探索如何使用 Expressive Code 来展示代码块效果。以下示例均基于官方文档，你可以参考官方文档获取更多细节。

Expressive Code#

语法高亮#

常规语法高亮#

1
console.log('这段代码是语法高亮的！')

渲染 ANSI 转义序列#

1
ANSI 颜色：
2
- 常规： 红 绿 黄 蓝 品红 青
3
- 粗体：    红 绿 黄 蓝 品红 青
4
- 暗淡：  红 绿 黄 蓝 品红 青
5

6
256 色（展示 160-177 号颜色）：
7
160 161 162 163 164 165
8
166 167 168 169 170 171
9
172 173 174 175 176 177
10

11
完整 RGB 颜色：
12
森林绿 - RGB(34, 139, 34)
13

14
文本格式： 粗体 暗淡 斜体 下划线

编辑器与终端边框#

编辑器与终端边框

代码编辑器边框#

1
console.log('标题属性示例')

1
<div>文件名注释示例</div>

终端边框#

1
echo "这个终端边框没有标题"

1
Write-Output "这个有标题！"

覆盖边框类型#

1
echo "看，没有边框！"

1
# 如果不覆盖，这会是终端边框
2
function Watch-Tail { Get-Content -Tail 20 -Wait $args }
3
New-Alias tail Watch-Tail

文本与行标记#

文本与行标记

标记整行与行范围#

1
// 第 1 行 - 按行号标记
2
// 第 2 行
3
// 第 3 行
4
// 第 4 行 - 按行号标记
5
// 第 5 行
6
// 第 6 行
7
// 第 7 行 - 按范围 "7-8" 标记
8
// 第 8 行 - 按范围 "7-8" 标记

选择行标记类型（mark、ins、del）#

1
function demo() {
2
  console.log('这一行被标记为删除')
3
  // 这一行和下一行被标记为插入
4
  console.log('这是第二行插入的代码')
5

6
  return '这一行使用默认的中性标记类型'
7
}

为行标记添加标签#

1
<button
2
  role="button"
3
  {...props}
4
  value={value}
5
  className={buttonClassName}
6
  disabled={disabled}
7
  active={active}
8
>
9
  {children &&
10
    !active &&
11
    (typeof children === 'string' ? <span>{children}</span> : children)}
12
</button>

在独立行上添加长标签#

1
<button
2
  role="button"
3
  {...props}
4

5
  value={value}
6
  className={buttonClassName}
7

8
  disabled={disabled}
9
  active={active}
10
>
11

12
  {children &&
13
    !active &&
14
    (typeof children === 'string' ? <span>{children}</span> : children)}
15
</button>

使用类似 diff 的语法#

1
这一行会被标记为插入
2
这一行会被标记为删除
3
这是一行普通代码

1
--- a/README.md
2
+++ b/README.md
3
@@ -1,3 +1,4 @@
4
+这是一个真正的 diff 文件
5
-所有内容将保持未修改
6
 空白也不会被移除

语法高亮与 diff 语法结合#

1
function thisIsJavaScript() {
2
  // 整个代码块会按 JavaScript 进行高亮，
3
  // 而且我们仍然可以给它添加 diff 标记！
4
  console.log('要删除的旧代码')
5
  console.log('崭新闪亮的代码！')
6
}

标记行内的单个文本#

1
function demo() {
2
  // 标记行内任意给定的文本
3
  return '支持对给定文本的多次匹配';
4
}

正则表达式#

1
console.log('单词 yes 和 yep 会被标记。')

转义正斜杠#

1
echo "Test" > /home/test.txt

选择行内标记类型（mark、ins、del）#

1
function demo() {
2
  console.log('这些是插入和删除标记类型');
3
  // return 语句使用默认标记类型
4
  return true;
5
}

自动换行#

自动换行

为单个代码块配置自动换行#

1
// 开启换行的示例
2
function getLongString() {
3
  return '这是一段非常长的字符串，除非容器极宽，否则它很可能放不下可用空间'
4
}

1
// 关闭换行（wrap=false）的示例
2
function getLongString() {
3
  return '这是一段非常长的字符串，除非容器极宽，否则它很可能放不下可用空间'
4
}

配置换行行的缩进#

1
// 保留缩进的示例（默认开启）
2
function getLongString() {
3
  return '这是一段非常长的字符串，除非容器极宽，否则它很可能放不下可用空间'
4
}

1
// 关闭保留缩进（preserveIndent=false）的示例
2
function getLongString() {
3
  return '这是一段非常长的字符串，除非容器极宽，否则它很可能放不下可用空间'
4
}

可折叠区域#

可折叠区域


5 collapsed lines
1
// 所有样板设置代码都会被折叠
2
import { someBoilerplateEngine } from '@example/some-boilerplate'
3
import { evenMoreBoilerplate } from '@example/even-more-boilerplate'
4

5
const engine = someBoilerplateEngine(evenMoreBoilerplate())
6

7
// 这部分代码默认可见
8
engine.doSomething(1, 2, 3, calcFn)
9

10
function calcFn() {
11
  // 你可以有多个折叠区域
3 collapsed lines
12
  const a = 1
13
  const b = 2
14
  const c = a + b
15

16
  // 这里保持可见
17
  console.log(`计算结果：${a} + ${b} = ${c}`)
18
  return c
19
}
20

4 collapsed lines
21
// 代码块末尾之前的这些代码会再次折叠
22
engine.closeConnection()
23
engine.freeMemory()
24
engine.shutdown({ reason: '示例样板代码结束' })

行号#

行号

为每个代码块显示行号#

1
// 这个代码块会显示行号
2
console.log('来自第 2 行的问候！')
3
console.log('我在第 3 行')

// 这个代码块禁用了行号
console.log('喂？')
console.log('抱歉，你知道我在第几行吗？')

修改起始行号#

5
console.log('来自第 5 行的问候！')
6
console.log('我在第 6 行')