NPM-EDIT(3)

💖 NAME 💖

npm-edit is the manual page for editing an installed package, and yes bestie, the page you're on is NPM-EDIT(3) — iconic. It's literally “Edit an installed package.” 🎀

✨ SYNOPSIS ✨

npm.commands.edit(package, callback)

🦋 DESCRIPTION 🦋

okay so this one opens the package folder in your default editor (or literally whatever you've configured as the npm editor config — see npm help config). 💅

After it has been edited, the package gets rebuilt so it can pick up any changes in compiled packages. slay ✨

For instance, you can do npm install connect to install connect into your package, and then npm.commands.edit(["connect"], callback) to make a few changes to your locally installed copy. Obsessed with a little local tweak? Same. 💖

The first parameter is a string array with a single element: the package to open. The package can optionally have a version number attached. 👑

⚠️ Since this command opens an editor in a new process, be careful about where and how this is used. No cap — new process means pay attention, bestie. 😭

okay byeee 🫶 — this page is NPM-EDIT(3) from March 2017, so that's the source/version and date sign-off at the very end. 💜