Expressive Code 代码块示例

本文将展示使用 Expressive Code 的代码块效果。以下示例基于官方文档。

Expressive Code#

语法高亮#

普通语法高亮#

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

渲染 ANSI 转义序列#

1
ANSI colors:
2
- Regular: Red Green Yellow Blue Magenta Cyan
3
- Bold:    Red Green Yellow Blue Magenta Cyan
4
- Dimmed:  Red Green Yellow Blue Magenta Cyan
5

6
256 colors (showing colors 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
Full RGB colors:
12
ForestGreen - RGB(34, 139, 34)
13

14
Text formatting: Bold Dimmed Italic Underline

编辑器与终端框架#

编辑器与终端框架

代码编辑器框架#

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" 标记

选择行标记类型（标注、插入、删除）#

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

选择内联标记类型（标注、插入、删除）#

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 的示例
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 行')