@astrojs/markdown-remark 2.0.0-beta.0 → 2.0.0-beta.2

package/src/remark-mdxish.ts

@@ -1,61 +0,0 @@
-import type * as fromMarkdown from 'mdast-util-from-markdown';
-import type { Tag } from 'mdast-util-mdx-jsx';
-import { mdxFromMarkdown, mdxToMarkdown } from './mdast-util-mdxish.js';
-import { mdxjs } from './mdxjs.js';
-
-// Prepare markdown extensions once to prevent performance issues
-const extMdxJs = mdxjs({});
-const extMdxFromMarkdown = makeFromMarkdownLessStrict(mdxFromMarkdown());
-const extMdxToMarkdown = mdxToMarkdown();
-
-export default function remarkMdxish(this: any) {
-	const data = this.data();
-
-	add('micromarkExtensions', extMdxJs);
-	add('fromMarkdownExtensions', extMdxFromMarkdown);
-	add('toMarkdownExtensions', extMdxToMarkdown);
-
-	function add(field: string, value: unknown) {
-		const list = data[field] ? data[field] : (data[field] = []);
-		list.push(value);
-	}
-}
-
-function makeFromMarkdownLessStrict(extensions: fromMarkdown.Extension[]) {
-	extensions.forEach((extension) => {
-		// Fix exit handlers that are too strict
-		['mdxJsxFlowTag', 'mdxJsxTextTag'].forEach((exitHandler) => {
-			if (!extension.exit || !extension.exit[exitHandler]) return;
-			extension.exit[exitHandler] = chainHandlers(fixSelfClosing, extension.exit[exitHandler]);
-		});
-	});
-
-	return extensions;
-}
-
-const selfClosingTags = new Set([
-	'area',
-	'base',
-	'br',
-	'col',
-	'embed',
-	'hr',
-	'img',
-	'input',
-	'link',
-	'meta',
-	'source',
-	'track',
-	'wbr',
-]);
-
-function fixSelfClosing(this: fromMarkdown.CompileContext) {
-	const tag = this.getData('mdxJsxTag') as Tag;
-	if (tag.name && selfClosingTags.has(tag.name)) tag.selfClosing = true;
-}
-
-function chainHandlers(...handlers: fromMarkdown.Handle[]) {
-	return function handlerChain(this: fromMarkdown.CompileContext, token: fromMarkdown.Token) {
-		handlers.forEach((handler) => handler.call(this, token));
-	};
-}

package/src/remark-unwrap.ts

@@ -1,44 +0,0 @@
-import { SKIP, visit as _visit } from 'unist-util-visit';
-
-// This is a workaround.
-// It fixes a compatibility issue between different, incompatible ASTs given by plugins to Unist
-const visit = _visit as (
-	node: any,
-	type: string,
-	callback?: (node: any, index: number, parent: any) => any
-) => any;
-
-// Remove the wrapping paragraph for <astro-island> islands
-export default function remarkUnwrap() {
-	const astroRootNodes = new Set();
-	let insideAstroRoot = false;
-
-	return (tree: any) => {
-		// reset state
-		insideAstroRoot = false;
-		astroRootNodes.clear();
-
-		visit(tree, 'html', (node) => {
-			if (node.value.indexOf('<astro-island') > -1 && !insideAstroRoot) {
-				insideAstroRoot = true;
-			}
-			if (node.value.indexOf('</astro-island') > -1 && insideAstroRoot) {
-				insideAstroRoot = false;
-			}
-			astroRootNodes.add(node);
-		});
-
-		visit(tree, 'paragraph', (node, index, parent) => {
-			if (parent && typeof index === 'number' && containsAstroRootNode(node)) {
-				parent.children.splice(index, 1, ...node.children);
-				return [SKIP, index];
-			}
-		});
-	};
-
-	function containsAstroRootNode(node: any) {
-		return node.children
-			.map((child: any) => astroRootNodes.has(child))
-			.reduce((all: boolean, v: boolean) => (all ? all : v), false);
-	}
-}

package/test/components.test.js

