1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<project default="checkstyle" name="CheckAnt" xmlns:ivy="antlib:org.apache.ivy.ant">
<description>
Check Ants codebase against certain code styleguide rules using
checkstyle and simian.
Checkstyle uses an abstract syntax tree (AST) for doing checks
against java sources. It is available at http://checkstyle.sourceforge.net/
under GPL 2.1 license.
"Simian (Similarity Analyser) identifies duplication in Java, C#, C,
CPP, COBOL, JSP, HTML source code and even plain text files."
It is available at http://www.redhillconsulting.com.au/products/simian/
and is for free use in open source projects.
See external task page and homepages for more information.
</description>
<import file="build.xml"/>
<property name="config.dir" location="${etc.dir}/checkstyle"/>
<property name="checkstyle.reportdir" location="${build.dir}/reports/checkstyle"/>
<property name="checkstyle.raw" location="${checkstyle.reportdir}/raw.xml"/>
<property name="stylesheet.html" location="${config.dir}/checkstyle-frames.xsl"/>
<property name="stylesheet.text" location="${config.dir}/checkstyle-text.xsl"/>
<property name="stylesheet.xdoc" location="${config.dir}/checkstyle-xdoc.xsl"/>
<property name="checkstyle.basedir" location="${java.dir}"/>
<!-- Ant Checkstyle report -->
<property name="tocheck" value="**/*.java"/>
<property name="javadoc.scope" value="public"/>
<taskdef resource="simiantask.properties"/>
<target name="init-ivy">
<property name="ivy.version" value="2.0.0-beta1"/>
<property name="ivy.jar.url" value="http://repo1.maven.org/maven2/org/apache/ivy/ivy/${ivy.version}/ivy-${ivy.version}.jar"/>
<property name="ivy.jar.dir" value="${build.dir}/ivy"/>
<property name="ivy.jar.file" value="${ivy.jar.dir}/ivy.jar"/>
<mkdir dir="${ivy.jar.dir}"/>
<get src="${ivy.jar.url}" dest="${ivy.jar.file}" usetimestamp="true"/>
<path id="ivy.lib.path">
<fileset dir="${ivy.jar.dir}" includes="*.jar"/>
</path>
<taskdef resource="org/apache/ivy/ant/antlib.xml" uri="antlib:org.apache.ivy.ant" classpathref="ivy.lib.path"/>
</target>
<target name="checkstyle" description="--> checks Ant codebase according to ${config.dir}/checkstyle-config" depends="init-ivy">
<ivy:cachepath organisation="checkstyle" module="checkstyle" revision="4.3"
inline="true" conf="default" pathid="checkstyle.classpath" transitive="true"/>
<taskdef resource="checkstyletask.properties" classpathref="checkstyle.classpath" />
<mkdir dir="${checkstyle.reportdir}"/>
<checkstyle config="${config.dir}/checkstyle-config" failOnViolation="false">
<formatter type="xml" toFile="${checkstyle.raw}"/>
<fileset dir="${java.dir}">
<include name="${tocheck}"/>
<exclude name="**/bzip2/*.java"/>
<exclude name="**/CVSPass.java"/>
</fileset>
</checkstyle>
</target>
<target name="htmlreport" description="--> generates a html checkstyle report" depends="init-ivy">
<ivy:cachepath organisation="xalan" module="xalan" revision="2.7.0"
inline="true" conf="default" pathid="xalan.classpath" transitive="true"/>
<mkdir dir="${checkstyle.reportdir}"/>
<xslt in="${checkstyle.raw}" style="${stylesheet.html}"
out="${checkstyle.reportdir}/html/output.txt">
<param name="basedir" expression="${checkstyle.basedir}"/>
</xslt>
</target>
<target name="textreport" description="--> generates a text checkstyle report">
<xslt in="${checkstyle.raw}" style="${stylesheet.text}"
out="${checkstyle.reportdir}/report.txt">
</xslt>
</target>
<target name="textreport-display" depends="textreport" description="--> generates a text checkstyle report and displays it immediately">
<loadfile property="report" srcfile="${checkstyle.reportdir}/report.txt"/>
<echo>${report}</echo>
</target>
<target name="xdocreport" description="--> generates a xdoc checkstyle report">
<xslt in="${checkstyle.raw}" style="${stylesheet.xdoc}"
out="${checkstyle.reportdir}/xdocs/index.xml">
<param name="basedir" expression="${checkstyle.basedir}"/>
</xslt>
</target>
<target name="dumphtml" depends="checkstyle, htmlreport" description="--> runs the checkstyle and generates a html report"/>
<target name="dumptext" depends="checkstyle, textreport" description="--> runs the checkstyle and displays result as text">
<concat>
<filelist dir="${checkstyle.reportdir}" files="report.txt"/>
</concat>
</target>
<target name="simiancheck" description="--> runs the check for duplicates">
<simian>
<fileset dir="${java.dir}" />
</simian>
</target>
<target name="fixTS" description="--> fix checkstyle errors 'Line has trailing spaces'">
<fail message="Define path to java file 'path'">
<condition><not><isset property="path"/></not></condition>
</fail>
<replaceregexp match="\s+$" replace="" flags="g" byline="true">
<fileset dir="src/main" includes="${path}"/>
</replaceregexp>
</target>
<target name="fixTab" description="--> fix checkstyle errors 'Line contains TAB sign'">
<fail message="Define path to java file 'path'">
<condition><not><isset property="path"/></not></condition>
</fail>
<fixcrlf srcdir="src/main" includes="${path}" javafiles="yes" tab="remove" tablength="4"/>
</target>
</project>
|
