用什么工具保证一致的代码风格?

更新日期: 2019-04-26阅读: 2.1k标签: 代码

1. 理解问题

首先这个问题展开来讲就是"如何在Node.js模块编写中保持代码一致性风格"。目前来说基本上有四种工具可以完成JSLint,JSHint,JSCS,ESLint。

下面将从历史的角度来看看他们四个有什么关系,以及选用建议。


2. 发展历程

关于保持代码一致性风格,我们可以追溯到Lint。

Lint是啥?Lint是针对C语言源码的检测工具,它的功能就是看看源码有没有编写错误,有没有风格问题。

啥是编写错误呢?

编写错误就意味着上考场没带准考证,别说考的好不好,根本没机会考。

编写错误意味着你的代码根本通不过编译。

啥是风格问题呢?

风格问题可以比喻为上考场穿着三角裤衩,虽然自己考的挺嗨,但是影响别人发挥(光看你的内裤啥颜色了)。

好了,既然C语言有这样的工具,那么我们JS语言有没有这样的工具呢?

答案是肯定的,按照时间顺序,JS语言界依次出现四位大咖:JSLint,JSHint,JSCS,ESLint。

JSLint 作为开山鼻祖,它不仅可以检测代码编写错误,还可以检测代码风格问题。

但是它的判定规则完全按照JSLint的作者经验来制定,不允许改变,大有信我者昌,逆我者亡的气势。

这样做,在检查代码编写错误时是没问题的,但是检查代码风格时候就有点尴尬,

比如有的公司就喜欢让员工穿裤衩上班,因为这样程序员可以快乐编程,但是用了你这款工具,程序员只能穿西服编码,大大降低宝宝们的编程效率,可恶可恶。

于是,JSHint就出现啦。

JSHint是JSLint的继承者,它继承JSLint拥有的规则,但是它允许通过配置文件来配置这些规则。

但是吧,还不够彻底,虽然他允许我配置规则,但是不允许我自定义规则。

就比如,原先在JSLint中,有这样一条规则:"禁止员工穿裤衩上班",

现在JSHint中将这条规则转化为"[禁止]员工穿裤衩上班",同时允许你在配置文件配置方框号中的内容,而且只能配置为[允许]和[禁止]

但是假如我想制定一条规则是"[禁止]员工穿拖鞋上班",JSHint就不支持啦,所以还是有点不尽兴。

不过,什么事情都难不倒的程序员,JSCS如约而至。

JSCS本身超过90条的规则,但是任然允许制定新的规则,比如"[禁止]员工穿拖鞋上班",嗯,突然觉得好满足。

但...JSCS仅仅支持代码风格检查,不能检查编写错误问题,为啥呢,我也不知道,也许作者觉得编写检查可以直接交给编译器?

天将降大任于斯人也,吸收前人的经验,弥补前人的不足,ESLint在众人期待中出现了。

ESLint支持检查编写错误问题,支持检查代码风格问题,支持制定自定义规则,支持通过配置文件修改预定义和自定义规则。

完美,终于可以愉快的生活啦,哈哈哈哈...


3. 选用建议

ESLint功能丰富,除了上面说的这些基础功能,还有很多很多,而且前端开发链条上的其他插件也愿意和ESLint配合。总之,ESLint出现坑,有人会填,其他的出现坑,只能自己跳进去填,所以,遵从你内心的选择吧。


原文来自:https://segmentfault.com/a/1190000018986067


链接: https://www.fly63.com/article/detial/3057

不要浪费时间写完美代码

一个系统可以维持5年,10年,甚至20年以上,但是代码和设计模式的生命周期非常短,当对一个解决方案使用不同的方法进行迭代的时候,通常只能维持数月,数日,甚至几分钟的时间

Google内部在代码质量上的实践

良好的编程习惯涉及到很多方面,但在软件行业内,大多数的公司或组织都不会把良好的编程习惯列为主要关注点。 例如,具有可读性和可维护性的代码比编写好的测试代码或使用正确的工具更有意义,前者的意义在于可以让代码更易于理解和修改。

减少嵌套,降低代码复杂度

减少嵌套会让代码可读性更好,同时也能更容易的找出bug,开发人员可以更快的迭代,程序也会越来越稳定。简化代码,让编程更轻松!

关于 Google 发布的 JS 代码规范

Google为了那些还不熟悉代码规范的人发布了一个JS代码规范。其中列出了编写简洁易懂的代码所应该做的最佳实践。代码规范并不是一种编写正确JavaScript代码的规则,而是为了保持源代码编写模式一致的一种选择。

你解决的问题比你编写的代码更重要!

程序员似乎忘记了软件的真正目的,那就是解决现实问题。您编写的代码的目的是为了创造价值并使现有世界变得更美好,而不是满足您对自我世界应该是什么的以自我为中心的观点。有人说:如果你拥有的只是一把锤子,那么一切看起来都像钉子一样

tinymce与prism代码高亮实现及汉化的配置

TinyMCE是一个轻量级的基于浏览器的所见即所得编辑器,由JavaScript写成。它对IE6+和Firefox1.5+都有着非常良好的支持。功能方强大,并且功能配置灵活简单。另一特点是加载速度非常快的。

js函数式编程与代码执行效率

函数式编程对应的是命令式编程, 函数式编程的核心当然是对函数的运用. 而高阶函数(Higher-order)是实现函数式编程的基本要素。高阶函数可以将其他函数作为参数或者返回结果。所以JS天生就支持函数式编程

接手代码太烂,要不要辞职?

朋友发表了一条说说:入职新公司,从重构代码到放弃”,我就问他怎么了?他说,刚进一家新公司,接手代码太烂,领导让我先熟悉业务逻辑,然后去修复之前项目中遗留的bug,实在不行就重构

js高亮显示关键词_页面、搜索关键词高亮显示

页面实现关键词高亮显示:在项目期间遇到一个需求,就是搜索关键词时需要高亮显示,主要通过正则匹配来实现页面关键词高亮显示。在搜索结果中高亮显示关键词:有一组关键词数组,在数组中筛选出符合关键字的内容并将关键字高亮

写优雅的代码,做优雅的程序员

软件工程学什么? 学计算机,写程序,做软件,当程序员。听说学计算机很辛苦? 是的,IT行业加班现象严重。在计算机世界里,技术日新月异,自学能力是程序员最重要的能力之一。选了这个专业,就要时刻保持好奇心和技术嗅觉,不能只满足于完成课内作业。

点击更多...

内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!