How to create "static" files through plugin?

[rohit-gohri]

I'm currently adding support for multi-file OpenAPI files (rohit-gohri/redocusaurus#23) to my plugin https://github.com/rohit-gohri/redocusaurus. I've got the bundling part done, but to provide a download link for the bundled spec I need to programmatically create a static file that would be included in the build.

AFAIK the addRoute option is for creating pages with react and not for static assets. I could copy the file to the static folder but then users of my plugin will have to gitignore that folder.

[Josh-Cena]

Just call fs.writeFile(path.join(context.siteDir, context.siteConfig.staticDirectories[0] ?? 'static'), data)? 🤔

[rohit-gohri]

Yes, exactly. But this static file is programmatically created by the plugin. User is not aware of this file

[Josh-Cena]

I think you can use the postBuild lifecycle and write directly to the build folder? Note that during development, you shouldn't assume the existence of build, since all assets are virtually served by webpack dev server. In this case, you either have to use static, or you use configureWebpack().devServer to proxy certain routes to a virtual HTML file.

[rohit-gohri]

I think you can use the postBuild lifecycle and write directly to the build folder?

Cool, I'll try that. Thanks

Note that during development, you shouldn't assume the existence of build.

I will skip it in dev, it's not a critical thing

[rohit-gohri]

postBuild is exactly what I needed. Thanks!

[slorber]

The sitemaps plugin is a good example ;)