@@ -1,78 +0,0 @@
-import { renderMarkdown } from '../dist/index.js';
-import chai from 'chai';
-
-describe('components', () => {
-	const renderAstroMd = (text) => renderMarkdown(text, { isAstroFlavoredMd: true });
-
-	it('should be able to serialize string', async () => {
-		const { code } = await renderAstroMd(`<Component str="cool!" />`);
-
-		chai.expect(code).to.equal(`<Component str="cool!" />`);
-	});
-
-	it('should be able to serialize boolean attribute', async () => {
-		const { code } = await renderAstroMd(`<Component bool={true} />`);
-
-		chai.expect(code).to.equal(`<Component bool={true} />`);
-	});
-
-	it('should be able to serialize array', async () => {
-		const { code } = await renderAstroMd(`<Component prop={["a", "b", "c"]} />`);
-
-		chai.expect(code).to.equal(`<Component prop={["a", "b", "c"]} />`);
-	});
-
-	it('should be able to serialize object', async () => {
-		const { code } = await renderAstroMd(`<Component prop={{ a: 0, b: 1, c: 2 }} />`);
-
-		chai.expect(code).to.equal(`<Component prop={{ a: 0, b: 1, c: 2 }} />`);
-	});
-
-	it('should be able to serialize empty attribute', async () => {
-		const { code } = await renderAstroMd(`<Component empty />`);
-
-		chai.expect(code).to.equal(`<Component empty />`);
-	});
-
-	// Notable omission: shorthand attribute
-
-	it('should be able to serialize spread attribute', async () => {
-		const { code } = await renderAstroMd(`<Component {...spread} />`);
-
-		chai.expect(code).to.equal(`<Component {...spread} />`);
-	});
-
-	it('should allow client:* directives', async () => {
-		const { code } = await renderAstroMd(`<Component client:load />`);
-
-		chai.expect(code).to.equal(`<Component client:load />`);
-	});
-
-	it('should normalize children', async () => {
-		const { code } = await renderAstroMd(`<Component bool={true}>Hello world!</Component>`);
-
-		chai.expect(code).to.equal(`<Component bool={true}>Hello world!</Component>`);
-	});
-
-	it('should be able to nest components', async () => {
-		const { code } = await renderAstroMd(
-			`<Component bool={true}><Component>Hello world!</Component></Component>`,
-			{}
-		);
-
-		chai
-			.expect(code)
-			.to.equal(`<Component bool={true}><Component>Hello world!</Component></Component>`);
-	});
-
-	it('should allow markdown without many spaces', async () => {
-		const { code } = await renderAstroMd(
-			`<Component>
-# Hello world!
-</Component>`,
-			{}
-		);
-
-		chai.expect(code).to.equal(`<Component><h1 id="hello-world">Hello world!</h1></Component>`);
-	});
-});

package/test/expressions.test.js

