There are some cases I want to add large text files like mock.jsoncontent.md into ClojureScript code. When I was using Webpack, I would use raw-loader which pack my files into strings. I can keep the content I use in files.
What’s the suggested way doing this in shadow-cljs or other ClojureScript bundlers?
Depending on how large the resources are you might want to stay away from inlining them via a macro. If you add a megabyte of raw text it will hurt overall performance and it would be better to load the files via XHR separately.
Its fine if you just have small snippets of text but always verify that you don’t add too much.
It also kind of sucks with caching enabled since the code is not recompiled if you change the .md files.
I can probably add a macro that sets some extra flags to inform the compiler that changes to the included file should trigger a recompile. For now you could just block the file from caching but this really sucks.
Tens of lines of text is large enough to look messy in cljs files. I do want to extract the text into a file, while it still behaves like normal cljs code(text changed, recompiled, reloaded). I think it’s a common usage. I’ve run into several projects where I need to embed Markdown or JSON files in a project.
Clojure is totally fine with multi-line strings so you could just do
"shadow-cljs provides everything you need to compile your ClojureScript code with a focus on simplicity and ease of use.
** Good configuration defaults so you don't have to sweat the details
* Supporting various targets :browser, :node-script, :npm-module, :react-native(exprimental)...
* Live Reload (CLJS + CSS)
* CLJS REPL
* Code splitting (via :modules)
* Fast builds, reliable caching, ...
But I understand that including static files makes things nicer.
As you note, this feature of Webpack is convenient. If you use the double bundle approach (example project) you can package additional dependencies and other non-code things like strings in an additional webpack bundle, and then export them to CLJS using something like window.myData=require("./my-data.txt") in a JS file read by Webpack. See also the official docs
io/resource is meant to find the file in the resources/ folder which will be packaged in an uberjar or be present during aot compilation. It restricts the path of the file to somewhere you know it will always be found. If you want to grab any file in your system, just slurp is a better idea.