当前位置: 首页 > 科技观察

创建现代Npm包的最佳实践

时间:2023-03-13 08:49:35 科技观察

技术一直在变化,我们的流程和实践需要跟上这些变化。因此,虽然npm已有12年历史,但围绕npm包创建的实践应该更加现代。在本课中,我们将使用现代最佳实践(截至2022年)逐步创建一个npm包。首先学习如何创建npm包,这样您就可以熟悉构建包并将其发布到npm注册表。然后,学习如何通过设置测试框架、持续集成和部署管道、安全检查和发布的自动语义版本控制来制作更健壮、可用于生产的npm包。简单的npm包示例让我们通过一个简单的示例来熟悉创建和发布npm包的过程。创建项目创建GitHub存储库:https://github.com/new克隆本地存储库。例如:gitclonehttps://github.com/snyk-labs/simple-npm-package.git打开终端并输入克隆的项目文件夹。例如:cdsimple-npm-package运行npminit-y来创建package.json文件。注意:如果您克隆了示例存储库,则不需要此步骤。在package.json中取一个名字,并为名称字段对应的包编写代码创建一个npm帐户为了让我们的npm包对其他人可用,需要一个npm帐户。通过https://www.npmjs.com/signup注册为了增加安全性,请在您的npm帐户上启用2FA:https://docs.npmjs.com/configuring-two-factor-authentication使用npmlogin命令登录您在终端中的npm帐户并按照屏幕上的说明进行操作。>npmloginnpmnotice登录https://registry.npmjs.org/Username:clarkioPassword:Email:(thisISpublic)npmnoticePleaseusetheone-timepassword(OTP)fromyourauthenticatorapplicationEnterone-来自我们的身份验证器应用程序的时间密码:在https://registry.npmjs.org/上以clarkio身份登录。如何发布npm包一旦你有了一个npm项目和一个npm帐户,你就可以将你的npm包发布到公共官方npmjs注册中心,以便其他人可以使用它。以下是您在执行之前检查将要发布的内容,然后运行实际发布过程的步骤。从终端运行npxnpm-packlist以查看发布的包中将包含哪些内容。这确保我们不会丢失包正常运行所需的任何源代码文件。确保我们不会不小心将敏感信息泄露给公众也是一种很好的做法,例如带有数据库凭据或API密钥的本地配置文件。>npxnpm-packlistLICENSEindex.jspackage.jsonREADME.md在终端中,运行npmpublish--dry-run以查看实际运行命令时会发生什么。>npm发布--dry-runnpm通知enpm通知