@@ -1,125 +0,0 @@
-import { renderMarkdown } from '../dist/index.js';
-import chai from 'chai';
-
-describe('expressions', () => {
-	const renderAstroMd = (text, opts) => renderMarkdown(text, { isAstroFlavoredMd: true, ...opts });
-
-	it('should be able to serialize bare expression', async () => {
-		const { code } = await renderAstroMd(`{a}`, {});
-
-		chai.expect(code).to.equal(`{a}`);
-	});
-
-	it('should be able to serialize expression inside component', async () => {
-		const { code } = await renderAstroMd(`<Component>{a}</Component>`, {});
-
-		chai.expect(code).to.equal(`<Component>{a}</Component>`);
-	});
-
-	it('should be able to serialize expression inside markdown', async () => {
-		const { code } = await renderAstroMd(`# {frontmatter.title}`, {});
-
-		chai
-			.expect(code)
-			.to.equal(`<h1 id={$$slug(\`\${frontmatter.title}\`)}>{frontmatter.title}</h1>`);
-	});
-
-	it('should be able to serialize complex expression inside markdown', async () => {
-		const { code } = await renderAstroMd(`# Hello {frontmatter.name}`, {});
-
-		chai
-			.expect(code)
-			.to.equal(`<h1 id={$$slug(\`Hello \${frontmatter.name}\`)}>Hello {frontmatter.name}</h1>`);
-	});
-
-	it('should be able to serialize complex expression with markup inside markdown', async () => {
-		const { code } = await renderAstroMd(`# Hello <span>{frontmatter.name}</span>`, {});
-
-		chai
-			.expect(code)
-			.to.equal(
-				`<h1 id={$$slug(\`Hello \${frontmatter.name}\`)}>Hello <span>{frontmatter.name}</span></h1>`
-			);
-	});
-
-	it('should be able to avoid evaluating JSX-like expressions in an inline code & generate a slug for id', async () => {
-		const { code } = await renderAstroMd(`# \`{frontmatter.title}\``, {});
-
-		chai
-			.expect(code)
-			.to.equal('<h1 id="frontmattertitle"><code is:raw>{frontmatter.title}</code></h1>');
-	});
-
-	it('should be able to avoid evaluating JSX-like expressions in inline codes', async () => {
-		const { code } = await renderAstroMd(`# \`{ foo }\` is a shorthand for \`{ foo: foo }\``, {});
-
-		chai
-			.expect(code)
-			.to.equal(
-				'<h1 id="-foo--is-a-shorthand-for--foo-foo"><code is:raw>{ foo }</code> is a shorthand for <code is:raw>{ foo: foo }</code></h1>'
-			);
-	});
-
-	it('should be able to avoid evaluating JSX-like expressions & escape HTML tag characters in inline codes', async () => {
-		const { code } = await renderAstroMd(
-			`###### \`{}\` is equivalent to \`Record<never, never>\` <small>(at TypeScript v{frontmatter.version})</small>`,
-			{}
-		);
-
-		chai
-			.expect(code)
-			.to.equal(
-				`<h6 id={$$slug(\`{} is equivalent to Record&lt;never, never&gt; (at TypeScript v\${frontmatter.version})\`)}><code is:raw>{}</code> is equivalent to <code is:raw>Record&lt;never, never&gt;</code> <small>(at TypeScript v{frontmatter.version})</small></h6>`
-			);
-	});
-
-	it('should be able to encode ampersand characters in code blocks', async () => {
-		const { code } = await renderAstroMd(
-			'The ampersand in `&nbsp;` must be encoded in code blocks.',
-			{}
-		);
-
-		chai
-			.expect(code)
-			.to.equal(
-				'<p>The ampersand in <code is:raw>&amp;nbsp;</code> must be encoded in code blocks.</p>'
-			);
-	});
-
-	it('should be able to encode ampersand characters in fenced code blocks', async () => {
-		const { code } = await renderAstroMd(`
-		\`\`\`md
-			The ampersand in \`&nbsp;\` must be encoded in code blocks.
-		\`\`\`
-		`);
-
-		chai.expect(code).to.match(/^<pre is:raw.*<code>.*The ampersand in `&amp;nbsp;`/);
-	});
-
-	it('should be able to serialize function expression', async () => {
-		const { code } = await renderAstroMd(
-			`{frontmatter.list.map(item => <p id={item}>{item}</p>)}`,
-			{}
-		);
-
-		chai.expect(code).to.equal(`{frontmatter.list.map(item => <p id={item}>{item}</p>)}`);
-	});
-
-	it('should unwrap HTML comments in inline code blocks', async () => {
-		const { code } = await renderAstroMd(`\`{/*<!-- HTML comment -->*/}\``);
-
-		chai.expect(code).to.equal('<p><code is:raw>&lt;!-- HTML comment --&gt;</code></p>');
-	});
-
-	it('should unwrap HTML comments in code fences', async () => {
-		const { code } = await renderAstroMd(
-			`
-			  \`\`\`
-				<!-- HTML comment -->
-				\`\`\`
-			`
-		);
-
-		chai.expect(code).to.match(/(?<!{\/\*)&lt;!-- HTML comment --&gt;(?!\*\/})/);
-	});
-});

package/test/strictness.test.js

