alda-core
The core machinery of Alda, implemented in Clojure.
Components
-
alda.parser (reads Alda code and transforms it into Clojure code in the context of the
alda.lispnamespace) -
alda.lisp (a Clojure DSL which provides the context for evaluating an Alda score, in its Clojure code form)
For more details about how each component works, see the alda-core development guide.
Development
Prerequisites
Development on the Alda core library requires that you have the Boot build tool installed. This allows you to run the tests.
boot test task
To run the unit test suite, run boot test.
Adding tests
It is generally good to add to the existing tests wherever it makes sense, i.e. whenever there is a new test case that Alda needs to consider. Test-driven development is a good idea.
If you find yourself adding a new file to the tests, be sure to add its namespace to the list of test namespaces in build.boot so that it will be included when you run the tests.
The automated test battery includes smoke tests where we parse and evaluate all of the example Alda scores in the examples/ directory. If you add an additional example score, be sure to add it to the list of score files in test/alda/examples_test.clj.
Logging
Alda uses timbre for logging. Every note event, attribute change, etc. is logged at the DEBUG level, which can be useful for debugging purposes.
The default logging level is WARN, so by default, you will not see these debug-level logs; you will only see warnings and errors.
To override this setting (e.g. for development and debugging), you can set the TIMBRE_LEVEL environment variable.
To see debug logs, for example, you can do this:
export TIMBRE_LEVEL=debug
When running tests via boot test and troubleshooting a failing test, it may be helpful to use debug-level logging by running TIMBRE_LEVEL=debug boot test.
License
Copyright © 2016 Dave Yarwood et al
Distributed under the Eclipse Public License version 1.0.