shiki 2.3.0 → 2.3.2

package/dist/types/wasm-dynamic.d.mts

@@ -1,8 +1,342 @@
 import { WebAssemblyInstantiator } from '@shikijs/core/types';
 
+// ## Interfaces
+
+/**
+ * Info associated with nodes by the ecosystem.
+ *
+ * This space is guaranteed to never be specified by unist or specifications
+ * implementing unist.
+ * But you can use it in utilities and plugins to store data.
+ *
+ * This type can be augmented to register custom data.
+ * For example:
+ *
+ * ```ts
+ * declare module 'unist' {
+ *   interface Data {
+ *     // `someNode.data.myId` is typed as `number | undefined`
+ *     myId?: number | undefined
+ *   }
+ * }
+ * ```
+ */
+interface Data$1 {}
+
+/**
+ * One place in a source file.
+ */
+interface Point {
+    /**
+     * Line in a source file (1-indexed integer).
+     */
+    line: number;
+
+    /**
+     * Column in a source file (1-indexed integer).
+     */
+    column: number;
+    /**
+     * Character in a source file (0-indexed integer).
+     */
+    offset?: number | undefined;
+}
+
+/**
+ * Position of a node in a source document.
+ *
+ * A position is a range between two points.
+ */
+interface Position {
+    /**
+     * Place of the first character of the parsed source region.
+     */
+    start: Point;
+
+    /**
+     * Place of the first character after the parsed source region.
+     */
+    end: Point;
+}
+
+/**
+ * Abstract unist node.
+ *
+ * The syntactic unit in unist syntax trees are called nodes.
+ *
+ * This interface is supposed to be extended.
+ * If you can use {@link Literal} or {@link Parent}, you should.
+ * But for example in markdown, a `thematicBreak` (`***`), is neither literal
+ * nor parent, but still a node.
+ */
+interface Node$1 {
+    /**
+     * Node type.
+     */
+    type: string;
+
+    /**
+     * Info from the ecosystem.
+     */
+    data?: Data$1 | undefined;
+
+    /**
+     * Position of a node in a source document.
+     *
+     * Nodes that are generated (not in the original source document) must not
+     * have a position.
+     */
+    position?: Position | undefined;
+}
+
+// ## Interfaces
+
+/**
+ * Info associated with hast nodes by the ecosystem.
+ *
+ * This space is guaranteed to never be specified by unist or hast.
+ * But you can use it in utilities and plugins to store data.
+ *
+ * This type can be augmented to register custom data.
+ * For example:
+ *
+ * ```ts
+ * declare module 'hast' {
+ *   interface Data {
+ *     // `someNode.data.myId` is typed as `number | undefined`
+ *     myId?: number | undefined
+ *   }
+ * }
+ * ```
+ */
+interface Data extends Data$1 {}
+
+/**
+ * Info associated with an element.
+ */
+interface Properties {
+    [PropertyName: string]: boolean | number | string | null | undefined | Array<string | number>;
+}
+
+// ## Content maps
+
+/**
+ * Union of registered hast nodes that can occur in {@link Element}.
+ *
+ * To register mote custom hast nodes, add them to {@link ElementContentMap}.
+ * They will be automatically added here.
+ */
+type ElementContent = ElementContentMap[keyof ElementContentMap];
+
+/**
+ * Registry of all hast nodes that can occur as children of {@link Element}.
+ *
+ * For a union of all {@link Element} children, see {@link ElementContent}.
+ */
+interface ElementContentMap {
+    comment: Comment;
+    element: Element;
+    text: Text;
+}
+
+/**
+ * Union of registered hast nodes that can occur in {@link Root}.
+ *
+ * To register custom hast nodes, add them to {@link RootContentMap}.
+ * They will be automatically added here.
+ */
+type RootContent = RootContentMap[keyof RootContentMap];
+
+/**
+ * Registry of all hast nodes that can occur as children of {@link Root}.
+ *
+ * > 👉 **Note**: {@link Root} does not need to be an entire document.
+ * > it can also be a fragment.
+ *
+ * For a union of all {@link Root} children, see {@link RootContent}.
+ */
+interface RootContentMap {
+    comment: Comment;
+    doctype: Doctype;
+    element: Element;
+    text: Text;
+}
+
+// ## Abstract nodes
+
+/**
+ * Abstract hast node.
+ *
+ * This interface is supposed to be extended.
+ * If you can use {@link Literal} or {@link Parent}, you should.
+ * But for example in HTML, a `Doctype` is neither literal nor parent, but
+ * still a node.
+ *
+ * To register custom hast nodes, add them to {@link RootContentMap} and other
+ * places where relevant (such as {@link ElementContentMap}).
+ *
+ * For a union of all registered hast nodes, see {@link Nodes}.
+ */
+interface Node extends Node$1 {
+    /**
+     * Info from the ecosystem.
+     */
+    data?: Data | undefined;
+}
+
+/**
+ * Abstract hast node that contains the smallest possible value.
+ *
+ * This interface is supposed to be extended if you make custom hast nodes.
+ *
+ * For a union of all registered hast literals, see {@link Literals}.
+ */
+interface Literal extends Node {
+    /**
+     * Plain-text value.
+     */
+    value: string;
+}
+
+/**
+ * Abstract hast node that contains other hast nodes (*children*).
+ *
+ * This interface is supposed to be extended if you make custom hast nodes.
+ *
+ * For a union of all registered hast parents, see {@link Parents}.
+ */
+interface Parent extends Node {
+    /**
+     * List of children.
+     */
+    children: RootContent[];
+}
+
+// ## Concrete nodes
+
+/**
+ * HTML comment.
+ */
+interface Comment extends Literal {
+    /**
+     * Node type of HTML comments in hast.
+     */
+    type: "comment";
+    /**
+     * Data associated with the comment.
+     */
+    data?: CommentData | undefined;
+}
+
+/**
+ * Info associated with hast comments by the ecosystem.
+ */
+interface CommentData extends Data {}
+
+/**
+ * HTML document type.
+ */
+interface Doctype extends Node$1 {
+    /**
+     * Node type of HTML document types in hast.
+     */
+    type: "doctype";
+    /**
+     * Data associated with the doctype.
+     */
+    data?: DoctypeData | undefined;
+}
+
+/**
+ * Info associated with hast doctypes by the ecosystem.
+ */
+interface DoctypeData extends Data {}
+
+/**
+ * HTML element.
+ */
+interface Element extends Parent {
+    /**
+     * Node type of elements.
+     */
+    type: "element";
+    /**
+     * Tag name (such as `'body'`) of the element.
+     */
+    tagName: string;
+    /**
+     * Info associated with the element.
+     */
+    properties: Properties;
+    /**
+     * Children of element.
+     */
+    children: ElementContent[];
+    /**
+     * When the `tagName` field is `'template'`, a `content` field can be
+     * present.
+     */
+    content?: Root | undefined;
+    /**
+     * Data associated with the element.
+     */
+    data?: ElementData | undefined;
+}
+
+/**
+ * Info associated with hast elements by the ecosystem.
+ */
+interface ElementData extends Data {}
+
+/**
+ * Document fragment or a whole document.
+ *
+ * Should be used as the root of a tree and must not be used as a child.
+ *
+ * Can also be used as the value for the content field on a `'template'` element.
+ */
+interface Root extends Parent {
+    /**
+     * Node type of hast root.
+     */
+    type: "root";
+    /**
+     * Children of root.
+     */
+    children: RootContent[];
+    /**
+     * Data associated with the hast root.
+     */
+    data?: RootData | undefined;
+}
+
+/**
+ * Info associated with hast root nodes by the ecosystem.
+ */
+interface RootData extends Data {}
+
+/**
+ * HTML character data (plain text).
+ */
+interface Text extends Literal {
+    /**
+     * Node type of HTML character data (plain text) in hast.
+     */
+    type: "text";
+    /**
+     * Data associated with the text.
+     */
+    data?: TextData | undefined;
+}
+
+/**
+ * Info associated with hast texts by the ecosystem.
+ */
+interface TextData extends Data {}
+
 /**
  * @deprecated Use `import('shiki/wasm')` instead.
  */
 declare const getWasmInlined: WebAssemblyInstantiator;
 
