返回

eslint配置及Prettier集成优化之道2022

前端

现在是时候将 JavaScript、TypeScript、HTML、CSS、JSON、markdown、YAML 文件的编码风格统一化了!本文旨在从全局角度,教会您如何以最低的配置开销和最快的集成速度,快速上手 ESLint 和 Prettier。本文涉及的知识范围包括:

  • 最新版本的 ESLint 8
  • 包括 JavaScript、TypeScript、HTML、CSS、JSON、markdown、YAML 文件的编码风格校验
  • 流行编辑器的 ESLint 和 Prettier 插件
  1. 安装 ESLint 和 Prettier

    npm install --save-dev eslint prettier
    
  2. 创建 .eslintrc.js 文件

    module.exports = {
      env: {
        browser: true,
        node: true,
      },
      extends: [
        'eslint:recommended',
        'plugin:prettier/recommended',
      ],
      plugins: ['prettier'],
      rules: {
        'prettier/prettier': 'error',
      },
    };
    
  3. 创建 .prettierrc.js 文件

    module.exports = {
      tabWidth: 2,
      printWidth: 100,
      semi: true,
      singleQuote: true,
      trailingComma: 'all',
      arrowParens: 'avoid',
    };
    
  4. 编辑器插件安装

    • Visual Studio Code :ESLint 和 Prettier
    • Sublime Text :ESLint 和 Prettier
    • Atom :ESLint 和 Prettier
  5. 启用插件

    • Visual Studio Code :转到“设置”>“扩展”,然后启用 ESLint 和 Prettier 扩展。
    • Sublime Text :转到“首选项”>“包设置”,然后启用 ESLint 和 Prettier 包。
    • Atom :转到“设置”>“包”,然后启用 ESLint 和 Prettier 包。
  6. 运行 ESLint 和 Prettier

    • Visual Studio Code :按 Ctrl+Alt+L 运行 ESLint。按 Shift+Alt+F 运行 Prettier。
    • Sublime Text :按 Ctrl+Alt+E 运行 ESLint。按 Ctrl+Alt+P 运行 Prettier。
    • Atom :按 Ctrl+Alt+L 运行 ESLint。按 Ctrl+Alt+P 运行 Prettier。
  7. 配置 ESLint 和 Prettier

    您可以通过编辑 .eslintrc.js.prettierrc.js 文件来配置 ESLint 和 Prettier。有关更多信息,请参阅 ESLint 和 Prettier 的文档。

  8. 自定义规则

    您可以使用 ESLint 和 Prettier 的插件来添加自定义规则。有关更多信息,请参阅 ESLint 和 Prettier 的文档。

  9. 开始使用 ESLint 和 Prettier

    现在您已经配置了 ESLint 和 Prettier,就可以开始使用它们来检查和修复代码中的问题。您可以使用编辑器插件或命令行工具来运行 ESLint 和 Prettier。

  10. 常见问题

    如果您在使用 ESLint 和 Prettier 时遇到问题,可以查看 ESLint 和 Prettier 的文档或在 GitHub 上提交问题。

  11. 结论

    ESLint 和 Prettier 是非常有用的工具,可以帮助您统一编码风格、优化团队协作流程。希望本文能帮助您快速上手 ESLint 和 Prettier,并将其集成到您的开发流程中。