npm-edit.1 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. .TH "NPM\-EDIT" "1" "August 2021" "" ""
  2. .SH "NAME"
  3. \fBnpm-edit\fR \- Edit an installed package
  4. .SS Synopsis
  5. .P
  6. .RS 2
  7. .nf
  8. npm edit <pkg>[/<subpkg>\.\.\.]
  9. .fi
  10. .RE
  11. .SS Description
  12. .P
  13. Selects a (sub)dependency in the current
  14. working directory and opens the package folder in the default editor
  15. (or whatever you've configured as the npm \fBeditor\fP config \-\- see
  16. \fBnpm\-config\fP \fInpm\-config)\.\fR
  17. .P
  18. After it has been edited, the package is rebuilt so as to pick up any
  19. changes in compiled packages\.
  20. .P
  21. For instance, you can do \fBnpm install connect\fP to install connect
  22. into your package, and then \fBnpm edit connect\fP to make a few
  23. changes to your locally installed copy\.
  24. .SS Configuration
  25. .SS editor
  26. .RS 0
  27. .IP \(bu 2
  28. Default: \fBEDITOR\fP environment variable if set, or \fB"vi"\fP on Posix,
  29. or \fB"notepad"\fP on Windows\.
  30. .IP \(bu 2
  31. Type: path
  32. .RE
  33. .P
  34. The command to run for \fBnpm edit\fP or \fBnpm config edit\fP\|\.
  35. .SS See Also
  36. .RS 0
  37. .IP \(bu 2
  38. npm help folders
  39. .IP \(bu 2
  40. npm help explore
  41. .IP \(bu 2
  42. npm help install
  43. .IP \(bu 2
  44. npm help config
  45. .IP \(bu 2
  46. npm help npmrc
  47. .RE