From 01c801108f1f5429436e4fc930018bf96ed31f79 Mon Sep 17 00:00:00 2001 From: Luca Di Gianventura Date: Fri, 27 Oct 2023 11:45:02 +0200 Subject: [PATCH] Fix: Markdoc Integration build when root folder contains spaces (#8759) Co-authored-by: Arsh <69170106+lilnasy@users.noreply.github.com> --- .changeset/seven-files-punch.md | 5 +++ .../markdoc/src/content-entry-type.ts | 4 +-- .../render with-space/astro.config.mjs | 7 ++++ .../fixtures/render with-space/package.json | 9 ++++++ .../src/content/blog/simple.mdoc | 7 ++++ .../render with-space/src/pages/index.astro | 19 +++++++++++ .../integrations/markdoc/test/render.test.js | 32 +++++++++++++++++++ pnpm-lock.yaml | 9 ++++++ 8 files changed, 90 insertions(+), 2 deletions(-) create mode 100644 .changeset/seven-files-punch.md create mode 100644 packages/integrations/markdoc/test/fixtures/render with-space/astro.config.mjs create mode 100644 packages/integrations/markdoc/test/fixtures/render with-space/package.json create mode 100644 packages/integrations/markdoc/test/fixtures/render with-space/src/content/blog/simple.mdoc create mode 100644 packages/integrations/markdoc/test/fixtures/render with-space/src/pages/index.astro diff --git a/.changeset/seven-files-punch.md b/.changeset/seven-files-punch.md new file mode 100644 index 0000000000..d46a274222 --- /dev/null +++ b/.changeset/seven-files-punch.md @@ -0,0 +1,5 @@ +--- +'@astrojs/markdoc': patch +--- + +Fix build process on markdoc integration when root folder contains spaces diff --git a/packages/integrations/markdoc/src/content-entry-type.ts b/packages/integrations/markdoc/src/content-entry-type.ts index f682e114fc..07c5268e4c 100644 --- a/packages/integrations/markdoc/src/content-entry-type.ts +++ b/packages/integrations/markdoc/src/content-entry-type.ts @@ -106,7 +106,7 @@ export async function getContentEntryType({ import { createGetHeadings, createContentComponent } from '@astrojs/markdoc/runtime'; ${ markdocConfigUrl - ? `import markdocConfig from ${JSON.stringify(markdocConfigUrl.pathname)};` + ? `import markdocConfig from ${JSON.stringify(fileURLToPath(markdocConfigUrl))};` : 'const markdocConfig = {};' } @@ -230,7 +230,7 @@ function getStringifiedImports( ? `{ ${config.namedExport} as ${componentNamePrefix + toImportName(key)} }` : componentNamePrefix + toImportName(key); const resolvedPath = - config.type === 'local' ? new URL(config.path, root).pathname : config.path; + config.type === 'local' ? fileURLToPath(new URL(config.path, root)) : config.path; stringifiedComponentImports += `import ${importName} from ${JSON.stringify(resolvedPath)};\n`; } diff --git a/packages/integrations/markdoc/test/fixtures/render with-space/astro.config.mjs b/packages/integrations/markdoc/test/fixtures/render with-space/astro.config.mjs new file mode 100644 index 0000000000..29d846359b --- /dev/null +++ b/packages/integrations/markdoc/test/fixtures/render with-space/astro.config.mjs @@ -0,0 +1,7 @@ +import { defineConfig } from 'astro/config'; +import markdoc from '@astrojs/markdoc'; + +// https://astro.build/config +export default defineConfig({ + integrations: [markdoc()], +}); diff --git a/packages/integrations/markdoc/test/fixtures/render with-space/package.json b/packages/integrations/markdoc/test/fixtures/render with-space/package.json new file mode 100644 index 0000000000..daae654430 --- /dev/null +++ b/packages/integrations/markdoc/test/fixtures/render with-space/package.json @@ -0,0 +1,9 @@ +{ + "name": "@test/markdoc-render-with-space", + "version": "0.0.0", + "private": true, + "dependencies": { + "@astrojs/markdoc": "workspace:*", + "astro": "workspace:*" + } +} diff --git a/packages/integrations/markdoc/test/fixtures/render with-space/src/content/blog/simple.mdoc b/packages/integrations/markdoc/test/fixtures/render with-space/src/content/blog/simple.mdoc new file mode 100644 index 0000000000..2dbe492fe1 --- /dev/null +++ b/packages/integrations/markdoc/test/fixtures/render with-space/src/content/blog/simple.mdoc @@ -0,0 +1,7 @@ +--- +title: Simple post with root folder containing a space +--- + +## Simple post with root folder containing a space + +This is a simple Markdoc post with root folder containing a space. diff --git a/packages/integrations/markdoc/test/fixtures/render with-space/src/pages/index.astro b/packages/integrations/markdoc/test/fixtures/render with-space/src/pages/index.astro new file mode 100644 index 0000000000..940eef1540 --- /dev/null +++ b/packages/integrations/markdoc/test/fixtures/render with-space/src/pages/index.astro @@ -0,0 +1,19 @@ +--- +import { getEntryBySlug } from "astro:content"; + +const post = await getEntryBySlug('blog', 'simple'); +const { Content } = await post.render(); +--- + + + + + + + + Content + + + + + diff --git a/packages/integrations/markdoc/test/render.test.js b/packages/integrations/markdoc/test/render.test.js index 3ac9c3ac47..f1760a8e61 100644 --- a/packages/integrations/markdoc/test/render.test.js +++ b/packages/integrations/markdoc/test/render.test.js @@ -69,6 +69,18 @@ describe('Markdoc - render', () => { await server.stop(); }); + + it('renders content - with root folder containing space', async () => { + const fixture = await getFixture('render with-space'); + const server = await fixture.startDevServer(); + + const res = await fixture.fetch('/'); + const html = await res.text(); + + renderWithRootFolderContainingSpace(html); + + await server.stop(); + }); }); describe('build', () => { @@ -116,6 +128,15 @@ describe('Markdoc - render', () => { renderNullChecks(html); }); + + it('renders content - with root folder containing space', async () => { + const fixture = await getFixture('render with-space'); + await fixture.build(); + + const html = await fixture.readFile('/index.html'); + + renderWithRootFolderContainingSpace(html); + }); }); }); @@ -189,3 +210,14 @@ function renderSimpleChecks(html) { const p = document.querySelector('p'); expect(p.textContent).to.equal('This is a simple Markdoc post.'); } + +/** @param {string} html */ +function renderWithRootFolderContainingSpace(html) { + const { document } = parseHTML(html); + const h2 = document.querySelector('h2'); + expect(h2.textContent).to.equal('Simple post with root folder containing a space'); + const p = document.querySelector('p'); + expect(p.textContent).to.equal( + 'This is a simple Markdoc post with root folder containing a space.' + ); +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 7e65279237..86f4cee5b5 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -3836,6 +3836,15 @@ importers: specifier: workspace:* version: link:../../../../../astro + packages/integrations/markdoc/test/fixtures/render with-space: + dependencies: + '@astrojs/markdoc': + specifier: workspace:* + version: link:../../.. + astro: + specifier: workspace:* + version: link:../../../../../astro + packages/integrations/markdoc/test/fixtures/render-html: dependencies: '@astrojs/markdoc':