npm与包(怎样开发一个自己的包)

npm上发布一个包的步骤

明确自己需要的功能需求(因为需要重复用,记得写备注知道哪一块是什么需求的功能)

初始化包的基本结构

1.新建一个文件夹(随便叫啥,去官网查询一下有没有重复),作为包的根目录

2.在文件夹内新建三个文件

*package.json(用来管理配置文件,name文件名,version版本号,main入口文件,license协议...等)

*index.js(包的入口文件,主要的功能代码就写在这)

*README.md(包的说明文档,能够实现哪些功能,是哪个版本的一些基础信息,方便其他人看到功能后下载)

包大致分为两大类

1.项目包

那些被安装到项目的 node_modules 目录中的包，都是项目包。

项目包又分为两类

*开发依赖包

npm i 包名 -D  (被记录到devDependencies节点下,只在开发期使用)

*核心依赖包

npm i 包名 (被记录到dependencies节点下,在开发期和项目上线后都会使用)

2.全局包

在执行 npm install 命令时,提供 -g 参数,会把包安装成全局包

npm i 包名 -g  #全局安装指定的包
npm uninstall 包名 -g  #卸载全局安装的包

全局包会被安装到 C:\Users\用户目录\AppData\Roaming\npm\node_modules  目录下

注意:

1.只有使用工具性质的包,才有全局安装的必要性,因为它们可以提供好用的终端命令

2.判断包是否需要全局安装后才能使用,参考官方提供的使用说明

包怎样被使用

1.通过命令行  (全局安装)

2.通过require引入后使用  (项目包)

i5ting_toc

i5ting_toc是一个可以把md文档转为html页面的工具

使用步骤:

# 将 i5ting_toc 安装为全局包
npm install -g i5ting_toc
#调用 i5ting_toc,实现md转html的功能
i5ting_toc -f 要转换的md文件路径 -o

npm常用的命令(记不住,使用时回头翻翻)

npm init  会引导你创建一个package.json文件，包括名称、版本、作者这些信息等

npm remove <name>移除

npm update <name>更新

npm ls 列出当前安装的所有包

npm root 查看当前包的安装路径

npm root -g  查看全局的包的安装路径

npm help  帮助，如果要单独查看install命令的帮助，可以使用的npm help install

发布包

注册 npm 账号

1.访问npmjs.com 官网,点击 sign up,进去注册

2.填写账号相关信息

3.点击提交,注册账号

4.登录邮箱,点击验证链接,进行账号的验证

注册完成后,在终端执行 npm login 命令 ,依次输入用户名,密码,邮箱后,登录成功

将终端切换到包的根目录后,运行 npm publish 命令 ,包就发布到了npm上

注意:

在运行 npm login 命令前,先将下包的服务器地址切换成 npm 官方服务器,否则会发布包失败.(发布后刷新)

怎样删除已发布的包

运行 npm unpublish 包名 --force 命令,就可以在npm上删除了