@astrojs/markdown-remark 0.7.0-next.0 → 0.8.0

package/.turbo/turbo-build.log

@@ -0,0 +1,5 @@
+@astrojs/markdown-remark:build: cache hit, replaying output 6e22a141f5baff6f
+@astrojs/markdown-remark:build: 
+@astrojs/markdown-remark:build: > @astrojs/markdown-remark@0.8.0 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: 

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @astrojs/markdown-remark
 
+## 0.8.0
+
+### Minor Changes
+
+- [`e425f896`](https://github.com/withastro/astro/commit/e425f896b668d98033ad3b998b50c1f28bc7f6ee) Thanks [@FredKSchott](https://github.com/FredKSchott)! - Update config options to resepect [RFC0019](https://github.com/withastro/rfcs/blob/main/proposals/0019-config-finalization.md)
+
+## 0.7.0
+
+### Minor Changes
+
+- [#2824](https://github.com/withastro/astro/pull/2824) [`0a3d3e51`](https://github.com/withastro/astro/commit/0a3d3e51a66af80fa949ba0f5e2104439d2be634) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Change shiki to our default markdown syntax highlighter. This includes updates to all relevant starter projects that used Prism-specific styles.
+
+### Patch Changes
+
+- [#2870](https://github.com/withastro/astro/pull/2870) [`d763ec18`](https://github.com/withastro/astro/commit/d763ec183ea391ad79ca16bf2b2e76848fc1180c) Thanks [@FredKSchott](https://github.com/FredKSchott)! - Fix a shiki performance issue affecting large sites
+
+- Updated dependencies [[`2db97f10`](https://github.com/withastro/astro/commit/2db97f10dc50f9498413181b78c477fe8833895b)]:
+  - @astrojs/prism@0.4.1
+
+## 0.7.0-next.1
+
+### Patch Changes
+
+- [#2870](https://github.com/withastro/astro/pull/2870) [`d763ec18`](https://github.com/withastro/astro/commit/d763ec183ea391ad79ca16bf2b2e76848fc1180c) Thanks [@FredKSchott](https://github.com/FredKSchott)! - Fix a shiki performance issue affecting large sites
+
+- Updated dependencies [[`2db97f10`](https://github.com/withastro/astro/commit/2db97f10dc50f9498413181b78c477fe8833895b)]:
+  - @astrojs/prism@0.4.1-next.0
+
 ## 0.7.0-next.0
 
 ### Minor Changes
@@ -165,10 +193,10 @@
 
   ```js
   export default {
-  	markdownOptions: {
-  		remarkPlugins: ['remark-slug', ['remark-autolink-headings', { behavior: 'prepend' }]],
-  		rehypePlugins: ['rehype-slug', ['rehype-autolink-headings', { behavior: 'prepend' }]],
-  	},
+    markdownOptions: {
+      remarkPlugins: ['remark-slug', ['remark-autolink-headings', { behavior: 'prepend' }]],
+      rehypePlugins: ['rehype-slug', ['rehype-autolink-headings', { behavior: 'prepend' }]],
+    },
   };
   ```
 

package/LICENSE

@@ -21,21 +21,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
 
-"""
-This license applies to parts of the `packages/astro-parser` subdirectory originating from the
-https://github.com/sveltejs/svelte repository:
-
-
-Copyright (c) 2016-21 [these people](https://github.com/sveltejs/svelte/graphs/contributors)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-"""
-
-
 """
 This license applies to parts of the `packages/create-astro` and `packages/astro` subdirectories originating from the https://github.com/sveltejs/kit repository:
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import type { AstroMarkdownOptions, MarkdownRenderingOptions } from './types';
-export { AstroMarkdownOptions, MarkdownRenderingOptions };
+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: {

package/dist/remark-prism.js

@@ -1,6 +1,6 @@
 import { visit } from "unist-util-visit";
 import Prism from "prismjs";
-import { addAstro } from "@astrojs/prism";
+import { addAstro } from "@astrojs/prism/internal";
 import loadLanguages from "prismjs/components/index.js";
 const noVisit = /* @__PURE__ */ new Set(["root", "html", "text"]);
 const languageMap = /* @__PURE__ */ new Map([["ts", "typescript"]]);

package/dist/remark-shiki.js

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

package/dist/types.d.ts

@@ -1,5 +1,6 @@
 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];
 export interface AstroMarkdownOptions {
     mode?: 'md' | 'mdx';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/markdown-remark",
-  "version": "0.7.0-next.0",
+  "version": "0.8.0",
   "type": "module",
   "author": "withastro",
   "license": "MIT",
@@ -16,7 +16,7 @@
     ".": "./dist/index.js"
   },
   "dependencies": {
-    "@astrojs/prism": "^0.4.0",
+    "@astrojs/prism": "^0.4.1",
     "assert": "^2.0.0",
     "github-slugger": "^1.4.0",
     "gray-matter": "^4.0.3",
@@ -35,7 +35,7 @@
     "remark-smartypants": "^2.0.0",
     "shiki": "^0.10.1",
     "unified": "^10.1.2",
-    "unist-util-map": "^3.0.0",
+    "unist-util-map": "^3.0.1",
     "unist-util-visit": "^4.1.0"
   },
   "devDependencies": {
@@ -46,6 +46,7 @@
   "scripts": {
     "prepublish": "pnpm build",
     "build": "astro-scripts build \"src/**/*.ts\" && tsc -p tsconfig.json",
+    "build:ci": "astro-scripts build \"src/**/*.ts\"",
     "postbuild": "astro-scripts copy \"src/**/*.js\"",
     "dev": "astro-scripts dev \"src/**/*.ts\""
   }

package/src/index.ts

@@ -1,4 +1,4 @@
-import type { AstroMarkdownOptions, MarkdownRenderingOptions } from './types';
+import type { AstroMarkdownOptions, MarkdownRenderingOptions, ShikiConfig, Plugin } from './types';
 
 import createCollectHeaders from './rehype-collect-headers.js';
 import scopedStyles from './remark-scoped-styles.js';
@@ -20,7 +20,7 @@ import rehypeStringify from 'rehype-stringify';
 import rehypeRaw from 'rehype-raw';
 import matter from 'gray-matter';
 
-export { AstroMarkdownOptions, MarkdownRenderingOptions };
+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) {

package/src/remark-prism.ts

@@ -1,6 +1,6 @@
 import { visit } from 'unist-util-visit';
 import Prism from 'prismjs';
-import { addAstro } from '@astrojs/prism';
+import { addAstro } from '@astrojs/prism/internal';
 import loadLanguages from 'prismjs/components/index.js';
 const noVisit = new Set(['root', 'html', 'text']);
 

package/src/remark-shiki.ts

@@ -33,19 +33,25 @@ export interface ShikiConfig {
 /**
  * getHighlighter() is the most expensive step of Shiki. Instead of calling it on every page,
  * cache it here as much as possible. Make sure that your highlighters can be cached, state-free.
+ * We make this async, so that multiple calls to parse markdown still share the same highlighter.
  */
-const highlighterCache = new Map<string, shiki.Highlighter>();
+const highlighterCacheAsync = new Map<string, Promise<shiki.Highlighter>>();
 
 const remarkShiki = async ({ langs = [], theme = 'github-dark', wrap = false }: ShikiConfig, scopedClassName?: string | null) => {
 	const cacheID: string = typeof theme === 'string' ? theme : theme.name;
-	let highlighter = highlighterCache.get(cacheID);
-	if (!highlighter) {
-		highlighter = await getHighlighter({ theme });
-		highlighterCache.set(cacheID, highlighter);
+	let highlighterAsync = highlighterCacheAsync.get(cacheID);
+	if (!highlighterAsync) {
+		highlighterAsync = getHighlighter({ theme });
+		highlighterCacheAsync.set(cacheID, highlighterAsync);
 	}
+	const highlighter = await highlighterAsync;
+
+	// NOTE: There may be a performance issue here for large sites that use `lang`.
+	// Since this will be called on every page load. Unclear how to fix this.
 	for (const lang of langs) {
 		await highlighter.loadLanguage(lang);
 	}
+
 	return () => (tree: any) => {
 		visit(tree, 'code', (node) => {
 			let html = highlighter!.codeToHtml(node.value, { lang: node.lang ?? 'plaintext' });

package/src/types.ts

@@ -1,5 +1,6 @@
 import type * as unified from 'unified';
 import type { ShikiConfig } from './remark-shiki';
+export { ShikiConfig };
 
 export type Plugin = string | [string, any] | unified.Plugin | [unified.Plugin, any];