diff options
| author | 2023-04-28 01:36:44 +0800 | |
|---|---|---|
| committer | 2023-04-28 01:36:44 +0800 | |
| commit | dd84b9d64fb98746a230cd24233ff50a562c39c9 (patch) | |
| tree | b583261ef00b3afe72ec4d6dacb31e57779a6faf /packages/turbo-tracing-next-plugin/README.md | |
| parent | 0b46fcd72ac34382387b2bcf9095233efbcc52f4 (diff) | |
| download | HydroRoll-dd84b9d64fb98746a230cd24233ff50a562c39c9.tar.gz HydroRoll-dd84b9d64fb98746a230cd24233ff50a562c39c9.zip | |
Diffstat (limited to 'packages/turbo-tracing-next-plugin/README.md')
| -rw-r--r-- | packages/turbo-tracing-next-plugin/README.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/packages/turbo-tracing-next-plugin/README.md b/packages/turbo-tracing-next-plugin/README.md new file mode 100644 index 0000000..dbd2609 --- /dev/null +++ b/packages/turbo-tracing-next-plugin/README.md @@ -0,0 +1,39 @@ +# `@vercel/experimental-nft-next-plugin` + +## Installation + +- yarn add -D `@vercel/experimental-nft-next-plugin` +- npm install -D `@vercel/experimental-nft-next-plugin` +- pnpm install -D `@vercel/experimental-nft-next-plugin` + +## Usage + +```js +// next.config.js + +const { createNodeFileTrace } = require("@vercel/experimental-nft-next-plugin"); + +const withNodeFileTrace = createNodeFileTrace({ + // experimental nft options + log: { + all: true, + }, +}); + +module.exports = withNodeFileTrace({ + // next config +}); +``` + +### experimental nft options + +> **Note** +> +> The default options should work fine. + +- `cwd?: string`, default is `process.cwd()`, you can override it to specify another directory to run experimental nft. +- `contextDirectory?: string`, relative to cwd, default is `.`. It must be the directory where the `node_modules` directory is located. If you are in the monorepo, you should set it to the root directory of the monorepo. For yarn2+/npm workspaces, the default value will respect the `PROJECT_CWD` and `npm_config_local_prefix` environment variables injected by yarn/npm client. If the default value doesn't work, you can override it to specify the root directory of the monorepo. +- `path?: string`, additional path which will be appended into the `PATH` environment variable. +- `log?.all?: boolean`, default is `false`, whether to show all logs. +- `log?.level?: string`, default is `error`, the log level. +- `log?.detail?: boolean`, default is `false`, whether to expand the log details. |
