搜索
首页web前端js教程使用 GitHub Actions 将 gimme_readme 重新发布到 npm

本周在我的开源课程中,我和我的同学的任务是将我们自己的每个程序发布到包注册表。

当你听到有人说代码注册表、包注册表或注册表时,我喜欢将这些词视为代表开发人员和公司发布代码供其他人下载的地方。想要更准确的描述,可以阅读Mozilla的这篇文章:

Re-publishing gimme_readme to npm with GitHub Actions

包管理基础知识 - 学习 Web 开发 | MDN

我们的包管理器之旅到此结束。我们的下一步行动是建立一个示例工具链,将我们迄今为止学到的所有知识付诸实践。

Re-publishing gimme_readme to npm with GitHub Actions

gimme_readme - npm

gimme_readme 是一个由 AI 提供支持的命令行工具,可为您的项目生成全面的 README.md 文件。它一次分析多个源代码文件,提供每个文件的用途、功能和关键组件的简明解释。最新版本:1.0.0,最后发布:16 小时前。通过运行“npm i gimme_readme”开始在项目中使用 gimme_readme。 npm 注册表中没有其他项目使用 gimme_readme。

Re-publishing gimme_readme to npm with GitHub Actions

正如您在上面所看到的,有很多文件夹和文件对于用户(而不是开发人员)来说是不必要的。例如,您认为我的用户会希望我的“tests”文件夹来测试我的程序代码吗? 可能不是。您认为我的用户需要格式化和检查我的源代码所需的配置文件吗? 可能不是。您认为我的用户是否出于任何特定原因需要使用我的“.github”文件夹? 可能不是

为此,我一直在努力寻找一种解决方案来最大程度地减少用户下载的内容;具体来说,我希望他们只拥有我的程序运行所需的源代码

是 .npmignore 还是不 .npmignore?这就是问题所在。

当我考虑重新发布我的代码时,我也在和我的朋友 Uday Rana 讨论使用 .npmignore 文件来“忽略”我不想发布的文件的想法。

就在我提到这个主题之后,Uday 在 Google 上搜索了 .npmignore,并找到了 Jeff D 撰写的一篇关于为什么人们应该永远不使用 .npmignore 文件的文章。需要明确的是,我完全同意杰夫的文章。

本质上,这个想法是我们应该明确我们想要发布的内容(白名单),而不是说明我们不 想要发布(列入黑名单)。

使用 npm 将我们想要发布的文件列入白名单非常简单。我们需要做的就是通过添加“files”选项来编辑 package.json 文件,该选项指示我们要为程序发布哪些文件。

下面,我截取了 package.json 的“files”选项的屏幕截图,该选项指出“发布此程序时包含 src/ 目录”。我已经提交了这些更改,并且这些更改可在我的代码 v1.0.0 版本中使用。

Re-publishing gimme_readme to npm with GitHub Actions

注意:默认情况下,某些文件始终发布到 npm,无论您在“文件”选项中指定或未指定什么。如果你想了解更多如何使用“files”选项,请查看 npm 的官方文档如何使用 file 选项。

使用更新后的 package.json 将我的代码发布到 npm 后,安装/重新安装 gimme_readme 的用户现在计算机上的膨胀会少很多!请参阅以下差异:

Re-publishing gimme_readme to npm with GitHub Actions

添加 GitHub 操作以在添加新版本时将代码发布到 npm

除了增强用户体验(通过减少通过 npm 安装 gimme_readme 带来的臃肿)之外,我还添加了一个持续开发管道(简称 cd 管道),当我创建新的项目时,它可以将我的发布过程自动化到 npm在 GitHub 上发布。有关如何执行此操作的具体详细信息,您可以参阅 GitHub 的发布 Node.js 包指南。现在感觉很好,因为只需点击几个按钮,我就可以发布我知道稳定的代码(根据我的 CI 管道),来自 GitHub。

您可以在这里找到我的 cd 管道的代码。

与乌代一起测试

正如我之前提到的,我正在与我的朋友 Uday Rana 一起进行测试。在撰写本文时,他能够安装我的工具,并像这样使用它:

Re-publishing gimme_readme to npm with GitHub Actions

事情对我来说看起来不错,而且我的工具的大多数选项或多或少都符合他的预期。但我必须再次重复这个过程,因为我想添加一些进一步的优化!

旅程永无止境……但这就是它的乐趣所在!

我最近还听说了进一步优化我的代码的方法。特别是,我致力于学习如何通过了解复合操作以及与 GitHub 操作相关的可重用工作流程来改进我的 CI 和 CD 管道。我希望这些技术能够帮助我减少编写的代码量,并提供某种类型的性能提升!我对这些主题还不太了解,但你可以打赌我可能很快就会在博客上介绍它。

