Code Guide by @imweb

命名规则

• 项目命名
• 目录命名
• JS文件命名
• CSS, SCSS文件命名
• HTML文件命名

HTML

• 语法
• HTML5 doctype
• lang属性
• 字符编码
• IE兼容模式
• 引入CSS, JS
• 属性顺序
• boolean属性
• JS生成标签
• 减少标签数量
• 实用高于完美

CSS, SCSS

• 缩进
• 分号
• 空格
• 空行
• 换行
• !important
• 注释
• 引号
• 命名
• 属性声明顺序
• 颜色
• 属性简写
• 媒体查询
• SCSS相关
• 杂项

JavaScript

• 缩进
• 单行长度
• 分号
• 空格
• 空行
• 换行
• 单行注释
• 多行注释
• 文档注释
• 引号
• 变量命名
• 变量声明
• 函数
• 数组、对象
• 括号
• null
• undefined
• jshint
• 杂项

code snippets

编辑器配置和构建检查

• sublime3
• grunt插件

最佳原则

坚持制定好的代码规范。

无论团队人数多少,代码应该同出一门。

如果你想要为这个规范做贡献或觉得有不合理的地方,请访问New Issue。

项目命名

全部采用小写方式, 以下划线分隔。

例:my_project_name

目录命名

参照项目命名规则;

完整英文命名的用复数形式,缩写用单数形式

例:scripts, js, styles, css, images, img, data_models, modules, lego_modules, pages

JS文件命名

参照项目命名规则。

例:account_model.js

CSS, SCSS文件命名

参照项目命名规则。

例:retina_sprites.scss

HTML文件命名

参照项目命名规则。

例:error_report.html

语法

• 缩进使用soft tab(4个空格);
• 嵌套的节点应该缩进;
• 在属性上,使用双引号,不要使用单引号;
• 属性名全小写,用中划线做分隔符;
• 不要在自动闭合标签结尾处使用斜线(HTML5 规范 指出他们是可选的);
• 不要忽略可选的关闭标签,例:</li> 和 </body>。

HTML5 doctype

在页面开头使用这个简单地doctype来启用标准模式,使其在每个浏览器中尽可能一致的展现;

虽然doctype不区分大小写,但是按照惯例,doctype大写 (关于html属性,大写还是小写)。

lang属性

根据HTML5规范:

应在html标签上加上lang属性。这会给语音工具和翻译工具帮助,告诉它们应当怎么去发音和翻译。

更多关于 lang 属性的说明在这里;

在sitepoint上可以查到语言列表;

但sitepoint只是给出了语言的大类,例如中文只给出了zh,但是没有区分香港,台湾,大陆。而微软给出了一份更加详细的语言列表,其中细分了zh-cn, zh-hk, zh-tw。

字符编码

通过声明一个明确的字符编码,让浏览器轻松、快速的确定适合网页内容的渲染方式,通常指定为'UTF-8'。

IE兼容模式

用 <meta> 标签可以指定页面应该用什么版本的IE来渲染;

如果你想要了解更多,请点击这里;

不同doctype在不同浏览器下会触发不同的渲染模式(这篇文章总结的很到位)。

引入CSS, JS

根据HTML5规范, 通常在引入CSS和JS时不需要指明 type,因为 text/css 和 text/javascript 分别是他们的默认值。

HTML5 规范链接

• 使用link
• 使用style
• 使用script

属性顺序

属性应该按照特定的顺序出现以保证易读性;

• id
• class
• name
• data-*
• src, for, type, href, value , max-length, max, min, pattern
• placeholder, title, alt
• aria-*, role
• required, readonly, disabled

boolean属性

boolean属性指不需要声明取值的属性,XHTML需要每个属性声明取值,但是HTML5并不需要;

更多内容可以参考 WhatWG section on boolean attributes:

boolean属性的存在表示取值为true,不存在则表示取值为false。

JS生成标签

在JS文件中生成标签让内容变得更难查找,更难编辑,性能更差。应该尽量避免这种情况的出现。

减少标签数量

在编写HTML代码时,需要尽量避免多余的父节点;

很多时候,需要通过迭代和重构来使HTML变得更少。

实用高于完美

尽量遵循HTML标准和语义,但是不应该以浪费实用性作为代价;

任何时候都要用尽量小的复杂度和尽量少的标签来解决问题。

缩进

使用soft tab(4个空格)。

分号

每个属性声明末尾都要加分号。

空格

以下几种情况不需要空格:

• 属性名后
• 多个规则的分隔符','前
• !important '!'后
• 属性值中'('后和')'前
• 行末不要有多余的空格

以下几种情况需要空格:

• 属性值前
• 选择器'>', '+', '~'前后
• '{'前
• !important '!'前
• @else 前后
• 属性值中的','后
• 注释'/*'后和'*/'前

空行

以下几种情况需要空行:

• 文件最后保留一个空行
• '}'后最好跟一个空行,包括scss中嵌套的规则
• 属性之间需要适当的空行,具体见属性声明顺序

换行

以下几种情况不需要换行:

• '{'前

以下几种情况需要换行:

• '{'后和'}'前
• 每个属性独占一行
• 多个规则的分隔符','后

!important

不允许使用!important。

注释

注释统一用'/* */'(scss中也不要用'//'),具体参照右边的写法;

缩进与下一行代码保持一致;

可位于一个代码行的末尾,与代码间隔一个空格。

引号

最外层统一使用双引号;

url的内容要用引号;

属性选择器中的属性值需要引号。

命名

• 使用小写字母,以中划线分隔
• scss中的变量、函数、混合、placeholder采用驼峰式命名

属性声明顺序

相关的属性声明按右边的顺序做分组处理,组之间需要有一个空行。

颜色

颜色16进制用小写字母;

颜色16进制尽量用简写。

媒体查询

尽量将媒体查询的规则靠近与他们相关的规则,不要将他们一起放到一个独立的样式文件中,或者丢在文档的最底部,这样做只会让大家以后更容易忘记他们。

SCSS相关

提交的代码中不要有 @debug;

@import 引入的文件不需要开头的'_'和结尾的'.scss';

嵌套最多不能超过4层;

@extend 中使用placeholder选择器;

去掉不必要的父级引用符号'&'。

杂项

不允许有空的规则;

元素选择器用小写字母;

去掉小数点前面的0;

去掉数字中不必要的小数点和末尾的0;

属性值'0'后面不要加单位;

同个属性不同前缀的写法需要在垂直方向保持对齐,具体参照右边的写法;

无前缀的标准属性应该写在有前缀的属性后面;

不要在同个规则里出现重复的属性,如果重复的属性是连续的则没关系;

不要在一个文件里出现两个相同的规则;

用 border: 0; 代替 border: none;;

选择器不要超过4层(在scss中如果超过4层应该考虑用嵌套的方式来写);

发布的代码中不要有 @import;

尽量少用'*'选择器。

缩进

使用soft tab(4个空格)。

单行长度

不要超过120,但如果编辑器开启word wrap可以不考虑单行长度。

长字符串拼接用加号。

分号

以下几种情况后需加分号:

• 变量声明
• 表达式
• return
• throw
• break
• continue
• do-while

空格

以下几种情况不需要空格:

• 对象的属性名后
• 前缀一元运算符后
• 后缀一元运算符前
• 函数调用括号前
• 无论是函数声明还是函数表达式,'('前不要空格
• 数组的'['后和']'前
• 对象的'{'后和'}'前
• 运算符'('后和')'前

以下几种情况需要空格:

• 二元运算符前后
• 三元运算符'?:'前后
• 代码块'{'前
• 下列关键字前:else, while, catch, finally
• 下列关键字后:if, else, for, while, do, switch, case, try, catch, finally, with, return, typeof
• 单行注释'//'后(若单行注释和代码同行,则'//'前也需要),多行注释'*'后
• 对象的属性值前
• for循环,分号后留有一个空格,前置条件如果有多个,逗号后留一个空格
• 无论是函数声明还是函数表达式,'{'前一定要有空格
• 函数的参数之间

空行

以下几种情况需要空行:

• 变量声明后(当变量声明在代码块的最后一行时,则无需空行)
• 注释前(当注释在代码块的第一行时,则无需空行)
• 代码块后(在函数调用、数组、对象中则无需空行)
• 文件最后保留一个空行

换行

换行的地方,行末必须有','或者运算符;

以下几种情况不需要换行:

• 下列关键字后:else, catch, finally
• 代码块'{'前

以下几种情况需要换行:

• 代码块'{'后和'}'前
• 定义变量后

单行注释

双斜线后,必须跟一个空格;

缩进与下一行代码保持一致;

可位于一个代码行的末尾,与代码间隔一个空格。

多行注释

最少三行, '*'后跟一个空格,具体参照右边的写法;

建议在以下情况下使用:

• 难于理解的代码段
• 可能存在错误的代码段
• 浏览器特殊的HACK代码
• 业务逻辑强相关的代码

文档注释

各类标签@param, @method等请参考usejsdoc和JSDoc Guide;

建议在以下情况下使用:

• 所有常量
• 所有函数
• 所有类

引号

最外层统一使用单引号。

变量命名

• 标准变量采用驼峰式命名(除了对象的属性外,主要是考虑到cgi返回的数据)
• 'ID'在变量名中全大写
• 'URL'在变量名中全大写
• 'Android'在变量名中大写第一个字母
• 'iOS'在变量名中小写第一个,大写后两个字母
• 常量全大写,用下划线连接
• 构造函数,大写第一个字母
• jquery对象必须以'$'开头命名

变量声明

一个函数作用域中所有的变量声明提到函数首部,除了for (...)里面使用的一次性变量。

var的数量不做限制,但要统一,一行定义一个变量。

函数

无论是函数声明还是函数表达式,'('前不要空格,但'{'前一定要有空格;

函数调用括号前不需要空格;

立即执行函数外必须包一层括号;

不要给inline function命名;

参数之间用', '分隔,注意逗号后有一个空格。

数组、对象

对象属性名不需要加引号;

对象以缩进的形式书写,不要写在一行;

数组、对象最后不要有逗号。

括号

下列关键字后必须有大括号(即使代码块的内容只有一行):if, else, for, while, do, switch, try, catch, finally, with。

null

适用场景:

• 初始化一个将来可能被赋值为对象的变量
• 与已经初始化的变量做比较
• 作为一个参数为对象的函数的调用传参
• 作为一个返回对象的函数的返回值

不适用场景:

• 不要用null来判断函数调用时有无传参
• 不要与未初始化的变量做比较

undefined

永远不要直接使用undefined进行变量判断;

使用typeof和字符串'undefined'对变量进行判断。

jshint

用'===', '!=='代替'==', '!=';

for-in里一定要有hasOwnProperty的判断;

不要在内置对象的原型上添加方法,如Array, Date;

不要在内层作用域的代码里声明了变量,之后却访问到了外层作用域的同名变量;

变量不要先使用后声明;

不要在一句代码中单单使用构造函数,记得将其赋值给某个变量;

不要在同个作用域下声明同名变量;

不要在一些不需要的地方加括号,例:delete(a.b);

不要使用未声明的变量(全局变量需要加到.jshintrc文件的globals属性里面);

不要声明了变量却不使用;

不要在应该做比较的地方做赋值;

debugger不要出现在提交的代码里;

数组中不要存在空元素;

不要在循环内部声明函数;

不要像这样使用构造函数,例:new function () { ... }, new Object;

杂项

不要混用tab和space;

不要在一处使用多个tab或space;

换行符统一用'LF';

对上下文this的引用命名范围:self> that> _this> me;

行尾不要有空白字符;

switch的falling through和no default的情况一定要有注释特别说明;

不允许三元运算符嵌套。

不允许有空的代码块。

code snippets规范列表,同时提供sublime插件Javascript Snippets for IMWeb支持这些snippets,可以通过Package Control安装。

说明:

[快捷代码] 描述

snippets的内容,其中占位符语法:${序号:默认值}

Console

• [cd] console.dir

  console.dir(${1:obj});

• [cl] console.log

  console.log(${1:obj});

EJS

• [=fo] <% for %>

  <% for (var ${1:i} = ${2:0}, ${3:l} = ${4:arr}.length; ${1:i} < ${3:l}; ++${1:i}) { %>
   ${5}
  <% } %>

• [=if] <% if %>

  <% if(${1:expr}) { %>
   ${2}
  <% } %>

• [=] <%= %>

  <%${1:=} ${2:expr} %>

For

• [fe] forEach

  ${1:myArray}.forEach(function(${2:elem}, ${3:index}) {
   ${4}
  });

• [fi] for in

  for (${1:prop} in ${2:obj}) {
   if (${2:obj}.hasOwnProperty(${1:prop})) {
   ${3}
   }
  }

• [for] for

  for (var ${1:i} = ${2:0}, ${3:l} = ${4:arr}.length; ${1:i} < ${3:l}; ++${1:i}) {
   ${5}
  }

Function

• [fn][fun] function

  function ${1:functionName}(${2:arguments}) {
   ${3:// body...}
  }

• [afn] anonymous function

  function(${1:arguments}) {
   ${2:// body...}
  }

• [ap] apply

  apply(${1:context}, [${2:arguments}]);

• [ca] call

  call(${1:context}, ${2:arguments});

• [iif] immediately-invoked function expression

  (function(${2:win}) {
   ${3:// body...}
  })(${1:window});

• [ofn] function as a property of an object

  ${1:functionName}: function(${2:arguments}) {
   ${3:// body...}
  },

If

• [ife] if else

  if (${1:expr}) {
   ${2:// if body...}
  } else {
   ${3}
  }

Jquery

• [jvt] var $this = $(this)

  var \$this = \$(this);

• [jve] var $var = $('var')

  var \$${1} = \$('${2}');

• [jvd] var d = $d.data('d')

  var ${1:cid} = \$${2:this}.data('${3:cid}');

• [da] data()

  data('${1}')

• [jext] $.extend

  \$.extend(${1});

• [ext] extend()

  extend(${1})

• [jat] $.attr

  \$${1:this}.attr('${2}'${3});

• [at] attr()

  attr('${1}'${2})

• [jcss] $.css

  \$${1:this}.css({${2}});

• [css] css()

  css({${2}})

• [jwi] $.width

  \$${1:this}.width(${2});

• [wi] width()

  width(${1})

• [jhe] $.height

  \$${1:this}.height(${2});

• [he] height()

  height(${1})

• [jsh] $.show

  \$${1:this}.show();

• [sh] show()

  show()

• [jhi] $.hide

  \$${1:this}.hide();

• [hi] hide()

  hide()

• [jac] $.addClass

  \$${1:this}.addClass('${2}');

• [addC] addClass()

  addClass('${1}')

• [jrc] $.removeClass

  \$${1:this}.removeClass('${2}');

• [rem] removeClass()

  removeClass('${1}')

• [jon] $.on

  \$${1:this}.on('${2:click}', ${3}function(e${4}) {
   ${5:// body...}
  });

• [on] on()

  on('${1:click}', ${2}function(e${3}) {
   ${4:// body...}
  });

• [jtri] $.trigger

  \$${1:doc}.trigger('${2:eventType}'${3});

• [tri] trigger()

  trigger('${1:eventType}'${2});

MISC

• [vs] var self = this

  var ${1:self} = this;

• [se] self = this

  self = this;

• [th] that = this

  that = this;

• [al] alert

  alert('${1:msg}');

• [de] debugger

  debugger;

• [ret] return

  return ${1:this};

• [ni] new Image

  new Image().src = '/${1}';

Node

• [re] require

  require('${1:module}');

• [rea] require.async

  require.async(['${1:moduleName}'], function(${2:module}) {
   ${3:// body...}
  });

• [me] module.exports

  module.exports = {${1}};

Timer

• [st][setT] setTimeout

  setTimeout(function() {
   ${2:// body...}
  }, ${1:delay});

• [si][setI] setInterval

  setInterval(function() {
   ${2:// body...}
  }, ${1:delay});

sublime3

1. 系统&环境要求

   • win7 & OSX10
   • node
   • ruby
   • sublime3

2. 脚本安装配置

   • 按下 ctrl+`
   • 复制粘贴以下代码执行,直到弹出【安装成功】弹窗
     pl="SublimeLinter,SublimeLinter-jscs,SublimeLinter-jshint,SublimeLinter-csslint,Emmet,SCSS,CSScomb,JsFormat,DocBlockr,SnippetMaker,BracketHighlighter,JavaScript Snippets for IMWeb,SideBarEnhancements";import webbrowser,urllib.request,os;jcp=os.path.join(sublime.packages_path(),"User",".jshintrc");jscsp=os.path.join(sublime.packages_path(),"User",".jscsrc");sm={"Preferences":{"translate_tabs_to_spaces":True,"word_wrap":True,"wrap_width":120,"tab_size":4,"default_line_ending":"unix"},"SublimeLinter":{"user":{"gutter_theme":"Packages/SublimeLinter/gutter-themes/Blueberry/round/Blueberry - round.gutter-theme","lint_mode":"load/save","linters":{"csslint":{"@disable":False,"args":[],"errors":"","excludes":[],"ignore":"box-model,adjoining-classes,box-sizing,compatible-vendor-prefixes,gradients,text-indent,fallback-colors,star-property-hack,underscore-property-hack,bulletproof-font-face,font-faces,import,regex-selectors,universal-selector,unqualified-attributes,overqualified-elements,duplicate-background-images,floats,font-sizes,ids,important,outline-none,qualified-headings,unique-headings","warnings":""},"jscs":{"@disable":True,"args":["--config",jscsp],"excludes":[]},"jshint":{"@disable":False,"args":["--config",jcp],"excludes":[]}},"mark_style":"outline"}},"JsFormat":{"indent_size":4,"indent_char":" ","eol":"\n","indent_level":0,"indent_with_tabs":False,"preserve_newlines":True,"max_preserve_newlines":10,"jslint_happy":False,"space_after_anon_function":False,"brace_style":"collapse","keep_array_indentation":False,"keep_function_indentation":False,"space_before_conditional":True,"break_chained_methods":False,"eval_code":False,"unescape_strings":False,"wrap_line_length":0,"wrap_attributes":"auto","wrap_attributes_indent_size":4,"end_with_newline":True},"CSScomb":{"config":{"remove-empty-rulesets":True,"always-semicolon":True,"color-case":"lower","block-indent":" ","color-shorthand":True,"element-case":"lower","eof-newline":True,"leading-zero":False,"quotes":"double","sort-order-fallback":"abc","space-before-colon":"","space-after-colon":" ","space-before-combinator":" ","space-after-combinator":" ","space-between-declarations":"\n","space-before-opening-brace":" ","space-after-opening-brace":"\n","space-after-selector-delimiter":"\n","space-before-selector-delimiter":"","space-before-closing-brace":"\n","strip-spaces":True,"tab-size":True,"unitless-zero":True,"vendor-prefix-align":True,"sort-order":[["display","visibility","float","clear","overflow","overflow-x","overflow-y","clip","zoom"],["table-layout","empty-cells","caption-side","border-spacing","border-collapse","list-style","list-style-position","list-style-type","list-style-image"],["-webkit-box-orient","-webkit-box-direction","-webkit-box-decoration-break","-webkit-box-pack","-webkit-box-align","-webkit-box-flex"],["position","top","right","bottom","left","z-index"],["margin","margin-top","margin-right","margin-bottom","margin-left","-webkit-box-sizing","-moz-box-sizing","box-sizing","border","border-width","border-style","border-color","border-top","border-top-width","border-top-style","border-top-color","border-right","border-right-width","border-right-style","border-right-color","border-bottom","border-bottom-width","border-bottom-style","border-bottom-color","border-left","border-left-width","border-left-style","border-left-color","-webkit-border-radius","-moz-border-radius","border-radius","-webkit-border-top-left-radius","-moz-border-radius-topleft","border-top-left-radius","-webkit-border-top-right-radius","-moz-border-radius-topright","border-top-right-radius","-webkit-border-bottom-right-radius","-moz-border-radius-bottomright","border-bottom-right-radius","-webkit-border-bottom-left-radius","-moz-border-radius-bottomleft","border-bottom-left-radius","-webkit-border-image","-moz-border-image","-o-border-image","border-image","-webkit-border-image-source","-moz-border-image-source","-o-border-image-source","border-image-source","-webkit-border-image-slice","-moz-border-image-slice","-o-border-image-slice","border-image-slice","-webkit-border-image-width","-moz-border-image-width","-o-border-image-width","border-image-width","-webkit-border-image-outset","-moz-border-image-outset","-o-border-image-outset","border-image-outset","-webkit-border-image-repeat","-moz-border-image-repeat","-o-border-image-repeat","border-image-repeat","padding","padding-top","padding-right","padding-bottom","padding-left","width","min-width","max-width","height","min-height","max-height"],["font","font-family","font-size","font-weight","font-style","font-variant","font-size-adjust","font-stretch","font-effect","font-emphasize","font-emphasize-position","font-emphasize-style","font-smooth","line-height","text-align","-webkit-text-align-last","-moz-text-align-last","-ms-text-align-last","text-align-last","vertical-align","white-space","text-decoration","text-emphasis","text-emphasis-color","text-emphasis-style","text-emphasis-position","text-indent","-ms-text-justify","text-justify","letter-spacing","word-spacing","-ms-writing-mode","text-outline","text-transform","text-wrap","-ms-text-overflow","text-overflow","text-overflow-ellipsis","text-overflow-mode","-ms-word-wrap","word-wrap","-ms-word-break","word-break"],["color","background","filter:progid:DXImageTransform.Microsoft.AlphaImageLoader","background-color","background-image","background-repeat","background-attachment","background-position","-ms-background-position-x","background-position-x","-ms-background-position-y","background-position-y","-webkit-background-clip","-moz-background-clip","background-clip","background-origin","-webkit-background-size","-moz-background-size","-o-background-size","background-size"],["outline","outline-width","outline-style","outline-color","outline-offset","opacity","filter:progid:DXImageTransform.Microsoft.Alpha(Opacity","-ms-filter:\\'progid:DXImageTransform.Microsoft.Alpha","-ms-interpolation-mode","-webkit-box-shadow","-moz-box-shadow","box-shadow","filter:progid:DXImageTransform.Microsoft.gradient","-ms-filter:\\'progid:DXImageTransform.Microsoft.gradient","text-shadow"],["-webkit-transition","-moz-transition","-ms-transition","-o-transition","transition","-webkit-transition-delay","-moz-transition-delay","-ms-transition-delay","-o-transition-delay","transition-delay","-webkit-transition-timing-function","-moz-transition-timing-function","-ms-transition-timing-function","-o-transition-timing-function","transition-timing-function","-webkit-transition-duration","-moz-transition-duration","-ms-transition-duration","-o-transition-duration","transition-duration","-webkit-transition-property","-moz-transition-property","-ms-transition-property","-o-transition-property","transition-property","-webkit-transform","-moz-transform","-ms-transform","-o-transform","transform","-webkit-transform-origin","-moz-transform-origin","-ms-transform-origin","-o-transform-origin","transform-origin","-webkit-animation","-moz-animation","-ms-animation","-o-animation","animation","-webkit-animation-name","-moz-animation-name","-ms-animation-name","-o-animation-name","animation-name","-webkit-animation-duration","-moz-animation-duration","-ms-animation-duration","-o-animation-duration","animation-duration","-webkit-animation-play-state","-moz-animation-play-state","-ms-animation-play-state","-o-animation-play-state","animation-play-state","-webkit-animation-timing-function","-moz-animation-timing-function","-ms-animation-timing-function","-o-animation-timing-function","animation-timing-function","-webkit-animation-delay","-moz-animation-delay","-ms-animation-delay","-o-animation-delay","animation-delay","-webkit-animation-iteration-count","-moz-animation-iteration-count","-ms-animation-iteration-count","-o-animation-iteration-count","animation-iteration-count","-webkit-animation-direction","-moz-animation-direction","-ms-animation-direction","-o-animation-direction","animation-direction"],["content","quotes","counter-reset","counter-increment","resize","cursor","-webkit-user-select","-moz-user-select","-ms-user-select","user-select","nav-index","nav-up","nav-right","nav-down","nav-left","-moz-tab-size","-o-tab-size","tab-size","-webkit-hyphens","-moz-hyphens","hyphens","pointer-events"]]}}};c1p=None;c1cb=None;arr2=None;arr3=None;pf='Package Control.sublime-package';ipp=sublime.installed_packages_path();pp=sublime.packages_path();arr=[v for v in pl.split(',') if not os.path.exists(os.path.join(ipp,v+'.sublime-package')) and not os.path.exists(os.path.join(pp,v))];pl=','.join(arr);c1=compile('global c1p;global c1cb;cip=os.path.join(ipp,c1p);cip2=os.path.join(pp,c1p.split(".")[0]);sublime.set_timeout(lambda:exec(c1cb),10000) if os.path.exists(cip) or os.path.exists(cip2) else sublime.set_timeout(lambda:exec(c1), 3000);','','exec');c11=compile('global arr;global arr2;global arr3;arr2=[print("=============================================================>",v,"安装成功!") or v for v in arr if os.path.exists(os.path.join(ipp,v+".sublime-package")) or os.path.exists(os.path.join(pp,v))];arr3=[vv for vv in arr if vv not in arr2];arr=arr3;sublime.set_timeout(lambda:exec(c11),1000) if len(arr)>0 else None;','','exec');c2=compile('global c1p;global c1cb;window.run_command("advanced_install_package",{"packages":pl}) if len(pl)>0 else None;pla=pl.split(",");c1p=pla[len(pla)-1]+".sublime-package";c1cb=c3;exec(c1);exec(c11);','','exec');c3=compile('[exec(c4,{"pn":name,"sv":value,"sublime":sublime}) for (name,value) in sm.items()];sublime.set_timeout(lambda:webbrowser.open_new_tab("http://imweb.github.io/CodeGuide/") if sublime.ok_cancel_dialog("安装成功!", "查看规范") else None,2000);','','exec');c4=compile('s=sublime.load_settings(pn+".sublime-settings");[s.set(k, v) for (k,v) in sv.items()];sublime.save_settings(pn+".sublime-settings");','','exec');c=compile('global c1p;global c1cb;os.system("npm install -g jscs");print("=============================================================> npm install -g jscs 安装结束!");os.system("npm install -g jshint");print("=============================================================> npm install -g jshint 安装结束!");os.system("npm install -g csslint");print("=============================================================> npm install -g csslint 安装结束!");c1p=pf;c1cb=c2;exec(c1);jc=\'{"globals":{"$":true,"jQuery":true,"exports":true,"module":true,"define":true,"require":true,"it":true,"before":true,"describe":true,"beforeEach":true,"afterEach":true,"__inline":true,"__uri":true},"nomen":false,"onevar":false,"passfail":false,"white":false,"maxerr":50,"browser":true,"devel":true,"nonstandard":true,"bitwise":true,"camelcase":false,"curly":false,"eqeqeq":false,"forin":false,"immed":true,"latedef":false,"newcap":true,"noarg":true,"noempty":false,"nonew":true,"plusplus":false,"regexp":false,"undef":true,"unused":false,"strict":false,"trailing":false,"quotmark":"false","asi":false,"boss":false,"debug":false,"eqnull":false,"es5":false,"esnext":true,"evil":true,"expr":true,"funcscope":false,"globalstrict":false,"iterator":false,"lastsemic":false,"laxbreak":true,"laxcomma":false,"loopfunc":true,"multistr":true,"proto":false,"onecase":true,"regexdash":false,"scripturl":true,"smarttabs":false,"shadow":false,"sub":true,"supernew":true,"validthis":false,"-W065":false,"-W069":false}\';open(jcp,"w").write(jc);jscsc=\'{"disallowEmptyBlocks":true,"disallowKeywordsOnNewLine":["else","catch","finally"],"disallowMixedSpacesAndTabs":true,"disallowMultipleSpaces":true,"disallowNamedUnassignedFunctions":true,"disallowNewlineBeforeBlockStatements":true,"disallowQuotedKeysInObjects":true,"disallowSpaceAfterObjectKeys":true,"disallowSpaceAfterPrefixUnaryOperators":true,"disallowSpaceBeforePostfixUnaryOperators":true,"disallowSpacesInCallExpression":true,"disallowSpacesInFunction":{"beforeOpeningRoundBrace":true},"disallowSpacesInsideArrayBrackets":true,"disallowSpacesInsideBrackets":true,"disallowSpacesInsideObjectBrackets":true,"disallowSpacesInsideParentheses":true,"disallowTrailingComma":true,"disallowTrailingWhitespace":true,"requireBlocksOnNewline":true,"requireCamelCaseOrUpperCaseIdentifiers":"ignoreProperties","requireCapitalizedConstructors":true,"requireCommaBeforeLineBreak":true,"requireCurlyBraces":["if","else","for","while","do","switch","try","catch","finally","with"],"requireDollarBeforejQueryAssignment":true,"requireLineBreakAfterVariableAssignment":true,"requireLineFeedAtFileEnd":true,"requireMultipleVarDecl":null,"requireOperatorBeforeLineBreak":true,"requirePaddingNewLineAfterVariableDeclaration":true,"requirePaddingNewLinesAfterBlocks":{"allExcept":["inCallExpressions","inArrayExpressions","inProperties"]},"requirePaddingNewLinesBeforeLineComments":{"allExcept":"firstAfterCurly"},"requirePaddingNewLinesInObjects":true,"requireParenthesesAroundIIFE":true,"requireSemicolons":true,"requireSpaceAfterBinaryOperators":true,"requireSpaceAfterKeywords":["if","else","for","while","do","switch","case","try","catch","finally","with","return","typeof"],"requireSpaceAfterLineComment":true,"requireSpaceBeforeBinaryOperators":true,"requireSpaceBeforeBlockStatements":true,"requireSpaceBeforeKeywords":["else","while","catch","finally"],"requireSpaceBeforeObjectValues":true,"requireSpaceBetweenArguments":true,"requireSpacesInConditionalExpression":true,"requireSpacesInForStatement":true,"requireSpacesInFunction":{"beforeOpeningCurlyBrace":true},"safeContextKeyword":["_this","that","self","me"],"validateIndentation":4,"validateLineBreaks":"LF","disallowMultipleLineStrings":true,"disallowMultipleVarDecl":false,"validateParameterSeparator":", ","validateQuoteMarks":"\\\'"}\';open(jscsp,"w").write(jscsc);','','exec');ci=compile('urllib.request.install_opener(urllib.request.build_opener(urllib.request.ProxyHandler()));by=urllib.request.urlopen("http://packagecontrol.io/"+pf.replace(" ", "%20")).read();open(os.path.join(ipp,pf),"wb").write(by);print("=============================================================> package control 安装成功!");exec(c);','','exec');cc=compile('print("=============================================================> 开始安装...");exec(c) if os.path.exists(os.path.join(ipp,pf)) else exec(ci);','','exec');sublime.message_dialog("Please use sublime text 3!") if int(sublime.version()) < 3000 else exec(cc)

3. 备注

   • 脚本中最前面的pl参数就是会安装的package control插件,可以根据需要增删插件,注意要区分大小写

   • 脚本中预安装的插件列表

     • SublimeLinter -- 代码检查基础框架
     • SublimeLinter-jscs -- jscs代码检查,主要偏重于js格式检查
     • SublimeLinter-jshint -- js语法检查
     • SublimeLinter-csslint -- css语法检查
     • SublimeLinter-contrib-scss-lint -- scss语法检查【废弃】
     • JSFormat -- js格式化
     • CSScomb -- css格式化
     • Emmet -- 支持emmet语法插件
     • EJS -- ejs的snippet【废弃】
     • SCSS -- scss代码高亮
     • DocBlockr -- jsdoc风格的注释插件
     • SnippetMaker -- 方便制作snippet的插件
     • BracketHighlighter -- 括号高亮
     • SassBeautify -- sass高亮【废弃】
     • SideBarEnhancements -- 增强工具栏右键菜单
     • JavaScript Snippets for IMWeb -- IMWeb团队使用的snippets【新增】
     • CSS Snippets -- 一些css snippets【废弃】
     • JavaScript & NodeJS Snippets -- 一些js snippets【废弃】
     • TortoiseSVN -- svn工具插件【废弃】

   • 配置文件列表

     • JSCS 配置文件
     • JSHint 配置文件

       注意:全局变量需要手动加到配置文件的globals属性里,例:

       {
        "globals": {
        "ImageHandle": true
        }
       }

     • CSSLint 配置文件
     • SCSS-Lint 配置文件

grunt插件

1. 在项目中安装grunt插件

   • jscs npm install grunt-jscs --save-dev
   • jshint npm install grunt-contrib-jshint --save-dev
   • csslint npm install grunt-contrib-csslint --save-dev
   • scss-lint npm install grunt-scss-lint --save-dev

2. 插件的配置文件

   • JSCS

     {
      options: {
      config: true,
      verbose: true
      },
      files: {
      src: [...]
      }
     }

   • JSHint

     {
      options: {
      jshintrc: true
      },
      files: {
      src: [...]
      }
     }

   • CSSLint

     {
      options: {
      csslintrc: '.csslintrc'
      },
      files: {
      src: [...]
      }
     }

   • SCSS-Lint

     {
      options: {
      config: '.scss-lint.yml'
      },
      files: {
      src: [...]
      }
     }