docs(pl-cli): document required --allow-build flag for pnpm dlx#1568
docs(pl-cli): document required --allow-build flag for pnpm dlx#1568dbolotin wants to merge 2 commits into
Conversation
🦋 Changeset detectedLatest commit: 7aba945 The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
Code Review
This pull request adds a README for the @platforma-sdk/pl-cli package and a changeset documenting the required --allow-build flag for pnpm dlx. The documentation includes a list of CLI commands. Feedback was provided to improve the clarity of command descriptions in the README by making them more descriptive.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1568 +/- ##
==========================================
- Coverage 55.85% 54.05% -1.80%
==========================================
Files 198 255 +57
Lines 10774 14603 +3829
Branches 2306 3027 +721
==========================================
+ Hits 6018 7894 +1876
- Misses 3996 5695 +1699
- Partials 760 1014 +254 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Summary
Adds a README to
@platforma-sdk/pl-clishowing the correctpnpm dlxinvocation.
@milaboratories/pframes-rs-nodeneeds its install script torun (
node-pre-gypdownloads the native.nodebinary); on pnpm 10 theonly way to allow that in a dlx context is the
--allow-buildCLI flag.Without it, the CLI fails at runtime with
MODULE_NOT_FOUNDforpframes_rs_node.node.Empty changeset — no publish impact;
filesalready includes the READMEso it ships on the next release.
Greptile Summary
Adds a
README.mdto@platforma-sdk/pl-clidocumenting thepnpm dlx --allow-build=@milaboratories/pframes-rs-nodeinvocation required on pnpm 10, along with a brief command reference. The README is already listed inpackage.json'sfilesfield and all documented commands match actual source files undersrc/cmd/.Confidence Score: 5/5
Safe to merge — docs-only change with no code modifications.
Both files are purely additive documentation. The README accurately reflects the codebase (all commands verified against source), the package.json already includes README.md in
files, and the empty changeset format is correct for a non-versioning change.No files require special attention.
Important Files Changed
Reviews (1): Last reviewed commit: "docs(pl-cli): document required --allow-..." | Re-trigger Greptile