52 lines
1.8 KiB
Markdown
52 lines
1.8 KiB
Markdown
# Example app with [babel-macros](https://github.com/kentcdodds/babel-macros)
|
|
|
|
This example features how to configure and use [`babel-macros`](https://github.com/kentcdodds/babel-macros) which allows you to easily add babel plugins which export themselves as a macro without needing to configure them.
|
|
|
|
## Deploy your own
|
|
|
|
Deploy the example using [ZEIT Now](https://zeit.co/now):
|
|
|
|
[](https://zeit.co/import/project?template=https://github.com/zeit/next.js/tree/canary/examples/with-babel-macros)
|
|
|
|
## How to use
|
|
|
|
### Using `create-next-app`
|
|
|
|
Execute [`create-next-app`](https://github.com/zeit/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
|
|
|
|
```bash
|
|
npm init next-app --example with-babel-macros with-babel-macros-app
|
|
# or
|
|
yarn create next-app --example with-babel-macros with-babel-macros-app
|
|
```
|
|
|
|
### Download manually
|
|
|
|
Download the example:
|
|
|
|
```bash
|
|
curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-babel-macros
|
|
cd with-babel-macros
|
|
```
|
|
|
|
Install it and run:
|
|
|
|
```bash
|
|
npm install
|
|
npm run dev
|
|
# or
|
|
yarn
|
|
yarn dev
|
|
```
|
|
|
|
Deploy it to the cloud with [ZEIT Now](https://zeit.co/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
|
|
|
|
## Note
|
|
|
|
You'll notice the configuration in `.babelrc` includes the `babel-macros`
|
|
plugin, then we can use the `preval.macro` in `pages/index.js` to pre-evaluate
|
|
code at build-time. `preval.macro` is effectively transforming our code, but
|
|
we didn't have to configure it to make that happen!
|
|
|
|
Specifically what we're doing is we're prevaling the username of the user who
|
|
ran the build.
|