我的朋友们,结束了我想在这个博客中谈论的内容。

下次见!

以上是使用 GitHub Actions 将 gimme_readme 重新发布到 npm的详细内容。更多信息请关注PHP中文网其他相关文章!

声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
node.js流带打字稿node.js流带打字稿Apr 30, 2025 am 08:22 AM

Node.js擅长于高效I/O,这在很大程度上要归功于流。 流媒体汇总处理数据,避免内存过载 - 大型文件,网络任务和实时应用程序的理想。将流与打字稿的类型安全结合起来创建POWE

Python vs. JavaScript:性能和效率注意事项Python vs. JavaScript:性能和效率注意事项Apr 30, 2025 am 12:08 AM

Python和JavaScript在性能和效率方面的差异主要体现在:1)Python作为解释型语言,运行速度较慢,但开发效率高,适合快速原型开发;2)JavaScript在浏览器中受限于单线程,但在Node.js中可利用多线程和异步I/O提升性能,两者在实际项目中各有优势。

JavaScript的起源:探索其实施语言JavaScript的起源:探索其实施语言Apr 29, 2025 am 12:51 AM

JavaScript起源于1995年,由布兰登·艾克创造,实现语言为C语言。1.C语言为JavaScript提供了高性能和系统级编程能力。2.JavaScript的内存管理和性能优化依赖于C语言。3.C语言的跨平台特性帮助JavaScript在不同操作系统上高效运行。

幕后:什么语言能力JavaScript?幕后:什么语言能力JavaScript?Apr 28, 2025 am 12:01 AM

JavaScript在浏览器和Node.js环境中运行,依赖JavaScript引擎解析和执行代码。1)解析阶段生成抽象语法树(AST);2)编译阶段将AST转换为字节码或机器码;3)执行阶段执行编译后的代码。

Python和JavaScript的未来:趋势和预测Python和JavaScript的未来:趋势和预测Apr 27, 2025 am 12:21 AM

Python和JavaScript的未来趋势包括:1.Python将巩固在科学计算和AI领域的地位,2.JavaScript将推动Web技术发展,3.跨平台开发将成为热门,4.性能优化将是重点。两者都将继续在各自领域扩展应用场景,并在性能上有更多突破。

Python vs. JavaScript:开发环境和工具Python vs. JavaScript:开发环境和工具Apr 26, 2025 am 12:09 AM

Python和JavaScript在开发环境上的选择都很重要。1)Python的开发环境包括PyCharm、JupyterNotebook和Anaconda,适合数据科学和快速原型开发。2)JavaScript的开发环境包括Node.js、VSCode和Webpack,适用于前端和后端开发。根据项目需求选择合适的工具可以提高开发效率和项目成功率。

JavaScript是用C编写的吗?检查证据JavaScript是用C编写的吗?检查证据Apr 25, 2025 am 12:15 AM

是的,JavaScript的引擎核心是用C语言编写的。1)C语言提供了高效性能和底层控制,适合JavaScript引擎的开发。2)以V8引擎为例,其核心用C 编写,结合了C的效率和面向对象特性。3)JavaScript引擎的工作原理包括解析、编译和执行,C语言在这些过程中发挥关键作用。

JavaScript的角色:使网络交互和动态JavaScript的角色:使网络交互和动态Apr 24, 2025 am 12:12 AM

JavaScript是现代网站的核心,因为它增强了网页的交互性和动态性。1)它允许在不刷新页面的情况下改变内容,2)通过DOMAPI操作网页,3)支持复杂的交互效果如动画和拖放,4)优化性能和最佳实践提高用户体验。

See all articles

热AI工具

Undresser.AI Undress

Undresser.AI Undress

人工智能驱动的应用程序,用于创建逼真的裸体照片

AI Clothes Remover

AI Clothes Remover

用于从照片中去除衣服的在线人工智能工具。

Undress AI Tool

Undress AI Tool

免费脱衣服图片

Clothoff.io

Clothoff.io

AI脱衣机

Video Face Swap

Video Face Swap

使用我们完全免费的人工智能换脸工具轻松在任何视频中换脸!

热工具

Dreamweaver Mac版

Dreamweaver Mac版

视觉化网页开发工具

SublimeText3 英文版

SublimeText3 英文版

推荐:为Win版本,支持代码提示!

SublimeText3 Mac版

SublimeText3 Mac版

神级代码编辑软件(SublimeText3)

VSCode Windows 64位 下载

VSCode Windows 64位 下载

微软推出的免费、功能强大的一款IDE编辑器

禅工作室 13.0.1

禅工作室 13.0.1

功能强大的PHP集成开发环境