Apache Daffodil is an open-source implementation of the DFDL specification that uses DFDL data descriptions to parse fixed format data into an infoset. This infoset is commonly converted into XML or JSON to enable the use of well-established XML or JSON technologies and libraries to consume, inspect, and manipulate fixed format data in existing solutions. Daffodil is also capable of serializing or “unparsing” data back to the original data format. The DFDL infoset can also be converted directly to/from the data structures carried by data processing frameworks so as to bypass any XML/JSON overheads.
For more information about Daffodil, see https://daffodil.apache.org/.
See BUILD.md for more details and DEVELOP.md for a developer guide.
sbt is the officially supported tool to build Daffodil. Below are some of the more commonly used commands for Daffodil development.
Compile source code:
sbt compile
Check all unit tests pass:
sbt test
Check all integration tests pass:
sbt daffodil-test-integration/test
Check format of source and sbt files:
sbt scalafmtCheckAll scalafmtSbtCheck
Reformat source and sbt files if necessary:
sbt scalafmtAll scalafmtSbt
Build the Daffodil command line interface (Linux and Windows shell scripts in daffodil-cli/target/universal/stage/bin/; see the Command Line Interface documentation for details on their usage):
sbt daffodil-cli/stage
Publish the Daffodil jars to a Maven repository (for Java projects) or Ivy repository (for Scala or schema projects).
Maven (for Java or mvn):
sbt publishM2
Ivy (for Scala or sbt):
sbt publishLocal
Run Apache RAT (license audit report in target/rat.txt and error if any unapproved licenses are found):
sbt ratCheck
Run sbt-scoverage (report in target/scala-ver/scoverage-report/):
sbt clean coverage test daffodil-test-integration/test sbt coverageAggregate
You can ask questions on the dev@daffodil.apache.org or users@daffodil.apache.org mailing lists. You can report bugs via the Daffodil JIRA.
Apache Daffodil is licensed under the Apache License, v2.0.