npm文档翻译-向注册表提供包-创建Node.js模块

227 阅读1分钟

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

概述

  • 创建package.json文件
  • 创建另一个应用引用您的模块时将加载的文件
  • 测试你的模块

创建package.json文件

  1. 创建package.json文件,在命令行,在你Node.js模块的根目录,运行npm init:
    • 对于作用域模块,运行 npm init --scope=@scope-name
    • 对于非作用域模块,运行npm init
  2. 对于必填字段进行填写(name和version),以及main字段:
    • name:你的模块的名称
    • version:初始化的模块版本。我们建议遵循语义化版本控制准则,从1.0.0开始。
      package.json文件更多的信息请参阅"Creating a package.json file"。

创建另一个应用引用您的模块时将加载的文件

在文件中,添加一个函数作为exports对象的属性。这将使这个函数可用于其他代码:

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

测试你的模块

  1. 将包发布到npm
    • 对于私有包和非作用域包,使用npm publish。
    • 对于作用域公共包,使用npm publish --access public
  2. 在命令行中,在你的项目文件夹外创建一个新的测试文件夹
mkdir test-directory  
  1. 切换到新的文件夹:
cd /path/to/test-directory  
  1. 在测试文件夹中,安装你的模块:
npm install <your-module-name>  
  1. 在测试文件夹中创建test.js文件,该文件引用你的模块并且将你的模块作为方法调用。
  2. 在命令行,运行node test.js。发送到console.log的信息将会展示出来。