You need to do some dynamic stuff, but don't want to do it at runtime. Or maybe
you want to do stuff like read the filesystem to get a list of files and you
can't do that in the browser.
This solution
This allows you to specify some code that runs in Node and whatever you
module.exports in there will be swapped. For example:
const x = preval`module.exports = 1`// ↓ ↓ ↓ ↓ ↓ ↓const x = 1
Or, more interestingly:
const x = preval` const fs = require('fs') const val = fs.readFileSync(__dirname + '/fixture1.md', 'utf8') module.exports = { val, getSplit: function(splitDelimiter) { return x.val.split(splitDelimiter) } }`// ↓ ↓ ↓ ↓ ↓ ↓const x = { val: '# fixture\n\nThis is some file thing...\n', getSplit: function getSplit(splitDelimiter) { return x.val.split(splitDelimiter) },}
There's also preval.require('./something') and
import x from /* preval */ './something' (which can both take some arguments)
or add // @preval comment at the top of a file.
Using the preval file comment will update a whole file to be evaluated down to
an export.
Whereas the above usages (assignment/import/require) will only preval the scope
of the assignment or file being imported.
Before:
// @prevalconst id = require('./path/identity')const one = require('./path/one')const compose = (...fns) => fns.reduce((f, g) => a => f(g(a)))const double = a => a * 2const square = a => a * amodule.exports = compose(square, id, double)(one)
After:
module.exports = 4
Exporting a function
If you export a function from a module that you're prevaling (whether using
preval.require or the import comment), then that function will be called and
whatever is returned will be the prevaled value.
It's important to know this if you want to have the prevaled value itself be a
function:
Once you've
configured babel-plugin-macros
you can import/require the preval macro at babel-plugin-preval/macro. For
example:
import preval from 'babel-plugin-preval/macro'const one = preval`module.exports = 1 + 2 - 1 - 1`
You could also use preval.macro if you'd prefer to type less
😀
Examples
Mastodon saved 40kb
(gzipped) using babel-plugin-preval
glamorous-website
uses preval.macro to determine Algolia options based on
process.env.LOCALE. It also uses preval.macro to load an
svg file as a string, base64 encode it, and use it as a background-url
for an input element.
Serverless with webpack
build serverless functions using webpack and Babel for development and
production with preval to replace (possible sensible) content in code.
prepack is intended to be run on your final bundle after you've run
your webpack/etc magic on it. It does a TON of stuff, but the idea is that your
code should work with or without prepack.
babel-plugin-preval is intended to let you write code that would not work
otherwise. Doing things like reading something from the file system are not
possible in the browser (or with prepack), but preval enables you to do this.
How is this different from webpack loaders?
This plugin was inspired by webpack's val-loader. The benefit of
using this over that loader (or any other loader) is that it integrates with
your existing babel pipeline. This is especially useful for the server where
you're probably not bundling your code with webpack, but you may be
using babel. (If you're not using either, configuring babel for this would be
easier than configuring webpack for val-loader).
In addition, you can implement pretty much any webpack loader using
babel-plugin-preval.
If you want to learn more, check webpack documentations about
loaders.
Inspiration
I needed something like this for the
glamorous website. I
live-streamed developing the whole thing. If you're interested you can find
the recording on my youtube channel
(note, screen only recording, no audio).