fdlint 0.1.0

data/lib/runner.rb

@@ -0,0 +1,225 @@
+# encoding: utf-8
+
+#require 'profile'
+
+require 'logger'
+require_relative 'base_parser'
+require_relative 'rule'
+require_relative 'parser_visitable'
+require_relative 'file_validator'
+require_relative 'log_entry'
+require_relative 'css/reader'
+require_relative 'css/parser'
+require_relative 'css/rule/checklist'
+require_relative 'html/parser'
+require_relative 'html/rule/check_tag_rule'
+require_relative 'js/parser'
+require_relative 'js/rule/all'
+require_relative 'js/rule/file_checker'
+require_relative 'helper/file_reader'
+require_relative 'helper/code_type'
+
+
+module XRay
+
+  module CSS
+    class VisitableParser < Parser
+      include XRay::ParserVisitable
+    end
+  end
+
+  module HTML 
+    class VisitableParser < Parser
+      include XRay::ParserVisitable
+    end
+  end
+
+  module JS
+    class VisitableParser < Parser
+      include XRay::ParserVisitable
+    end
+  end
+
+
+  class Runner
+    
+    include Helper::FileReader
+
+    attr_reader :source, :rules
+  
+    def initialize(opt={})
+      @opt = {
+        :encoding => 'utf-8',
+        :debug    => false,
+        :log_level => :warn
+      }.merge opt
+
+      @rules = []
+
+      if @opt[:debug]
+        @logger = Logger.new(STDOUT)
+        @logger.level = Logger::INFO
+      end
+
+      Rule.import_all
+
+
+    end
+
+    def check_css(css, opt = {})
+      @source              = css
+      parser               = XRay::CSS::VisitableParser.new(css, @logger)
+      visitor              = XRay::CSS::Rule::CheckListRule.new( opt )
+      parser.add_visitor visitor
+      run_parser( parser )
+    end
+
+    def check_css_file( file, opt={} )
+      results = []
+      begin
+        "".extend(XRay::Rule).check_css_file(file).each do |msg, level, *pos|
+          results.unshift LogEntry.new( msg, level, pos[0] || 0, pos[1] || 0 )
+        end
+
+        source = XRay::CSS::Reader.read( file, @opt )
+        results.concat check_css( source, opt.merge({
+          :scope => CodeType.scope(file)
+        }))
+      rescue EncodingError => e
+        results.unshift LogEntry.new( "File can't be read as #{@opt[:encoding]} charset", :fatal)
+      rescue => e
+        if @opt[:debug]
+          puts e
+          puts e.backtrace 
+        end
+        results.unshift LogEntry.new( e.to_s, :fatal)
+      end
+      results
+    end
+
+    def check_js(js, opt={})
+      @source = js
+      parser = JS::VisitableParser.new(js, @logger)
+      parser.add_visitors JS::Rule::All.new
+      run_parser( parser )
+    end
+
+    def check_js_file(file, opt = {})
+      results = []
+      begin
+        results.concat JS::Rule::FileChecker.new.check_file(file)
+
+        source, encoding = readfile(file, opt)
+        results.concat check_js(source)
+      rescue  EncodingError => e
+        results.unshift LogEntry.new( "File can't be read as #{@opt[:encoding]} charset", :fatal)
+      rescue => e
+        if @opt[:debug]
+          puts e
+          puts e.backtrace 
+        end
+        results.unshift LogEntry.new( e.to_s, :fatal )
+      end
+      results
+    end
+
+    def check_html(text, opt={})
+      @source = text
+      parser = HTML::VisitableParser.new(text, @logger)
+      visitor = HTML::Rule::CheckTagRule.new( opt )
+      parser.add_visitor visitor
+      results = run_parser( parser )
+      unless @parsed_element.nil? or @parsed_element.empty?
+        results += check_scripts_in_html(opt)
+        results += check_styles_in_html(opt)
+      end
+      results
+    end
+
+    def check_scripts_in_html(opt={})
+      results = []
+      @parsed_element.query('script') do |script|
+        row = script.position.row
+        col = script.position.column
+        Runner.new.check_js(script.text, opt).each do |ret|
+          ret.column += script.outer_html[/^\s*<script*?>/].size if ret.row == 1
+          ret.row += row - 1
+          results << ret
+        end
+      end
+
+      results
+    end
+
+    def check_styles_in_html(opt={})
+      results = []
+      @parsed_element.query('style') do |style|
+        row = style.position.row
+        col = style.position.column
+        Runner.new.check_css(style.text, opt.merge({:scope => :in_page })).each do |ret|
+          ret.column += style.outer_html[/^\s*<style*?>/].size if ret.row == 1
+          ret.row += row - 1
+          results << ret
+        end
+      end
+
+      results
+    end
+
+    def check_html_file(file, opt={})
+      source, encoding = readfile file
+      check_html source
+    end
+
+    def check_file( file )
+      type = CodeType.guess_by_name(file)
+      send( "check_#{type}_file", file ) if CodeType.is_style_file? file
+    end
+
+    def check(text, filename="")
+      type = CodeType.guess(text, filename)
+      send "check_#{type}", text
+    end
+
+    def valid_file? file
+      CodeType.is_style_file?(file) and !minified_and_ignored(file) and type_ok?(file)
+    end
+
+    def minified_and_ignored(file)
+      !@opt[:check_min] && file.to_s =~ /-min\.(css|js)$/
+    end
+
+    def type_ok?(file)
+      if @opt[:type]
+        CodeType.guess_by_name(file) == @opt[:type]
+      else
+        true
+      end
+    end
+
+    def run_parser(parser)
+      @parsed_element = parser.parse_no_throw
+      filter_results( parser.results ).sort_by!(&:row)
+    end
+
+    def filter_results(results)
+      case log_level
+        when :warn
+          results
+        when :error
+          results.select {|r| r.level == :error || r.level == :fatal }
+        when :fatal
+          results.select {|r| r.level == :fatal }
+      end
+    end
+
+    def log_level
+      @opt[:log_level]
+    end
+
+    def log_level=(lvl)
+      @opt[:log_level] = lvl
+    end
+
+  end
+end

