@nuxtjs/mdc 0.7.1 → 0.8.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxtjs/mdc",
-  "version": "0.7.1",
+  "version": "0.8.1",
   "description": "Nuxt MDC module",
   "repository": "nuxt-modules/mdc",
   "license": "MIT",
@@ -18,11 +18,11 @@
     },
     "./runtime": {
       "types": "./dist/runtime/index.d.ts",
-      "import": "./dist/runtime/index.mjs"
+      "import": "./dist/runtime/index.js"
     },
     "./dist/runtime": {
       "types": "./dist/runtime/index.d.ts",
-      "import": "./dist/runtime/index.mjs"
+      "import": "./dist/runtime/index.js"
     },
     "./runtime/components/*": {
       "types": "./dist/runtime/components/*.d.ts",
@@ -34,11 +34,11 @@
     },
     "./runtime/*": {
       "types": "./dist/runtime/*.d.ts",
-      "import": "./dist/runtime/*.mjs"
+      "import": "./dist/runtime/*.js"
     },
     "./dist/runtime/*": {
       "types": "./dist/runtime/*.d.ts",
-      "import": "./dist/runtime/*.mjs"
+      "import": "./dist/runtime/*.js"
     }
   },
   "main": "./dist/module.cjs",
@@ -66,23 +66,24 @@
     "dev:docs": "nuxi dev docs",
     "release": "release-it",
     "lint": "eslint .",
+    "typecheck": "nuxt typecheck",
     "test": "vitest run",
     "test:watch": "vitest watch"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.11.2",
-    "@shikijs/transformers": "^1.5.2",
+    "@nuxt/kit": "^3.12.1",
+    "@shikijs/transformers": "^1.6.4",
     "@types/hast": "^3.0.4",
     "@types/mdast": "^4.0.4",
     "@vue/compiler-core": "^3.4.27",
     "consola": "^3.2.3",
-    "debug": "^4.3.4",
+    "debug": "^4.3.5",
     "defu": "^6.1.4",
     "destr": "^2.0.3",
     "detab": "^3.0.2",
     "github-slugger": "^2.0.0",
     "hast-util-to-string": "^3.0.0",
-    "mdast-util-to-hast": "^13.1.0",
+    "mdast-util-to-hast": "^13.2.0",
     "micromark-util-sanitize-uri": "^2.0.0",
     "ohash": "^1.1.3",
     "parse5": "^7.1.2",
@@ -93,13 +94,13 @@
     "rehype-slug": "^6.0.0",
     "rehype-sort-attribute-values": "^5.0.0",
     "rehype-sort-attributes": "^5.0.0",
-    "remark-emoji": "^4.0.1",
+    "remark-emoji": "^5.0.0",
     "remark-gfm": "^4.0.0",
     "remark-mdc": "^3.2.1",
     "remark-parse": "^11.0.0",
     "remark-rehype": "^11.1.0",
     "scule": "^1.3.0",
-    "shiki": "^1.5.2",
+    "shiki": "^1.6.4",
     "ufo": "^1.5.3",
     "unified": "^11.0.4",
     "unist-builder": "^4.0.0",
@@ -108,19 +109,22 @@
   },
   "devDependencies": {
     "@nuxt/devtools": "latest",
-    "@nuxt/eslint-config": "^0.3.12",
-    "@nuxt/module-builder": "^0.6.0",
-    "@nuxt/schema": "^3.11.2",
-    "@nuxt/test-utils": "^3.13.0",
+    "@nuxt/eslint-config": "^0.3.13",
+    "@nuxt/module-builder": "^0.7.1",
+    "@nuxt/schema": "^3.12.1",
+    "@nuxt/test-utils": "^3.13.1",
     "@nuxt/ui": "^2.16.0",
-    "@types/node": "^20.12.12",
+    "@types/node": "^20.14.2",
     "changelogen": "^0.5.5",
-    "eslint": "^9.2.0",
-    "nuxt": "^3.11.2",
+    "eslint": "^9.4.0",
+    "nuxt": "^3.12.1",
     "rehype": "^13.0.1",
-    "release-it": "^17.2.1",
-    "vitest": "^1.6.0"
+    "release-it": "^17.3.0",
+    "typescript": "^5.4.5",
+    "vitest": "^1.6.0",
+    "vue-tsc": "^2.0.19"
   },
