@ox-content/vite-plugin-solid 2.81.0

package/dist/index.d.cts

@@ -0,0 +1,252 @@
+import { PluginOption } from "vite";
+import { OxContentOptions, oxContent } from "@ox-content/vite-plugin";
+
+//#region src/types.d.ts
+/**
+ * Code annotation options for the Solid integration.
+ *
+ * The Solid integration supports the same opt-in fence metadata as the core
+ * plugin, but only exposes the attribute key because rendering is handled by
+ * the Solid markdown transform.
+ */
+interface CodeAnnotationsOptions {
+  /**
+   * Attribute name read from the code fence meta string.
+   *
+   * @default 'annotate'
+   */
+  metaKey?: string;
+}
+interface ResolvedCodeAnnotationsOptions {
+  enabled: boolean;
+  metaKey: string;
+}
+/**
+ * Map from Markdown component names to import paths.
+ */
+type ComponentsMap = Record<string, string>;
+/**
+ * Component registration options.
+ *
+ * Can be a map, a glob pattern, or an array of glob patterns.
+ * Globbed components are resolved relative to the Vite project root during
+ * `configResolved`.
+ */
+type ComponentsOption = ComponentsMap | string | string[];
+/**
+ * Solid integration plugin options.
+ *
+ * This extends the core ox-content options with Solid component registration.
+ * Markdown files are transformed into Solid JSX modules while the core plugin
+ * still provides shared parsing, embeds, and environment setup.
+ *
+ * Solid has no runtime JSX factory, so the generated modules must still be
+ * compiled by `vite-plugin-solid`. See {@link SolidIntegrationOptions.verifySolidPlugin}.
+ */
+interface SolidIntegrationOptions extends OxContentOptions {
+  /**
+   * Markdown-like file extensions to process.
+   *
+   * Values are normalized with a leading dot before matching file paths.
+   *
+   * @default ['.md', '.markdown', '.mdx']
+   */
+  extensions?: string[];
+  /**
+   * Components to register for use in Markdown.
+   *
+   * Can be a map of names to paths, a glob pattern, or an array of globs.
+   * When using glob patterns, component names are derived from file names.
+   *
+   * @default {}
+   *
+   * @example
+   * ```ts
+   * // Glob pattern (recommended)
+   * components: './src/components/*.tsx'
+   *
+   * // Explicit map
+   * components: { Counter: './src/components/Counter.tsx' }
+   * ```
+   */
+  components?: ComponentsOption;
+  /**
+   * Enable opt-in line annotations for fenced code blocks.
+   *
+   * Pass `true` to use the default `annotate` meta key, or an object to change it.
+   *
+   * @default false
+   */
+  codeAnnotations?: boolean | CodeAnnotationsOptions;
+  /**
+   * Fail fast when `vite-plugin-solid` cannot compile the generated modules.
+   *
+   * Markdown files are emitted as Solid JSX, and Solid's JSX has no runtime
+   * factory to fall back on: it only works after `babel-preset-solid` has
+   * compiled it. `vite-plugin-solid` only looks at `.jsx`/`.tsx` ids unless its
+   * own `extensions` option lists the Markdown extensions too, so a missing
+   * entry surfaces as an opaque syntax error in an unrelated file.
+   *
+   * With this enabled the plugin checks the resolved plugin list and throws a
+   * message naming the extensions that are missing. Turn it off when Solid JSX
+   * is compiled by something other than `vite-plugin-solid`.
+   *
+   * @default true
+   *
+   * @example
+   * ```ts
+   * plugins: [
+   *   solid({ extensions: ['.md', '.markdown', '.mdx'] }),
+   *   oxContentSolid({ srcDir: 'docs' }),
+   * ]
+   * ```
+   */
+  verifySolidPlugin?: boolean;
+  /**
+   * Built-in static embeds rendered during Markdown transformation.
+   *
+   * Set to `false` to disable all built-in embeds.
+   * Configure individual fetch-related options under `github` and `openGraph`.
+   *
+   * @default { github: true, openGraph: true }
+   */
+  embeds?: BuiltinEmbedOptions | false;
+}
+/**
+ * Fetch options for Solid GitHub embeds.
+ */
+interface GitHubEmbedOptions {
+  /**
+   * GitHub API token used for higher rate limits and private repository access.
+   * @default ''
+   */
+  token?: string;
+  /**
+   * Cache fetched repository and source data in memory for the current process.
+   * @default true
+   */
+  cache?: boolean;
+  /**
+   * Cache TTL in milliseconds.
+   * @default 3600000
+   */
+  cacheTTL?: number;
+  /**
+   * Maximum source file size to inline in bytes.
+   * @default 200000
+   */
+  maxSourceBytes?: number;
+  /**
+   * Maximum source lines to inline when no line range is specified.
+   * @default 120
+   */
+  maxSourceLines?: number;
+}
+/**
+ * Fetch options for Solid Open Graph embeds.
+ */
+interface OpenGraphEmbedOptions {
+  /**
+   * Request timeout in milliseconds.
+   * @default 10000
+   */
+  timeout?: number;
+  /**
+   * Cache fetched Open Graph metadata in memory for the current process.
+   * @default true
+   */
+  cache?: boolean;
+  /**
+   * Cache TTL in milliseconds.
+   * @default 3600000
+   */
+  cacheTTL?: number;
+  /**
+   * User agent sent with metadata fetch requests.
+   * @default 'ox-content-ogp-bot/1.0 (compatible; +https://github.com/ubugeeei-prod/ox-content)'
+   */
+  userAgent?: string;
+}
+/**
+ * Built-in embed options for the Solid integration.
+ */
+interface BuiltinEmbedOptions {
+  /**
+   * Render `<GitHub repo="owner/name" />` repository cards.
+   * @default true
+   */
+  github?: boolean | GitHubEmbedOptions;
+  /**
+   * Render `<OgCard url="https://example.com" />` Open Graph link cards.
+   * @default true
+   */
+  openGraph?: boolean | OpenGraphEmbedOptions;
+}
+interface ResolvedBuiltinEmbedOptions {
+  github: GitHubEmbedOptions | false;
+  openGraph: OpenGraphEmbedOptions | false;
+}
+interface ResolvedSolidOptions {
+  srcDir: string;
+  outDir: string;
+  base: string;
+  extensions: string[];
+  gfm: boolean;
+  autolinks: boolean;
+  frontmatter: boolean;
+  toc: boolean;
+  tocMaxDepth: number;
+  codeAnnotations: ResolvedCodeAnnotationsOptions;
+  components: ComponentsMap;
+  verifySolidPlugin: boolean;
+  embeds: ResolvedBuiltinEmbedOptions;
+  root?: string;
+}
+interface SolidTransformResult {
+  code: string;
+  map: null;
+  usedComponents: string[];
+  frontmatter: Record<string, unknown>;
+}
+interface ComponentIsland {
+  name: string;
+  props: Record<string, unknown>;
+  position: number;
+  id: string;
+  content?: string;
+}
+//#endregion
+//#region src/index.d.ts
+/**
+ * Creates the Ox Content Solid integration plugin.
+ *
+ * Unlike the React and Svelte integrations, this plugin must be listed **before**
+ * `vite-plugin-solid`, and that plugin must be told about the Markdown
+ * extensions. Markdown is turned into Solid JSX here, and Solid's JSX is
+ * compile-time only — `vite-plugin-solid` is what turns it into DOM or SSR
+ * instructions.
+ *
+ * @example
+ * ```ts
+ * // vite.config.ts
+ * import { defineConfig } from 'vite';
+ * import solid from 'vite-plugin-solid';
+ * import { oxContentSolid } from '@ox-content/vite-plugin-solid';
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     oxContentSolid({
+ *       srcDir: 'docs',
+ *       components: {
+ *         Counter: './src/components/Counter.tsx',
+ *       },
+ *     }),
+ *     solid({ extensions: ['.md', '.markdown', '.mdx'] }),
+ *   ],
+ * });
+ * ```
+ */
+declare function oxContentSolid(options?: SolidIntegrationOptions): PluginOption[];
+//#endregion
+export { type BuiltinEmbedOptions, type ComponentIsland, type ComponentsMap, type ComponentsOption, type GitHubEmbedOptions, type OpenGraphEmbedOptions, type ResolvedBuiltinEmbedOptions, type ResolvedSolidOptions, type SolidIntegrationOptions, type SolidTransformResult, oxContent, oxContentSolid };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/types.ts","../src/index.ts"],"mappings":";;;;;;;AASA;;;;UAAiB,sBAAA;EASA;;;;;EAHf,OAAA;AAAA;AAAA,UAGe,8BAAA;EACf,OAAA;EACA,OAAA;AAAA;;;;KAMU,aAAA,GAAgB,MAAA;AAqB5B;;;;;;;AAAA,KAZY,gBAAA,GAAmB,aAAA;;;;;;;;;;;UAYd,uBAAA,SAAgC,gBAAA;EAuEnB;AAM9B;;;;;;EArEE,UAAA;EA4FA;;;;AAYF;;;;;;;;;;AA6BA;;;EAlHE,UAAA,GAAa,gBAAA;EAuHb;;;;;;AASF;EAvHE,eAAA,aAA4B,sBAAA;;;;;;;;;AA4H9B;;;;;;;;;;;;;;;EAnGE,iBAAA;EA4GA;;;;;;;;EAlGA,MAAA,GAAS,mBAAA;AAAA;;AA0GX;;UApGiB,kBAAA;EAwGI;;;;EAnGnB,KAAA;EAmGa;;;AAGf;EAhGE,KAAA;;;;;EAMA,QAAA;EA6FA;;;;EAvFA,cAAA;;;;ACrFF;ED2FE,cAAA;AAAA;;;;UAMe,qBAAA;ECjGkE;;;;EDsGjF,OAAA;;;;;EAMA,KAAA;;;;;EAMA,QAAA;;;;;EAMA,SAAA;AAAA;;;;UAMe,mBAAA;;;;;EAKf,MAAA,aAAmB,kBAAA;;;;;EAMnB,SAAA,aAAsB,qBAAA;AAAA;AAAA,UAGP,2BAAA;EACf,MAAA,EAAQ,kBAAA;EACR,SAAA,EAAW,qBAAA;AAAA;AAAA,UAGI,oBAAA;EACf,MAAA;EACA,MAAA;EACA,IAAA;EACA,UAAA;EACA,GAAA;EACA,SAAA;EACA,WAAA;EACA,GAAA;EACA,WAAA;EACA,eAAA,EAAiB,8BAAA;EACjB,UAAA,EAAY,aAAA;EACZ,iBAAA;EACA,MAAA,EAAQ,2BAAA;EACR,IAAA;AAAA;AAAA,UAGe,oBAAA;EACf,IAAA;EACA,GAAA;EACA,cAAA;EACA,WAAA,EAAa,MAAA;AAAA;AAAA,UAGE,eAAA;EACf,IAAA;EACA,KAAA,EAAO,MAAA;EACP,QAAA;EACA,EAAA;EACA,OAAA;AAAA;;;;AA1NF;;;;;AAQA;;;;;AASA;;;;;AAYA;;;;;;;;;;;;;iBCegB,cAAA,CAAe,OAAA,GAAS,uBAAA,GAA+B,YAAA"}