data/rules.d/css.rule

@@ -0,0 +1,127 @@
+# encoding: utf-8
+# vi: filetype=ruby
+css
+
+check_file_name_without_ad do |name|
+  unless defined? ADVERTISMENT
+    ADVERTISMENT = /(?:[^a-z0-9%_-]|^)ad(?:[sv][^a-z\r=\?]+|banner|click|ver|name|x|log|[^a-z\r_-]*[\.\/]|bot|c_|client|council|gifs|graph|images|img|fshow|pic|vert|view|info|click|sponsor)/
+  end
+  if name =~ ADVERTISMENT
+    ['路径和文件名中不应该出现ad', :error]
+  end
+end
+
+check_file_name_without_underscore do |name|
+  if File.basename(name) =~ /_/
+    ['文件名中单词的分隔符应该使用中横线“-”', :error] 
+  end
+end
+
+check_file_name_seperator do |name|
+  if File.dirname(name) =~ /-(?!v?[\d.])/
+    ['文件夹只有需要版本区分时才可用中横线分隔，如fdev-v3', :error] 
+  end
+end
+
+check_file_name_downcase do |name|
+  win_disk = /^[a-zA-Z]:/
+  if name.sub( win_disk, '') =~ /[A-Z]/
+    ['文件夹和文件命名必须用小写字母', :error] 
+  end
+end
+
+check_selector_with_id do |selector|
+  if context.page_level? &&
+      selector =~ /#[-\w]+/
+    ['页面级别样式不使用id', :error]
+  end
+end
+
+check_selector_with_global_tag do |selector|
+  if context.page_level? &&
+      selector =~ /^\w+$/
+    ['页面级别样式不能全局定义标签样式', :error]
+  end
+end
+
+check_selector_level do |selector|
+  if selector.text.split(/[>\s]/).length > 4
+    ['CSS级联深度不能超过4层', :error]
+  end
+end
+
+check_selector_with_star do |selector|
+  if selector =~ /^\*/
+    ['禁止使用星号选择符', :error]
+  end
+end
+
+check_selector_redefine_lib_css do |selector|
+  if !context.lib? &&
+      selector =~ /^\.fd-\w+$/
+    ['禁止修改或重载type中的样式', :error]
+  end
+end
+
+check_declaration_font do |dec|
+  if dec.property =~ /^font(-family)?$/ && 
+      dec.value.to_s.each_byte.any? {|b| b>127}
+    ['字体名称中的中文必须用ascii字符表示', :error]
+  end
+end
+
+check_ruleset_redefine_a_hover_color do |ruleset|
+  if ruleset.selector &&
+      ruleset.selector.text == 'a:hover' &&
+        ruleset.declarations.find { |dec| dec.property.text == 'color' }
+    ['禁止重写reset中定义的a标签的hover色（现为#ff7300）', :error]
+  end
+end
+
+check_declarations_sequence do |ruleset|
+  list = [
+    %w(position display visible z-index overflow float clear),
+    %w(width height top right bottom left margin padding border),
+    %w(background opacity),
+    %w(font color text line-height vertical-align)
+  ] 
+
+  now = 0
+  ruleset.declarations.each do |dec|
+    prop_text = dec.property.text
+    index = list.find_index do |bag| 
+      bag.any? { |field| prop_text.index field }
+    end 
+
+    next unless index
+    return ['建议使用Mozilla推荐CSS书写顺序'\
+        'http://wd.alibaba-inc.com/doc/page/regulations/css', :warn] if index < now
+    now = index
+  end
+  nil
+end
+
+check_selector_using_hack do |selector|
+  if selector =~ /\S\*/
+    ['合理使用hack', :error]
+  end
+end
+
+check_property_hack do |property|
+  if property =~ /[^-a-z]/
+    ['合理使用hack', :error]
+  end
+end
+
+check_value_use_css_expression do |value|
+  if value =~ /^expression\(/
+    ['禁止使用CSS表达式', :error]
+  end
+end
+
+check_value_use_hack do |value|
+  if value =~ /\\\d$/
+    ['合理使用hack', :error]
+  end
+end
+

data/rules.d/html.dtd.rule

@@ -0,0 +1,22 @@
+# encoding: utf-8
+# vi: filetype=ruby
+html
+
+check_doc do |doc|
+  unless context.have_dtd?
+    ["必须存在文档类型声明", :error] 
+  end
+end
+
+check_dtd_type_must_be_html5 do |dtd|
+  unless dtd.type =~ /^html$/i
+    ['新页面统一使用HTML 5 DTD', :warn]
+  end
+end
+
+check_dtd_upcase do |dtd|
+  unless dtd =~ /^<!DOCTYPE/
+    ['必须使用大写的"DOCTYPE"', :warn]
+  end
+end
+

data/rules.d/html.prop.rule

@@ -0,0 +1,51 @@
+# encoding: utf-8
+# vi: filetype=ruby
+
+html
+
+check_property_no_inline_style do |prop|
+  if prop.name =~ /^style$/im
+    ["不能定义内嵌样式style", :error]
+  end
+end
+
+check_property_name_downcase do |prop|
+  if prop.name =~ /[A-Z]/
+    ["属性名必须小写，连字符用中横线", :error]
+  end
+end
+
+check_property_id_prop_value_downcase do |prop|
+  if prop.name_equal? 'id' and prop.value =~ /[A-Z]/
+    ["id名称全部小写，单词分隔使用中横线", :error]
+  end
+end
+
+check_property_class_prop_value_downcase do |prop|
+  if prop.name_equal? 'class' and prop.value =~ /[A-Z]/
+    ["class名称全部小写，单词分隔使用中横线", :error]
+  end
+end
+
+check_property_value_sep do |prop|
+  if prop.value and prop.sep != '"'
+    ["属性值必须使用双引号", :error]
+  end
+end
+
+check_property_value_exsit do |prop|
+  if prop.value.nil?
+    ["不能仅有属性名", :error]
+  end
+end
+
+check_property_class_count do |prop|
+  if prop.name_equal? 'class'
+    names = prop.value.split /\s+/
+    names.reject! { |s| s =~ /^(fd-|layout|grid|w952)\b/ }
+    if names.size > 3
+      ["一个节点上定义的class个数最多不超过3个(不含lib中的class)", :error]
+    end
+  end
+end
+

data/rules.d/html.tag.rule

@@ -0,0 +1,136 @@
+# encoding: utf-8
+# vi: filetype=ruby
+
+html
+
+check_tag_name_downcase do |tag|
+  if tag.tag_name =~ /[A-Z]/ || tag.ending =~ /[A-Z]/
+    ["标签名必须小写", :error]
+  end
+end
+
+check_tag_img_must_have_alt do |tag|
+  if tag.tag_name_equal? 'img'
+    unless tag.has_prop?(:alt)
+      ["img标签必须加上alt属性", :error]
+    end
+  end
+end
+
+check_tag_hyperlink_with_target do |tag|
+
+  if tag.tag_name_equal? 'base' and tag.prop_value(:target)
+    @has_target = true
+  end
+
+  unless @has_target
+    if tag.tag_name_equal? 'a' and tag.prop_value(:href) =~ /^#/ and tag.prop_value(:target) != '_self'
+      ['功能a必须加target="_self"，除非preventDefault过', :warn]
+    end
+  end
+end
+
+check_tag_hyperlink_with_title do |tag|
+  if tag.tag_name_equal? 'a' and tag.prop_value(:href) =~ /^[^#]/
+    unless (prop = tag.prop_value(:title)) and !prop.empty?
+      ['非功能能点的a标签必须加上title属性', :error]
+    end
+  end
+end
+
+check_tag_unique_script_import do |tag|
+  if tag.tag_name_equal? 'script'
+    src = tag.prop_value(:src).to_s
+    if !src.empty? and context.script_used? src
+      ["避免重复引用同一或相同功能文件", :error]
+    end
+  end
+end
+
+check_tag_unique_style_import do |tag|
+  if tag.tag_name_equal? 'link' and tag.prop_value(:rel) =~ /stylesheet/i
+    src = tag.prop_value(:href).to_s
+    if !src.empty? and context.style_used? src
+      ["避免重复引用同一或相同功能文件", :error]
+    end
+  end
+end
+
+check_tag_no_import_in_style_tag do |tag|
+  if tag.tag_name_equal? 'style' and tag.inner_text =~ /@import\s/m
+    ["不通过@import在页面上引入CSS", :error]
+  end
+end
+
+check_tag_head_contain_meta_and_title do |tag|
+  if tag.tag_name_equal? 'head'
+    children = tag.children
+    has_meta = children.any? { |e| e.tag_name_equal? 'meta' and e.prop_value('charset') }
+    has_title = children.any? { |e| e.tag_name_equal? 'title' }
+    unless has_meta and has_title
+      ["head必须包含字符集meta和title", :error]
+    end
+  end
+end
+
+check_tag_block_in_block do |tag|
+  if !tag.tag_name_equal?('a') and tag.inline? and tag.children.any? { |e| !e.inline? }
+    ["行内标签不得包含块级标签，a标签例外", :error]
+  end
+end
+
+check_tag_form_element_with_name do |tag|
+  if (tag.tag_name_equal?('input') and %w(text radio checkbox).include?(tag.prop_value('type').to_s.downcase) or 
+  tag.tag_name_equal?('select') or
+  tag.tag_name_equal?('textarea'))
+    val = tag.prop_value('name')
+    unless val and !val.empty?
+      ["text、radio、checkbox、textarea、select必须加name属性", :error]
+    end
+  end
+end
+
+check_tag_form_button do |tag|
+  if tag.tag_name_equal?('input') and %w(button submit reset).include?(tag.prop_value('type').to_s.downcase)
+    ["所有按钮必须用button（button/submit/reset）", :error]
+  end
+end
+
+check_tag_css_in_head do |tag|
+  if tag.tag_name_equal?('link') and tag.prop_value(:rel) =~ /stylesheet/i
+    if tag.has_scope? and !tag.in_scope?('head')
+        ["外链CSS置于head里(例外：应用里的footer样式)", :warn]
+    end
+  end
+end
+
+check_tag_closed do |tag|
+  if !tag.closed? or (tag.auto_close? and !tag.self_closed?)
+    ["标签必须正确闭合", :error]
+  end
+end
+
+check_tag_html_template do |tag|
+  info = ["新页面按库中的HTML基本结构模板书写基本页面结构", :warn]
+  if tag.tag_name_equal?('head')
+    if  !tag.children.any? { |e| e === 'meta[name==description]' } or
+        !tag.children.any? { |e| e === 'meta[name==keywords]' }
+      info
+    end
+  elsif tag.tag_name_equal?('body')
+    info unless tag.children.any? { |e| e === 'div#doc' }
+  elsif tag === 'div#doc'
+    if  !tag.children.any? { |e| e === 'div#header' } or
+        !tag.children.any? { |e| e === 'div#footer' } or
+        !tag.children.any? { |e| e === 'div#alibar' } or
+        !tag.children.any? { |e| e === 'div#content' }
+      info
+    end
+  end
+end
+
+check_text_should_escape do |el|
+  if el.text =~ /[<>]/
+    ["特殊HTML符号(>和<)必须转义", :error]
+  end
+end

data/rules.d/js.file.rule

@@ -0,0 +1,13 @@
+# encoding: utf-8
+# vi: filetype=ruby
+
+js
+
+check_file_functional_file_must_have_comment do |file, src|
+  if context.func_file? file
+    unless context.has_doc_comment? src
+      ['功能文件头必须有文档注释(以/**开始的多行注释)', :warn]
+    end
+  end
+end
+

data/rules.d/js.jquery.rule

@@ -0,0 +1,56 @@
+# encoding: utf-8
+# vi: filetype=ruby
+
+js
+
+JQ_IDS = %w(jQuery $ jQ jq)
+
+check_expr_member_direct_jquery_call do |expr|
+  expr = context.find_expr_member(expr) do |expr| 
+    ['.', '(', '['].include?(expr.type) && expr.left.text == 'jQuery'
+  end
+
+  if expr
+    unless expr.type == '.' && expr.right.text == 'namespace'
+      ['禁止直接使用jQuery变量，使用全局闭包写法"(function($, NS){....})(jQuery,Namespace);"，jQuery.namespace例外', :error]
+    end
+  end
+end
+
+check_expr_member_forbit_method_call do |expr|
+  methods = %w(sub noConflict)
+  expr = context.find_expr_member(expr) do |expr|
+    expr.type == '.' && JQ_IDS.include?(expr.left.text) && 
+      methods.include?(expr.right.text) 
+  end
+
+  ['禁止使用jQuery.sub()和jQuery.noConflict方法', :error] if expr
+end
+
+check_expr_member_data_call_param do |expr|
+  expr = context.find_expr_member(expr) do |expr| 
+    if expr.type == '('
+      name = expr.left
+      if name.is_a?(XRay::JS::Expression) && name.type == '.' && 
+          name.right.text == 'data'
+        param = expr.right[0]
+        param && param.text =~ /[-_]/
+      end
+    end  
+  end
+  
+  ['使用".data()"读写自定义属性时需要转化成驼峰形式', :error] if expr
+end
+
+check_expr_member_ctor_selector do |expr|
+  expr = context.find_expr_member(expr) do |expr|
+    expr.type == '(' && JQ_IDS.include?(expr.left.text)
+  end
+  
+  if expr
+    param = expr.right[0] 
+    if param && param.type == 'string' && param.text !~ /^['"][#\w<]/
+      ['使用选择器时，能确定tagName的，必须加上tagName', :warn]
+    end
+  end
+end

data/rules.d/js.mergefile.rule

@@ -0,0 +1,71 @@
+# encoding: utf-8
+# vi: filetype=ruby
+
+js
+
+check_merge_importing_one_line_one_import do |import, pathes, file|
+  same_line = pathes.select { |path| path[:row] == import[:row] }
+  if same_line.size > 1 and same_line.index(import) > 0
+    ['一行只能有一个import文件', :error, import[:row], import[:col]]
+  end
+end
+
+check_merge_importing_strict_import_js do |import, pathes, file|
+  url = import[:url]
+  if context.lib_scope?(url) or context.relative?(url)
+    break 
+  end
+
+  unless /ImportJavscript\.url\(['"]?([^'"]+)['"]?\);/ =~ import[:text]
+    ['merge文件格式不正确', :error, import[:row], import[:col]]
+  end
+end
+
+check_merge_importing_global_cannot_import_page do |import, pathes, file|
+  url = import[:url]
+  if context.lib_scope?(url) or context.relative?(url)
+    break 
+  end
+
+  if context.global_scope? file and context.page_scope?(url)
+    ['产品线merge文件不能引用page文件', :error, import[:row], import[:col]]
+  end
+end
+
+check_merge_importing_can_only_import_from_same_app do |import, pathes, file|
+  url = import[:url]
+  if context.lib_scope?(url) or context.relative?(url)
+    break 
+  end
+
+  app = context.app(file) 
+  if app && app != context.app(url)
+    ['merge文件引用非该产品线文件', :error, import[:row], import[:col]]
+  end
+end
+
+check_merge_importing_page_can_only_import_same_page do |import, pathes, file|
+  if context.page_scope?(file)
+    path         = file.sub /\\/, '/'
+    url          = import[:url]
+    prefix       = File.basename(path).sub /-merge([-_]\d+)?\.js/, ''
+    page_pattern = %r"/page/#{prefix}(-min|(/.+))?\.js"
+    if context.page_scope?(file) && context.page_scope?(url) && url !~ page_pattern
+      ['页面级别merge文件只允许merge当前页面所属js文件', :error, import[:row], import[:col]]
+    end
+  end
+end
+
+##Style 拆分之后可能merge的文件已经不存在
+##stop checking this rule
+#check_merge_importing_exist do |import, pathes, file|
+#end
+
+check_merge_importing_must_be_minified do |import, pathes, file|
+  if !context.min_file?(import[:url])
+    ['merge文件需要引用压缩版的js, 如a-min.js', :warn, 
+      import[:row], 
+      import[:col] + import[:text].rindex(/\/|\\/) + 1
+    ]
+  end
+end