@astrojs/markdown-remark 2.2.0 → 2.2.1

package/src/types.ts

@@ -1,96 +0,0 @@
-import type * as hast from 'hast';
-import type * as mdast from 'mdast';
-import type {
-	all as Handlers,
-	one as Handler,
-	Options as RemarkRehypeOptions,
-} from 'remark-rehype';
-import type { ILanguageRegistration, IThemeRegistration, Theme } from 'shiki';
-import type * as unified from 'unified';
-import type { VFile } from 'vfile';
-
-export type { Node } from 'unist';
-
-export type MarkdownAstroData = {
-	frontmatter: Record<string, any>;
-};
-
-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 type RemarkRehype = Omit<RemarkRehypeOptions, 'handlers' | 'unknownHandler'> & {
-	handlers?: typeof Handlers;
-	handler?: typeof Handler;
-};
-
-export interface ShikiConfig {
-	langs?: ILanguageRegistration[];
-	theme?: Theme | IThemeRegistration;
-	wrap?: boolean | null;
-}
-
-export interface AstroMarkdownOptions {
-	drafts?: boolean;
-	syntaxHighlight?: 'shiki' | 'prism' | false;
-	shikiConfig?: ShikiConfig;
-	remarkPlugins?: RemarkPlugins;
-	rehypePlugins?: RehypePlugins;
-	remarkRehype?: RemarkRehype;
-	gfm?: boolean;
-	smartypants?: boolean;
-}
-
-export interface ImageMetadata {
-	src: string;
-	width: number;
-	height: number;
-	type: string;
-}
-
-export interface MarkdownRenderingOptions extends AstroMarkdownOptions {
-	/** @internal */
-	fileURL?: URL;
-	/** @internal */
-	$?: {
-		scopedClassName: string | null;
-	};
-	/** Used for frontmatter injection plugins */
-	frontmatter?: Record<string, any>;
-	experimentalAssets?: boolean;
-}
-
-export interface MarkdownHeading {
-	depth: number;
-	slug: string;
-	text: string;
-}
-
-export interface MarkdownMetadata {
-	headings: MarkdownHeading[];
-	source: string;
-	html: string;
-}
-
-export interface MarkdownVFile extends VFile {
-	data: {
-		__astroHeadings?: MarkdownHeading[];
-		imagePaths?: Set<string>;
-	};
-}
-
-export interface MarkdownRenderingResult {
-	metadata: MarkdownMetadata;
-	vfile: MarkdownVFile;
-	code: string;
-}

package/test/autolinking.test.js

@@ -1,43 +0,0 @@
-import { renderMarkdown } from '../dist/index.js';
-import chai from 'chai';
-import { mockRenderMarkdownParams } from './test-utils.js';
-
-describe('autolinking', () => {
-	describe('plain md', () => {
-		it('autolinks URLs starting with a protocol in plain text', async () => {
-			const { code } = await renderMarkdown(
-				`See https://example.com for more.`,
-				mockRenderMarkdownParams
-			);
-
-			chai
-				.expect(code.replace(/\n/g, ''))
-				.to.equal(`<p>See <a href="https://example.com">https://example.com</a> for more.</p>`);
-		});
-
-		it('autolinks URLs starting with "www." in plain text', async () => {
-			const { code } = await renderMarkdown(
-				`See www.example.com for more.`,
-				mockRenderMarkdownParams
-			);
-
-			chai
-				.expect(code.trim())
-				.to.equal(`<p>See <a href="http://www.example.com">www.example.com</a> for more.</p>`);
-		});
-
-		it('does not autolink URLs in code blocks', async () => {
-			const { code } = await renderMarkdown(
-				'See `https://example.com` or `www.example.com` for more.',
-				mockRenderMarkdownParams
-			);
-
-			chai
-				.expect(code.trim())
-				.to.equal(
-					`<p>See <code>https://example.com</code> or ` +
-						`<code>www.example.com</code> for more.</p>`
-				);
-		});
-	});
-});

package/test/entities.test.js

@@ -1,14 +0,0 @@
-import { renderMarkdown } from '../dist/index.js';
-import { expect } from 'chai';
-import { mockRenderMarkdownParams } from './test-utils.js';
-
-describe('entities', () => {
-	it('should not unescape entities in regular Markdown', async () => {
-		const { code } = await renderMarkdown(
-			`<i>This should NOT be italic</i>`,
-			mockRenderMarkdownParams
-		);
-
-		expect(code).to.equal(`<p>&#x3C;i>This should NOT be italic&#x3C;/i></p>`);
-	});
-});

package/test/plugins.test.js

@@ -1,28 +0,0 @@
-import { renderMarkdown } from '../dist/index.js';
-import { mockRenderMarkdownParams } from './test-utils.js';
-import chai from 'chai';
-
-import { fileURLToPath } from 'node:url';
-
-describe('plugins', () => {
-	// https://github.com/withastro/astro/issues/3264
-	it('should be able to get file path when passing fileURL', async () => {
-		let context;
-		await renderMarkdown(`test`, {
-			...mockRenderMarkdownParams,
-			fileURL: new URL('virtual.md', import.meta.url),
-			remarkPlugins: [
-				function () {
-					const transformer = (tree, file) => {
-						context = file;
-					};
-
-					return transformer;
-				},
-			],
-		});
-
-		chai.expect(typeof context).to.equal('object');
-		chai.expect(context.path).to.equal(fileURLToPath(new URL('virtual.md', import.meta.url)));
-	});
-});

package/test/test-utils.js

@@ -1,3 +0,0 @@
-export const mockRenderMarkdownParams = {
-	contentDir: new URL('file:///src/content/'),
-};

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "../../../tsconfig.base.json",
-  "include": ["src"],
-  "compilerOptions": {
-    "allowJs": true,
-    "target": "ES2021",
-    "module": "ES2022",
-    "outDir": "./dist"
-  }
-}