@astrojs/markdown-remark 0.8.3 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @astrojs/markdown-remark
 
+## 0.9.0
+
+### Minor Changes
+
+- [`53162534`](https://github.com/withastro/astro/commit/53162534450e160f65b95e7ef1523a106347ca28) Thanks [@FredKSchott](https://github.com/FredKSchott)! - - Removed `renderMarkdownWithFrontmatter` because it wasn't being used
+  - All options of `renderMarkdown` are now required — see the exported interface `AstroMarkdownOptions`
+  - New types: RemarkPlugin, RehypePlugin and ShikiConfig
+
+## 0.8.2
+
+### Patch Changes
+
+- [#2970](https://github.com/withastro/astro/pull/2970) [`b835e285`](https://github.com/withastro/astro/commit/b835e285defb4f31fc5ac1039c7f607c07f3c00b) Thanks [@JuanM04](https://github.com/JuanM04)! - Improved type checking
+
 ## 0.8.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,21 +1,9 @@
-import type { AstroMarkdownOptions, MarkdownRenderingOptions, ShikiConfig, Plugin } from './types';
-export { AstroMarkdownOptions, MarkdownRenderingOptions, ShikiConfig, Plugin };
-/** Internal utility for rendering a full markdown file and extracting Frontmatter data */
-export declare function renderMarkdownWithFrontmatter(contents: string, opts?: MarkdownRenderingOptions | null): Promise<{
-    frontmatter: {
-        [key: string]: any;
-    };
-    metadata: {
-        headers: any[];
-        source: string;
-        html: string;
-    };
-    code: string;
-}>;
+import type { MarkdownRenderingOptions } from './types';
+export * from './types.js';
 export declare const DEFAULT_REMARK_PLUGINS: string[];
 export declare const DEFAULT_REHYPE_PLUGINS: string[];
 /** Shared utility for rendering markdown */
-export declare function renderMarkdown(content: string, opts?: MarkdownRenderingOptions | null): Promise<{
+export declare function renderMarkdown(content: string, opts: MarkdownRenderingOptions): Promise<{
     metadata: {
         headers: any[];
         source: string;
@@ -23,4 +11,3 @@ export declare function renderMarkdown(content: string, opts?: MarkdownRendering
     };
     code: string;
 }>;
-export default renderMarkdownWithFrontmatter;

package/dist/index.js

@@ -1,22 +1,3 @@
-var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
 import createCollectHeaders from "./rehype-collect-headers.js";
 import scopedStyles from "./remark-scoped-styles.js";
 import { remarkExpressions, loadRemarkExpressions } from "./remark-expressions.js";
@@ -34,21 +15,13 @@ import markdown from "remark-parse";
 import markdownToHtml from "remark-rehype";
 import rehypeStringify from "rehype-stringify";
 import rehypeRaw from "rehype-raw";
-import matter from "gray-matter";
-async function renderMarkdownWithFrontmatter(contents, opts) {
-  const { data: frontmatter, content } = matter(contents);
-  const value = await renderMarkdown(content, opts);
-  return __spreadProps(__spreadValues({}, value), { frontmatter });
-}
+export * from "./types.js";
 const DEFAULT_REMARK_PLUGINS = ["remark-gfm", "remark-smartypants"];
 const DEFAULT_REHYPE_PLUGINS = ["rehype-slug"];
 async function renderMarkdown(content, opts) {
   var _a;
-  let { remarkPlugins = [], rehypePlugins = [] } = opts ?? {};
-  const scopedClassName = (_a = opts == null ? void 0 : opts.$) == null ? void 0 : _a.scopedClassName;
-  const mode = (opts == null ? void 0 : opts.mode) ?? "mdx";
-  const syntaxHighlight = (opts == null ? void 0 : opts.syntaxHighlight) ?? "shiki";
-  const shikiConfig = (opts == null ? void 0 : opts.shikiConfig) ?? {};
+  let { mode, syntaxHighlight, shikiConfig, remarkPlugins, rehypePlugins } = opts;
+  const scopedClassName = (_a = opts.$) == null ? void 0 : _a.scopedClassName;
   const isMDX = mode === "mdx";
   const { headers, rehypeCollectHeaders } = createCollectHeaders();
   await Promise.all([loadRemarkExpressions(), loadRemarkJsx()]);
@@ -96,11 +69,8 @@ async function renderMarkdown(content, opts) {
     code: result.toString()
   };
 }
-var src_default = renderMarkdownWithFrontmatter;
 export {
   DEFAULT_REHYPE_PLUGINS,
   DEFAULT_REMARK_PLUGINS,
-  src_default as default,
-  renderMarkdown,
-  renderMarkdownWithFrontmatter
+  renderMarkdown
 };

package/dist/load-plugins.d.ts

@@ -1,3 +1,2 @@
 import * as unified from 'unified';
-import type { Plugin } from './types';
-export declare function loadPlugins(items: Plugin[]): Promise<[unified.Plugin, any?]>[];
+export declare function loadPlugins(items: (string | [string, any] | unified.Plugin<any[], any> | [unified.Plugin<any[], any>, any])[]): Promise<[unified.Plugin, any?]>[];

package/dist/remark-shiki.d.ts

@@ -1,30 +1,3 @@
-import type * as shiki from 'shiki';
-export interface ShikiConfig {
-    /**
-     * The languages loaded to Shiki.
-     * Supports all languages listed here: https://github.com/shikijs/shiki/blob/main/docs/languages.md#all-languages
-     * Instructions for loading a custom language: https://github.com/shikijs/shiki/blob/main/docs/languages.md#supporting-your-own-languages-with-shiki
-     *
-     * @default []
-     */
-    langs?: shiki.ILanguageRegistration[];
-    /**
-     * The styling theme.
-     * Supports all themes listed here: https://github.com/shikijs/shiki/blob/main/docs/themes.md#all-themes
-     * Instructions for loading a custom theme: https://github.com/shikijs/shiki/blob/main/docs/themes.md#loading-theme
-     *
-     * @default "github-dark"
-     */
-    theme?: shiki.IThemeRegistration;
-    /**
-     * Enable word wrapping.
-     *  - true: enabled.
-     *  - false: enabled.
-     *  - null: All overflow styling removed. Code will overflow the element by default.
-     *
-     * @default false
-     */
-    wrap?: boolean | null;
-}
+import type { ShikiConfig } from './types.js';
 declare const remarkShiki: ({ langs, theme, wrap }: ShikiConfig, scopedClassName?: string | null | undefined) => Promise<() => (tree: any) => void>;
 export default remarkShiki;

package/dist/remark-shiki.js

@@ -1,7 +1,7 @@
 import { getHighlighter } from "shiki";
 import { visit } from "unist-util-visit";
 const highlighterCacheAsync = /* @__PURE__ */ new Map();
-const remarkShiki = async ({ langs = [], theme = "github-dark", wrap = false }, scopedClassName) => {
+const remarkShiki = async ({ langs, theme, wrap }, scopedClassName) => {
   const cacheID = typeof theme === "string" ? theme : theme.name;
   let highlighterAsync = highlighterCacheAsync.get(cacheID);
   if (!highlighterAsync) {

package/dist/types.d.ts

@@ -1,15 +1,26 @@
 import type * as unified from 'unified';
-import type { ShikiConfig } from './remark-shiki';
-export { ShikiConfig };
-export declare type Plugin = string | [string, any] | unified.Plugin | [unified.Plugin, any];
+import type * as mdast from 'mdast';
+import type * as hast from 'hast';
+import type { ILanguageRegistration, IThemeRegistration, Theme } from 'shiki';
+export type { Node } from 'unist';
+export declare type RemarkPlugin<PluginParameters extends any[] = any[]> = unified.Plugin<PluginParameters, mdast.Root>;
+export declare type RemarkPlugins = (string | [string, any] | RemarkPlugin | [RemarkPlugin, any])[];
+export declare type RehypePlugin<PluginParameters extends any[] = any[]> = unified.Plugin<PluginParameters, hast.Root>;
+export declare type RehypePlugins = (string | [string, any] | RehypePlugin | [RehypePlugin, any])[];
+export interface ShikiConfig {
+    langs: ILanguageRegistration[];
+    theme: Theme | IThemeRegistration;
+    wrap: boolean | null;
+}
 export interface AstroMarkdownOptions {
-    mode?: 'md' | 'mdx';
-    syntaxHighlight?: 'shiki' | 'prism' | false;
-    shikiConfig?: ShikiConfig;
-    remarkPlugins?: Plugin[];
-    rehypePlugins?: Plugin[];
+    mode: 'md' | 'mdx';
+    drafts: boolean;
+    syntaxHighlight: 'shiki' | 'prism' | false;
+    shikiConfig: ShikiConfig;
+    remarkPlugins: RemarkPlugins;
+    rehypePlugins: RehypePlugins;
 }
-export interface MarkdownRenderingOptions extends Partial<AstroMarkdownOptions> {
+export interface MarkdownRenderingOptions extends AstroMarkdownOptions {
     /** @internal */
     $?: {
         scopedClassName: string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/markdown-remark",
-  "version": "0.8.3",
+  "version": "0.9.0",
   "type": "module",
   "author": "withastro",
   "license": "MIT",
@@ -26,7 +26,6 @@
     "@astrojs/prism": "^0.4.1",
     "assert": "^2.0.0",
     "github-slugger": "^1.4.0",
-    "gray-matter": "^4.0.3",
     "mdast-util-mdx-expression": "^1.2.0",
     "mdast-util-mdx-jsx": "^1.2.0",
     "mdast-util-to-string": "^3.1.0",
@@ -47,7 +46,10 @@
   },
   "devDependencies": {
     "@types/github-slugger": "^1.3.0",
+    "@types/hast": "^2.3.4",
+    "@types/mdast": "^3.0.10",
     "@types/prismjs": "^1.26.0",
+    "@types/unist": "^2.0.6",
     "astro-scripts": "workspace:*"
   }
 }

package/src/index.ts

@@ -1,4 +1,4 @@
-import type { AstroMarkdownOptions, MarkdownRenderingOptions, ShikiConfig, Plugin } from './types';
+import type { MarkdownRenderingOptions } from './types';
 
 import createCollectHeaders from './rehype-collect-headers.js';
 import scopedStyles from './remark-scoped-styles.js';
@@ -18,31 +18,17 @@ import markdown from 'remark-parse';
 import markdownToHtml from 'remark-rehype';
 import rehypeStringify from 'rehype-stringify';
 import rehypeRaw from 'rehype-raw';
-import matter from 'gray-matter';
-
-export { AstroMarkdownOptions, MarkdownRenderingOptions, ShikiConfig, Plugin };
-
-/** Internal utility for rendering a full markdown file and extracting Frontmatter data */
-export async function renderMarkdownWithFrontmatter(
-	contents: string,
-	opts?: MarkdownRenderingOptions | null
-) {
-	const { data: frontmatter, content } = matter(contents);
-	const value = await renderMarkdown(content, opts);
-	return { ...value, frontmatter };
-}
+
+export * from './types.js';
 
 export const DEFAULT_REMARK_PLUGINS = ['remark-gfm', 'remark-smartypants'];
 
 export const DEFAULT_REHYPE_PLUGINS = ['rehype-slug'];
 
 /** Shared utility for rendering markdown */
-export async function renderMarkdown(content: string, opts?: MarkdownRenderingOptions | null) {
-	let { remarkPlugins = [], rehypePlugins = [] } = opts ?? {};
-	const scopedClassName = opts?.$?.scopedClassName;
-	const mode = opts?.mode ?? 'mdx';
-	const syntaxHighlight = opts?.syntaxHighlight ?? 'shiki';
-	const shikiConfig = opts?.shikiConfig ?? {};
+export async function renderMarkdown(content: string, opts: MarkdownRenderingOptions) {
+	let { mode, syntaxHighlight, shikiConfig, remarkPlugins, rehypePlugins } = opts;
+	const scopedClassName = opts.$?.scopedClassName;
 	const isMDX = mode === 'mdx';
 	const { headers, rehypeCollectHeaders } = createCollectHeaders();
 
@@ -111,5 +97,3 @@ export async function renderMarkdown(content: string, opts?: MarkdownRenderingOp
 		code: result.toString(),
 	};
 }
-
-export default renderMarkdownWithFrontmatter;

package/src/load-plugins.ts

@@ -1,5 +1,4 @@
 import * as unified from 'unified';
-import type { Plugin } from './types';
 
 async function importPlugin(p: string | unified.Plugin): Promise<unified.Plugin> {
 	if (typeof p === 'string') {
@@ -10,7 +9,9 @@ async function importPlugin(p: string | unified.Plugin): Promise<unified.Plugin>
 	return p;
 }
 
-export function loadPlugins(items: Plugin[]): Promise<[unified.Plugin, any?]>[] {
+export function loadPlugins(
+	items: (string | [string, any] | unified.Plugin<any[], any> | [unified.Plugin<any[], any>, any])[]
+): Promise<[unified.Plugin, any?]>[] {
 	return items.map((p) => {
 		return new Promise((resolve, reject) => {
 			if (Array.isArray(p)) {

package/src/remark-shiki.ts

@@ -1,34 +1,7 @@
 import type * as shiki from 'shiki';
 import { getHighlighter } from 'shiki';
 import { visit } from 'unist-util-visit';
-
-export interface ShikiConfig {
-	/**
-	 * The languages loaded to Shiki.
-	 * Supports all languages listed here: https://github.com/shikijs/shiki/blob/main/docs/languages.md#all-languages
-	 * Instructions for loading a custom language: https://github.com/shikijs/shiki/blob/main/docs/languages.md#supporting-your-own-languages-with-shiki
-	 *
-	 * @default []
-	 */
-	langs?: shiki.ILanguageRegistration[];
-	/**
-	 * The styling theme.
-	 * Supports all themes listed here: https://github.com/shikijs/shiki/blob/main/docs/themes.md#all-themes
-	 * Instructions for loading a custom theme: https://github.com/shikijs/shiki/blob/main/docs/themes.md#loading-theme
-	 *
-	 * @default "github-dark"
-	 */
-	theme?: shiki.IThemeRegistration;
-	/**
-	 * Enable word wrapping.
-	 *  - true: enabled.
-	 *  - false: enabled.
-	 *  - null: All overflow styling removed. Code will overflow the element by default.
-	 *
-	 * @default false
-	 */
-	wrap?: boolean | null;
-}
+import type { ShikiConfig } from './types.js';
 
 /**
  * getHighlighter() is the most expensive step of Shiki. Instead of calling it on every page,
@@ -38,7 +11,7 @@ export interface ShikiConfig {
 const highlighterCacheAsync = new Map<string, Promise<shiki.Highlighter>>();
 
 const remarkShiki = async (
-	{ langs = [], theme = 'github-dark', wrap = false }: ShikiConfig,
+	{ langs, theme, wrap }: ShikiConfig,
 	scopedClassName?: string | null
 ) => {
 	const cacheID: string = typeof theme === 'string' ? theme : theme.name;

package/src/types.ts

@@ -1,18 +1,40 @@
 import type * as unified from 'unified';
-import type { ShikiConfig } from './remark-shiki';
-export { ShikiConfig };
+import type * as mdast from 'mdast';
+import type * as hast from 'hast';
+import type { ILanguageRegistration, IThemeRegistration, Theme } from 'shiki';
 
-export type Plugin = string | [string, any] | unified.Plugin | [unified.Plugin, any];
+export type { Node } from 'unist';
+
+export type RemarkPlugin<PluginParameters extends any[] = any[]> = unified.Plugin<
+	PluginParameters,
+	mdast.Root
+>;
+
+export type RemarkPlugins = (string | [string, any] | RemarkPlugin | [RemarkPlugin, any])[];
+
+export type RehypePlugin<PluginParameters extends any[] = any[]> = unified.Plugin<
+	PluginParameters,
+	hast.Root
+>;
+
+export type RehypePlugins = (string | [string, any] | RehypePlugin | [RehypePlugin, any])[];
+
+export interface ShikiConfig {
+	langs: ILanguageRegistration[];
+	theme: Theme | IThemeRegistration;
+	wrap: boolean | null;
+}
 
 export interface AstroMarkdownOptions {
-	mode?: 'md' | 'mdx';
-	syntaxHighlight?: 'shiki' | 'prism' | false;
-	shikiConfig?: ShikiConfig;
-	remarkPlugins?: Plugin[];
-	rehypePlugins?: Plugin[];
+	mode: 'md' | 'mdx';
+	drafts: boolean;
+	syntaxHighlight: 'shiki' | 'prism' | false;
+	shikiConfig: ShikiConfig;
+	remarkPlugins: RemarkPlugins;
+	rehypePlugins: RehypePlugins;
 }
 
-export interface MarkdownRenderingOptions extends Partial<AstroMarkdownOptions> {
+export interface MarkdownRenderingOptions extends AstroMarkdownOptions {
 	/** @internal */
 	$?: {
 		scopedClassName: string | null;

package/.turbo/turbo-build.log

@@ -1,5 +0,0 @@
-@astrojs/markdown-remark:build: cache hit, replaying output 5817ab166c77bc86
-@astrojs/markdown-remark:build: 
-@astrojs/markdown-remark:build: > @astrojs/markdown-remark@0.8.1 build /Users/fks/Code/astro/packages/markdown/remark
-@astrojs/markdown-remark:build: > astro-scripts build "src/**/*.ts" && tsc -p tsconfig.json
-@astrojs/markdown-remark:build: