document/TranslateProject
2
0
Fork 0
mirror of https://github.com/LCTT/TranslateProject.git synced 2024-12-26 21:30:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #8661 from MjSeven/master

Browse Source 
20180126 How To Manage NodeJS Packages Using Npm.md 翻译完毕
This commit is contained in:
Vic Yu 2018-05-02 10:51:55 +08:00 committed by GitHub
commit acf3e56804
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 368 additions and 375 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

375
sources/tech/20180126 How To Manage NodeJS Packages Using Npm.md
View File

@ -1,375 +0,0 @@
Translating by MjSeven
How To Manage NodeJS Packages Using Npm
======
![](https://www.ostechnix.com/wp-content/uploads/2018/01/npm-720x340.png)
A while ago, we have published a guide to [**manage Python packages using PIP**][1]. Today, we are going to discuss how to manage NodeJS packages using Npm. NPM is the largest software registry that contains over 600,000 packages. Everyday, developers across the world shares and downloads packages through npm. In this guide, I will explain the the basics of working with npm, such as installing packages(locally and globally), installing certain version of a package, updating, removing and managing NodeJS packages and so on.
### Manage NodeJS Packages Using Npm
##### Installing NPM
Since npm is written in NodeJS, we need to install NodeJS in order to use npm. To install NodeJS on different Linux distributions, refer the following link.
Once installed, ensure that NodeJS and NPM have been properly installed. There are couple ways to do this.
To check where node has been installed:
```
$ which node
/home/sk/.nvm/versions/node/v9.4.0/bin/node
```
Check its version:
```
$ node -v
v9.4.0
```
Log in to Node REPL session:
```
$ node
> .help
.break Sometimes you get stuck, this gets you out
.clear Alias for .break
.editor Enter editor mode
.exit Exit the repl
.help Print this help message
.load Load JS from a file into the REPL session
.save Save all evaluated commands in this REPL session to a file
> .exit
```
Check where npm installed:
```
$ which npm
/home/sk/.nvm/versions/node/v9.4.0/bin/npm
```
And the version:
```
$ npm -v
5.6.0
```
Great! Node and NPM have been installed and are working! As you may have noticed, I have installed NodeJS and NPM in my $HOME directory to avoid permission issues while installing modules globally. This is the recommended method by NodeJS team.
Well, let us go ahead to see managing NodeJS modules (or packages) using npm.
##### Installing NodeJS modules
NodeJS modules can either be installed locally or globally(system wide). Now I am going to show how to install a package locally.
**Install packages locally**
To manage packages locally, we normally use **package.json** file.
First, let us create our project directory.
```
$ mkdir demo
```
```
$ cd demo
```
Create a package.json file inside your project's directory. To do so, run:
```
$ npm init
```
Enter the details of your package such as name, version, author, github page etc., or just hit ENTER key to accept the default values and type **YES** to confirm.
```
This utility will walk you through creating a package.json file.
It only covers the most common items, and tries to guess sensible defaults.
See `npm help json` for definitive documentation on these fields
and exactly what they do.
Use `npm install <pkg>` afterwards to install a package and
save it as a dependency in the package.json file.
Press ^C at any time to quit.
package name: (demo)
version: (1.0.0)
description: demo nodejs app
entry point: (index.js)
test command:
git repository:
keywords:
author:
license: (ISC)
About to write to /home/sk/demo/package.json:
{
"name": "demo",
"version": "1.0.0",
"description": "demo nodejs app",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
Is this ok? (yes) yes
```
The above command initializes your project and create package.json file.
You can also do this non-interactively using command:
```
npm init --y
```
This will create a package.json file quickly with default values without the user interaction.
Now let us install package named [**commander**][2].
```
$ npm install commander
```
Sample output:
```
npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN demo@1.0.0 No repository field.
+ commander@2.13.0
added 1 package in 2.519s
```
This will create a directory named **" node_modules"** (if it doesn't exist already) in the project's root directory and download the packages in it.
Let us check the package.json file.
```
$ cat package.json
{
"name": "demo",
"version": "1.0.0",
"description": "demo nodejs app",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC",
**"dependencies": {**
**"commander": "^2.13.0"**
}
}
```
You will see the dependencies have been added. The caret ( **^** ) at the front of the version number indicates that when installing, npm will pull the highest version of the package it can find.
```
$ ls node_modules/
commander
```
The advantage of package.json file is if you had the package.json file in your project's directory, you can just type "npm install", then npm will look into the dependencies that listed in the file and download all of them. You can even share it with other developers or push into your GitHub repository, so when they type "npm install", they will get all the same packages that you have.
You may also noticed another json file named **package-lock.json**. This file ensures that the dependencies remain the same on all systems the project is installed on.
To use the installed package in your program, create a file **index.js** (or any name of you choice) in the project's directory with the actual code, and then run it using command:
```
$ node index.js
```
**Install packages globally**
If you want to use a package as a command line tool, then it is better to install it globally. This way, it works no matter which directory is your current directory.
```
$ npm install async -g
+ async@2.6.0
added 2 packages in 4.695s
```
Or,
```
$ npm install async --global
```
To install a specific version of a package, we do:
```
$ npm install async@2.6.0 --global
```
##### Updating NodeJS modules
To update the local packages, go the the project's directory where the package.json is located and run:
```
$ npm update
```
Then, run the following command to ensure all packages were updated.
```
$ npm outdated
```
If there is no update, then it returns nothing.
To find out which global packages need to be updated, run:
```
$ npm outdated -g --depth=0
```
If there is no output, then all packages are updated.
To update the a single global package, run:
```
$ npm update -g <package-name>
```
To update all global packages, run:
```
$ npm update -g <package>
```
##### Listing NodeJS modules
To list the local packages, go the project's directory and run:
```
$ npm list
demo@1.0.0 /home/sk/demo
└── commander@2.13.0
```
As you see, I have installed "commander" package in local mode.
To list global packages, run this command from any location:
```
$ npm list -g
```
Sample output:
```
/home/sk/.nvm/versions/node/v9.4.0/lib
├─┬ async@2.6.0
│ └── lodash@4.17.4
└─┬ npm@5.6.0
├── abbrev@1.1.1
├── ansi-regex@3.0.0
├── ansicolors@0.3.2
├── ansistyles@0.1.3
├── aproba@1.2.0
├── archy@1.0.0
[...]
```
This command will list all modules and their dependencies.
To list only the top level modules, use -depth=0 option:
```
$ npm list -g --depth=0
/home/sk/.nvm/versions/node/v9.4.0/lib
├── async@2.6.0
└── npm@5.6.0
```
##### Searching NodeJS modules
To search for a module, use "npm search" command:
```
npm search <search-string>
```
Example:
```
$ npm search request
```
This command will display all modules that contains the search string "request".
##### Removing NodeJS modules
To remove a local package, go to the project's directory and run following command to remove the package from your **node_modules** directory:
```
$ npm uninstall <package-name>
```
To remove it from the dependencies in **package.json** file, use the **save** flag like below:
```
$ npm uninstall --save <package-name>
```
To remove the globally installed packages, run:
```
$ npm uninstall -g <package>
```
##### Cleaning NPM cache
By default, NPM keeps the copy of a installed package in the cache folder named npm in your $HOME directory when installing it. So, you can install it next time without having to download again.
To view the cached modules:
```
$ ls ~/.npm
```
The cache folder gets flooded with all old packages over time. It is better to clean the cache from time to time.
As of npm@5, the npm cache self-heals from corruption issues and data extracted from the cache is guaranteed to be valid. If you want to make sure everything is consistent, run:
```
$ npm cache verify
```
To clear the entire cache, run:
```
$ npm cache clean --force
```
##### Viewing NPM configuration
To view the npm configuration, type:
```
$ npm config list
```
Or,
```
$ npm config ls
```
Sample output:
```
; cli configs
metrics-registry = "https://registry.npmjs.org/"
scope = ""
user-agent = "npm/5.6.0 node/v9.4.0 linux x64"
; node bin location = /home/sk/.nvm/versions/node/v9.4.0/bin/node
; cwd = /home/sk
; HOME = /home/sk
; "npm config ls -l" to show all defaults.
```
To display the current global location:
```
$ npm config get prefix
/home/sk/.nvm/versions/node/v9.4.0
```
And, that's all for now. What we have just covered here is just the basics. NPM is a vast topic. For more details, head over to the the [**NPM Getting Started**][3] guide.
Hope this was useful. More good stuffs to come. Stay tuned!
Cheers!
--------------------------------------------------------------------------------
via: https://www.ostechnix.com/manage-nodejs-packages-using-npm/
作者：[SK][a]
译者：[译者ID](https://github.com/译者ID)
校对：[校对者ID](https://github.com/校对者ID)
本文由 [LCTT](https://github.com/LCTT/TranslateProject) 原创编译，[Linux中国](https://linux.cn/) 荣誉推出
[a]:https://www.ostechnix.com/author/sk/
[1]:https://www.ostechnix.com/manage-python-packages-using-pip/
[2]:https://www.npmjs.com/package/commander
[3]:https://docs.npmjs.com/getting-started/

368
translated/tech/20180126 How To Manage NodeJS Packages Using Npm.md Normal file
View File

@ -0,0 +1,368 @@
如何使用 Npm 管理 NodeJS 包
=====
![](https://www.ostechnix.com/wp-content/uploads/2018/01/npm-720x340.png)
前一段时间，我们发布了一个[**使用 PIP 管理 Python 包**][3]的指南。今天，我们将讨论如何使用 Npm 管理 NodeJS 包。NPM 是最大的软件注册中心，包含 600,000 多个包。每天，世界各地的开发人员通过 npm 共享和下载软件包。在本指南中，我将解释使用 npm 基础知识，例如安装包（本地和全局）、安装特定版本的包、更新、删除和管理 NodeJS 包等等。
### 使用 Npm 管理 NodeJS 包
##### 安装 NPM
用于 npm 是用 NodeJS 编写的，我们需要安装 NodeJS 才能使用 npm。要在不同的 Linux 发行版上安装 NodeJS，请参考下面的链接。
检查 node 安装的位置：
```
$ which node
/home/sk/.nvm/versions/node/v9.4.0/bin/node
```
检查它的版本：
```
$ node -v
v9.4.0
```
进入 Node 交互式解释器：
```
$ node
> .help
.break Sometimes you get stuck, this gets you out
.clear Alias for .break
.editor Enter editor mode
.exit Exit the repl
.help Print this help message
.load Load JS from a file into the REPL session
.save Save all evaluated commands in this REPL session to a file
> .exit
```
检查 npm 安装的位置：
```
$ which npm
/home/sk/.nvm/versions/node/v9.4.0/bin/npm
```
还有版本：
```
$ npm -v
5.6.0
```
棒极了！Node 和 NPM 已安装并能工作！正如你可能已经注意到，我已经在我的 $HOME 目录中安装了 NodeJS 和 NPM，这样是为了避免在全局模块时出现权限问题。这是 NodeJS 团队推荐的方法。
那么，让我们继续看看如何使用 npm 管理 NodeJS 模块（或包）。
##### 安装 NodeJS 模块
NodeJS 模块可以安装在本地或全局（系统范围）。现在我将演示如何在本地安装包。
**在本地安装包**
为了在本地管理包，我们通常使用 **package.json** 文件来管理。
首先，让我们创建我们的项目目录。
```
$ mkdir demo
```
```
$ cd demo
```
在项目目录中创建一个 package.json 文件。为此，运行：
```
$ npm init
```
输入你的包的详细信息，例如名称，版本，作者，github 页面等等，或者按下 ENTER 键接受默认值并键入 **YES** 确认。
```
This utility will walk you through creating a package.json file.
It only covers the most common items, and tries to guess sensible defaults.
See `npm help json` for definitive documentation on these fields
and exactly what they do.
Use `npm install <pkg>` afterwards to install a package and
save it as a dependency in the package.json file.
Press ^C at any time to quit.
package name: (demo)
version: (1.0.0)
description: demo nodejs app
entry point: (index.js)
test command:
git repository:
keywords:
author:
license: (ISC)
About to write to /home/sk/demo/package.json:
{
"name": "demo",
"version": "1.0.0",
"description": "demo nodejs app",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
Is this ok? (yes) yes
```
上面的命令初始化你的项目并创建了 package.json 文件。
你也可以使用命令以非交互式方式执行此操作：
```
npm init --y
```
现在让我们安装名为 [**commander**][2] 的包。
```
$ npm install commander
```
示例输出：
```
npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN demo@1.0.0 No repository field.
+ commander@2.13.0
added 1 package in 2.519s
```
这将在项目的根目录中创建一个名为 **" node_modules"** 的目录（如果它不存在的话），并在其中下载包。
让我们检查 pachage.json 文件。
```
$ cat package.json
{
"name": "demo",
"version": "1.0.0",
"description": "demo nodejs app",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC",
**"dependencies": {**
**"commander": "^2.13.0"**
}
}
```
你会看到添加了依赖文件，版本号前面的插入符号 ( **^** ) 表示在安装时，npm 将取出它可以找到的最高版本的包。
```
$ ls node_modules/
commander
```
package.json 文件的优点是，如果你的项目目录中有 package.json 文件，只需键入 "npm install"，那么 npm 将查看文件中列出的依赖关系并下载它们。你甚至可以与其他开发人员共享它或将其推送到你的 GitHub 仓库。因此，当他们键入 “npm install” 时，他们将获得你拥有的所有相同的包。
你也可能会注意到另一个名为 **package-lock.json** 的文件，该文件确保在项目安装的所有系统上都保持相同的依赖关系。
要在你的程序中使用已安装的包，使用实际代码在项目目录中创建一个 **index.js**（或者其他任何名称）文件，然后使用以下命令运行它：
```
$ node index.js
```
**在全局安装包**
如果你想使用一个包作为命令行工具，那么最好在全局安装它。这样，无论你的当前目录是哪个目录，它都能正常工作。
```
$ npm install async -g
+ async@2.6.0
added 2 packages in 4.695s
```
或者
```
$ npm install async --global
```
要安装特定版本的包，我们可以：
```
$ npm install async@2.6.0 --global
```
##### 更新 NodeJS 模块
要更新本地包，转到 package.json 所在的项目目录并运行：
```
$ npm update
```
然后，运行以下命令确保所有包都更新了。
```
$ npm outdated
```
如果没有需要更新的，那么它返回空。
要找出哪一个全局包需要更新，运行：
```
$ npm outdated -g --depth=0
```
如果没有输出，意味着所有包都已更新。
更新单个全局包，运行：
```
$ npm update -g <package-name>
```
更新所有的全局包，运行：
```
$ npm update -g <package>
```
##### 列出 NodeJS 模块
列出本地包，转到项目目录并运行：
```
$ npm list
demo@1.0.0 /home/sk/demo
└── commander@2.13.0
```
如你所见，我在本地安装了 "commander" 这个包。
要列出全局包，从任何位置都可以运行以下命令：
```
$ npm list -g
```
示例输出：
```
/home/sk/.nvm/versions/node/v9.4.0/lib
├─┬ async@2.6.0
│ └── lodash@4.17.4
└─┬ npm@5.6.0
├── abbrev@1.1.1
├── ansi-regex@3.0.0
├── ansicolors@0.3.2
├── ansistyles@0.1.3
├── aproba@1.2.0
├── archy@1.0.0
[...]
```
该命令将列出所有模块及其依赖关系。
要仅仅列出顶级模块，使用 -depth=0 选项：
```
$ npm list -g --depth=0
/home/sk/.nvm/versions/node/v9.4.0/lib
├── async@2.6.0
└── npm@5.6.0
```
##### 寻找 NodeJS 模块
要搜索一个模块，使用 "npm search" 命令：
```
npm search <search-string>
```
例如：
```
$ npm search request
```
该命令将显示包含搜索字符串 "request" 的所有模块。
##### 移除 NodeJS 模块
要删除本地包，转到项目目录并运行以下命令，这会从 **node_modules** 目录中删除包：
```
$ npm uninstall <package-name>
```
要从 **package.json** 文件中的依赖关系中删除它，使用如下所示的 **save** 标志：
```
$ npm uninstall --save <package-name>
```
要删除已安装的全局包，运行：
```
$ npm uninstall -g <package>
```
##### 清楚 NPM 缓存
默认情况下，NPM 在安装包时，会将其副本保存在 $HOME 目录中名为 npm 的缓存文件夹中。所以，你可以在下次安装时不必再次下载。
查看缓存模块：
```
$ ls ~/.npm
```
随着时间的推移，缓存文件夹会充斥着大量旧的包。所以不时清理缓存会好一些。
从 npm@5 开始，npm 缓存可以从 corruption 问题中自行修复，并且保证从缓存中提取的数据有效。如果你想确保一切都一致，运行：
```
$ npm cache verify
```
清楚整个缓存，运行：
```
$ npm cache clean --force
```
##### 查看 NPM 配置
要查看 NPM 配置，键入：
```
$ npm config list
```
或者
```
$ npm config ls
```
示例输出：
```
; cli configs
metrics-registry = "https://registry.npmjs.org/"
scope = ""
user-agent = "npm/5.6.0 node/v9.4.0 linux x64"
; node bin location = /home/sk/.nvm/versions/node/v9.4.0/bin/node
; cwd = /home/sk
; HOME = /home/sk
; "npm config ls -l" to show all defaults.
```
要显示当前的全局位置：
```
$ npm config get prefix
/home/sk/.nvm/versions/node/v9.4.0
```
好吧，这就是全部了。我们刚才介绍的只是基础知识，NPM 是一个广泛话题。有关更多详细信息，参阅 [**NPM Getting Started**][3] 指南。
希望这对你有帮助。更多好东西即将来临，敬请关注！
干杯！
--------------------------------------------------------------------------------
via: https://www.ostechnix.com/manage-nodejs-packages-using-npm/
作者：[SK][a]
译者：[MjSeven](https://github.com/MjSeven)
校对：[校对者ID](https://github.com/校对者ID)
本文由 [LCTT](https://github.com/LCTT/TranslateProject) 原创编译，[Linux中国](https://linux.cn/) 荣誉推出
[a]:https://www.ostechnix.com/author/sk/
[1]:https://www.ostechnix.com/manage-python-packages-using-pip/
[2]:https://www.npmjs.com/package/commander
[3]:https://docs.npmjs.com/getting-started/