@vuepress/plugin-shiki 2.0.0-rc.34 → 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.
@@ -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
@@ -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
+ };
@@ -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
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vuepress/plugin-shiki",
3
- "version": "2.0.0-rc.34",
3
+ "version": "2.0.0-rc.36",
4
4
  "description": "VuePress plugin - shiki",
5
5
  "keywords": [
6
6
  "vuepress-plugin",
@@ -30,16 +30,12 @@
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.6.2",
39
- "@vuepress/helper": "2.0.0-rc.34",
40
- "@vuepress/highlighter-helper": "2.0.0-rc.34",
34
+ "@shikijs/transformers": "^1.7.0",
35
+ "@vuepress/helper": "2.0.0-rc.36",
36
+ "@vuepress/highlighter-helper": "2.0.0-rc.36",
41
37
  "nanoid": "^5.0.7",
42
- "shiki": "^1.6.2"
38
+ "shiki": "^1.7.0"
43
39
  },
44
40
  "peerDependencies": {
45
41
  "vuepress": "2.0.0-rc.13"
@@ -47,9 +43,5 @@
47
43
  "publishConfig": {
48
44
  "access": "public"
49
45
  },
50
- "devDependencies": {
51
- "@types/markdown-it": "^14.1.1",
52
- "markdown-it": "^14.1.0"
53
- },
54
- "gitHead": "93df303baa6291f52e3523f136073e79d53274ea"
46
+ "gitHead": "7f283f7243f9f9b86a9621f6ebc00d8d335d5f94"
55
47
  }