@achil/npm-programmatic 中文文档教程
npm-programmatic
npm-programmatic 是一个允许您从 javascript 以编程方式访问 npm 命令的库,
Usage
每个函数都返回一个 Bluebird promise。
CWD 指的是当前工作目录,允许您确保命令在文件系统中的某个文件夹中执行。 如果设置了输出,npm 的输出将显示在控制台中。
Installation of Packages
npm.install(packages, opts).then(function)
Name | Type | Value |
---|---|---|
packages | Array | packages to be installed |
opts | Object | save:true/false; global:true/false; cwd:string; saveDev:true/false; noOptional:true/false; legacyBundling: true/false; output:true/false |
Example
var npm = require('npm-programmatic');
npm.install(['left-pad'], {
cwd:'/path/to/my/project',
save:true
})
.then(function(){
console.log("SUCCESS!!!");
})
.catch(function(){
console.log("Unable to install package");
});
Unistallation of Packages
npm.uninstall(packages, opts).then(function)
Name | Type | Value |
---|---|---|
packages | Array | packages to be uninstalled |
opts | Object | save:true/false; global:true/false; cwd:string; saveDev:true/false; output:true/false |
Example
var npm = require('npm-programmatic');
npm.uninstall(['left-pad'], {
cwd:'/path/to/my/project',
save:true
})
.then(function(){
console.log("SUCCESS!!!");
})
.catch(function(){
console.log("Unable to uninstall package");
});
List Installed Packages
npm.list(path).then(function)
Name | Type | Value |
---|---|---|
path | String | path at which to look |
Example
var npm = require('npm-programmatic');
npm.list('/path/to/project')
.then(function(arrayOfPackages){
console.log(arrayOfPackages);
})
.catch(function(){
console.log("Unable to uninstall package");
});
Tests
安装 mocha 和 dev 依赖项。 然后运行 <代码>npm 测试
npm-programmatic
npm-programmatic is a library that allows you to access npm commands programmatically from javascript
Usage
Every function returns a Bluebird promise.
CWD refers to current working directory, allowing you to ensure the command executes in a certain folder in the filesystem. If output is set, the output of npm will be shown in the console.
Installation of Packages
npm.install(packages, opts).then(function)
Name | Type | Value |
---|---|---|
packages | Array | packages to be installed |
opts | Object | save:true/false; global:true/false; cwd:string; saveDev:true/false; noOptional:true/false; legacyBundling: true/false; output:true/false |
Example
var npm = require('npm-programmatic');
npm.install(['left-pad'], {
cwd:'/path/to/my/project',
save:true
})
.then(function(){
console.log("SUCCESS!!!");
})
.catch(function(){
console.log("Unable to install package");
});
Unistallation of Packages
npm.uninstall(packages, opts).then(function)
Name | Type | Value |
---|---|---|
packages | Array | packages to be uninstalled |
opts | Object | save:true/false; global:true/false; cwd:string; saveDev:true/false; output:true/false |
Example
var npm = require('npm-programmatic');
npm.uninstall(['left-pad'], {
cwd:'/path/to/my/project',
save:true
})
.then(function(){
console.log("SUCCESS!!!");
})
.catch(function(){
console.log("Unable to uninstall package");
});
List Installed Packages
npm.list(path).then(function)
Name | Type | Value |
---|---|---|
path | String | path at which to look |
Example
var npm = require('npm-programmatic');
npm.list('/path/to/project')
.then(function(arrayOfPackages){
console.log(arrayOfPackages);
})
.catch(function(){
console.log("Unable to uninstall package");
});
Tests
install mocha and dev dependencies. Then run npm test