Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Migrate to PNPM from NPM #118

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Migrate to PNPM from NPM #118

wants to merge 2 commits into from

Conversation

Atmois
Copy link
Contributor

@Atmois Atmois commented Aug 16, 2025 •
edited by sourcery-ai bot
Loading

Speeds up deployments 1~ minute and there is no loss of functionality.

Summary by Sourcery

Migrate the project from npm to pnpm for package management, updating scripts, configuration, and documentation.

Enhancements:

  • Switch to pnpm for dependency installation and script execution to improve deployment speed

Build:

  • Add .pnpmrc and pnpm-lock.yaml, and declare pnpm in packageManager and engines in package.json

Documentation:

  • Rename NPM_SCRIPTS.md to PNPM_SCRIPTS.md and update all script references from npm to pnpm
  • Update README.md to instruct usage of pnpm commands and reference the new script documentation

Chores:

  • Remove npm-specific lock and config files (.npmrc, package-lock.json, .nvmrc, .node-version)

@Atmois Atmois requested a review from kzndotsh August 16, 2025 20:15
@sourcery-ai Sourcery AI
Copy link
Contributor

sourcery-ai bot commented Aug 16, 2025 •
edited
Loading

Reviewer's Guide

This PR replaces npm with pnpm as the package manager across scripts, documentation, and configuration, updating command invocations, metadata, and lockfiles to leverage pnpm’s faster install and execution workflows.

File-Level Changes

Change Details Files
Rename and update the scripts reference file for pnpm
  • Renamed NPM_SCRIPTS.md to PNPM_SCRIPTS.md and updated the top-level title
  • Replaced all npm run prefixes with pnpm run in script examples
  • Adjusted npx invocations to pnpm exec for OpenNext commands
 NPM_SCRIPTS.md
PNPM_SCRIPTS.md
Migrate package.json metadata and scripts to pnpm
  • Added packageManager: [email protected] and pnpm engine requirement
  • Replaced every npm run and npx call in scripts with pnpm run and pnpm exec
  • Removed npm lockfile references and adjusted build, deploy, check, and utility scripts
 package.json
Update README to instruct pnpm usage
  • Changed package manager links and references from npm to pnpm
  • Replaced npm install with pnpm install
  • Updated all example script invocations (run dev:all, run build, run deploy) to use pnpm
 README.md
Replace npm config and lockfiles with pnpm equivalents
  • Deleted .npmrc, package-lock.json, .nvmrc, .node-version, and other npm artifacts
  • Added .pnpmrc and pnpm-lock.yaml
 .npmrc
package-lock.json
.nvmrc
.node-version
.pnpmrc
pnpm-lock.yaml
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Aug 16, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes and they look great!

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@kzndotsh kzndotsh Awaiting requested review from kzndotsh

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Atmois