Improve build system: read version from version.txt, fix build without compiler

* read the version from version.txt * set default target to build * added dependencies to all targets * allow the build to run without a local copy of the closure compiler * updated license header with @VERSION@ which will be replaced during the build * added the license header to all files (that one will be stripped out by the closure compiler)
2023-08-10 21:13:10 +03:00 · 2011-11-16 00:25:02 +01:00 · 2011-11-16 00:25:02 +01:00 · 16c74d1f8c
commit 16c74d1f8c
parent 962d5b8e8d
12 changed files with 105 additions and 54 deletions
--- a/.gitignore
+++ b/.gitignore
@ -6,9 +6,8 @@
 /tests/flashcanvas.html
 /lib/
 /dist/
-/build/tmp.js
-/build/html2canvas.min.js
+/build/*.js
 index.html
 image.jpg
 screenshots.html
-screenshots_local.html
+screenshots_local.html
--- a/build.xml
+++ b/build.xml
@ -1,77 +1,75 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
-<project name="html2canvas" basedir=".">
+<project name="html2canvas" basedir="." default="build">
    <property name="src.dir" location="src"/>
    <property name="lib.dir" location="../lib"/>
    <property name="build.dir" location="build"/>
    <property name="dist"  location="dist"/>
-    
-    
    <property name="jquery-externs" value="jquery-1.4.4.externs.js"/>
-    
-    
+
    <property name="JS_NAME" value="html2canvas.js"/>
    <property name="JS_NAME_MIN" value="html2canvas.min.js"/>
    <property name="JQUERY_PLUGIN_NAME" value="jquery.plugin.html2canvas.js"/>
-    
+    <loadfile property="version" srcfile="version.txt" />

-    <path id="sourcefiles">
-        <fileset dir="${src.dir}" includes="LICENSE"/>
-        <fileset dir="." includes="LICENSE"/>
-        <fileset dir="${src.dir}" includes="Core.js"/>  
-        <fileset dir="${src.dir}" includes="Generate.js"/>
-        <fileset dir="${src.dir}" includes="Parse.js"/>
-        <fileset dir="${src.dir}" includes="Preload.js"/>
-        <fileset dir="${src.dir}" includes="Queue.js"/>
-        <fileset dir="${src.dir}" includes="Renderer.js"/>    
+    <fileset id="sourcefiles" dir="${src.dir}">
+        <include name="LICENSE"/>
+        <include name="Core.js"/>
+        <include name="Generate.js"/>
+        <include name="Parse.js"/>
+        <include name="Preload.js"/>
+        <include name="Queue.js"/>
+        <include name="Renderer.js"/>
+    </fileset>

-          
-    </path>
-    
    <path id="jquery-plugin">
        <fileset dir="${src.dir}" includes="LICENSE"/>
-        <fileset dir="." includes="LICENSE"/>
        <fileset dir="${src.dir}/plugins" includes="${JQUERY_PLUGIN_NAME}"/>    
    </path>
- 
-    <path id="minified">
-        <fileset dir="${src.dir}" includes="LICENSE"/>
-        <fileset dir="${build.dir}" includes="tmp.js"/>    
-    </path>
-    
+
    <target name="plugins">
        <concat fixlastline="yes" destfile="${build.dir}/${JQUERY_PLUGIN_NAME}">
            <path refid="jquery-plugin"/>
        </concat>
+        <replaceregexp match="@VERSION@" replace="${version}" flags="g" byline="true" file="${build.dir}/${JQUERY_PLUGIN_NAME}" />
    </target>
- 
-    
-    <target name="build">
+
+
+    <target name="build" depends="plugins">
        <concat fixlastline="yes" destfile="${build.dir}/${JS_NAME}">
-            <path refid="sourcefiles"/>
+            <fileset refid="sourcefiles"/>
        </concat>
+        <replaceregexp match="@VERSION@" replace="${version}" flags="g" byline="true" file="${build.dir}/${JS_NAME}" />
    </target>
-    
-    
+
+
    <taskdef name="jscomp" classname="com.google.javascript.jscomp.ant.CompileTask"
-           classpath="${lib.dir}/compiler.jar"/>
-  
-    <target name="release">
-            
-        <jscomp compilationLevel="simple" warning="verbose" 
-            debug="false" 
-            output="${build.dir}/tmp.js">
+           classpath="${lib.dir}/compiler.jar" onerror="report"/>
+
+    <target name="release" depends="build">
+        <jscomp compilationLevel="simple" warning="verbose"
+            debug="false"
+            output="${build.dir}/${JS_NAME_MIN}">
            <externs dir="${lib.dir}">
-                <file name="${jquery-externs}"/>
+                 <file name="${jquery-externs}"/>
            </externs>
-            <sources dir="${build.dir}">
-                <file name="${JS_NAME}" />
+            <sources dir="${src.dir}">
+                <!-- need to write them again here since the closure compiler doesn't understand filesets,... -->
+                <file name="LICENSE"/>
+                <file name="Core.js"/>
+                <file name="Generate.js"/>
+                <file name="Parse.js"/>
+                <file name="Preload.js"/>
+                <file name="Queue.js"/>
+                <file name="Renderer.js"/>
            </sources>
        </jscomp>
-        
-        <concat fixlastline="yes" destfile="${build.dir}/${JS_NAME_MIN}">
-            <path refid="minified"/>
-        </concat>  
+        <replaceregexp match="@VERSION@" replace="${version}" flags="g" byline="true" file="${build.dir}/${JS_NAME_MIN}" />
+    </target>

+    <target name="clean">
+        <delete file="${build.dir}/${JS_NAME}"></delete>
+        <delete file="${build.dir}/${JS_NAME_MIN}"></delete>
+        <delete file="${build.dir}/${JQUERY_PLUGIN_NAME}"></delete>
    </target>
 </project>

--- a/build/.gitkeepdir
+++ b/build/.gitkeepdir
--- a/src/Core.js
+++ b/src/Core.js
@ -1,3 +1,11 @@
+/*
+  html2canvas @VERSION@ <http://html2canvas.hertzen.com>
+  Copyright (c) 2011 Niklas von Hertzen. All rights reserved.
+  http://www.twitter.com/niklasvh
+
+  Released under MIT License
+*/
+
 var html2canvas = {};

 html2canvas.logging = true;
