克莱布恩特拉 / 基因自述文件

GENEREADME 是一个命令行工具，它接收源代码文件并生成 README.md 文件，该文件利用 LLM 解释文件中的代码。

贡献

欢迎为 GENEREADME 做出贡献！请查看 CONTRIBUTING.md 以获取有关设置环境、如何运行和测试该工具以及提交更改的指南。

GENEREADME

GENEREADME 是一个命令行工具，它接收文件、处理它并生成一个 README 文件，其中包含文件内容的解释或文档。该工具利用 OpenAI 聊天完成来分析文件并生成内容。

Formatting and Linting for consistency

用法

该工具目前支持 Groq 和 OpenRouter，默认使用 Groq。必须提供相应提供商的有效 API 密钥。

通过创建 .env 文件或在使用命令时通过 -a 或 --api-key 标志来提供有效的 API 密钥：

API_KEY=API_KEY

or

genereadme <files> -a API_KEY
genereadme <files> --api-key API_KEY

登录后复制

安装依赖项：

npm install -g

登录后复制

使用现有示例文件运行该工具或开始使用您自己的：

genereadme <files&gt
genereadme examples/sum.js
genereadme examples/createUser.js

登录后复制

…

在 GitHub 上查看

格式化程序

对于我的格式化程序，我选择使用 Prettier。原因很简单，我选择这个是因为我之前只是使用过它的基本功能，并且我打算进一步了解它。

从技术上讲，我已经将 IDE 设置为默认使用 prettier，因此我从一开始就已经拥有了格式化程序。然而，现在项目本身有了更漂亮的设置，这将允许贡献者也使用格式化程序，使项目的代码在格式方面保持一致。

我只是在 .prettierrc 文件中添加了关于如何格式化代码的规则，以及 .vscode/ 下的 settings.json 中的一些设置，用于保存格式等选项。

短绒

对于我的 linter，我选择使用 ESLint。由于我使用的是 JavaScript，所以我使用了一种流行的 linter，我以前也有过使用它的经验，但我自己并没有真正设置过。因此，我选择了 ESLinter。

设置 ESLinter 并不复杂。在 eslint.config.js 中进行简单的安装和设置规则就足以让 linter 正常工作。但是，由于我同时使用格式化程序和 linter，因此我必须确保它们都能正常工作。其中基本上包括附加规则，以确保不会与 linter 和格式化程序发生任何冲突。

如何使用工具

这些工具在项目中的使用方式有很多种，我个人更喜欢这些特定的配置：format on save for prettier 和 run on type for eslint。这样，linter 将始终在开发人员键入时检查 linting 问题，然后格式化程序将在触发保存时自动格式化更改。

然而，对于本周的任务，我还添加了脚本以允许用户通过 CLI 手动运行格式化程序和 linter。还实现了预提交挂钩，以确保提交到存储库的任何代码都符合项目的格式和 linting 标准。通过添加这个钩子，我可以在每次提交之前自动运行 Prettier 和 ESLint，尽早发现任何问题并保持贡献之间的代码一致性。此设置有助于减少出现小格式问题的可能性，并提高参与该项目的任何人的代码可读性。

以上是格式化和 Linting 以保持一致性的详细内容。更多信息请关注PHP中文网其他相关文章！