npm 代码格式

描述

npm的代码格式有点不循常规。不是为了不同而不同的缘故,而是精心设计的风格,为了减少视觉上的混乱和bugs更明显。

如果想要给npm贡献(很鼓励这样),应该让你的代码遵循npm's的风格。

注意:这意味到你从npm registry下载的npm的代码不是特定的包

代码长度

保证一行少于80字符。短行比长行更好。将长lists, objects,和其他语句分成多行。

缩进

两个空格。Tabs更好,但是在web浏览器和GitHub上看起来像地狱,并且node使用2个空格,所以就用2个空格咯

大括号

好的方式:

// bad
function ()
{

// good
function () {

如果一块代码需要在下一行,使用大括号。如果不需要就不要用。

// bad
if (foo) {bar()}
while (foo)
  bar()

// good
if (foo) bar()
while (foo) {
  bar()
}

分号

除了以下四种情况,不要使用:

  • for(;;)循环,因为是必须的
  • 空循环比如:while(something);(但是最好你有一个好理由需要什么做)
  • ``case 'foo': doSomething();break
  • (或者[开始的行。这可以防止表达式被解释为一个函数调用或属性访问,分别地。

一些使用分好的好例子:

;(x || y).doSomething()

;[a, b, c].forEach(doSomething)

for (var i = 0; i < 10; i ++) { 
  switch (state) {
    case 'begin': start(); continue 
    case 'end': finish(); break 
    default: throw new Error('unknown state')
  } 
  end()
}

注意以-+开始的行也应该以分号开始,但这不常见。

逗号开始

如果一些things被逗号分开,并且是多行,将逗号放在下一行的开始。将list的最后token作为一行。比如:

var magicWords = [ 'abracadabra' 
                 , 'gesundheit' 
                 , 'ventrilo' ] 
  , spells = { 'fireball' : function () { setOnFire() } 
              , 'water' : function () { putOut() } } 
  , a = 1 
  , b = 'abc' 
  , etc 
  , somethingElse

引号

使用单引号声明字符串,避免转义

// bad
var notOk = "Just double quotes"

// good
var ok = 'String contains "double" quotes'
var alsoOk = "String contains 'single' quotes or apostrophe"

空格

除了方法调用,在所有的(前放一个空格。同时一个空格让代码更可读。

不要在一行的结尾留一个空格。不要在空行缩进。不要使用太多的空格。

方法

使用命名functions,他们让堆栈给容易阅读。

回调,异步/同步风格

尽可能使用异步/非阻塞的方式。对于npm使用同步fs APIs可能更有意义,但是这样,fs和http和子进程这些都是用相同的回调-传递方法

回调应该总是最后一个参数,它的第一个参数是Error或者null

小心永远不要throw anything.它比不用更坏。将错误信息作为错误消息返回给回调。

Errors

总是创建一个新Error object返回信息。不要只是返回string message到callback.堆栈跟踪很有用。

日志

日志通过使用npmlog工具。

请清理掉没有用的日志。特别是,一遍又一遍的记录相同的日志并没有什么用。日志应该记录发生了什么,所以更容易的跟踪哪里发生了错误。

使用合适的日志等级。查看npm-config并且搜寻"loglevel"

大小写,命名 等等

使用小驼峰命名对象、函数、方法、属性或者任何这里没有说明的。

为类名使用大驼峰命名

使用全小写用-连接的(all-lower-hyphen-css-case)多个单词命名文件名和config keys.

使用命名式函数。让跟踪堆栈更容易

使用大写下划线连接的方式命名常量。

为匿名函数,但需要递归调用自己的使用一个大写字母命名。表明它是一个"throwaway"方法

null,undefined,false,0

Boolean的变量和方法应该总是true或者false.不要将它设置为0,除非期望得到一个数字。

当故意丢失或删除的,设置为null。

不要赋值为undefined. 预留的值以为着:“啥也没设置”

Boolean对象是禁止的。

了解更多

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,431评论 25 707
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,567评论 18 399
  • 来源与:阿里云栖 禁止用于商业用途 ps:如果需要电子书 评论你们邮箱 我会发给你们 下面感觉还是有点乱 目录 一...
    小向资源网阅读 7,572评论 0 12
  • 原文地址 前言 因为平时在写代码的过程中,有些算法会经常重复写,比如数组去重、数组抽取随机值等!虽然这些不是很难的...
    豌豆突突突阅读 1,091评论 0 0
  • 今天由于某件事(大概是我工作态度的事),我们持不同想法,他在劝说我半天我仍然不改不听的情况下,他。。居然。。拿着。...
    孙小本同学阅读 356评论 0 1