如何创建npm包

🌙
手机阅读
本文目录结构

Node.js 模块是一种可以发布到 npm 的包。

创建package.json

当你创建一个新模块时,创建 package.json 文件是第一步。

你可以使用 npm init 命令创建 package.json 文件。

命令行中将会提示 package.json 字段中需要你输入的值。

名称(name) 和 版本(version) 这两个字段是必填的。

你还需要输入 入口文件字段(main) 字段,当然,可以使用默认值 index.js

如果你想为作者(author)字段添加信息,你可以使用以下格式(邮箱、网址都是选填的):

Your Name <email@example.com> (http://example.com)

指定入口文件

创建 package.json 文件之后,还需要创建模块的入口文件。

如果使用默认值,文件名是 index.js

默认的基础文件如下

{
  "name": "axihe-test",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

main字段就是入口

书写方法

在此文件中,添加一个函数,作为 exports对象的一个属性。

这样,require 此文件之后,这个函数在其他代码中就可以使用了。

exports.printMsg = function() {
  console.log("This is a message from the demo package");
}

记得一定要导出模块;

发送并且使用

  • 将你的包发布到 npm。
    • 如何发布请参考 npm publish
  • 在你的项目外新建一个目录。
  • 然后 cd 进入这个新目录。
  • 执行 npm install <package> 命令。
  • 创建一个 test.js 文件,require 这个包,并调用其中的方法。
  • 执行 node test.js 命令。是否输出 console.log 中填写的信息?

AXIHE / 精选资源

浏览全部教程

面试题

学习网站

前端培训
自己甄别

前端书籍

关于朱安邦

我叫 朱安邦,阿西河的站长,在杭州。

以前是一名平面设计师,后来开始接接触前端开发,主要研究前端技术中的JS方向。

业余时间我喜欢分享和交流自己的技术,欢迎大家关注我的 Bilibili

关注我: Github / 知乎

于2021年离开前端领域,目前重心放在研究区块链上面了

我叫朱安邦,阿西河的站长

目前在杭州从事区块链周边的开发工作,机械专业,以前从事平面设计工作。

2014年底脱产在老家自学6个月的前端技术,自学期间几乎从未出过家门,最终找到了满意的前端工作。更多>

于2021年离开前端领域,目前从事区块链方面工作了