Your packages as updatable templates
$ npm install install-here -g
Install npm package in folder you want: launch this command in the project folder
$ install-here <package> [<options>]
the package will be cloned directly in folder. Once the original package has been updated and you want to update yours, simply use the command (without specifying the package name):
$ install-here
changing options defined in the file:
install-here.json
(created by the tool at the first launch) you can skip or manage overwriting modes for existing files or folders.
See USE CASE for more details.
Similar to a basic yeoman but considering an npm package as template!
Options can be defined using file
install-here.json
saved on working directory
-
ignore
string value (es:
"*.yml;package.json;favicon.ico;*.jpg"
).Every file match with this filter will be skipped.
-
ignoreOverwrite
string value (es:
"*.json"
).Every existing file match with this filter will be skipped.
-
ignorePath
string value (es:
"my/folder/**"
).Every file match with this filter will be skipped if path exists.
-
checkVersion
boolean value.
Cancel upgrade the package if the version is the same as the remote one.
-
xpre
string value (es:
"gulp deploy"
).pre-execution script.
-
xpost
string value (es:
"gulp deploy"
).post-execution script.
-
-v, --version
retrieve the version
-
-f, --force
force updates all files bypassing version check
-
--verbose
shows the verbose log
-
-h, --help
shows the help
-
-p, --patch
install in patch mode: save all files but package.json and dependencies. Not provide for pre/post actions. Like a merge to other package, different from current.
-
-xpre, -xpost
pre/post execution script
$ install-here <package> --xpost "gulp deploy"
File names filters can be write gulp-like syntax:
filter | match |
---|---|
your-file.ext |
specific filename |
your/path/*.* |
all files in your path (not in sub folders) |
your/path/**/*.json |
all .json files in your path and sub folders |
your/path/** |
all files in your path and sub folders |
your/path/your-file*.* |
all files in your path starts with "your-file" |