+  "packageManager": "pnpm@9.3.0",
   "release-it": {
     "git": {
       "commitMessage": "chore(release): release v${version}"

package/dist/runtime/highlighter/types.d.ts

@@ -1,14 +0,0 @@
-import type { ElementContent } from 'hast';
-import type { BuiltinTheme } from 'shiki';
-export type MdcThemeOptions = BuiltinTheme | string | Record<string, BuiltinTheme | string>;
-export interface HighlighterOptions {
-    highlights?: number[];
-    meta?: string;
-}
-export interface HighlightResult {
-    tree: ElementContent[];
-    className?: string;
-    style?: string;
-    inlineStyle?: string;
-}
-export type Highlighter = (code: string, lang: string, theme: MdcThemeOptions, options: Partial<HighlighterOptions>) => Promise<HighlightResult>;

package/dist/runtime/index.mjs

@@ -1,4 +0,0 @@
-export { parseMarkdown, createMarkdownParser } from "./parser/index.mjs";
-export { rehypeHighlight } from "./highlighter/rehype.mjs";
-export { createShikiHighlighter } from "./highlighter/shiki.mjs";
-export * from "./utils/node.mjs";

package/dist/runtime/parser/handlers/index.mjs

@@ -1,22 +0,0 @@
-import emphasis from "./emphasis.mjs";
-import code from "./code.mjs";
-import html from "./html.mjs";
-import link from "./link.mjs";
-import list from "./list.mjs";
-import paragraph from "./paragraph.mjs";
-import image from "./image.mjs";
-import strong from "./strong.mjs";
-import inlineCode from "./inlineCode.mjs";
-import containerComponent from "./containerComponent.mjs";
-export default {
-  emphasis,
-  code,
-  link,
-  paragraph,
-  html,
-  list,
-  image,
-  strong,
-  inlineCode,
-  containerComponent
-};

package/dist/runtime/types/config.d.ts

@@ -1,44 +0,0 @@
-import type { Highlighter, HighlighterCore, ShikiTransformer } from 'shiki';
-import type { Processor } from 'unified';
-import type { MdcThemeOptions, HighlighterOptions } from '../highlighter/types';
-export type Awaitable<T> = T | Promise<T>;
-export interface MdcConfig {
-    /**
-     * Hooks for the unified markdown pipeline
-     */
-    unified?: {
-        /**
-         * Custom setup for unified processor before other plugins
-         */
-        pre?: (processor: Processor) => Awaitable<void | Processor>;
-        /**
-         * Custom setup for unified processor after remark but before rehype
-         */
-        remark?: (processor: Processor) => Awaitable<void | Processor>;
-        /**
-         * Custom setup for unified processor after rehype
-         */
-        rehype?: (processor: Processor) => Awaitable<void | Processor>;
-        /**
-         * Custom setup for unified processor after all plugins
-         */
-        post?: (processor: Processor) => Awaitable<void | Processor>;
-    };
-    /**
-     * Custom hightlighter, available when `highlighter` is set to `custom`
-     */
-    highlighter?: Highlighter;
-    /**
-     * Hooks for shiki
-     */
-    shiki?: {
-        /**
-         * Get transformers for shiki
-         */
-        transformers?: ShikiTransformer[] | ((code: string, lang: string, theme: MdcThemeOptions, options: Partial<HighlighterOptions>) => Awaitable<ShikiTransformer[]>);
-        /**
-         * Custom setup for shiki instance, only called once on server or client
-         */
-        setup?: (highlighter: HighlighterCore) => Awaitable<void>;
-    };
-}

package/dist/runtime/types/hast.d.ts

@@ -1,255 +0,0 @@
-import type { Data as UnistData, Literal as UnistLiteral, Node as UnistNode, Parent as UnistParent } from './unist';
-/**
- * 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
- *   }
- * }
- * ```
- */
-export interface Data extends UnistData {
-}
-/**
- * Info associated with an element.
- */
-export interface Properties {
-    [PropertyName: string]: boolean | number | string | null | undefined | Array<string | number>;
-}
-/**
- * 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.
- */
-export 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}.
- */
-export 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.
- */
-export 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}.
- */
-export interface RootContentMap {
-    comment: Comment;
-    doctype: Doctype;
-    element: Element;
-    text: Text;
-}
-/**
- * Union of registered hast nodes that can occur in {@link Root}.
- *
- * @deprecated Use {@link RootContent} instead.
- */
-export type Content = RootContent;
-/**
- * Union of registered hast literals.
- *
- * To register custom hast nodes, add them to {@link RootContentMap} and other
- * places where relevant.
- * They will be automatically added here.
- */
-export type Literals = Extract<Nodes, UnistLiteral>;
-/**
- * Union of registered hast nodes.
- *
- * To register custom hast nodes, add them to {@link RootContentMap} and other
- * places where relevant.
- * They will be automatically added here.
- */
-export type Nodes = Root | RootContent;
-/**
- * Union of registered hast parents.
- *
- * To register custom hast nodes, add them to {@link RootContentMap} and other
- * places where relevant.
- * They will be automatically added here.
- */
-export type Parents = Extract<Nodes, UnistParent>;
-/**
- * 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}.
- */
-export interface Node extends UnistNode {
-    /**
-     * 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}.
- */
-export 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}.
- */
-export interface Parent extends Node {
-    /**
-     * List of children.
-     */
-    children: RootContent[];
-}
-/**
- * HTML comment.
- */
-export 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.
- */
-export interface CommentData extends Data {
-}
-/**
- * HTML document type.
- */
-export interface Doctype extends UnistNode {
-    /**
-     * 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.
- */
-export interface DoctypeData extends Data {
-}
-/**
- * HTML element.
- */
-export 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.
- */
-export 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.
- */
-export 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.
- */
-export interface RootData extends Data {
-}
-/**
- * HTML character data (plain text).
- */
-export 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.
- */
-export interface TextData extends Data {
-}

package/dist/runtime/types/index.d.ts

@@ -1,3 +0,0 @@
-export * from './tree';
-export * from './parser';
-export * from './toc';

package/dist/runtime/types/index.mjs

@@ -1,3 +0,0 @@
-export * from "./tree.mjs";
-export * from "./parser.mjs";
-export * from "./toc.mjs";

package/dist/runtime/types/parser.d.ts

@@ -1,41 +0,0 @@
-import type { Options as RehypeOption } from 'remark-rehype';
-import type { RehypeHighlightOption } from '../highlighter/rehype';
-import type { MdcConfig } from './config';
-import type { MDCData, MDCRoot } from './tree';
-import type { Toc } from './toc';
-export interface RemarkPlugin {
-    instance?: any;
-    options?: Array<any> | Record<string, any>;
-}
-export interface RehypePlugin {
-    instance?: any;
-    options?: Array<any> | Record<string, any>;
-}
-export interface MDCParseOptions {
-    remark?: {
-        plugins?: Record<string, false | RemarkPlugin>;
-    };
-    rehype?: {
-        options?: RehypeOption;
-        plugins?: Record<string, false | RehypePlugin>;
-    };
-    highlight?: RehypeHighlightOption | false;
-    toc?: {
-        /**
-         * Maximum heading depth to include in the table of contents.
-         */
-        depth?: number;
-        searchDepth?: number;
-    };
-    keepComments?: boolean;
-    /**
-     * Inline mdc.config.ts
-     */
-    configs?: MdcConfig[];
-}
-export interface MDCParserResult {
-    data: MDCData;
-    body: MDCRoot;
-    excerpt: MDCRoot | undefined;
-    toc: Toc | undefined;
-}

package/dist/runtime/types/toc.d.ts

@@ -1,12 +0,0 @@
-export interface TocLink {
-    id: string;
-    text: string;
-    depth: number;
-    children?: TocLink[];
-}
-export interface Toc {
-    title: string;
-    depth: number;
-    searchDepth: number;
-    links: TocLink[];
-}

package/dist/runtime/types/tree.d.ts

@@ -1,23 +0,0 @@
-export type MDCText = {
-    type: 'text';
-    value: string;
-};
-export type MDCComment = {
-    type: 'comment';
-    value: string;
-};
-export type MDCElement = {
-    type: 'element';
-    tag: string;
-    props: Record<string, any> | undefined;
-    children: Array<MDCElement | MDCText | MDCComment>;
-};
-export type MDCNode = MDCElement | MDCText | MDCComment;
-export type MDCRoot = {
-    type: 'root';
-    children: Array<MDCNode>;
-};
-export interface MDCData extends Record<string, any> {
-    title: string;
-    description: string;
-}

package/dist/runtime/types/unist.d.ts

@@ -1,107 +0,0 @@
-/**
- * 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
- *   }
- * }
- * ```
- */
-export interface Data {
-}
-/**
- * One place in a source file.
- */
-export 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.
- */
-export 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 that contains the smallest possible value.
- *
- * This interface is supposed to be extended.
- *
- * For example, in HTML, a `text` node is a leaf that contains text.
- */
-export interface Literal extends Node {
-    /**
-     * Plain value.
-     */
-    value: unknown;
-}
-/**
- * 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.
- */
-export interface Node {
-    /**
-     * Node type.
-     */
-    type: string;
-    /**
-     * Info from the ecosystem.
-     */
-    data?: Data | 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;
-}
-/**
- * Abstract unist node that contains other nodes (*children*).
- *
- * This interface is supposed to be extended.
- *
- * For example, in XML, an element is a parent of different things, such as
- * comments, text, and further elements.
- */
-export interface Parent extends Node {
-    /**
-     * List of children.
-     */
-    children: Node[];
-}