fdlint 0.1.3 → 0.2.0.pre

data/lib/fdlint/rule/validation.rb

@@ -0,0 +1,79 @@
+module Fdlint; module Rule
+
+  class Validation < Struct.new( :scope, :validate_block )
+
+    attr_accessor :desc, :uri, :group
+
+    def long_desc
+      if desc
+        uri ? desc + ", more info: #{uri}" : desc
+      end
+    end
+
+    def to_s
+      "<Validation #{scope} #{long_desc}>"
+    end
+
+    def inspect
+      to_s
+    end
+
+    def to_visitor( opt={} )
+      [
+        scope,
+        proc { |node, source, parser|
+          exec( node, source, opt[:file], parser )
+        }
+      ]
+    end
+
+    def exec( node, source, file = nil, parser = nil )
+      Runner.new.exec( node, source, file, parser, validate_block ) do |results|
+        results.map do |msg, level, opt|
+          pos = if node.respond_to?( :position ) && node.position
+                  node.position
+                else
+                  opt[:pos]
+                end
+
+          if pos
+            pos.column  += opt[:column_offset] if opt[:column_offset]
+            pos.row     += opt[:row_offset] if opt[:row_offset]
+            row, column  = pos.row, pos.column
+          end
+
+          LogEntry.new( msg, level, row, column ).tap do |entry|
+            entry.validation = self
+          end
+        end
+      end
+    end
+
+    class Runner
+
+      def exec( node, source, file, parser, validate_block, &block )
+        instance_exec( node, source, file, parser, &validate_block ) 
+        yield results if block_given?
+      end
+
+      def results
+        @results ||= []
+      end
+
+      def fatal( msg, opt={} )
+        results << [msg, :fatal, opt]
+      end
+      
+      def error( msg, opt={} )
+        results << [msg, :error, opt]
+      end
+
+      def warn( msg, opt={} )
+        results << [msg, :warn, opt]
+      end
+
+
+    end
+  end
+
+end; end

data/lib/fdlint/rule.rb

@@ -0,0 +1,81 @@
+require 'fdlint/rule/validation'
+require 'fdlint/rule/dsl'
+
+module Fdlint
+
+  module Rule
+
+    RULE_PATH = File.expand_path '../../rules.d', File.dirname(__FILE__)
+
+    class << self
+
+      include ::Fdlint::Helper::Logger
+
+      SYNTAXES = [:css, :html, :js]
+      
+      # Public: Rules for file validation
+      #
+      # opt - options including syntax
+      #
+      # Returns an Array holding all validations for this file
+      def validations_for_file( opt={} )
+        (all[opt[:code_type]] || []).select do |validation|
+          validation.scope == :file
+        end
+      end
+
+      alias_method :for_file, :validations_for_file
+
+      SYNTAXES.each do |syntax|
+        # Public: Rules for css content validation
+        #
+        # Returns an Array holding all rules for content validation.
+        define_method "validations_for_#{syntax}_content" do
+          (all[syntax] || []).select do |validation|
+            validation.scope != :file
+          end
+        end
+
+        alias_method :"for_#{syntax}_content", :"validations_for_#{syntax}_content"
+      end
+
+      def all
+        @rules ||= {}
+        import unless @imported
+        @rules
+      end
+
+      alias_method :rules, :all
+
+      def import
+        debug { "importing rules" }
+        Dir.glob( File.join RULE_PATH, '**', '*.rule.rb' ) do |rule|
+          begin
+            DSL.instance_eval File.read(rule), rule
+          rescue SyntaxError, NoMethodError => e
+            fatal { "Error parsing rule file:".red }
+            fatal { "  -> #{rule}" }
+            fatal { "" }
+            raise
+          end
+        end
+        @imported = true
+        debug { "done" }
+      end
+
+      def add( code_type, scope, opt )
+        debug { "  -> adding rule: #{code_type.inspect} - #{scope.inspect} - #{opt[:desc]}" }
+        cache = @rules[code_type] ||= []
+        cache << Validation.new( scope, opt[:block] ).tap do |v|
+          v.desc = opt[:desc]
+          v.uri  = opt[:uri]
+        end
+        @rules
+      end
+
+    end
+
+  end
+
+end
+

