npm-edit.1 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. .TH "NPM\-EDIT" "1" "October 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>
  9. .fi
  10. .RE
  11. .P
  12. Note: This command is unaware of workspaces\.
  13. .SS Description
  14. .P
  15. Selects a dependency in the current project and opens the package folder in
  16. the default editor (or whatever you've configured as the npm \fBeditor\fP
  17. config \-\- see \fBnpm\-config\fP \fInpm\-config)\.\fR
  18. .P
  19. After it has been edited, the package is rebuilt so as to pick up any
  20. changes in compiled packages\.
  21. .P
  22. For instance, you can do \fBnpm install connect\fP to install connect
  23. into your package, and then \fBnpm edit connect\fP to make a few
  24. changes to your locally installed copy\.
  25. .SS Configuration
  26. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS START \-\->
  27. <!\-\- automatically generated, do not edit manually \-\->
  28. <!\-\- see lib/utils/config/definitions\.js \-\->
  29. .SS \fBeditor\fP
  30. .RS 0
  31. .IP \(bu 2
  32. Default: The EDITOR or VISUAL environment variables, or 'notepad\.exe' on
  33. Windows, or 'vim' on Unix systems
  34. .IP \(bu 2
  35. Type: String
  36. .RE
  37. .P
  38. The command to run for \fBnpm edit\fP and \fBnpm config edit\fP\|\.
  39. <!\-\- automatically generated, do not edit manually \-\->
  40. <!\-\- see lib/utils/config/definitions\.js \-\->
  41. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS END \-\->
  42. .SS See Also
  43. .RS 0
  44. .IP \(bu 2
  45. npm help folders
  46. .IP \(bu 2
  47. npm help explore
  48. .IP \(bu 2
  49. npm help install
  50. .IP \(bu 2
  51. npm help config
  52. .IP \(bu 2
  53. npm help npmrc
  54. .RE