core: Ant target to generate openAjaxMetadata; uses http://www.exfer.net/jquery/creat...
[jquery.git] / build.xml
index fe28a15..f49d3dd 100644 (file)
--- a/build.xml
+++ b/build.xml
-<project name="jQuery" default="all" basedir=".">
-       
-       <!--
-       - Using this build file to create your own custom distribution -
-       
-       If you want to include jQuery on your site with a certain set of plugins,
-       follow these steps to create your custom build:
-       
-       1. Copy the plugins you need to the plugins folder (if you haven't already, checkout
-          the plugins folder from SVN.
-       2. Modify the PLUGINS property to include all plugins you want, see PLUGINS_ALL for syntax
-          eg. if you need form and tabs plugin, set the value for PLUGINS to this:
-          form/*.js, tabs/*.js
-       3. Execute the standard jquery and packed targets to build your distribution
-
-       TODO Using this build file to create docs for a single plugin
-       -->
-
-       <!-- SETUP -->
-
-       <property description="Source Folder" name="SRC_DIR" value="src" />
-       <property description="Files for parsing etc." name="BUILD_DIR" value="build" />
-       <property description="Rhino JS Engine" name="JAR" value="${BUILD_DIR}/js.jar" />
-
-       <property description="Dir to look for plugins" name="PLUGIN_DIR" location="../plugins" />
-       <property description="Add single plugins here" name="PLUGINS" value="none" />
-       <property description="Add all plugins here" name="PLUGINS_ALL" 
-               value="button/*.js,center/*.js,cookie/*.js,form/*.js,greybox/*.js,interface/*.js,pager/*.js,tablesorter/*.js,tabs/*.js,tooltip/*.js,accordion/*.js" />
-
-       <property description="Target parent folder for built files" name="PREFIX" value="." />
-       <property description="Folder for docs target" name="DOCS_DIR" value="${PREFIX}/docs" />
-       <property description="Folder for test target" name="TEST_DIR" value="${PREFIX}/test" />
-       <property description="Folder for jquery, min, lite and packed target" name="DIST_DIR" value="${PREFIX}/dist" />
-
-       <!-- Files names for distribution -->
-       <property name="JQ" value="${DIST_DIR}/jquery.js" />
-       <property name="JQ_LITE" value="${DIST_DIR}/jquery.lite.js" />
-       <property name="JQ_MIN" value="${DIST_DIR}/jquery.min.js" />
-       <property name="JQ_PACK" value="${DIST_DIR}/jquery.pack.js" />
-
-       <!-- MAIN -->
-
-       <target name="jquery" description="Main jquery build, set PLUGINS property to include plugins">
-               <echo message="Building ${JQ}" />
-               <mkdir dir="${DIST_DIR}" />
-               <concat destfile="${JQ}">
-                       <fileset dir="${SRC_DIR}" includes="intro.js" />
-                       <fileset dir="${SRC_DIR}" includes="jquery/jquery.js" />
-                       <fileset dir="${SRC_DIR}" includes="selector/selector.js" />
-                       <fileset dir="${SRC_DIR}" includes="event/event.js" />
-                       <fileset dir="${SRC_DIR}" includes="fx/fx.js" />
-                       <fileset dir="${SRC_DIR}" includes="ajax/ajax.js" />
-                       <fileset dir="${PLUGIN_DIR}" includes="${PLUGINS}" />
-                       <fileset dir="${SRC_DIR}" includes="outro.js" />
-               </concat>
-               <echo message="${JQ} built." />
-       </target>
-
-       <target name="jquery_with_plugins" description="Build jquery with all plugins, useful to full documentation">
-               <antcall target="jquery">
-                       <param name="PLUGINS" value="${PLUGINS_ALL}" />
-               </antcall>
-       </target>
-
-       <target name="lite" depends="jquery" description="Remove all /** */ comments">
-               <echo message="Building ${JQ_LITE}" />
-               <java jar="${JAR}" fork="true">
-                       <arg value="${BUILD_DIR}/build/lite.js" />
-                       <arg value="${JQ}" />
-                       <arg value="${JQ_LITE}" />
-               </java>
-               <echo message="${JQ_LITE} built." />
-       </target>
-
-       <target name="min" depends="jquery" description="Remove all comments and whitespace, no compression">
-               <echo message="Building ${JQ_MIN}" />
-               <java jar="${JAR}" fork="true">
-                       <arg value="${BUILD_DIR}/build/min.js" />
-                       <arg value="${JQ}" />
-                       <arg value="${JQ_MIN}" />
-               </java>
-               <echo message="${JQ_MIN} built." />
-       </target>
-
-       <target name="pack" depends="jquery" description="Remove all comments and whitespace and compress">
-               <echo message="Building ${JQ_PACK}" />
-               <java jar="${JAR}" fork="true">
-                       <arg value="${BUILD_DIR}/build/pack.js" />
-                       <arg value="${JQ}" />
-                       <arg value="${JQ_PACK}" />
-               </java>
-               <echo message="${JQ_PACK} built." />
-       </target>
-
-       <target name="pack_with_plugins" depends="jquery_with_plugins" description="Pack jquery with all plugins, not very useful">
-               <echo message="Building ${JQ_PACK}" />
-               <java jar="${JAR}" fork="true">
-                       <arg value="${BUILD_DIR}/build/pack.js" />
-                       <arg value="${JQ}" />
-                       <arg value="${JQ_PACK}" />
-               </java>
-               <echo message="${JQ_PACK} built." />
-       </target>
-
-       <target name="test" depends="jquery" description="Copy files for the test suite into their own directory.">
-               <echo message="Building Test Suite" />
-               <delete dir="${TEST_DIR}" />
-               <mkdir dir="${TEST_DIR}/data" />
-               <copy todir="${TEST_DIR}/data">
-                       <fileset dir="${BUILD_DIR}/test/data/" />
-               </copy>
-               <copy todir="${TEST_DIR}" file="${BUILD_DIR}/test/index.html" />
-               <echo message="Test Suite built." />
-       </target>
-
-       <target name="docs" depends="jquery" description="Reads inline docs from source and compiles into xml file">
-               <echo message="Building Documentation" />
-               <delete dir="${DOCS_DIR}" />
-               <mkdir dir="${DOCS_DIR}/data" />
-               <copy todir="${DOCS_DIR}" file="${BUILD_DIR}/docs/.htaccess" />
-               <mkdir dir="${DOCS_DIR}/js" />
-               <copy todir="${DOCS_DIR}/js">
-                       <fileset dir="${BUILD_DIR}/docs/js">
-                               <include name="**/*.js" />
-                       </fileset>
-               </copy>
-               <copy todir="${DOCS_DIR}/style">
-                       <fileset dir="${BUILD_DIR}/docs/style">
-                               <include name="**" />
+<project name="jQuery" default="jquery" basedir=".">
+
+    <!--
+    To get jQuery even smaller, remove the modules you don't need by removing the fileset elements
+       in the jquery-target, for example leaving only these:
+
+       <fileset dir="${SRC_DIR}" includes="intro.js" />
+    <fileset dir="${SRC_DIR}" includes="core.js" />
+    <fileset dir="${SRC_DIR}" includes="selector.js" />
+    <fileset dir="${SRC_DIR}" includes="event.js" />
+    <fileset dir="${SRC_DIR}" includes="outro.js" />
+
+       That'd remove ajax, fx and offset support, leaving basic selectors, manipulation and event handling.
+    -->
+
+    <!-- SETUP -->
+
+    <property description="Source Folder" name="SRC_DIR" value="src"  />
+    <property description="Files for parsing etc." name="BUILD_DIR" value="build" />
+    <property description="Rhino JS Engine" name="JAR" value="${BUILD_DIR}/js.jar" />
+    <property description="YUICompressor" name="YUICompressor" value="${BUILD_DIR}/yuicompressor-2.4.2.jar" />
+       <loadfile description="Version to build" property="version" srcfile="version.txt" />
+
+    <property description="Folder for jquery, min, lite and packed target" name="DIST_DIR" value="./dist" />
+
+    <!-- Files names for distribution -->
+    <property name="JQ" value="${DIST_DIR}/jquery.js" />
+    <property name="JQ_LITE" value="${DIST_DIR}/jquery.lite.js" />
+    <property name="JQ_MIN" value="${DIST_DIR}/jquery.min.js" />
+    <property name="JQ_PACK" value="${DIST_DIR}/jquery.pack.js" />
+
+    <!-- MAIN -->
+
+    <target name="jquery" description="Main jquery build, concatenates source files and replaces @VERSION">
+        <echo message="Building ${JQ}" />
+        <mkdir dir="${DIST_DIR}" />
+        <concat destfile="${JQ}">
+            <fileset dir="${SRC_DIR}" includes="intro.js" />
+            <fileset dir="${SRC_DIR}" includes="core.js" />
+            <fileset dir="${SRC_DIR}" includes="data.js" />
+            <fileset dir="${SRC_DIR}" includes="selector.js" />
+            <fileset dir="${SRC_DIR}" includes="event.js" />
+            <fileset dir="${SRC_DIR}" includes="support.js" />
+            <fileset dir="${SRC_DIR}" includes="ajax.js" />
+            <fileset dir="${SRC_DIR}" includes="fx.js" />
+            <fileset dir="${SRC_DIR}" includes="offset.js" />
+            <fileset dir="${SRC_DIR}" includes="dimensions.js" />
+            <fileset dir="${SRC_DIR}" includes="outro.js" />
+        </concat>
+       <java jar="${JAR}" fork="true">
+            <arg value="${BUILD_DIR}/build/version.js" />
+            <arg value="${JQ}" />
+        </java>
+        <echo message="${JQ} built." />
+    </target>
+
+    <target name="min" depends="jquery" description="Remove all comments and whitespace, no compression, great in combination with GZip">
+        <echo message="Building ${JQ_MIN}" />
+               <apply executable="java" parallel="false" verbose="true" dest="${DIST_DIR}">
+                       <fileset dir="${DIST_DIR}">
+                               <include name="jquery.js" />
                        </fileset>
-               </copy>
+                       <arg line="-jar" />
+                       <arg path="${YUICompressor}" />
+                       <arg value="--charset" />
+                       <arg value="ANSI" />
+                       <arg value="-o" />
+                       <targetfile />
+                       <mapper type="glob" from="jquery.js" to="jquery.min.js" />
+               </apply>
+        <echo message="${JQ_MIN} built." />
+    </target>
+
+    <target name="pack" depends="jquery" description="Remove all comments and whitespace and compress">
+        <echo message="Building ${JQ_PACK}" />
+        <java jar="${JAR}" fork="true">
+            <arg value="${BUILD_DIR}/build/pack.js" />
+            <arg value="${JQ}" />
+            <arg value="${JQ_PACK}" />
+        </java>
+        <echo message="${JQ_PACK} built." />
+    </target>
+
+       <target name="runtest">
+               <echo message="Running Automated Test Suite" />
                <java jar="${JAR}" fork="true">
-                       <arg value="${BUILD_DIR}/docs/docs.js" />
-                       <arg value="${JQ}" />
-                       <arg value="${DOCS_DIR}" />
-               </java>
-               <echo message="Documentation built." />
+            <arg value="${BUILD_DIR}/runtest/test.js" />
+        </java>
+               <echo message="Test Suite Finished" />
        </target>
 
-       <!-- TODO refactor to remove duplication with above -->
-       <target name="docs_with_plugins" depends="jquery_with_plugins">
-               <echo message="Building Documentation" />
-               <delete dir="${DOCS_DIR}" />
-               <mkdir dir="${DOCS_DIR}/data" />
-               <copy todir="${DOCS_DIR}" file="${BUILD_DIR}/docs/.htaccess" />
-               <mkdir dir="${DOCS_DIR}/js" />
-               <copy todir="${DOCS_DIR}/js">
-                       <fileset dir="${BUILD_DIR}/docs/js">
-                               <include name="**/*.js" />
-                       </fileset>
-               </copy>
-               <copy todir="${DOCS_DIR}/style">
-                       <fileset dir="${BUILD_DIR}/docs/style">
-                               <include name="**" />
-                       </fileset>
-               </copy>
-               <java jar="${JAR}" fork="true">
-                       <arg value="${BUILD_DIR}/docs/docs.js" />
-                       <arg value="${JQ}" />
-                       <arg value="${DOCS_DIR}" />
-               </java>
-               <echo message="Documentation built." />
-       </target>
-
-       <target name="clean">
-               <delete dir="${DOCS_DIR}" />
-               <delete dir="${TEST_DIR}" />
-               <delete dir="${DIST_DIR}" />
-       </target>
+    <target name="clean">
+        <delete dir="${DIST_DIR}" />
+    </target>
 
-       <target name="all" depends="clean,jquery,lite,min,pack,docs,test">
-               <echo message="Build complete." />
-       </target>
-       
-       <!-- Extra stuff for Tabs plugin -->
+    <target name="all" depends="clean,jquery,min,pack">
+        <echo message="Build complete." />
+    </target>
        
-       <property name="TABS" value="${PLUGIN_DIR}/tabs/tabs.js" />
-       <property name="TABS_PACK" value="${DIST_DIR}/jquery.tabs.pack.js" />
-
-       <target name="pack_tabs">
-               <echo message="Building ${TABS_PACK}" />
-               <mkdir dir="${DIST_DIR}" />
-               <java jar="${JAR}" fork="true">
-                       <arg value="${BUILD_DIR}/build/pack.js" />
-                       <arg value="${TABS}" />
-                       <arg value="${TABS_PACK}" />
-               </java>
-               <echo message="${TABS_PACK} built." />
+       <target name="openAjaxMetadata">
+               <property name="target" value="openAjaxMetadata-jquery-${version}.xml" />
+               <delete file="dist/jquery-*.xml" />
+               <get src="http://www.exfer.net/jquery/createjQueryXMLDocs.py?version=1.3" dest="${target}" />
+               <xslt includes="${target}" excludes="build.xml" destdir="./dist" style="build/style.xsl" extension=".xml" />
+               <delete file="${target}" />
        </target>
 
 </project>