介绍
@hotelquickly/eslint-config-hotelquickly是HotelQuickly开发团队内部使用的ESLint配置。它基于eslint-config-airbnb构建，并进行一些自定义的修改，以满足我们的代码风格和最佳实践需求。
在这篇教程中，我们将会介绍如何安装和使用@hotelquickly/eslint-config-hotelquickly，以及如何在项目中自定义配置规则。
安装
安装@hotelquickly/eslint-config-hotelquickly非常简单。你可以使用npm或者yarn包管理器。
# 使用npm安装 npm install --save-dev @hotelquickly/eslint-config-hotelquickly # 使用yarn安装 yarn add --dev @hotelquickly/eslint-config-hotelquickly
使用
基本用法
完成安装后，在你的项目根目录下创建.eslintrc文件，并添加以下内容：
{
"extends": "@hotelquickly/hotelquickly"
}这样就可以直接使用@hotelquickly/eslint-config-hotelquickly提供的规则了。
与Prettier一起使用
如果你的项目中使用了Prettier来格式化代码，你可以使用eslint-config-prettier来关闭ESLint中与Prettier存在冲突的规则。在这种情况下，你需要添加一个.eslintrc文件，并包含以下内容：
{
"extends": [
"@hotelquickly/hotelquickly",
"plugin:prettier/recommended"
]
}自定义规则
如果需要对默认规则进行修改或者添加额外的规则，你可以在.eslintrc文件中添加以下内容：
{
"extends": "@hotelquickly/hotelquickly",
"rules": {
// 在这里添加你需要修改或者添加的规则
"rule-name": "rule-value"
}
}在命令行中运行ESLint
如果你想在命令行中运行ESLint，可以使用以下命令：
./node_modules/.bin/eslint yourfile.js
或者，你可以在package.json文件中使用scripts字段来保存命令：
{
"scripts": {
"lint": "eslint yourfile.js"
}
}这样你就可以使用以下命令来运行ESLint了：
npm run lint # 或者 yarn lint
示例代码
下面是一些符合@hotelquickly/eslint-config-hotelquickly规则的示例代码：
-- -------------------- ---- ------- -- -- ----------- ----- ------- - ------- ------- -- -- ----------- ----- -- - ---- -- -- ------ ----- ------ - --- -- - - - -- -- ------------ ----- ---- - - ---- -- ---- - - ----- ---- - - ---- - - ----- ---- - - -------- ------- - -- -- ------ ----- ------- - --- -- -- -- -- ----- ------- ------- -------- - ------- -- -- ------- ----- ---- - ------- ----- ------- - ------- ---------
总结
@hotelquickly/eslint-config-hotelquickly提供了对于代码风格和最佳实践的支持，你可以直接在你的项目中使用它，也可以根据自己的需求进行配置。希望这篇文章对你有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066bb8967216659e2440e6