vscode+eslint+prettier 对代码进行检错及格式化

  • 在项目下安装必要插件
//无论使用yarn还是npm,需要全局安装eslint
npm install eslint -g 全局安装
//如果你使用Npm
npm install  eslint babel-eslint eslint-plugin-react eslint-config-alloy -D
//如果你使用yarn
yarn add     eslint babel-eslint eslint-plugin-react eslint-config-alloy -D
  • 在项目目录下创建配置文件 - .eslintrc.js
//.eslintrc.js
module.exports = {
    extends: [//使用哪些默认规则来检查,由于我们安装了 eslint-config-alloy 所以直接使用它的规则
        'alloy',
        'alloy/react',
    ],
    env: {
      browser: true,
      commonjs: true,
      es6: true
    },
    globals: {
      '$':true,//这里可以将一些全局变量忽略检查,如果你没有则可以不用配置
    },
    rules: {
      // 自定义你的规则,https://eslint.bootcss.com/docs/rules/ 可以查找规则
     'no-debugger':1,//比如发现debugger时只是警告,不要报错
     'indent': [1, 2], // 控制一个tab缩进为2个空格
     'quotes': [1, 'single'], // 要求字符串使用单引号包裹
      
    }
};
  • 配置vscode
    1、首先需要在vscode内自己把eslint的插件安装好
    2、在vscode的setting.json中增加配置
{
    "eslint.validate": [
        "javascript",
        "javascriptreact",//增加了对react的支持
    ],
    // 开启保存时自动根据规则会修复一些问题,比如刚才我们配置了缩进和单引号包裹字符串,那么这个时候会自动格式化这些问题
    "editor.codeActionsOnSave": {
        "source.fixAll.eslint": true
    }
}
  • 排除某些文件夹或者文件不实用eslint检测
    1、在需要不检测的文件头部增加 /* eslint-disable */ 注释
    2、创建.eslintignore 文件,配置需要忽略的文件
    //.eslintignore 加入要过滤的文件夹和文件
    node_modules
    webpack.config.js
    

加入prettier来帮我们格式化代码

1、首先vscode内安装好prettier插件
2、在项目根目录下增加配置文件 prettier.config.js

module.exports={
  //简单配置几个常用的格式化方案
  tabWidth: 2,//1个tab用2个空格代替
  useTabs: false,
  printWidth: 120,
  semi:true,//末尾必须有分号
  singleQuote:true,//使用单引号包裹字符串
  jsxSingleQuote:true //jsx内也使用单引号包裹字符串
  //其他规则可以在https://prettier.io/docs/en/options.html查询
};

  • 然后在vscode的setting.json内增加配置
{
    "editor.formatOnSave": true,//当保存的时候,自动格式化
    //指定react和js都使用prettier来作为格式化工具
     "[javascriptreact]": {
        "editor.defaultFormatter": "esbenp.prettier-vscode"
     },
     "[javascript]": {
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    },
}

好了接下来试试在编辑代码后按保存看看
如果不想自动格式化代码,可以将 "editor.formatOnSave": false 然后通过鼠标右键点击格式化命令来随时格式化

相关文件引用及推荐

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 224,861评论 6 522
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 96,263评论 3 402
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 172,033评论 0 366
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 60,999评论 1 300
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 70,000评论 6 400
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 53,483评论 1 314
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 41,850评论 3 428
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 40,827评论 0 279
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 47,366评论 1 324
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 39,404评论 3 346
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 41,525评论 1 355
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 37,130评论 5 351
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 42,853评论 3 338
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 33,293评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 34,426评论 1 276
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 50,082评论 3 381
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 46,590评论 2 366