|
|
|
.TH "NPM\-SUBMODULE" "1" "September 2014" "" ""
|
|
|
|
.SH "NAME"
|
|
|
|
\fBnpm-submodule\fR \- Add a package as a git submodule
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.P
|
|
|
|
.RS 2
|
|
|
|
.EX
|
|
|
|
npm submodule <pkg>
|
|
|
|
.EE
|
|
|
|
.RE
|
|
|
|
.SH DESCRIPTION
|
|
|
|
.P
|
|
|
|
If the specified package has a git repository url in its package\.json
|
|
|
|
description, then this command will add it as a git submodule at
|
|
|
|
\fBnode_modules/<pkg name>\fR\|\.
|
|
|
|
.P
|
|
|
|
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\.
|
|
|
|
.SH SEE ALSO
|
|
|
|
.RS 0
|
|
|
|
.IP \(bu 2
|
|
|
|
npm help 5 package\.json
|
|
|
|
.IP \(bu 2
|
|
|
|
git help submodule
|
|
|
|
|
|
|
|
.RE
|
|
|
|
|