npm 包 eslint-config-get-off-my-lawn-prettier 使用教程

在前端开发中，代码风格规范化越来越受到重视。而 eslint 是目前最流行的代码规范化工具之一。而在 eslint 的基础上， eslint-config-get-off-my-lawn-prettier 是一款结合了 prettier 强制格式化和一些常见的 eslint 规则的 npm 包，可以让开发者在编写代码时更加规范化和高效化。

安装 eslint-config-get-off-my-lawn-prettier

首先，在项目中安装 eslint 和 eslint-config-get-off-my-lawn-prettier 包：

$ npm i eslint eslint-config-get-off-my-lawn-prettier -D

安装完毕后，在项目根目录下创建一个 .eslintrc.js 的配置文件：

module.exports = {
    extends: ['get-off-my-lawn-prettier'],
    rules: {
        // 自定义规则
    }
}

然后在项目根目录下创建一个 .prettierrc.js 的配置文件，用于配置 prettier 规则：

module.exports = {
    // prettier 配置选项
}

需要注意的是，在 eslint 的官网中，提供了一份 可复用的配置文件，这份配置文件已经集成了 eslint-plugin-import、eslint-plugin-node 等官方和第三方插件的常见规则和限制。当然，也可以根据需要进行个性化的配置。

代码示例

下面是一个使用了 eslint-config-get-off-my-lawn-prettier 的代码示例：

const foo = () => 'hello'

const bar = (name) => {
  console.log(`Hello, ${name}!`)
}

bar(foo())

在使用 eslint 和 eslint-config-get-off-my-lawn-prettier 的情况下，上述代码示例可以自动格式化成为符合规范化的代码：

const foo = () => 'hello';

const bar = (name) => {
    console.log(`Hello, ${name}!`);
};

bar(foo());

总结

通过使用 eslint-config-get-off-my-lawn-prettier，我们可以在编写代码时自动强制按照代码规范化进行格式化，规避了空格、缩进、bracket 等常见问题，提升代码的可读性和维护性，并且可以避免因为代码风格问题而耗费时间和精力去解决这些琐事。

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