Module: LicenseHeader

Defined in:

lib/license_header/auditor.rb,
lib/license_header.rb,
lib/license_header/version.rb

Overview

Module to assist in making sure that all files have the right license block as a header.

Defined Under Namespace

Classes: Auditor

Constant Summary

LANGUAGE_SYNTAX =

For each language you can define five variables

:pre will be prepended to the header :each will be prepended to each line of the header :post will be appended to the end of the file :sep determines whether an empty line should separate the header from the body :exts lists the extensions the syntax will apply to

Only :each is required; if the other two are not provided they will be ignored

{ 
  :css        => { :pre => '/* ',  :each => ' * ', :post => '*/',  :sep => true,  :exts => %w(.css .scss)            },
  :erb        => { :pre => '<%#',  :each => '',    :post => '%>',  :sep => false, :exts => %w(.erb)                  },
  :haml       => { :pre => '-#',   :each => '  ',                  :sep => true,  :exts => %w(.haml)                 },
  :html       => { :pre => '<!--', :each => '',    :post => '-->', :sep => false, :exts => %w(.html)                 },
  :javascript => { :pre => '/* ',  :each => ' * ', :post => '*/',  :sep => true,  :exts => %w(.js .json)             },
  :ruby       => {                 :each => '# ',                  :sep => true,  :exts => %w(.rb .rake .coffee .pp) },
}

VERSION =

"0.0.3"