npm 包 @clark/eslint-config-ember 使用教程

简介

@clark/eslint-config-ember 是一个在 Ember.js 项目中使用的 ESLint 配置规则包。此包可以帮助开发者规范化代码风格，提高代码质量和可读性。

安装

在你的项目目录下，执行以下命令：

npm install --save-dev @clark/eslint-config-ember

使用

在项目的 .eslintrc 文件中，指定该包规则：

{
  "extends": ["@clark/ember"]
}

如果有特殊需求，比如关闭某些规则，也可以在配置文件中进行修改：

{
  "extends": ["@clark/ember"],
  "rules": {
    "no-console": "off"
  }
}

规则说明

@clark/eslint-config-ember 中包含了许多常用的规则，下面我们介绍其中的一些：

ember/no-empty-attrs

禁止在标签中使用空的属性，例如：

<div class=""></div>
<HelloWorld @message=""></HelloWorld>

如果你这么写，eslint 就会在控制台中打印出以下提示信息：

Do not use empty attribute '{{attr}}'

ember/no-observers

禁止在代码中使用 observes 观察者。

ember/no-mixins

禁止在代码中使用 Ember.Mixin。

ember/no-jquery

禁止在代码中使用 jQuery，推荐使用 Ember 或者原生 JavaScript。

ember/no-test-this-render

在测试代码中，不允许使用 this.render()。

示例代码

比如我们有一个简单的 Ember.js 的项目，包含如下代码：

import Route from '@ember/routing/route';

export default class MyRoute extends Route {
  model() {
    // 在这里请求数据
  }
}

当我们使用 @clark/eslint-config-ember 后，将会自动应用定义的规则：

-- -------------------- ---- -------
-
  ---------- -----------------
  -------- -
    ----------------------- --------
    --------------------- --------
    ------------------ --------
    ------------------ --------
    ---------------------------- -------
  -
-

如果我们在代码中使用了空属性：

<div class=""></div>

eslint 将会在控制台中打印出以下提示信息：

Do not use empty attribute '{{attr}}'

总结

通过使用 @clark/eslint-config-ember，我们能够规范化代码风格，提高代码质量和可读性。同时，对于不符合规则的代码，ESLint 也会提示我们让我们及时修改错误。

因此，我们强烈推荐在开发 Ember.js 项目时使用 @clark/eslint-config-ember，以便在提高工作效率的同时，为项目的长期发展打下良好的基础。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f76874a7116197505561a74