@vuepress/plugin-shiki 2.0.0-rc.33 → 2.0.0-rc.36
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/node/markdown/applyHighlighter/index.js +2 -1
- package/lib/node/markdown/index.d.ts +0 -1
- package/lib/node/markdown/index.js +0 -1
- package/lib/node/options.d.ts +3 -2
- package/lib/node/shikiPlugin.js +3 -2
- package/lib/node/transformers/getTransformers.d.ts +2 -0
- package/lib/node/transformers/getTransformers.js +13 -1
- package/lib/node/types.d.ts +26 -7
- package/package.json +7 -14
- package/lib/node/markdown/lineNumberPlugin.d.ts +0 -3
- package/lib/node/markdown/lineNumberPlugin.js +0 -36
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { transformerCompactLineOptions } from '@shikijs/transformers';
|
|
2
2
|
import { getHighlighter } from 'shiki';
|
|
3
3
|
import { bundledLanguageNames } from '../../shiki.js';
|
|
4
|
-
import { getTransformers } from '../../transformers/getTransformers.js';
|
|
4
|
+
import { getTransformers, whitespaceTransformer, } from '../../transformers/getTransformers.js';
|
|
5
5
|
import { attrsToLines } from '../../utils.js';
|
|
6
6
|
import { createMarkdownFilePathGetter } from './createMarkdownFilePathGetter.js';
|
|
7
7
|
import { getLanguage } from './getLanguage.js';
|
|
@@ -33,6 +33,7 @@ export const applyHighlighter = async (md, app, { langs = bundledLanguageNames,
|
|
|
33
33
|
...(options.highlightLines ?? true
|
|
34
34
|
? [transformerCompactLineOptions(attrsToLines(attrs))]
|
|
35
35
|
: []),
|
|
36
|
+
...whitespaceTransformer(attrs, options.whitespace),
|
|
36
37
|
...userTransformers,
|
|
37
38
|
],
|
|
38
39
|
...('themes' in options
|
package/lib/node/options.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { MarkdownItLineNumbersOptions } from '@vuepress/highlighter-helper';
|
|
2
|
+
import type { PreWrapperOptions, ShikiHighlightOptions } from './types.js';
|
|
2
3
|
/**
|
|
3
4
|
* Options of @vuepress/plugin-shiki
|
|
4
5
|
*/
|
|
5
|
-
export type ShikiPluginOptions = ShikiHighlightOptions & PreWrapperOptions &
|
|
6
|
+
export type ShikiPluginOptions = ShikiHighlightOptions & PreWrapperOptions & Pick<MarkdownItLineNumbersOptions, 'lineNumbers'>;
|
package/lib/node/shikiPlugin.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
|
+
import { lineNumbers as lineNumbersPlugin } from '@vuepress/highlighter-helper';
|
|
1
2
|
import { isPlainObject } from 'vuepress/shared';
|
|
2
|
-
import { applyHighlighter, highlightLinesPlugin,
|
|
3
|
+
import { applyHighlighter, highlightLinesPlugin, preWrapperPlugin, } from './markdown/index.js';
|
|
3
4
|
export const shikiPlugin = ({ preWrapper = true, lineNumbers = true, ...options } = {}) => ({
|
|
4
5
|
name: '@vuepress/plugin-shiki',
|
|
5
6
|
extendsMarkdown: async (md, app) => {
|
|
@@ -11,7 +12,7 @@ export const shikiPlugin = ({ preWrapper = true, lineNumbers = true, ...options
|
|
|
11
12
|
md.use(highlightLinesPlugin);
|
|
12
13
|
md.use(preWrapperPlugin, { preWrapper });
|
|
13
14
|
if (preWrapper) {
|
|
14
|
-
md.use(
|
|
15
|
+
md.use(lineNumbersPlugin, { lineNumbers });
|
|
15
16
|
}
|
|
16
17
|
},
|
|
17
18
|
});
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import type { WhitespacePosition } from '@vuepress/highlighter-helper';
|
|
1
2
|
import type { ShikiTransformer } from 'shiki';
|
|
2
3
|
import type { ShikiHighlightOptions } from '../types.js';
|
|
3
4
|
export declare const getTransformers: (options: ShikiHighlightOptions) => ShikiTransformer[];
|
|
5
|
+
export declare const whitespaceTransformer: (meta: string, defaultPosition?: boolean | WhitespacePosition) => ShikiTransformer[];
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import { transformerNotationDiff, transformerNotationErrorLevel, transformerNotationFocus, transformerNotationHighlight, } from '@shikijs/transformers';
|
|
1
|
+
import { transformerMetaWordHighlight, transformerNotationDiff, transformerNotationErrorLevel, transformerNotationFocus, transformerNotationHighlight, transformerNotationWordHighlight, transformerRenderWhitespace, } from '@shikijs/transformers';
|
|
2
|
+
import { resolveWhitespacePosition } from '@vuepress/highlighter-helper';
|
|
2
3
|
import { addClassTransformer, cleanupTransformer, emptyLineTransformer, removeEscapeTransformer, } from './vuepressTransformers.js';
|
|
3
4
|
export const getTransformers = (options) => {
|
|
4
5
|
const transformers = [];
|
|
@@ -17,6 +18,17 @@ export const getTransformers = (options) => {
|
|
|
17
18
|
if (options.notationErrorLevel) {
|
|
18
19
|
transformers.push(transformerNotationErrorLevel());
|
|
19
20
|
}
|
|
21
|
+
if (options.notationWordHighlight) {
|
|
22
|
+
transformers.push(transformerNotationWordHighlight());
|
|
23
|
+
transformers.push(transformerMetaWordHighlight());
|
|
24
|
+
}
|
|
20
25
|
transformers.push(addClassTransformer, cleanupTransformer, removeEscapeTransformer, emptyLineTransformer);
|
|
21
26
|
return transformers;
|
|
22
27
|
};
|
|
28
|
+
export const whitespaceTransformer = (meta, defaultPosition = false) => {
|
|
29
|
+
const position = resolveWhitespacePosition(meta, defaultPosition);
|
|
30
|
+
// disabled current code block
|
|
31
|
+
if (position === false)
|
|
32
|
+
return [];
|
|
33
|
+
return [transformerRenderWhitespace({ position })];
|
|
34
|
+
};
|
package/lib/node/types.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { WhitespacePosition } from '@vuepress/highlighter-helper';
|
|
1
2
|
import type { BundledLanguage, BundledTheme, Highlighter, LanguageInput, ShikiTransformer, SpecialLanguage, StringLiteralUnion, ThemeRegistrationAny } from 'shiki';
|
|
2
3
|
export type ShikiLang = LanguageInput | StringLiteralUnion<BundledLanguage> | SpecialLanguage;
|
|
3
4
|
export type ShikiTheme = ThemeRegistrationAny | StringLiteralUnion<BundledTheme>;
|
|
@@ -91,6 +92,31 @@ export type ShikiHighlightOptions = ShikiThemeOptions & {
|
|
|
91
92
|
* @see https://shiki.style/packages/transformers#transformernotationerrorlevel
|
|
92
93
|
*/
|
|
93
94
|
notationErrorLevel?: boolean;
|
|
95
|
+
/**
|
|
96
|
+
* Enable notation word highlight transformer
|
|
97
|
+
*
|
|
98
|
+
* @default false
|
|
99
|
+
*
|
|
100
|
+
* @see https://shiki.style/packages/transformers#transformernotationwordhighlight
|
|
101
|
+
*/
|
|
102
|
+
notationWordHighlight?: boolean;
|
|
103
|
+
/**
|
|
104
|
+
* Enable whitespace
|
|
105
|
+
* - true: enable render whitespace, same of `all`
|
|
106
|
+
* - false: disable render whitespace
|
|
107
|
+
* - 'all': render all whitespace
|
|
108
|
+
* - 'boundary': render leading and trailing whitespace of each line.
|
|
109
|
+
* - 'trailing': render trailing whitespace of each line
|
|
110
|
+
*
|
|
111
|
+
* you are able to use `:whitespace` or `:no-whitespace` or `:whitespace=position` to set single code block
|
|
112
|
+
*
|
|
113
|
+
* position: 'all' | 'boundary' | 'trailing'
|
|
114
|
+
*
|
|
115
|
+
* @default false
|
|
116
|
+
*
|
|
117
|
+
* @see https://shiki.style/packages/transformers#transformerrenderwhitespace
|
|
118
|
+
*/
|
|
119
|
+
whitespace?: boolean | WhitespacePosition;
|
|
94
120
|
/**
|
|
95
121
|
* Log level Highlighter language detecter
|
|
96
122
|
*
|
|
@@ -100,13 +126,6 @@ export type ShikiHighlightOptions = ShikiThemeOptions & {
|
|
|
100
126
|
*/
|
|
101
127
|
logLevel?: 'silent' | 'warn' | 'debug';
|
|
102
128
|
};
|
|
103
|
-
export interface LineNumberOptions {
|
|
104
|
-
/**
|
|
105
|
-
* Show line numbers in code blocks
|
|
106
|
-
* @default true
|
|
107
|
-
*/
|
|
108
|
-
lineNumbers?: boolean | number;
|
|
109
|
-
}
|
|
110
129
|
export interface PreWrapperOptions {
|
|
111
130
|
/**
|
|
112
131
|
* Wrap the `<pre>` tag with an extra `<div>` or not. Do not disable it unless you
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vuepress/plugin-shiki",
|
|
3
|
-
"version": "2.0.0-rc.
|
|
3
|
+
"version": "2.0.0-rc.36",
|
|
4
4
|
"description": "VuePress plugin - shiki",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"vuepress-plugin",
|
|
@@ -30,25 +30,18 @@
|
|
|
30
30
|
"files": [
|
|
31
31
|
"lib"
|
|
32
32
|
],
|
|
33
|
-
"scripts": {
|
|
34
|
-
"build": "tsc -b tsconfig.build.json",
|
|
35
|
-
"clean": "rimraf --glob ./lib ./*.tsbuildinfo"
|
|
36
|
-
},
|
|
37
33
|
"dependencies": {
|
|
38
|
-
"@shikijs/transformers": "^1.
|
|
39
|
-
"@vuepress/helper": "2.0.0-rc.
|
|
34
|
+
"@shikijs/transformers": "^1.7.0",
|
|
35
|
+
"@vuepress/helper": "2.0.0-rc.36",
|
|
36
|
+
"@vuepress/highlighter-helper": "2.0.0-rc.36",
|
|
40
37
|
"nanoid": "^5.0.7",
|
|
41
|
-
"shiki": "^1.
|
|
38
|
+
"shiki": "^1.7.0"
|
|
42
39
|
},
|
|
43
40
|
"peerDependencies": {
|
|
44
|
-
"vuepress": "2.0.0-rc.
|
|
41
|
+
"vuepress": "2.0.0-rc.13"
|
|
45
42
|
},
|
|
46
43
|
"publishConfig": {
|
|
47
44
|
"access": "public"
|
|
48
45
|
},
|
|
49
|
-
"
|
|
50
|
-
"@types/markdown-it": "^14.1.1",
|
|
51
|
-
"markdown-it": "^14.1.0"
|
|
52
|
-
},
|
|
53
|
-
"gitHead": "6e9565ef71b7eb41f8bf8736dc9f6544f1925c58"
|
|
46
|
+
"gitHead": "7f283f7243f9f9b86a9621f6ebc00d8d335d5f94"
|
|
54
47
|
}
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
// markdown-it plugin for generating line numbers.
|
|
2
|
-
// It depends on preWrapper plugin.
|
|
3
|
-
const LINE_NUMBERS_REGEXP = /:line-numbers\b/;
|
|
4
|
-
const NO_LINE_NUMBERS_REGEXP = /:no-line-numbers\b/;
|
|
5
|
-
const LINE_NUMBERS_START_REGEXP = /:line-numbers=(\d+)\b/;
|
|
6
|
-
export const lineNumberPlugin = (md, { lineNumbers = true } = {}) => {
|
|
7
|
-
const rawFence = md.renderer.rules.fence;
|
|
8
|
-
md.renderer.rules.fence = (...args) => {
|
|
9
|
-
const rawCode = rawFence(...args);
|
|
10
|
-
const [tokens, idx] = args;
|
|
11
|
-
const info = tokens[idx].info;
|
|
12
|
-
const enableLineNumbers = LINE_NUMBERS_REGEXP.test(info);
|
|
13
|
-
const disableLineNumbers = NO_LINE_NUMBERS_REGEXP.test(info);
|
|
14
|
-
if ((!lineNumbers && !enableLineNumbers) ||
|
|
15
|
-
(lineNumbers && disableLineNumbers)) {
|
|
16
|
-
return rawCode;
|
|
17
|
-
}
|
|
18
|
-
const code = rawCode.slice(rawCode.indexOf('<code>'), rawCode.indexOf('</code>'));
|
|
19
|
-
const lines = code.split('\n');
|
|
20
|
-
if (typeof lineNumbers === 'number' &&
|
|
21
|
-
lines.length < lineNumbers &&
|
|
22
|
-
!enableLineNumbers) {
|
|
23
|
-
return rawCode;
|
|
24
|
-
}
|
|
25
|
-
const startNumbers = Number(info.match(LINE_NUMBERS_START_REGEXP)?.[1] ?? 1) - 1;
|
|
26
|
-
const lineNumbersStyle = `style="counter-reset:line-number ${startNumbers}"`;
|
|
27
|
-
const lineNumbersCode = [...Array(lines.length)]
|
|
28
|
-
.map(() => `<div class="line-number"></div>`)
|
|
29
|
-
.join('');
|
|
30
|
-
const lineNumbersWrapperCode = `<div class="line-numbers" aria-hidden="true" ${lineNumbersStyle}>${lineNumbersCode}</div>`;
|
|
31
|
-
const finalCode = rawCode
|
|
32
|
-
.replace(/<\/div>$/, `${lineNumbersWrapperCode}</div>`)
|
|
33
|
-
.replace(/"(language-[^"]*?)"/, '"$1 line-numbers-mode"');
|
|
34
|
-
return finalCode;
|
|
35
|
-
};
|
|
36
|
-
};
|