data/lib/fdlint/support/core/array.rb

@@ -0,0 +1,5 @@
+class Array
+
+  alias_method :blank?, :empty?
+
+end

data/lib/fdlint/support/core/file.rb

@@ -0,0 +1,8 @@
+class File
+
+  def name
+    File.basename( path )
+  end
+
+end
+

data/lib/fdlint/support/core/hash.rb

@@ -0,0 +1,5 @@
+class Hash
+
+  alias_method :blank?, :empty?
+
+end

data/lib/fdlint/support/core/nil.rb

@@ -0,0 +1,7 @@
+class NilClass
+
+  def blank?
+    true
+  end
+
+end

data/lib/fdlint/support/core/string.rb

@@ -0,0 +1,7 @@
+class String
+
+  def blank?
+    !(self =~ /\S/)
+  end
+
+end

data/lib/fdlint/support/core_ext.rb

@@ -0,0 +1,5 @@
+require_relative 'core/nil'
+require_relative 'core/string'
+require_relative 'core/array'
+require_relative 'core/hash'
+require_relative 'core/file'

data/lib/fdlint/validator.rb

@@ -0,0 +1,102 @@
+require 'fdlint/rule'
+require 'fdlint/helper/code_type'
+require 'fdlint/parser'
+require 'fdlint/parser/js/js_parser'
+require 'fdlint/parser/html/html_parser'
+require 'fdlint/parser/css/css_parser'
+
+module Fdlint
+
+  class Validator
+
+    attr_reader :file, :source, :results, :code_type
+    include Fdlint::Helper::Logger
+
+    def initialize( path = nil, options = {} )
+      @file      = path
+      @source    = options[:text]
+      @code_type = options[:code_type] || Helper::CodeType.guess( source, file )
+    end
+
+    def validate
+      @results = []
+
+      begin
+        @source ||= read_file
+
+        validate_file if file
+        validate_content
+      rescue EncodingError
+        results << InvalidFileEncoding.new
+      end
+
+      yield file, source, results
+    end
+
+    def validate_file
+      debug { "validating file: " << file }
+      file = File.new( self.file )
+      entries = file_level_rules.map do |validation|
+        validation.exec( file, source, file )
+      end
+      self << entries.flatten.compact
+    end
+
+    def validate_content
+      if source.valid_encoding?
+        self << parse.flatten
+      else
+        self << [InvalidFileEncoding.new]
+      end
+    end
+
+    protected
+
+      def << results
+        @results ||= []
+        if results
+          @results.concat results
+        end
+        @results
+      end
+
+      def read_file
+        ::Fdlint::Helper::FileReader.readfile( file, force_utf8: true )
+      end
+
+      def parse
+        parser.parse_no_throw
+        parser.results
+      end
+
+      def parser
+        @parser ||= build_parser
+      end
+
+      def build_parser
+        base_parser = {
+          :js   => ::Fdlint::Parser::JS::JsParser,
+          :css  => ::Fdlint::Parser::CSS::CssParser,
+          :html => ::Fdlint::Parser::HTML::HtmlParser
+        }.fetch( code_type ).new( source )
+
+        file = File.new(self.file) if self.file
+
+        base_parser.tap do |parser|
+          content_level_rules.each do |validation|
+            parser.add_visitor *validation.to_visitor( file: file )
+          end
+        end
+      end
+
+      def content_level_rules
+        Fdlint::Rule.send( :"for_#{code_type}_content" )
+      end
+
+      def file_level_rules
+        Fdlint::Rule.for_file( :code_type => code_type )
+      end
+
+  end
+
+end

data/lib/fdlint/version.rb

@@ -0,0 +1,3 @@
+module Fdlint
+  VERSION = '0.2.0.pre'
+end

data/lib/fdlint.rb

@@ -0,0 +1,5 @@
+require 'fdlint/version'
+require 'fdlint/support/core_ext'
+require 'fdlint/helper/logger'
+require 'fdlint/validator'
+require 'fdlint/printer'

data/rules.d/css.rule.rb

