node/deps/npm/man/man3/npm-submodule.3

36 lines
1.0 KiB
Groff
Raw Normal View History

2014-11-05 07:08:12 +08:00
.TH "NPM\-SUBMODULE" "3" "October 2014" "" ""
.SH "NAME"
2014-09-25 05:41:07 +08:00
\fBnpm-submodule\fR \- Add a package as a git submodule
.SH SYNOPSIS
.P
.RS 2
2014-11-05 07:08:12 +08:00
.nf
npm\.commands\.submodule(packages, callback)
2014-11-05 07:08:12 +08:00
.fi
2014-09-25 05:41:07 +08:00
.RE
.SH DESCRIPTION
.P
For each package specified, npm will check if it has a git repository url
2014-09-25 05:41:07 +08:00
in its package\.json description then add it as a git submodule at
\fBnode_modules/<pkg name>\fR\|\.
.P
2014-09-25 05:41:07 +08:00
This is a convenience only\. From then on, it's up to you to manage
updates by using the appropriate git commands\. npm will stubbornly
refuse to update, modify, or remove anything with a \fB\|\.git\fR subfolder
in it\.
.P
This command also does not install missing dependencies, if the package
does not include them in its git repository\. If \fBnpm ls\fR reports that
things are missing, you can either install, link, or submodule them yourself,
or you can do \fBnpm explore <pkgname> \-\- npm install\fR to install the
dependencies into the submodule folder\.
2014-09-25 05:41:07 +08:00
.SH SEE ALSO
.RS 0
.IP \(bu 2
npm help json
2014-09-25 05:41:07 +08:00
.IP \(bu 2
git help submodule
2014-09-25 05:41:07 +08:00
.RE