NPM-中文文档

56次阅读

共计 1810 个字符,预计需要花费 5 分钟才能阅读完成。

关于本文档

这是一套关于 NPM 命令行和使用的文档介绍,属于 API 文档级别的;

这篇文章是整个 API 文章的目录索引;下面表格内有对应的命令说明

比官方的文档更加接地气,很多命令,都在命令行里敲一遍,截图让读者直观的看到;对于中文习惯的开发者来说,非常友好

如果见到不合适的地方,欢迎告诉我;

这里介绍 npm 的配置,文件内都是做什么用的,以及所有的 CLI 命令;

相信您看完以后,会有一个更加深刻的理解;

如果您想看 NPM 的教程,请参考本站的 NPM 教程;

杜绝纯机器翻译,本文档内容都是逐行检查过,并且命令都试验过才写出来的;

有很多地方官方文档写的比较简洁,我根据实际使用的情况有做添加和修改;

文档的目录

NPM 配置

项目 说明
./node_modulesnpm 包存放的文件夹
.npmrcnpm 配置文件
package-lock.json 列表的展示
package-locksnpm 锁定文件的说明
package.jsonnpm 的 package
shrinkwrap.json 可发布的锁定文件

CLI 命令

A

项目 说明
npm access 设置已发布软件包的访问级别
npm adduser 添加注册表用户帐户
npm audit 运行安全审核

B

项目 说明
npm bin 显示 npm bin 文件夹
npm bugs 网络浏览器中程序包的错误
npm build 建立一个包
npm bundleREMOVED

C

项目 说明
npm cache 处理软件包缓存
npm ci 使用干净的面板安装项目
npm completionnpm 的制表符完成
npm config 管理 npm 配置文件

D

项目 说明
npm dedupe 减少重复
npm deprecate 弃用软件包的版本
npm dist-tag 修改包分发标签
npm docs 在网络浏览器中获取软件包的文档
npm doctor 检查您的环境

E

项目 说明
npm edit 编辑已安装的软件包
npm explore 浏览已安装的软件包

H

项目 说明
npm help-search 搜索 NPM 帮助文档
npm help 在 npm 上获取帮助
npm hook 管理注册表挂钩

I

项目 说明
npm init 创建一个 package.json 文件
npm install-ci-test 使用干净的面板安装项目并运行测试
npm install-test 安装软件包并运行测试
npm install 安装套件

L

项目 说明
npm link 符号链接包文件夹
npm logout 注销注册表
npm ls 列出已安装的软件包

N

项目 说明
npm 包管理器

O

项目 说明
npm org 管理组织
npm outdated 检查过时的包
npm owner 管理软件包所有者

P

项目 说明
npm pack 从包中创建一个 tarball
npm pingPing NPM 注册表
npm prefix 显示前缀
npm profile 更改注册表配置文件中的设置
npm prune 删除无关的软件包
npm publish 发布包

R

项目 说明
npm rebuild 重建套件
npm repo 在浏览器中打开软件包存储库页面
npm restart 重新启动程序包
npm root 显示 npm 根目录
npm run-script 运行任意包脚本

S

项目 说明
npm search 搜索包
npm shrinkwrap 锁定要发布的依赖版本
npm star 标记您喜欢的包
npm stars 查看标记为收藏的软件包
npm start 开始打包
npm stop 停止包

T

项目 说明
npm team.html) 管理组织团队和团队成员
npm test 测试包
npm token 管理您的身份验证令牌

U

项目 说明
npm uninstall 卸载包
npm unpublish 从注册表中删除软件包
npm update 更新包

V

项目 说明
npm version 查看版本
npm view 查看注册表信息

W

项目 说明
npm whoami 显示 npm 用户名

NPM 使用

项目 说明
coding-stylenpm 推荐的编码风格
configNPM config 的详细解读
developersNPM 包 / 模块开发的注意事项
disputes 处理模块名称争议
orgsnpm 团队和组织管理的详细
registryJavaScript 包注册表
scope 范围包
scriptsnpm 如何处理 “scripts ” 字段
removalCleaning the Slate
semvernpm 的语义版本控制程序

关于 NPM

npm 是世界上最大的软件注册表。来自各大洲的开源开发人员使用 npm 共享和借用软件包,许多组织也使用 npm 管理私人开发。

更新记录

  • 2019 年 9 月 23 日开始写 NPM 中文 API 文档

本文参考 NPM 中文文档

正文完
 0