editorconfig-ant-tasks
editorconfig-ant-tasks
provides Ant tasks for checking whether project files comply with format rules
defined in .editorconfig
files and eventually also for fixing the violations.
|
editorconfig-ant-tasks are new. Expect issues of all kinds which is not to say that you should not
report them :)
|
Basic usage
editorconfig-ant-tasks
requires Java 7+ and Ant 1.8.0+.
Download the tasks and its dependencies
wget http://central.maven.org/maven2/org/ec4j/ant/editorconfig-ant-tasks/0.0.1/editorconfig-ant-tasks-0.0.1.jar mkdir -p libs cd libs wget http://central.maven.org/maven2/org/antlr/antlr4-runtime/4.7/antlr4-runtime-4.7.jar wget http://central.maven.org/maven2/org/ec4j/core/ec4j-core/0.0.1/ec4j-core-0.0.1.jar wget http://central.maven.org/maven2/org/ec4j/maven/ec4j-lint-api/0.0.6/ec4j-lint-api-0.0.6.jar wget http://central.maven.org/maven2/org/ec4j/maven/ec4j-linters/0.0.6/ec4j-linters-0.0.6.jar
Basic build.xml
file:
<project name="editorconfig-example" basedir="." xmlns:ec4j="antlib:org.ec4j.ant">
<taskdef uri="antlib:org.ec4j.ant" resource="org/ec4j/ant/antlib.xml">
<classpath>
<fileset dir="...">
<include name="editorconfig-ant-tasks-*.jar"/>
<include name="libs/*.jar"/>
</fileset>
</classpath>
</taskdef>
<target name="editorconfigCheck">
<!-- This checks whether the source tree complies with the rules defined in the .editorconfig file -->
<ec4j:editorconfigCheck />
</target>
<target name="editorconfigFormat">
<!-- This fixes any violations against the rules defined in the .editorconfig file -->
<ec4j:editorconfigFormat />
</target>
</project>
To check whether any of your source files does not comply with .editorconfig
rules run
ant editorconfigCheck
In case any violations are detected, you may want to fix them automagically by running
ant editorconfigFormat
Configuration
TODO
How to build
Prerequisites:
-
Java 7+
-
Optionally Maven 3.5.0+, unless you want to use
./mvnw
ormvnw.bat
delivered by the project
The most common build with unit tests:
./mvnw clean install
On Windows:
.\mvnw.cmd clean install
Misc.
-
All code and contributions are under Apache License
-
Issues and Discussions: https://github.com/ec4j/editorconfig-ant-tasks/issues