-
Notifications
You must be signed in to change notification settings - Fork 15
fix(docs): update mintlify dev script
#1535
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Replace devDependency with `pnpm dlx` command.
🦋 Changeset detectedLatest commit: 73ac244 The changes in this PR will be included in the next version bump. This PR includes changesets to release 18 packages
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 |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
… when running development server locally.
Greptile SummaryThis PR eliminates security vulnerabilities by removing the Key changes:
After this change, running Confidence Score: 5/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant Dev as Developer
participant PNPM as pnpm
participant Registry as npm Registry
participant Mint as mint CLI
participant Docs as Local Docs Server
Note over Dev,Docs: Before (with devDependencies)
Dev->>PNPM: pnpm install
PNPM->>Registry: Download mintlify + dependencies
Note right of Registry: Includes vulnerable deps:<br/>body-parser, path-to-regexp,<br/>qs, tar, zod, js-yaml, etc.
PNPM->>Dev: Install complete
Dev->>PNPM: pnpm dev
PNPM->>Mint: mintlify dev
Mint->>Docs: Start server on :3000
Note over Dev,Docs: After (with pnpm dlx)
Dev->>PNPM: pnpm mint dev
PNPM->>Registry: Download mint@^4.1.0 (temporary)
Note right of Registry: No install to node_modules<br/>No audit issues
Registry->>PNPM: Return mint package
PNPM->>Mint: Execute: mint dev
Mint->>Docs: Start server on :3000
Note right of Docs: Same functionality,<br/>cleaner dependencies
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1 file reviewed, 1 comment
Also, updates relevant docs.
|
@greptile re-review |
Greptile found no issues!From now on, if a review finishes and we haven't found any issues, we will not post anything, but you can confirm that we reviewed your changes in the status check section. This feature can be toggled off in your Code Review Settings by deselecting "Create a status check for each PR". |
lightwalker-eth
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tk-o Nice! Looks good to me 😄
Lite PR
Summary
This PR:
Why
mintlifyCLI withdevDependenciescauses multiple dependency audit issues.Details
Testing
pnpm ito updatepnpm-lock.yamlfile and then executedpnpm audit --audit-level=moderatecommand with the following result:It means no issues with at least
moderatelevel.Notes for Reviewer (Optional)
pnpm dlxis a useful method for executing dev scripts/binaries without defining explicitdevDependencies.Checklist