@@ -0,0 +1,100 @@
+# CSS review rules
+# Author: @qhwa
+
+css_rules
+
+review( 'selector' ) {
+
+  desc "页面级别样式请用class选择符代替id选择符，以免在重用时影响其他页面"
+  rule { |selector, source, file|
+    if file && file.page_level?  && selector =~ /^#/
+      error '页面级别样式不使用id'
+    end
+  }
+
+  desc "页面级别的样式如果使用 body、p 等全局标签样式，会增加复用难度"
+  rule { |selector, source, file|
+    if file && file.page_level? && selector =~ /^\w+$/
+      error '页面级别样式不能全局定义标签样式'
+    end
+  }
+
+  desc "过多的 '>' 层级会影响性能"
+  rule { |selector|
+    if selector.text.split(/[>\s]/).length > 4
+      error 'CSS级联深度不能超过4层'
+    end
+  }
+
+  rule { |selector|
+    if selector =~ /^\*/
+      error '禁止使用星号选择符'
+    end
+  }
+
+  rule { |selector|
+    if selector =~ /\S\*/
+      error '合理使用hack'
+    end
+  }
+}
+
+review( 'declaration' ) {
+  rule { |declaration|
+    if declaration.property =~ /^font(-family)?$/ && declaration.value =~ /\p{Han}+/u
+      error '字体名称中的中文必须用ascii字符表示'
+    end
+  }
+}
+
+review( 'ruleset' ) {
+
+  uri 'http://wd.alibaba-inc.com/doc/page/regulations/css'
+  rule { |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.include? field }
+      end 
+
+      if index
+        if index < now
+          warn '建议使用Mozilla推荐CSS书写顺序'
+          break
+        end
+        now = index
+      end
+    end
+    nil
+  }
+}
+
+review( 'property' ) {
+  rule { |property|
+    if property =~ /[^-a-z]/
+      error '合理使用hack'
+    end
+  }
+}
+
+review( 'value' ) {
+  rule { |value|
+
+    if value =~ /^expression\(/
+      error '禁止使用CSS表达式'
+    end
+
+    if value =~ /\\\d$/
+      error '合理使用hack'
+    end
+  }
+}
+

data/rules.d/filename.rule.rb

@@ -0,0 +1,49 @@
+rules_for 'css', 'js'
+
+review( 'file' ) {
+  rule { |file|
+    if file.name =~ /(?:[^a-z0-9%_-]|^)
+      #以ad开头，与后面文字组合，构成常见的广告单词
+      ad
+      (?:
+        [sv][^a-z\r=\?]+
+        |[^a-z\r_-]*[\.\/]
+        |bot|c_|client|council|gifs|graph|images|img
+        |fshow|pic|vert|view|info|click|sponsor|banner
+        |click|ver|name|x|log|
+      )/x
+      error '路径和文件名中不应该出现ad'
+    end
+  }
+
+  desc '使用规范的文件名可以避免不同操作系统上的编码问题'
+  uri  '#file-name'
+  rule { |file|
+
+    unless file.name =~ /\A[_\-a-zA-Z0-9\.]+\Z/
+      error "文件名只能是英文字符"
+    end
+
+    if file.name =~ /[_]/
+      warn "文件名中的连字符建议使用“-”而不是“_”"
+    end
+
+    win_disk = /^[a-zA-Z]:/
+    if file.name.sub( win_disk, '') =~ /[A-Z]/
+      error '文件夹和文件命名必须用小写字母'
+    end
+  }
+
+}
+
+helpers( 'file' ) {
+  def page_level?
+    !library_level?
+  end
+
+  def library_level?
+    name =~ %r{/lib/}
+  end
+}
+
+

data/rules.d/html.rule.rb

@@ -0,0 +1,169 @@
+# encoding: utf-8
+html_rules
+
+review( 'doc' ) { |doc|
+  unless doc.have_dtd?
+    error "必须存在文档类型声明"
+  end
+}
+
+review( 'dtd' ) { |dtd|
+  unless dtd.type =~ /^html$/i
+    warn '推荐使用HTML 5 DTD'
+  end
+
+  unless dtd =~ /^<!DOCTYPE/
+    warn '必须使用大写的"DOCTYPE"'
+  end
+}
+
+review( 'property' ) { |prop|
+
+  # Bad case: <div style="padding:0">...</div>
+  if prop =~ /^style$/im
+    error "不能定义内嵌样式style"
+  end
+
+  if prop =~ /[A-Z_]/
+    error "属性名必须小写，连字符用中横线"
+  end
+
+  if prop =~ 'id' and prop.value =~ /[A-Z]/
+    error "id名称全部小写，单词分隔使用中横线"
+  end
+
+  if prop =~ 'class' and prop.value =~ /[A-Z]/
+    error "class名称全部小写，单词分隔使用中横线"
+  end
+
+  if prop.value and prop.sep != '"'
+    error "属性值必须使用双引号"
+  end
+
+  if prop.value.nil?
+    error "不能仅有属性名"
+  end
+
+}
+
+review( 'tag' ) { |tag|
+
+  if tag =~ /[A-Z]/ || tag.ending =~ /[A-Z]/
+    error "标签名必须小写"
+  end
+
+  if tag =~ 'img'
+    unless tag.has_prop?( 'alt' )
+      error "img标签必须加上alt属性"
+    end
+  end
+
+  if tag =~ 'a' and tag['href'] =~ /^[^#]/
+    unless tag['title']
+      error '非功能能点的a标签必须加上title属性'
+    end
+  end
+}
+
+review( 'tag' ) {
+
+  # <base target='_self'>
+  after( 'tag' ) { |tag|
+    if tag =~ 'base' and tag.prop_value('target')
+      @has_target = true
+    end
+  }
+
+  rule { |tag|
+    unless @has_target
+      if tag =~ 'a' and tag.prop_value('href') =~ /^#/ and tag.prop_value(:target) != '_self'
+        warn '功能a必须加target="_self"，除非preventDefault过'
+      end
+    end
+  }
+
+}
+
+review( 'tag' ) {
+
+  after( 'tag' ) {|tag|
+    if tag =~ 'script'
+      src = tag['src'].to_s
+      if !src.empty?
+        @scripts_used ||= []
+        @scripts_used << src
+      end
+    elsif tag.stylesheet_link?
+      src = tag['href'].to_s
+      if !src.empty?
+        @styles_used ||= []
+        @styles_used << src
+      end
+    end
+  }
+
+  rule { |tag|
+    if tag =~ 'script'
+      src = tag['src'].to_s
+      if !src.empty? && (@script_used || []).include?( src )
+        error "避免重复引用同一或相同功能文件"
+      end
+    elsif tag.stylesheet_link?
+      src = tag['src'].to_s
+      if !src.empty? && (@styles_used || []).include?( src )
+        error "避免重复引用同一或相同功能文件"
+      end
+    end
+  }
+}
+
+
+review( 'tag' ) { |tag|
+
+  if tag =~ 'style' and tag.inner_text =~ /@import\s/m
+    error "不通过@import在页面上引入CSS"
+  end
+
+  if tag =~ 'head'
+    
+    children  = tag.children
+    has_meta  = children.any? { |e| e =~ 'meta' and e['charset'] }
+    has_title = children.any? { |e| e =~ 'title' }
+
+    unless has_meta and has_title
+      error "head必须包含字符集meta和title"
+    end
+  end
+
+  if !(tag =~ 'a') and tag.inline? and tag.children.any? { |e| !e.inline? }
+    error "行内标签不得包含块级标签，a标签例外"
+  end
+
+  if (tag =~ 'input') and tag['type'].to_s =~ /text|radio|checkbox/ or
+      tag =~ /^(select|textarea)$/
+
+    if tag['name'].blank?
+      error "text、radio、checkbox、textarea、select必须加name属性"
+    end
+  end
+
+  if tag =~ /input/ and tag['type'].to_s =~ /button|submit|reset/
+    error "所有按钮必须用button（button/submit/reset）"
+  end
+
+  if tag.stylesheet_link?
+    if tag.has_scope? and !tag.in_scope?('head')
+      error "外链CSS置于head里(例外：应用里的footer样式)"
+    end
+  end
+
+  if !tag.closed?
+    error "标签必须正确闭合"
+  end
+}
+
+review( 'text_tag' ) do |text_tag|
+  if text_tag.text =~ /[<>]/
+    error "特殊HTML符号(>和<)必须转义"
+  end
+end

data/rules.d/js.jquery.rule.rb

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