docs: add Yarn PnP options describe #142
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for Yarn Plug'n'Play (PnP) support to the README. The changes include adding PnP to the feature list and documenting two new configuration options (enablePnp and pnpManifest) in the "Other Options" table.
- Adds Yarn Plug'n'Play feature to the main features list
- Documents
enablePnpoption for enabling Yarn PnP support - Documents
pnpManifestoption for specifying a custom PnP manifest file path - Reorganizes the "Other Options" table with improved formatting
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
README.md
Outdated
| | tsconfig.configFile | | A relative path to the tsconfig file based on `cwd`, or an absolute path of tsconfig file. | | ||
| | tsconfig.references | `[]` | - 'auto': inherits from TypeScript config <br/> - `string []`: relative path (based on directory of the referencing tsconfig file) or absolute path of referenced project's tsconfig | | ||
| | enablePnp | false | Enable Yarn Plug'n'Play support | | ||
| | pnpManifest | None | Absolute path to the Yarn Plug'n'Play manifest file; takes effect when PnP is enabled. <br/> - `None`: PnP manifest located in the nearest ancestor directory; <br/> - `Some(PathBuf)`: Use a specific PnP manifest file. This is useful when enabling PnP with `enableGlobalCache: true`, but users must ensure there are no cross-project requires across Yarn PnP projects. | |
There was a problem hiding this comment.
Grammar issue: "PnP manifest located in the nearest ancestor directory" should read "PnP manifest is located in the nearest ancestor directory" for clarity and grammatical correctness.
Suggested change
| | pnpManifest | None | Absolute path to the Yarn Plug'n'Play manifest file; takes effect when PnP is enabled. <br/> - `None`: PnP manifest located in the nearest ancestor directory; <br/> - `Some(PathBuf)`: Use a specific PnP manifest file. This is useful when enabling PnP with `enableGlobalCache: true`, but users must ensure there are no cross-project requires across Yarn PnP projects. | | |
| | pnpManifest | None | Absolute path to the Yarn Plug'n'Play manifest file; takes effect when PnP is enabled. <br/> - `None`: PnP manifest is located in the nearest ancestor directory; <br/> - `Some(PathBuf)`: Use a specific PnP manifest file. This is useful when enabling PnP with `enableGlobalCache: true`, but users must ensure there are no cross-project requires across Yarn PnP projects. | |
README.md
Outdated
| | tsconfig.configFile | | A relative path to the tsconfig file based on `cwd`, or an absolute path of tsconfig file. | | ||
| | tsconfig.references | `[]` | - 'auto': inherits from TypeScript config <br/> - `string []`: relative path (based on directory of the referencing tsconfig file) or absolute path of referenced project's tsconfig | | ||
| | enablePnp | false | Enable Yarn Plug'n'Play support | | ||
| | pnpManifest | None | Absolute path to the Yarn Plug'n'Play manifest file; takes effect when PnP is enabled. <br/> - `None`: PnP manifest located in the nearest ancestor directory; <br/> - `Some(PathBuf)`: Use a specific PnP manifest file. This is useful when enabling PnP with `enableGlobalCache: true`, but users must ensure there are no cross-project requires across Yarn PnP projects. | |
There was a problem hiding this comment.
The description references Rust types (Some(PathBuf)) in user-facing documentation. Since this is a JavaScript/TypeScript API (as evidenced by the napi bindings), the description should use JavaScript/TypeScript terminology instead. Consider changing "Some(PathBuf)" to "string (absolute path)" to match the expected TypeScript type.
Suggested change
| | pnpManifest | None | Absolute path to the Yarn Plug'n'Play manifest file; takes effect when PnP is enabled. <br/> - `None`: PnP manifest located in the nearest ancestor directory; <br/> - `Some(PathBuf)`: Use a specific PnP manifest file. This is useful when enabling PnP with `enableGlobalCache: true`, but users must ensure there are no cross-project requires across Yarn PnP projects. | | |
| | pnpManifest | None | Absolute path to the Yarn Plug'n'Play manifest file; takes effect when PnP is enabled. <br/> - If omitted: the PnP manifest is located in the nearest ancestor directory. <br/> - `string` (absolute path): use a specific PnP manifest file. This is useful when enabling PnP with `enableGlobalCache: true`, but users must ensure there are no cross-project requires across Yarn PnP projects. | |
chenjiahan
approved these changes
Dec 31, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.