@@ -1,98 +0,0 @@
-import { renderMarkdown } from '../dist/index.js';
-import chai from 'chai';
-
-describe('strictness in Astro-flavored markdown', () => {
-	const renderAstroMd = (text, opts) => renderMarkdown(text, { isAstroFlavoredMd: true, ...opts });
-
-	it('should allow self-closing HTML tags (void elements)', async () => {
-		const { code } = await renderAstroMd(
-			`Use self-closing void elements<br>like word<wbr>break and images: <img src="hi.jpg">`,
-			{}
-		);
-
-		chai
-			.expect(code)
-			.to.equal(
-				`<p>Use self-closing void elements<br />like word<wbr />break and images: ` +
-					`<img src="hi.jpg" /></p>`
-			);
-	});
-
-	it('should allow attribute names starting with ":" after element names', async () => {
-		const { code } = await renderAstroMd(`<div :class="open ? '' : 'hidden'">Test</div>`, {});
-
-		chai.expect(code.trim()).to.equal(`<div :class="open ? '' : 'hidden'">Test</div>`);
-	});
-
-	it('should allow attribute names starting with ":" after local element names', async () => {
-		const { code } = await renderAstroMd(`<div.abc :class="open ? '' : 'hidden'">x</div.abc>`, {});
-
-		chai.expect(code.trim()).to.equal(`<div.abc :class="open ? '' : 'hidden'">x</div.abc>`);
-	});
-
-	it('should allow attribute names starting with ":" after attribute names', async () => {
-		const { code } = await renderAstroMd(`<input type="text" disabled :placeholder="hi">`, {});
-
-		chai.expect(code.trim()).to.equal(`<input type="text" disabled :placeholder="hi" />`);
-	});
-
-	it('should allow attribute names starting with ":" after local attribute names', async () => {
-		const { code } = await renderAstroMd(
-			`<input type="text" x-test:disabled :placeholder="hi">`,
-			{}
-		);
-
-		chai.expect(code.trim()).to.equal(`<input type="text" x-test:disabled :placeholder="hi" />`);
-	});
-
-	it('should allow attribute names starting with ":" after attribute values', async () => {
-		const { code } = await renderAstroMd(`<input type="text" :placeholder="placeholder">`, {});
-
-		chai.expect(code.trim()).to.equal(`<input type="text" :placeholder="placeholder" />`);
-	});
-
-	it('should allow attribute names starting with "@" after element names', async () => {
-		const { code } = await renderAstroMd(`<button @click="handleClick">Test</button>`, {});
-
-		chai.expect(code.trim()).to.equal(`<button @click="handleClick">Test</button>`);
-	});
-
-	it('should allow attribute names starting with "@" after local element names', async () => {
-		const { code } = await renderAstroMd(
-			`<button.local @click="handleClick">Test</button.local>`,
-			{}
-		);
-
-		chai.expect(code.trim()).to.equal(`<button.local @click="handleClick">Test</button.local>`);
-	});
-
-	it('should allow attribute names starting with "@" after attribute names', async () => {
-		const { code } = await renderAstroMd(`<button disabled @click="handleClick">Test</button>`, {});
-
-		chai.expect(code.trim()).to.equal(`<button disabled @click="handleClick">Test</button>`);
-	});
-
-	it('should allow attribute names starting with "@" after local attribute names', async () => {
-		const { code } = await renderAstroMd(
-			`<button x-test:disabled @click="handleClick">Test</button>`,
-			{}
-		);
-
-		chai.expect(code.trim()).to.equal(`<button x-test:disabled @click="handleClick">Test</button>`);
-	});
-
-	it('should allow attribute names starting with "@" after attribute values', async () => {
-		const { code } = await renderAstroMd(
-			`<button type="submit" @click="handleClick">Test</button>`,
-			{}
-		);
-
-		chai.expect(code.trim()).to.equal(`<button type="submit" @click="handleClick">Test</button>`);
-	});
-
-	it('should allow attribute names containing dots', async () => {
-		const { code } = await renderAstroMd(`<input x-on:input.debounce.500ms="fetchResults">`, {});
-
-		chai.expect(code.trim()).to.equal(`<input x-on:input.debounce.500ms="fetchResults" />`);
-	});
-});