Jetpack accepts some configuration via CLI.
$ jetpack --help
Usage: jetpack [options] [command] [path]
Options:
-v, --version print the version of jetpack and rspack
-p, --port <n> port, defaults to 3030
-d, --dir [path] run jetpack in the context of this directory
-c, --config config file to use, defaults to jetpack.config.js
-r, --no-hot disable hot reloading
-u, --no-minify disable minification
-m, --modern build a modern bundle
-l, --legacy build a legacy bundle
-x, --exec [path] execute an additional process, e.g. an api server
-i, --print-config print the rspack config object used in the current command
--log [levels] select log levels: info, progress, none (default: "info,progress")
-h, --help display help for command
Commands:
dev run the dev server
build build for production
inspect analyze bundle
browsers [options] print supported browsers
clean remove the dist dir
help [command] display help for command
Jetpack can also be configured using jetpack.config.js file. Here are all of the available options.
module.exports = {
// directory to run jetpack in
dir: '.',
// entry module path relative to dir
// defaults to which ever is found first:
// index.js
// package.json#main
// src/index.js
entry: '.',
// port of the dev server
port: 3030,
// relative path to static assets file dir
// these are files that you don't want to process via rspack
// but want to serve as part of your application, these
// will get exposed under /assets/*
static: 'assets',
// build output path relative to dir
dist: 'dist',
// use when uploading assets to CDN, e.g. 'https://storage.googleapis.com/humaans-static/assets/'
// or when serving from a different path than the jetpack default. Note: this doesn't affect
// the build output structure, you will still get dist/index.html and dist/assets/*, but
// manifest.json and index.html will be pointing to this publicPath instead of the default /assets
publicPath: '/assets/',
// jsx pragma
// defaults to `React.createElement` if react is installed, `h` otherwise
jsx: 'React.createElement',
// hot reloading
hot: true,
// unified flag for source maps for js and css
// follows rspack naming, but can also be simply set to true
// it's true by default in development and false in production
sourceMaps: true,
// in you need to turn off minification in production for any reason
minify: false,
// set to `true` to enable retries on chunk loads
// defaults to trying 5 times with exponential backoff
chunkLoadRetry: false,
// command executed to run the server/api process
// this command is executed only if `-x` arg is passed to jetpack
// even if this option is configured
exec: 'node .',
// used for proxying certain requests to a different server
// e.g. { '/api/*': 'http://localhost:3000',
// '/api2/*': 'http://localhost:3001/:splat',
// '/api3/*': 'http://localhost:3002/custom/:splat' }
// it can also be a function that receives an express app
// e.g. (app) => app.get('/api/foo', (req, res) => {...})
proxy: {},
// configure logging
log: 'info,progress',
// the index.html template generation
// defaults to package.json#name or 'jetpack' if not available
title: 'jetpack',
// useful for adding meta tags or scripts
// can be specified in handlebars template syntax
head: null,
// body
// can be specified in handlebars template syntax
body: `<div id='root'></div>`,
// the html template
// can be specified in handlebars template syntax
html: `see lib/template.hbs`,
// css options
css: {
// css modules
modules: false,
// a shortcut for setting lightningcss feature flags
// e.g. { 'nesting': true, colorFunction: true }
// see https://rspack.dev/guide/features/builtin-lightningcss-loader#options
// and https://lightningcss.dev/transpilation.html
features: {
include: {},
exclude: {},
},
// when using Sass, you can specify paths to your global scss resources
// so that you can use your shared variables & mixins across all Sass styles
// without manually importing them in each file. Works with CSS Modules.
// See further tips: https://github.com/shakacode/sass-resources-loader#tips
resources: []
},
target: {
modern: true,
legacy: false
},
// rspack config transform fn
rspack: (config, options) => {
// config is the rspack config generated by jetpack
// options is this jetpack options object including defaults,
// but also includes a very handy options.production flag
// see 02-customizing-rspack.md for more details
}
}The default html template is the following:
You can override it completely using the html option or extend it by using head and body options.
Jetpack exports the following modules:
It's a middleware that can serve your assets in development and production. It proxies to jetpack dev server in development and serves files from dist in production. For example:
const express = require('express')
const jetpack = require('jetpack/serve')
const app = express();
app.get('/api/unicorns', (req, res) => {...})
app.get('*', jetpack)Receive all of the jepack config. Might be useful if you want to look at the port, dist, or generated assets in production if you're say generating your HTML server side, e.g.:
const options = require('jetpack/options')
options.production
options.entry
options.port
options.assets
options.assets.js.forEach(script => console.log(script))
options.assets.css.forEach(script => console.log(script))
options.assets.other
options.assets.runtime // the path to the runtime
options.runtime // the content of the runtime script
A simple proxy helper, useful if you want to customize your proxy behaviour using a function. E.g.
const proxy = require('jetpack/proxy')
module.exports = {
proxy: (app) => {
app.post('/custom', (req, res) => res.send(422))
app.get('/api/*', proxy('http://localhost:3000'))
}
}An export of the rspack module used by jetpack. Useful to access rspack's plugins, etc.