Dev and build your code painlessly in monorepos
- In dev mode, your code behaves the same as it will in production, including locally linked in monorepos
- Add multiple entrypoints to your packages for publishing
- CLI helps walk you through set-up and making changes to your configs
- Works with different kinds of JS monorepos
- Also works for single package repos!
- Builds your code with rollup
Assuming you already have a source file at src/index.js (or src/index.ts) or you're using Yarn Workspaces and have packages with src/index.js (or src/index.ts), you can setup Preconstruct like this.
yarn add --dev @preconstruct/cli
yarn preconstruct init
If you're in a monorepo, you should also run yarn preconstruct dev
and add it to a postinstall script("postinstall": "preconstruct dev"
) that runs preconstruct dev so that you can import your code without having to rebuild your project every time in changes.
Before you publish packages to npm, run preconstruct build
. Preconstruct will use your Babel config and build flat bundles so make sure to configure Babel with the transforms you want.
We strongly recomment making a single script in your package.json that runs both build and publish, to stop broken publishes, such as
"release": "preconstruct build && yarn publish:packages
. If you're in a single-package repo, you could also runpreconstruct build
in aprepare
orprepublishOnly
script.
There are a number of tasks that become easier with preconstruct that lie slightly outside the main workflow. Check out the following guides for setting these up.
- A more detailed account of getting set up
- Setting up a second entrypoint
- CLI command documentation
- Other configuration
See the docs at preconstruct.tools
- microbundle was a huge inspiration for this! β€οΈ
- rollup - rollup has done the really hard stuff that makes preconstruct possible!
- bolt - lots of utils and things in this project were inspired by things in bolt
- Kye Hohenberger for thinking of the name preconstruct
- Too many awesome people to name at Thinkmill who have given so much great feedback to make Preconstruct better and Thinkmill for sponsoring the development of Preconstruct π
- all the people who wrote all the dependencies for this project!