Trying to compile MDX files and return React JSX elements using ESBuild

So im trying to use ESBuild to, during compile time read a bunch of index.mdx files from subfolders in the folder src/content.

What i want to do is:

  • get all the folder names
  • parse the frontmatter in the header of each mdxfile
  • parse the body of the MDX file and return as a JSX.Element (React component)

In the end i wish to return a list of Articles containing objects with the following type structure:

interface Article {
  path: string,
  content: JSX.Element,
  metadata: Metadata
}

interface Metadata {
 // Different metadata params
}

I have written a custom ESBuild plugin:

// Read folder names
const getFolderNamesInDirectory = (dir) => {
  return fs.readdirSync(dir).filter((item) => {
    const itemPath = path.join(dir, item);
    return fs.statSync(itemPath).isDirectory();
  });
};

// Helper function to read and parse an MDX file
const parseMDXFile = async (filePath) => {
  const content = fs.readFileSync(filePath, 'utf8');
  const { data: metadata, content: mdxContent } = matter(content);

  const compiledMdx = await compile(mdxContent, {
    remarkPlugins: [remarkPrism, remarkImages],
    jsx: true,
  });

  return {
    metadata: metadata,
    jsx: String(compiledMdx),
  };
};

// Define the plugin
const ArticlesPlugin = (folder) => ({
  name: 'articles-plugin',
  setup(build) {
    // Read all folder names in the specified directory
    const folders = getFolderNamesInDirectory(folder);
    const articles = [];

    // Read and parse each index.mdx file
    folders.forEach(async (folderName) => {
      const mdxFilePath = path.join(folder, folderName, 'index.mdx');
      if (fs.existsSync(mdxFilePath)) {
        const { metadata, jsx } = await parseMDXFile(mdxFilePath);

        articles.push({
          path: folderName,
          componentCode: `
            import React from 'react';
            ${jsx}
            export default MDXContent;
          `,
          metadata: metadata,
        });
      }
    });

    // Create a virtual module exporting the articles array
    build.onResolve({ filter: /^virtual:articles$/ }, (args) => {
      console.log(args);
      return { path: args.path, namespace: 'virtual' };
    });

    build.onLoad({ filter: /.*/, namespace: 'virtual' }, (args) => {
      if (args.path === 'virtual:articles') {
          const contents = `
            import React from 'react';
            export const articles = {
              ${articles.map((article) => `path: '${article.path}', article: () => { ${article.componentCode} }, metadata: ${article.metadata}` ).join(',n')}
            };
          `;
        return {
          contents,
          loader: 'jsx',
        };
      }
    });
  },
});

The problem im having with the above code is that im getting the following build error when running my esbuild build script:

✘ [ERROR] Unexpected "React"

    virtual:virtual:articles:5:19:
      5 │             import React from 'react';

I have a had quite the hard time to understand what type of content a ESBuild plugin should return. It was my understanding that i could return content as a correctly formatted React module.

If i remove the import React from 'react' and remove the jsx: true flag on the mdx compiler i get a different error:

✘ [ERROR] Expected "(" but found "{"

    virtual:virtual:articles:4:19:
      4 │             import {Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs} from "react/jsx-runtime";
        │                    ^
        ╵  

I have spent a lot of time reading the ESBuild plugin documentation and the MDXCompiler docs and i feel im getting really close, but its this last part that is giving me a rough time.

So how do i return React components from an ESBuild plugin so i can import them in my react code.

Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa Dịch vụ tổ chức sự kiện 5 sao Thông tin về chúng tôi Dịch vụ sinh nhật bé trai Dịch vụ sinh nhật bé gái Sự kiện trọn gói Các tiết mục giải trí Dịch vụ bổ trợ Tiệc cưới sang trọng Dịch vụ khai trương Tư vấn tổ chức sự kiện Hình ảnh sự kiện Cập nhật tin tức Liên hệ ngay Thuê chú hề chuyên nghiệp Tiệc tất niên cho công ty Trang trí tiệc cuối năm Tiệc tất niên độc đáo Sinh nhật bé Hải Đăng Sinh nhật đáng yêu bé Khánh Vân Sinh nhật sang trọng Bích Ngân Tiệc sinh nhật bé Thanh Trang Dịch vụ ông già Noel Xiếc thú vui nhộn Biểu diễn xiếc quay đĩa Dịch vụ tổ chức tiệc uy tín Khám phá dịch vụ của chúng tôi Tiệc sinh nhật cho bé trai Trang trí tiệc cho bé gái Gói sự kiện chuyên nghiệp Chương trình giải trí hấp dẫn Dịch vụ hỗ trợ sự kiện Trang trí tiệc cưới đẹp Khởi đầu thành công với khai trương Chuyên gia tư vấn sự kiện Xem ảnh các sự kiện đẹp Tin mới về sự kiện Kết nối với đội ngũ chuyên gia Chú hề vui nhộn cho tiệc sinh nhật Ý tưởng tiệc cuối năm Tất niên độc đáo Trang trí tiệc hiện đại Tổ chức sinh nhật cho Hải Đăng Sinh nhật độc quyền Khánh Vân Phong cách tiệc Bích Ngân Trang trí tiệc bé Thanh Trang Thuê dịch vụ ông già Noel chuyên nghiệp Xem xiếc khỉ đặc sắc Xiếc quay đĩa thú vị
Trang chủ Giới thiệu Sinh nhật bé trai Sinh nhật bé gái Tổ chức sự kiện Biểu diễn giải trí Dịch vụ khác Trang trí tiệc cưới Tổ chức khai trương Tư vấn dịch vụ Thư viện ảnh Tin tức - sự kiện Liên hệ Chú hề sinh nhật Trang trí YEAR END PARTY công ty Trang trí tất niên cuối năm Trang trí tất niên xu hướng mới nhất Trang trí sinh nhật bé trai Hải Đăng Trang trí sinh nhật bé Khánh Vân Trang trí sinh nhật Bích Ngân Trang trí sinh nhật bé Thanh Trang Thuê ông già Noel phát quà Biểu diễn xiếc khỉ Xiếc quay đĩa
Thiết kế website Thiết kế website Thiết kế website Cách kháng tài khoản quảng cáo Mua bán Fanpage Facebook Dịch vụ SEO Tổ chức sinh nhật