关于npm
NPM是随同NodeJS一起安装的包管理工具,能解决NodeJS代码部署上的很多问题,常见的使用场景有以下几种:
- 允许用户从NPM服务器下载别人编写的第三方包到本地使用。
- 允许用户从NPM服务器下载并安装别人编写的命令行程序到本地使用。
- 允许用户将自己编写的包或命令行程序上传到NPM服务器供别人使用。
发布代码到npm步骤
- 验证node.js、验证npm
node -v
npm -v
如果显示版本号,说明已安装node.js与npm包 - 新建package.json文件
package.json 位于模块的目录下,用于定义包的属性。
在项目根目录下新建一个package.json,这是一个用来描述你的包的json文件,例如包名,依赖的其他包,作者等等。
package.json属性说明:
- name - 包名。
- version - 包的版本号。
- description - 包的描述。
- homepage - 包的官网 url 。
- author - 包的作者姓名。
- contributors - 包的其他贡献者姓名。
- dependencies - 依赖包列表。如果依赖包没有安装,npm 会自动将依赖包安装在 node_module 目录下。
- repository - 包代码存放的地方的类型,可以是 git 或 svn,git 可在 Github 上。
- main - main 字段指定了程序的主入口文件,require(‘moduleName’) 就会加载这个文件。这个字段的默认值是模块根目录下面的 index.js。
- keywords - 关键字
借助npm来初始化可快速新建,在根目录下输入命令:
npm init
- 编写代码
在根目录下创建index.js
const tool = ()=>{
let str = 'hello npm';
document.write(str)
};
export default tool
- 发布
npm publish
如果看到这样的提示,那么恭喜你已经发布了一个npm包:
这样你就可以在https://www.npmjs.com搜索并找到你刚才发布的npm包名(例如我的是:syc-tools):
包引用
在终端输入指令cnpm install syc-tools --save-dev
安装成功后import引入使用
import tool from 'syc-tools'
Tips
- 如果没有npm账号,需注册,
注册方法:
在终端输入指令npm adduser
输入用户名、密码、邮箱 - 如果需要更新包,在修改完代码后请记得修改package.json包的version字段,然后
npm publish
。否则会无法发布; - 如果在发布中显示类似’请确认你是否有权限更新xxx包’的英文提示,这就说明你的包名有人使用了。换个包名就好啦。
- 如果你想删除一个自己发布过的包,请使用命令
npm unpublish --force ‘包名’