rsnext/examples/with-babel-macros
leung018 66597be8a7
Add .yarn/install-state.gz to .gitignore (#56637)
### Reason for making this change
https://yarnpkg.com/getting-started/qa#:~:text=yarn%2Finstall%2Dstate.,your%20workspaces%20all%20over%20again.
In the official documentation of `yarn`, it is stated that `.yarn/install-state.gz` is an optimization file that developer shouldn't ever have to commit. However, currently, when running `create-next-app`, `.yarn/install-state.gz` is being commited.

### Remaining work
I apologize for only modifying one template initially to initiate the discussion first.

If this change is agreed upon,  it should be synchronized with other `.gitignore` templates. Would it be possible to follow a similar approach as in https://github.com/vercel/next.js/pull/47241? I would appreciate any assistance in syncing this change.
2023-10-18 16:34:48 +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 Add .yarn/install-state.gz to .gitignore (#56637) 2023-10-18 16:34:48 +00:00
package.json Update Examples to use React 18 (#42027) 2022-10-28 17:43:20 +00:00
README.md update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -04: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.