阿西河

所有教程

公众号
🌙
阿西河前端的公众号

我的收藏

    最近访问  (文章)

      教程列表

      抓包专区
      测试专区

      如何创建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 中填写的信息?
      目录
      目录