格式化和 Linting 以保持一致性

碧海醫心

发布时间：2024-11-08 10:51:42

904人浏览过

来源于dev.to

转载

此活动涉及在我的开源项目 genereadme 中实施统计分析工具，以提高代码质量和一致性。

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

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

贡献

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

genereadme

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

格式化和 Linting 以保持一致性

用法

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

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

api_key=api_key

or

genereadme  -a api_key
genereadme  --api-key api_key

安装依赖项：

npm install -g

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

genereadme …

在 github 上查看

格式化程序

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

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

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

短绒

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

magento(麦进斗)

Magento是一套专业开源的PHP电子商务系统。Magento设计得非常灵活，具有模块化架构体系和丰富的功能。易于与第三方应用系统无缝集成。Magento开源网店系统的特点主要分以下几大类，网站管理促销和工具国际化支持SEO搜索引擎优化结账方式运输快递支付方式客户服务用户帐户目录管理目录浏览产品展示分析和报表Magento 1.6 主要包含以下新特性：•持久性购物 - 为不同的

下载

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

如何使用工具

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

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

如何使用正则表达式精确匹配指定字符串（排除含特定前缀的整行）

如何使用正则表达式精准匹配行内特定字符串（排除含 import 的整行）

如何在正则中精准匹配特定字符串（排除含指定前缀的整行）

如何在 Windows 命令提示符中正确运行 Node.js 脚本

javascript如何调试_有哪些常用的调试工具

相关专题

js获取数组长度的方法

在js中，可以利用array对象的length属性来获取数组长度，该属性可设置或返回数组中元素的数目，只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值，也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容，供大家免费下载使用。

553

2023.06.20

js刷新当前页面

js刷新当前页面的方法：1、reload方法，该方法强迫浏览器刷新当前页面，语法为“location.reload([bForceGet]) ”；2、replace方法，该方法通过指定URL替换当前缓存在历史里（客户端）的项目，因此当使用replace方法之后，不能通过“前进”和“后退”来访问已经被替换的URL，语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

374

2023.07.04

js四舍五入

js四舍五入的方法：1、tofixed方法，可把 Number 四舍五入为指定小数位数的数字；2、round() 方法，可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

731

2023.07.04

js删除节点的方法

js删除节点的方法有：1、removeChild()方法，用于从父节点中移除指定的子节点，它需要两个参数，第一个参数是要删除的子节点，第二个参数是父节点；2、parentNode.removeChild()方法，可以直接通过父节点调用来删除子节点；3、remove()方法，可以直接删除节点，而无需指定父节点；4、innerHTML属性，用于删除节点的内容。

477

2023.09.01

JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号，可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容，供大家免费下载体验。

394

2023.09.04

js生成随机数的方法

js生成随机数的方法有：1、使用random函数生成0-1之间的随机数；2、使用random函数和特定范围来生成随机整数；3、使用random函数和round函数生成0-99之间的随机整数；4、使用random函数和其他函数生成更复杂的随机数；5、使用random函数和其他函数生成范围内的随机小数；6、使用random函数和其他函数生成范围内的随机整数或小数。

990

2023.09.04

如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍：1、内联脚本是将JavaScript代码直接嵌入到HTML标签中；2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中；3、外部脚本是将JavaScript代码放置在一个独立的文件；4、外部脚本是将JavaScript代码放置在一个独立的文件。

656

2023.09.12

Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型，用于表示独一无二的值。Symbol的特点：1、独一无二，每个Symbol值都是唯一的，不会与其他任何值相等；2、不可变性，Symbol值一旦创建，就不能修改或者重新赋值；3、隐藏性，Symbol值不会被隐式转换为其他类型；4、无法枚举，Symbol值作为对象的属性名时，默认是不可枚举的。

551

2023.09.20