package/dist/index.d.mts

@@ -0,0 +1,252 @@
+import { OxContentOptions, oxContent } from "@ox-content/vite-plugin";
+import { PluginOption } from "vite";
+
+//#region src/types.d.ts
+/**
+ * Code annotation options for the Solid integration.
+ *
+ * The Solid integration supports the same opt-in fence metadata as the core
+ * plugin, but only exposes the attribute key because rendering is handled by
+ * the Solid markdown transform.
+ */
+interface CodeAnnotationsOptions {
+  /**
+   * Attribute name read from the code fence meta string.
+   *
+   * @default 'annotate'
+   */
+  metaKey?: string;
+}
+interface ResolvedCodeAnnotationsOptions {
+  enabled: boolean;
+  metaKey: string;
+}
+/**
+ * Map from Markdown component names to import paths.
+ */
+type ComponentsMap = Record<string, string>;
+/**
+ * Component registration options.
+ *
+ * Can be a map, a glob pattern, or an array of glob patterns.
+ * Globbed components are resolved relative to the Vite project root during
+ * `configResolved`.
+ */
+type ComponentsOption = ComponentsMap | string | string[];
+/**
+ * Solid integration plugin options.
+ *
+ * This extends the core ox-content options with Solid component registration.
+ * Markdown files are transformed into Solid JSX modules while the core plugin
+ * still provides shared parsing, embeds, and environment setup.
+ *
+ * Solid has no runtime JSX factory, so the generated modules must still be
+ * compiled by `vite-plugin-solid`. See {@link SolidIntegrationOptions.verifySolidPlugin}.
+ */
+interface SolidIntegrationOptions extends OxContentOptions {
+  /**
+   * Markdown-like file extensions to process.
+   *
+   * Values are normalized with a leading dot before matching file paths.
+   *
+   * @default ['.md', '.markdown', '.mdx']
+   */
+  extensions?: string[];
+  /**
+   * Components to register for use in Markdown.
+   *
+   * Can be a map of names to paths, a glob pattern, or an array of globs.
+   * When using glob patterns, component names are derived from file names.
+   *
+   * @default {}
+   *
+   * @example
+   * ```ts
+   * // Glob pattern (recommended)
+   * components: './src/components/*.tsx'
+   *
+   * // Explicit map
+   * components: { Counter: './src/components/Counter.tsx' }
+   * ```
+   */
+  components?: ComponentsOption;
+  /**
+   * Enable opt-in line annotations for fenced code blocks.
+   *
+   * Pass `true` to use the default `annotate` meta key, or an object to change it.
+   *
+   * @default false
+   */
+  codeAnnotations?: boolean | CodeAnnotationsOptions;
+  /**
+   * Fail fast when `vite-plugin-solid` cannot compile the generated modules.
+   *
+   * Markdown files are emitted as Solid JSX, and Solid's JSX has no runtime
+   * factory to fall back on: it only works after `babel-preset-solid` has
+   * compiled it. `vite-plugin-solid` only looks at `.jsx`/`.tsx` ids unless its
+   * own `extensions` option lists the Markdown extensions too, so a missing
+   * entry surfaces as an opaque syntax error in an unrelated file.
+   *
+   * With this enabled the plugin checks the resolved plugin list and throws a
+   * message naming the extensions that are missing. Turn it off when Solid JSX
+   * is compiled by something other than `vite-plugin-solid`.
+   *
+   * @default true
+   *
+   * @example
+   * ```ts
+   * plugins: [
+   *   solid({ extensions: ['.md', '.markdown', '.mdx'] }),
+   *   oxContentSolid({ srcDir: 'docs' }),
+   * ]
+   * ```
+   */
+  verifySolidPlugin?: boolean;
+  /**
+   * Built-in static embeds rendered during Markdown transformation.
+   *
+   * Set to `false` to disable all built-in embeds.
+   * Configure individual fetch-related options under `github` and `openGraph`.
+   *
+   * @default { github: true, openGraph: true }
+   */
+  embeds?: BuiltinEmbedOptions | false;
+}
+/**
+ * Fetch options for Solid GitHub embeds.
+ */
+interface GitHubEmbedOptions {
+  /**
+   * GitHub API token used for higher rate limits and private repository access.
+   * @default ''
+   */
+  token?: string;
+  /**
+   * Cache fetched repository and source data in memory for the current process.
+   * @default true
+   */
+  cache?: boolean;
+  /**
+   * Cache TTL in milliseconds.
+   * @default 3600000
+   */
+  cacheTTL?: number;
+  /**
+   * Maximum source file size to inline in bytes.
+   * @default 200000
+   */
+  maxSourceBytes?: number;
+  /**
+   * Maximum source lines to inline when no line range is specified.
+   * @default 120
+   */
+  maxSourceLines?: number;
+}
+/**
+ * Fetch options for Solid Open Graph embeds.
+ */
+interface OpenGraphEmbedOptions {
+  /**
+   * Request timeout in milliseconds.
+   * @default 10000
+   */
+  timeout?: number;
+  /**
+   * Cache fetched Open Graph metadata in memory for the current process.
+   * @default true
+   */
+  cache?: boolean;
+  /**
+   * Cache TTL in milliseconds.
+   * @default 3600000
+   */
+  cacheTTL?: number;
+  /**
+   * User agent sent with metadata fetch requests.
+   * @default 'ox-content-ogp-bot/1.0 (compatible; +https://github.com/ubugeeei-prod/ox-content)'
+   */
+  userAgent?: string;
+}
+/**
+ * Built-in embed options for the Solid integration.
+ */
+interface BuiltinEmbedOptions {
+  /**
+   * Render `<GitHub repo="owner/name" />` repository cards.
+   * @default true
+   */
+  github?: boolean | GitHubEmbedOptions;
+  /**
+   * Render `<OgCard url="https://example.com" />` Open Graph link cards.
+   * @default true
+   */
+  openGraph?: boolean | OpenGraphEmbedOptions;
+}
+interface ResolvedBuiltinEmbedOptions {
+  github: GitHubEmbedOptions | false;
+  openGraph: OpenGraphEmbedOptions | false;
+}
+interface ResolvedSolidOptions {
+  srcDir: string;
+  outDir: string;
+  base: string;
+  extensions: string[];
+  gfm: boolean;
+  autolinks: boolean;
+  frontmatter: boolean;
+  toc: boolean;
+  tocMaxDepth: number;
+  codeAnnotations: ResolvedCodeAnnotationsOptions;
+  components: ComponentsMap;
+  verifySolidPlugin: boolean;
+  embeds: ResolvedBuiltinEmbedOptions;
+  root?: string;
+}
+interface SolidTransformResult {
+  code: string;
+  map: null;
+  usedComponents: string[];
+  frontmatter: Record<string, unknown>;
+}
+interface ComponentIsland {
+  name: string;
+  props: Record<string, unknown>;
+  position: number;
+  id: string;
+  content?: string;
+}
+//#endregion
+//#region src/index.d.ts
+/**
+ * Creates the Ox Content Solid integration plugin.
+ *
+ * Unlike the React and Svelte integrations, this plugin must be listed **before**
+ * `vite-plugin-solid`, and that plugin must be told about the Markdown
+ * extensions. Markdown is turned into Solid JSX here, and Solid's JSX is
+ * compile-time only — `vite-plugin-solid` is what turns it into DOM or SSR
+ * instructions.
+ *
+ * @example
+ * ```ts
+ * // vite.config.ts
+ * import { defineConfig } from 'vite';
+ * import solid from 'vite-plugin-solid';
+ * import { oxContentSolid } from '@ox-content/vite-plugin-solid';
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     oxContentSolid({
+ *       srcDir: 'docs',
+ *       components: {
+ *         Counter: './src/components/Counter.tsx',
+ *       },
+ *     }),
+ *     solid({ extensions: ['.md', '.markdown', '.mdx'] }),
+ *   ],
+ * });
+ * ```
+ */
+declare function oxContentSolid(options?: SolidIntegrationOptions): PluginOption[];
+//#endregion
+export { type BuiltinEmbedOptions, type ComponentIsland, type ComponentsMap, type ComponentsOption, type GitHubEmbedOptions, type OpenGraphEmbedOptions, type ResolvedBuiltinEmbedOptions, type ResolvedSolidOptions, type SolidIntegrationOptions, type SolidTransformResult, oxContent, oxContentSolid };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/index.ts"],"mappings":";;;;;;;AASA;;;;UAAiB,sBAAA;EASA;;;;;EAHf,OAAA;AAAA;AAAA,UAGe,8BAAA;EACf,OAAA;EACA,OAAA;AAAA;;;;KAMU,aAAA,GAAgB,MAAA;AAqB5B;;;;;;;AAAA,KAZY,gBAAA,GAAmB,aAAA;;;;;;;;;;;UAYd,uBAAA,SAAgC,gBAAA;EAuEnB;AAM9B;;;;;;EArEE,UAAA;EA4FA;;;;AAYF;;;;;;;;;;AA6BA;;;EAlHE,UAAA,GAAa,gBAAA;EAuHb;;;;;;AASF;EAvHE,eAAA,aAA4B,sBAAA;;;;;;;;;AA4H9B;;;;;;;;;;;;;;;EAnGE,iBAAA;EA4GA;;;;;;;;EAlGA,MAAA,GAAS,mBAAA;AAAA;;AA0GX;;UApGiB,kBAAA;EAwGI;;;;EAnGnB,KAAA;EAmGa;;;AAGf;EAhGE,KAAA;;;;;EAMA,QAAA;EA6FA;;;;EAvFA,cAAA;;;;ACrFF;ED2FE,cAAA;AAAA;;;;UAMe,qBAAA;ECjGkE;;;;EDsGjF,OAAA;;;;;EAMA,KAAA;;;;;EAMA,QAAA;;;;;EAMA,SAAA;AAAA;;;;UAMe,mBAAA;;;;;EAKf,MAAA,aAAmB,kBAAA;;;;;EAMnB,SAAA,aAAsB,qBAAA;AAAA;AAAA,UAGP,2BAAA;EACf,MAAA,EAAQ,kBAAA;EACR,SAAA,EAAW,qBAAA;AAAA;AAAA,UAGI,oBAAA;EACf,MAAA;EACA,MAAA;EACA,IAAA;EACA,UAAA;EACA,GAAA;EACA,SAAA;EACA,WAAA;EACA,GAAA;EACA,WAAA;EACA,eAAA,EAAiB,8BAAA;EACjB,UAAA,EAAY,aAAA;EACZ,iBAAA;EACA,MAAA,EAAQ,2BAAA;EACR,IAAA;AAAA;AAAA,UAGe,oBAAA;EACf,IAAA;EACA,GAAA;EACA,cAAA;EACA,WAAA,EAAa,MAAA;AAAA;AAAA,UAGE,eAAA;EACf,IAAA;EACA,KAAA,EAAO,MAAA;EACP,QAAA;EACA,EAAA;EACA,OAAA;AAAA;;;;AA1NF;;;;;AAQA;;;;;AASA;;;;;AAYA;;;;;;;;;;;;;iBCegB,cAAA,CAAe,OAAA,GAAS,uBAAA,GAA+B,YAAA"}