9f9214abe5
This PR updates the docs and examples for `create-next-app` to include pnpm usage.
The following script was used to update every example README:
```js
const fs = require('fs')
const examples = fs.readdirSync('./examples')
for (let example of examples) {
const filename = `./examples/${example}/README.md`
const markdown = fs.readFileSync(filename, 'utf8')
const regex = new RegExp(`^yarn create next-app --example (.*)$`, 'gm')
const output = markdown.replace(regex, (yarn, group) => {
const pnpm = `pnpm create next-app -- --example ${group}`
return `${yarn}\n# or\n${pnpm}`
})
fs.writeFileSync(filename, output)
}
```
|
||
|---|---|---|
| .. | ||
| pages | ||
| .babelrc | ||
| .gitignore | ||
| package.json | ||
| README.md | ||
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
How to use
Execute create-next-app with npm or Yarn to bootstrap the example:
npx create-next-app --example with-babel-macros with-babel-macros-app
# or
yarn create next-app --example with-babel-macros with-babel-macros-app
# or
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.