美文网首页饥人谷技术博客
Atom 编辑器配置 ESLint 和 EditorConfig

Atom 编辑器配置 ESLint 和 EditorConfig

作者: _于曼丽_ | 来源:发表于2018-08-24 19:57 被阅读4次

    ESLint 是一个代码规范和语法错误检查工具。使用 ESLint 可以规范我们的代码书写,可以在编写代码期间就能发现一些低级错误。ESLint 需要结合编辑器或 IDE 使用。

    EditorConfig 是一个保持缩进风格的一致的工具。当多人共同开发一个项目的时候,往往会出现每个人用不同编辑器的情况,而且有的人用 tab 缩进,有的人用 2 个空格缩进,有的人用 4 > 个空格缩进,EditorConfig 就是为了解决这个问题而诞生。EditorConfig 需要结合编辑器或 IDE 使用。

    配置 ESLint

    在 Atom 编辑器中,安装插件 linter 和 linter-eslint。

    linter.png

    在项目目录中本地安装 eslint。由于我们没有选择全局安装 eslint,因此只要是想使用 eslint 的项目,都要本地安装 eslint,并且初始化生成一个 .eslintrc.json 的配置文件。

    $ npm install eslint --save-dev
    

    在项目目录中初始化 eslint 配置。

    $ ./node_modules/.bin/eslint --init
    

    依次选择以下选项:

    • Use a popular style guide
    • Standard
    • JSON

    eslint 会创建一个 .eslintrc.json 的配置文件,同时自动安装并添加相关的模块到 devDependencies。这里我们使用 Standard 规范,其主要特点是不加分号。

    至此,在你的项目目录 (包括子目录) 中使用 Atom 编辑器编辑以 .js 结尾的文件时,ESLint 会自动检查你的语法是否符合规范。

    lint.png

    配置 EditorConfig

    在 Atom 编辑器中,安装插件 editorconfig。

    editorconfig.png

    在项目目录中创建 .editorconfig 配置文件。具体配置文件可以参考 https://atom.io/packages/editorconfig

    # editorconfig.org
    root = true
    
    [*]
    indent_style = space
    indent_size = 2
    end_of_line = lf
    charset = utf-8
    trim_trailing_whitespace = true
    insert_final_newline = true
    tab_width = 2
    
    [*.md]
    trim_trailing_whitespace = false
    
    [Makefile]
    indent_style = tab
    

    这里我们使用 2 个空格缩进,tab 长度也是 2 个空格。trim_trailing_whitespace 用来删除每一行最后多余的空格,insert_final_newline 用来在代码最后插入一个空的换行。

    至此,在你的项目目录 (包括子目录) 中使用 Atom 编辑器编辑任何类型文件的时候,都会按照 editorconfig 的配置文件来自动处理空白字符。

    参考

    《一起学 Node.js》彻底重写完毕

    相关文章

      网友评论

        本文标题:Atom 编辑器配置 ESLint 和 EditorConfig

        本文链接:https://www.haomeiwen.com/subject/vnmiiftx.html