rsnext/examples/with-babel-macros
Henrik Wenz 64a3697d05
[Docs] Update examples to favour functional _document (#39871)
## Changes

- Migrate class based `_document`s to functional documents 
- Removed `_document.js` where default
- Removed `MyDocument.getInitialProps` where default

## Motivation

This removes some boilerplate and prepares examples for server components.

## Documentation / Examples

- [x] Make sure the linting passes by running `pnpm lint`
- [x] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)
2022-08-23 18:52:31 +00:00
..
pages [Docs] Update examples to favour functional _document (#39871) 2022-08-23 18:52:31 +00:00
.babelrc Fix with-babel-macros by upgrading packages (#5762) 2018-11-28 20:34:46 +01:00
.gitignore Update default gitignore templates (#39051) 2022-07-26 20:08:40 -05:00
package.json Clean up examples package.json (#27121) 2021-07-12 19:58:03 +00:00
README.md docs(examples): improve DX while copying command to create new project (#38410) 2022-07-26 21:57:48 -05:00

Example app with babel-macros

This example features how to configure and use 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 Vercel or preview live with StackBlitz

Deploy with Vercel

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example with-babel-macros with-babel-macros-app
yarn create next-app --example with-babel-macros with-babel-macros-app
pnpm create next-app --example with-babel-macros with-babel-macros-app

Deploy it to the cloud with Vercel (Documentation).

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.