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
ForestGreen - RGB(34, 139, 34)
13

14
文本样式：Bold Dimmed Italic Underline

编辑器与终端框架#

编辑器与终端框架

代码编辑器框架#

1
console.log('title 属性示例')

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
// 禁用换行的示例
2
function getLongString() {
3
  return '这是一段很长的字符串，如果容器不是特别宽，它大概率放不下，需要自动换行'
4
}

配置换行后文本的缩进#

1
// preserveIndent 示例（默认开启）
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 行')