-export { getWasmInlined as g };
+export { type Root as R, getWasmInlined as g };

package/dist/types.d.mts

@@ -2,7 +2,6 @@ import { BundledLanguage } from './langs.mjs';
 import { BundledTheme } from './themes.mjs';
 export * from '@shikijs/core/types';
 import '@shikijs/types';
-import '@shikijs/core';
 
 type BuiltinLanguage = BundledLanguage;
 type BuiltinTheme = BundledTheme;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shiki",
   "type": "module",
-  "version": "2.3.0",
+  "version": "2.3.2",
   "description": "A beautiful Syntax Highlighter.",
   "author": "Pine Wu <octref@gmail.com>; Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -119,17 +119,17 @@
   "dependencies": {
     "@shikijs/vscode-textmate": "^10.0.1",
     "@types/hast": "^3.0.4",
-    "@shikijs/core": "2.3.0",
-    "@shikijs/engine-oniguruma": "2.3.0",
-    "@shikijs/engine-javascript": "2.3.0",
-    "@shikijs/langs": "2.3.0",
-    "@shikijs/themes": "2.3.0",
-    "@shikijs/types": "2.3.0"
+    "@shikijs/core": "2.3.2",
+    "@shikijs/engine-javascript": "2.3.2",
+    "@shikijs/engine-oniguruma": "2.3.2",
+    "@shikijs/themes": "2.3.2",
+    "@shikijs/types": "2.3.2",
+    "@shikijs/langs": "2.3.2"
   },
   "devDependencies": {
     "rollup-plugin-copy": "^3.5.0",
-    "tm-grammars": "^1.22.11",
-    "tm-themes": "^1.9.10",
+    "tm-grammars": "^1.22.13",
+    "tm-themes": "^1.9.12",
     "vscode-oniguruma": "1.7.0"
   },
   "scripts": {