freeCodeCamp/guide/chinese/miscellaneous/create-an-npm-module/index.md

1.9 KiB
Raw Blame History

title localeTitle
Create an Npm Module 创建一个Npm模块

NPM模块是捆绑到可分发包中的一组Javascript功能。 NPM维护所有可用包的注册表,也是用于从其注册表安装包的工具。

NPM的美妙之处在于您可以组装其他人创建的包以创建新的东西稍后某人可以使用您创建的包。如果您想要与世界共享某些代码则可以轻松地将模块发布到NPM。

第1步创建脚本

我创建了这个简单的实用程序作为index.js

var time = new Date().toTimeString(); 
 console.log(time); 

第2步创建包信息

下一步是创建要与包一起发布的信息,存储在package.json 。 NPM提供了一个向导可以轻松创建此文件。

只需运行npm init并回答问题。

你的package.json应该是这样的:

{ 
  "name": "whattimeisit", 
  "version": "1.0.0", 
  "description": "accurate time retrieval", 
  "main": "index.js", 
  "author": "HoursAndMinutes", 
  "license": "ISC" 
 } 

如果代码在GitHub上请不要忘记包含GitHub存储库链接

第3步在NPM上创建用户帐户

要将包发布到NPM您需要注册一个帐户。为此请运行npm adduser 。您可以使用npm config ls验证当前正在使用的帐户。

第4步发布到NPM

在将包发布到NPM之前请检查该目录是否包含您不希望公开的任何文件例如密码私钥等。您可以将这些文件添加到名为.npmignore的文件中,以将其从包发布中排除。 NPM也会尊重.gitignore如果你有。

完成包装内容后,运行npm publish 。您可以在https://npmjs.com/package/yourpackagename确认您的包裹的详细信息。

更多信息:

创建Node.js模块npm