npm 包 @charmander/eslint-config-base 使用教程

前言

在前端开发中，代码规范是十分重要的，可以提高代码的可维护性、可读性、降低出 bug 的风险等等。而 eslint 可以帮助我们实现对代码规范的检查。

下面介绍的 @charmander/eslint-config-base，是一个符合 eslint 规范的 eslint 配置文件，可以帮助我们快速的将 eslint 集成到我们的项目中。

安装

在使用 @charmander/eslint-config-base 之前，需要确保你的项目中已经安装了 eslint，如果没有安装可以使用下面命令安装：

npm install eslint --save-dev

然后可以执行如下命令安装 @charmander/eslint-config-base

npm install @charmander/eslint-config-base --save-dev

配置文件

完成安装后，可以在项目的根目录下创建一个 .eslintrc.js 文件，并添加如下内容：

module.exports = {
    extends: "@charmander/eslint-config-base"
};

这里我们通过 extends 继承了 @charmander/eslint-config-base 配置。

如果你的项目中有一些特殊的 eslint 配置需求，可以在 .eslintrc.js 文件中添加配置，例如：

module.exports = {
    extends: "@charmander/eslint-config-base",
    rules: {
        "no-console": "off"
    }
};

配置 eslint 命令

由于通过继承 @charmander/eslint-config-base，我们可以使用一些已经定义好的规则。接下来我们同样需要在项目中配置 eslint 的命令，以便在开发时及时发现代码中的问题。

在 package.json 文件中，添加如下的脚本配置：

{
    "scripts": {
        "eslint": "eslint src/**"
    }
}

这里的 src/** 是指检查 src 目录下的所有 js 文件，你也可以根据自己的需求修改。

然后运行如下命令：

npm run eslint

即可检查项目中的代码规范问题。

总结

通过使用 @charmander/eslint-config-base，我们可以快速集成 eslint 到我们的项目中，提高代码的可维护性、可读性、降低出 bug 的风险等等。希望这篇文章对你有帮助。

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