npm 包 eslint-formatter-friendly 使用教程

在前端开发中，我们经常会使用 ESLint来进行代码风格和错误检查。而eslint-formatter-friendly是一个可以让 ESLint 输出更友好的格式的 npm 包。本文将详细介绍如何使用该包，以及如何配置。

安装

要安装这个 npm 包，只需要在命令行中输入以下命令即可。

npm install eslint-formatter-friendly --save-dev

执行以上的命令即可安装eslint-formatter-friendly。

使用

使用这个包很简单。你只需要在你的 ESLint 命令中加入 --format 这个参数，它指定你要用什么样的格式进行输出。

eslint example.js --format=node_modules/eslint-formatter-friendly

上面的命令将以 eslint-formatter-friendly 格式输出检查结果，具体代码示例如下：

index.js
    1:10  error    Unexpected var, use let or const instead  no-var
    2:1   warning  Unexpected console statement               no-console
    4:5   error    Expected indentation of 2 spaces but found 4  indent
    9:3   warning  Unexpected console statement               no-console

✖ 4 problems (2 errors, 2 warnings)

配置

我们可以通过修改配置文件来进行该包的设置。首先需要在 .eslintrc.js 中配置 formatter 属性，具体如下：

module.exports = {
    formatter: 'node_modules/eslint-formatter-friendly'
}

然后添加自己需要的 ESLint 配置即可。

现在，你可以通过在命令行中执行 eslint 命令来检查你的代码，并通过 eslint-formatter-friendly 插件格式化你检查结果的输出了。

总结

通过使用 eslint-formatter-friendly，我们可以让 ESLint 的检查结果更加友好。本文介绍了使用方法和配置方法。希望本文对大家有所帮助，让大家在写代码时更加高效和规范。

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