@ -121,4 +129,4 @@ html2canvas.Util.Extend = function (options, defaults) {
 html2canvas.Util.Children = function(el) {
    // $(el).contents() !== el.childNodes, Opera / IE have issues with that
    return $(el).contents();
-}
+}
--- a/src/Generate.js
+++ b/src/Generate.js
@ -1,3 +1,11 @@
+/*
+  html2canvas @VERSION@ <http://html2canvas.hertzen.com>
+  Copyright (c) 2011 Niklas von Hertzen. All rights reserved.
+  http://www.twitter.com/niklasvh
+
+  Released under MIT License
+*/
+
 html2canvas.Generate = {};


--- a/src/LICENSE
+++ b/src/LICENSE
@ -1,7 +1,7 @@
-/* 
-  html2canvas v0.30 <http://html2canvas.hertzen.com>
+/**
+  @license html2canvas @VERSION@ <http://html2canvas.hertzen.com>
  Copyright (c) 2011 Niklas von Hertzen. All rights reserved.
-  http://www.twitter.com/niklasvh 
-  
+  http://www.twitter.com/niklasvh
+
  Released under MIT License
-*/
+ */
--- a/src/Parse.js
+++ b/src/Parse.js
@ -1,3 +1,11 @@
+/*
+  html2canvas @VERSION@ <http://html2canvas.hertzen.com>
+  Copyright (c) 2011 Niklas von Hertzen. All rights reserved.
+  http://www.twitter.com/niklasvh
+
+  Released under MIT License
+*/
+
 /*
 *  New function for traversing elements
 */
--- a/src/Preload.js
+++ b/src/Preload.js
@ -1,3 +1,11 @@
+/*
+  html2canvas @VERSION@ <http://html2canvas.hertzen.com>
+  Copyright (c) 2011 Niklas von Hertzen. All rights reserved.
+  http://www.twitter.com/niklasvh
+
+  Released under MIT License
+*/
+
 html2canvas.Preload = function(element, opts){
    
    var options = {
--- a/src/Queue.js
+++ b/src/Queue.js
@ -1,3 +1,10 @@
+/*
+  html2canvas @VERSION@ <http://html2canvas.hertzen.com>
+  Copyright (c) 2011 Niklas von Hertzen. All rights reserved.
+  http://www.twitter.com/niklasvh
+
+  Released under MIT License
+*/
 html2canvas.canvasContext = function (width, height) {
    this.storage = [];
    this.width = width;
--- a/src/Renderer.js
+++ b/src/Renderer.js
@ -1,3 +1,10 @@
+/*
+  html2canvas @VERSION@ <http://html2canvas.hertzen.com>
+  Copyright (c) 2011 Niklas von Hertzen. All rights reserved.
+  http://www.twitter.com/niklasvh
+
+  Released under MIT License
+*/
 html2canvas.Renderer = function(parseQueue, opts){


--- a/src/Util.js
+++ b/src/Util.js
@ -0,0 +1,7 @@
+/*
+  html2canvas @VERSION@ <http://html2canvas.hertzen.com>
+  Copyright (c) 2011 Niklas von Hertzen. All rights reserved.
+  http://www.twitter.com/niklasvh
+
+  Released under MIT License
+*/
--- a/version.txt
+++ b/version.txt
@ -0,0 +1 @@
+v0.30