Thanks to visit codestin.com
Credit goes to github.com

Skip to content

npm 基础用法 #104

@qingquan-li

Description

@qingquan-li

参考:


1. npm install

安装项目依赖(的软件包)。

在当前目录中,如果已经存在 package.json 文件,那么执行命令 npm install , npm 将使用语义版本规则来查看该文件中列出的依赖关系并下载最新版本的软件包。
这将在当前目录中创建 node_modules 目录(如果目录尚不存在),并将项目依赖的软件包下载到该目录。
如果加了 -g 参数则会安装到全局。

注意:安装项目依赖时不要使用代理(proxy),不然会因为安全性问题报错。

实例:

zanui-weapp



2. npm run

执行编译。

参考:阮一峰 | npm scripts 使用指南

npm 允许在 package.json文件里面 ,使用 scripts 字段定义脚本命令。

{
  "scripts": {
    "dev": "node scripts/build-dev.js --color"
  }
}

上面代码是 package.json 文件的一个片段,里面的 scripts 字段是一个对象。它的每一个属性,对应一段脚本(上例的 build-dev.js 在当前目录中的 scripts 文件中)。


实例: 从 GitHub 下载: git clone 有赞小程序UI git clone https://github.com/youzan/zanui-weapp.git ,运行 npm install 安装项目依赖后,执行组件编译: npm run dev
这将在 zanui-weapp/example 目录(小程序实例项目)中生成一个 dist 文件(内含编译后的组件)。

$ npm run dev
# 等同于执行
$ node build-dev.js


3. npm install <package_name>

安装软件包。

这将在当前目录中创建 node_modules 目录(如果目录尚不存在),并将该软件包下载到该目录。

卸载包:

$ npm uninstall <package>
# 卸载全局软件包
$ npm install -g <package>

记录安装(添加依赖)到 package.json

  1. 把 npm 软件包记录到 package.json 的 dependencies (生产环境)依赖中。

    npm install <package_name> --save
  2. 把 npm 软件包记录到 package.json 的 devDependencies (开发环境)依赖中。

    注:一般使用这种方式在 package.json 中添加依赖关系。

    npm install <package_name> --save-dev

附: npm 依赖管理 - dependencies

参考:nodejs 包管理工具 npm 的模块依赖 dependencies 简介

nodejs 包管理工具 npm 依靠 package.json 文件进行依赖管理。

package.json 文件中的 dependencies 与 devDependencies 配置,决定了下载一个包后还需要如何下载依赖包;依赖包后面声明的版本配置则决定了其位置如何存放。

在一个目录下,如果存在 package.json,那么执行命令 npm install ,则会安装相关依赖包到当前目录下的 node_modules 目录中。如果加了 -g 参数则会安装到全局。

dependencies 与 devDependencies 是最常见的依赖声明,此外还有 optionalDependencies 。



4. npm init 和创建 package.json

Node.js 包管理工具 npm 使用 package.json 文件进行依赖管理。

管理本地安装的 npm 软件包,最好方法是创建一个 package.json 文件。


package.json 文件作用:

用于定义项目中所需的各种模块,以及项目的配置信息(比如名称、版本、许可证等元数据)。

  • 列出你的项目依赖的软件包。
  • 允许你使用语义版本规则来指定项目可以使用的包的版本。
  • 让你的构建( build )可以复用,因此很多更容易与其他开发者共享。

package.json 文件中必须包含:

  • "name"
    • 全部使用小写
    • one word, no spaces(空格)
    • 允许连字符和下划线
  • "version"

实例:

{
  "name": "my-awesome-package",
  "version": "1.0.0"
}

创建一个 package.json 文件

方法一:创建一个自定义的 package.json 文件

运行 CLI (命令行界面 command-line interface )问卷( questionnaire ):

$ npm init

npm-init


方法二:创建一个默认的 package.json 文件
$ npm init --yes

npm-init---yes

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions