fdlint 0.1.3 → 0.2.0.pre

data/rules.d/js.rule.rb

@@ -0,0 +1,205 @@
+# encoding: utf-8
+# vi: filetype=ruby
+
+js_rules
+
+review( 'file' ) {
+  desc "版权或维护信息在头部注释中声明"
+  rule { |file, source|
+    unless source =~ %r{^\s*
+        /\*\*
+        [^*]*
+        \*+
+        (?:[^/*][^*]*\*+)
+        */}x
+      warn '功能文件头必须有文档注释(以/**开始的多行注释)'
+    end
+  }
+}
+
+review( 'statement' ) { |stat|
+  ary = %w(empty var continue break return throw expression)
+  if ary.include?(stat.type) && !stat.end_with_semicolon?
+    error '所有语句结束带上分号'
+  end
+}
+
+review( 'stat_if' ) {
+
+  rule { |stat|
+    # if (condition1) state1;       <--- true_part
+    # else if (condition2) state2;  <--- false_part of condition1
+    #                                    true_part  of condition2
+    # else state3;                  <--- false_part of condition2
+    if stat.true_part.type != 'block' ||
+        stat.false_part && stat.false_part.type != 'if' && stat.false_part.type != 'block'
+      error '所有条件区域必须用花括号括起来'
+    end
+  }
+
+  rule { |stat|
+    count = 0;
+    # count "else if"
+    while stat.false_part && stat.false_part.type == 'if'
+      count += 1
+      stat = stat.false_part
+    end
+    # count "else"
+    count += 1 if stat.false_part
+    if count >= 3
+      error '3个条件及以上的条件语句用switch代替if else'
+    end
+  }
+}
+
+review( 'expr_new' ) { |expr|
+  expr = expr.left
+  if expr.type == '('
+    args = expr.right.elements
+    expr = expr.left
+  end
+
+  if args.nil? || args.empty?
+    if expr.text == 'Object'
+      error '使用{}代替new Object()'
+    elsif expr.text == 'Array'
+      error '使用[]代替new Array()'
+    end 
+  end
+}
+
+review( 'expression' ) {
+
+  rule { |expr|
+    checks = %w(
+      (.,window,eval)
+      eval
+    )
+    if expr && expr.left && checks.include?(expr.left.text)
+      error '不允许使用eval'
+    end
+  }
+
+  rule { |expr|
+    if expr.left && expr.left.text == 'alert'
+      warn '必须去掉临时调试代码。如果一定要使用alert功能，请使用 window.alert'
+    end
+  }
+
+  rule { |expr|
+    if expr.left
+      if expr.left.text =~ /(?<!this|self),_/
+        error '禁止调用对象的私有方法'
+      end
+    end
+  }
+
+}
+
+review( 'expr_equal' ) { |expr|
+  if expr.type == '==' || expr.type == '!='
+    warn '避免使用==和!=操作符'
+  end
+}
+
+review( 'stat' ) { |stat|
+  if stat.try_part.contains?('try') ||
+      stat.catch_part && (stat.catch_part.contains? 'try') ||
+      stat.finally_part && (stat.finally_part.contains? 'try')
+    warn 'try catch一般不允许嵌套，若嵌套，需要充分的理由'
+  end
+}
+
+# 检查是否有全局变量、全局函数
+group( 'no global variables or functions' ) {
+
+  scope_depth = 0
+  scoped_vars = []
+
+  before( 'program' ) { scope_depth = 0 }
+  before( 'function_declaration' ) { scope_depth += 1 }
+
+  after( 'function_parameters' ) { |params|
+    scoped_vars << params.elements.map { |expr|
+      if expr.type == "id"
+        param_name = expr.left.text
+      end
+    }.compact
+  }
+
+  after( 'function_declaration' ) { |function|
+    scoped_vars.pop
+    scope_depth -= 1
+  }
+
+  review( 'expr_assignment' ) { |expr|
+    if expr.type == "="
+      expr = expr.left
+      if expr.type == "id" && !scoped_vars.flatten.include?( expr.left.text )
+        error '禁止使用未定义的变量(或全局变量)'
+      end
+    end
+  }
+
+  review( 'stat_var_declaration' ) { |stat|
+    error "禁止使用未定义的变量(或全局变量)" if scope_depth <= 0
+  }
+
+  review( 'function_name' ) { |name|
+    error '不允许申明全局函数' if scope_depth <= 1
+  }
+}
+
+# bad case:  x_y, x_Y, X_y, _Xy
+# good case: X_Y, _xy, _xY
+group( '变量名的命名规范' ) {
+  review( 'stat_var_declaration' ) { |stat|
+    var_name = stat.left.text.sub(/^_+/, '')
+    if var_name =~ /[a-z]/ && var_name =~ /[A-Z]/ && var_name =~ /[^_]_/
+      error '成员函数，成员对象，局部变量采用首字母小写的驼峰格式'
+    end
+  }
+  review( 'expr_assignment' ) { |expr|
+    if expr.type == "="
+      var_name = expr.left.text.sub(/^_+/, '')
+      if var_name =~ /[a-z]/ && var_name =~ /[A-Z]/ && var_name =~ /[^_]_/
+        error '成员函数，成员对象，局部变量采用首字母小写的驼峰格式'
+      end
+    end
+  }
+}
+
+
+review( 'expr_literal_string' ) { |string|
+  if string.text.start_with? '"'
+    warn '尽可能使用单引号，而不是双引号'
+  end
+}
+
+review( 'statement' ) { |stat, source, file, parser|
+  line = parser.scanned_source.lines.last
+  if line =~ /^\t+/
+    error '不要使用 tab 来表示缩进'
+  elsif line =~ /^[ ]{1,3}\S/
+    error '应该使用连续的4个空白字符表示缩进'
+  end
+}
+
+review( 'expr_logical_or' ) { |expr, source|
+  if expr.left && expr.right
+    left = expr.position.pos - 2
+    unless expr.type == "(" || expr.type == "."
+      unless source[left, expr.type.size + 2] == (" " << expr.type << " ")
+        error '操作符(如, +/-/*/% 等)两边留空'
+      end
+    end
+  end
+}
+
+before( 'function_parameters' ) { |params, source, file, parser|
+  if parser.check /[^)]*\)\{/
+    warn "函数定义的'{'前应该留一个空格",
+      pos: parser.scanner_pos,
+      column_offset: parser.rest_source.index('){')
+  end
+}

data/test/default_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class DefaultTest < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_the_truth
+    assert true
+  end
+end

data/test/fixtures/js/scope-test.js

@@ -6,11 +6,22 @@
         var temp;
     }
 
-    var _createSeperator = function(){
+    var _createSeperator = function( temp4, data, time, scope ){
          var _self = this,
             menuEl = _self.get('menuEl');
-         //TempӦ��Ҫ����ȷ�ؼ��Ϊȫ�ֱ��� 
+         //tempӦ��Ҫ����ȷ�ؼ��Ϊȫ�ֱ��� 
          temp = [a,b,c];
+
+         // $ �ڸ��ռ��ж��壬����ȫ�ֱ���
+         $ = jQuery;
+
+         // temp3 ���·����壬����ȫ�ֱ���
+         temp3 = "foo";
+         var temp3;
+
+         // temp4 �Ǻ�������������ȫ�ֱ���
+         temp4 = "bar";
+
          return new Node(temp).appendTo(menuEl);
 
 		 test = 123;
@@ -19,4 +30,6 @@
 		temp2 = 234;
       };
 
+    $.data;
+
 })(jQuery);

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+
+# Add test libraries you want to use here, e.g. mocha
+
+class Test::Unit::TestCase
+
+  # Add global extensions to the test case class here
+  
+end