[H5]使用JSHint 配置完善代码规范

什么是JSHint
发现错误和潜在问题的社区驱动的工具

常见js编辑器的JSHint插件


安装JSHint命令行工具

  • npm install jshint -g

使用JSHint命令行工具

  • 创建.jshintrc配置文件
{
  "esversion": 3
}
  • 创建HelloWorld.js执行文件
let text = 'HelloWorld';
console.log (text);
  • 使用jshint分析HelloWorld.js文件
 jshint -c ./.jshintrc ./HelloWorld.js 
  • 得到分析文件的结果
./HelloWorld.js: line 5, col 1, 'let' is available in ES6 (use 'esversion: 6') or Mozilla JS extensions (use moz).
1 error

JSHintjshint -help命令解析

Usage:
  jshint [OPTIONS] [ARGS]

Options: 
  /**
   * 自定义配置文件路径 `.jshintrc`
   * example
   * jshint -c ./.jshintrc
   */
  -c, --config STRING    Custom configuration file

      /**
       * 修改报错输出使用的插件
       * example
       * jshint --reporter checkstyle 
       */
      --reporter STRING  Custom reporter (<PATH>|jslint|checkstyle|unix) 

      /**
       * 分析前的依赖全局变量
       * example
       * jshint -c ./.jshintrc  --prereq "var lala;"
       */
      --prereq STRING    Comma-separate list of prerequisite (paths). E.g. 
                         files which includedefinitions of global variabls 
                         used throughout your project 
      /**
       * 指定不需要分析的js文件和`.jshintignore`用法相同
       * example
       * jshint -c ./.jshintrc  --exclude ./HelloWorld.js  ./
       */
      --exclude STRING   Exclude files matching the given filename pattern 
                         (same as .jshintignore) 

      /**
       * 指定不需要分析的js文件和`.jshintignore`用法相同
       * example
       * jshint -c ./.jshintrc  --exclude-path ./.jshintignore ./
       */
      --exclude-path STRINGPass in a custom jshintignore file path
      --filename STRING  Pass in a filename when using STDIN to emulate config 
                         lookup for that file name 
      --verbose          Show message codes

      /**
       * 文件分析没有错误时输出结果
       * example
       * jshint --show-non-errors
       */
      --show-non-errors  Show additional data generated by jshint
  -e, --extra-ext STRING Comma-separated list of file extensions to use 
                         (default is .js) 
      --extract [STRING] Extract inline scripts contained in HTML 
                         (auto|always|never, default to never)  (Default is never)
      --jslint-reporter  Use a jslint compatible reporter (DEPRECATED, use 
                         --reporter=jslint instead) 
      --checkstyle-reporter Use a CheckStyle compatible XML reporter 
                            (DEPRECATED, use --reporter=checkstyle 
                            instead) 
  -v, --version          Display the current version
  -h, --help             Display help and usage details

JSHint常见的设置选项

  • 强制选项

    • 禁用位运算符,位运算符在 JavaScript 中使用较少,经常是把 && 错输成 &
    bitwise: true
    
    • 循环或者条件语句必须使用花括号包围
    curly: true
    
    • 强制使用三等号
    eqeqeq: true
    
    • 兼容低级浏览器 IE 6/7/8/9
    es3: true
    
    • 禁止重写原生对象的原型,比如 Array , Date
    freeze: true
    
    • 代码缩进
    indent: true
    
    • 禁止定义之前使用变量,忽略 function 函数声明
    latedef: "nofunc"
    
    • 构造器函数首字母大写
    newcap: true
    
    • 禁止使用 arguments.caller 和 arguments.callee ,未来会被弃用, ECMAScript 5 禁止使用 arguments.callee
    noarg:true
    
    • 为 true 时,禁止单引号和双引号混用
    "quotmark": false
    
    • 变量未定义
    "undef": true
    
    • 变量未使用
    "unused": true
    
    • 严格模式
    strict:true
    
    • 最多参数个数
    maxparams: 4
    
    • 最大嵌套深度
    maxdepth: 4
    
    • 复杂度检测
    maxcomplexity:true
    
    • 最大行数
    maxlen: 600
    
  • 宽松选项

    • 控制“缺少分号”的警告
    "asi": true
    "boss": true
    
    • 忽略 debugger
    "debug": true
    
    • 控制 eval 使用警告
    "evil": true
    
    • 检查一行代码最后声明后面的分号是否遗漏
    "lastsemic": true
    
    • 检查不安全的折行,忽略逗号在最前面的编程风格
    "laxcomma": true
    
    • 检查循环内嵌套 function
    "loopfunc": true
    
    • 检查多行字符串
    "multistr": true
    
    • 检查无效的 typeof 操作符值
    "notypeof": true
    
    • person['name'] vs. person.name
    "sub": true
    
    • new function () { ... } 和 new Object ;
    "supernew": true
    
    • 在非构造器函数中使用 this
    "validthis": true
    
  • 环境

    • 预定义全局变量 document , navigator , FileReader 等
    "browser": true
    
    • 定义用于调试的全局变量: console , alert
    "devel": true
    
    • 定义全局变量
    "jquery": true,
    "node": true
    

参考文章

JSHint Documentation
JSHint Configuration Options
JSHint Grunt Pluign
Improving Code Quality with JSHint
JSHint 配置简析

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

推荐阅读更多精彩内容

  • 什么是JSHint? 官方网站这样介绍: JSHint, A Static Code Analysis Tool ...
    9I阅读 29,453评论 5 51
  • 严格模式 1、设立严格模式的目的 消除JavaScript语法的一些不合理、不严谨之处,减少一些怪异行为;(会将J...
    K丶Aionro阅读 1,902评论 0 0
  • 我的小时候, 任性吵闹的时候, 我的外婆总会唱歌哄我。 外婆得脑梗快十年了。现在的外婆打我都轮不起来胳膊,骂我也没...
    温暖的我也爱你阅读 895评论 0 0
  • 一波未平一波又起,设计的事总是没完没了的出现。“撩”的事件还没摆平,新的工作任务又来了,老板最终没能选择我们的方案...
    羊家的杨阅读 441评论 0 0
  • 一路上经历了千辛万苦的两人终于到达了真新镇。拜访了大木博士以后,就到小智家去串门。小智告诉龙他明天就可以领取神奇宝...
    阿团SAMA阅读 173评论 0 1