tmlbl / appconf.jl

Simple application configuration for Julia

AppConf.jl

A simple configuration module for Julia applications. Implements a basic syntax for a configuration file, and manages an environment variable JULIA_ENV to manage code differences for development and production environments.

Basic Configuration

When using AppConf, call parseconf with a path to your configuration file to load it.

using AppConf

parseconf("app.conf")

Where app.conf contains basic name-value pairs:

log.level=DEBUG
app.secret="provoke-dance-surveillance-friend"
session.timeout=60
require.auth=false

Then, the global variable conf will be a dictionary populated with those items.

julia> conf
Dict{AbstractString,Any} with 4 entries:
  "require.auth"    => false
  "app.secret"      => "provoke-dance-surveillance-friend"
  "log.level"       => "DEBUG"
  "session.timeout" => 60

Supported Values

Values will be interpreted as strings or numbers based on their structure. Strings can optionally be in double quotes. Arrays are also supported with the following syntax:

arr=["one", 2, three]

Is parsed into:

Dict{AbstractString,Any}("arr" => Any["one",2,"three"])

Using JULIA_ENV

The variable JULIA_ENV is set to "dev" by default. It can be overridden by setting its value in the system environment, or by setting env in the config file. The macros @dev and @prod allow code blocks to be specified to compile in only one environment.

@dev begin
  println("I'm on your laptop")
end
@prod begin
  println("I'm on your server")
end

TODO

Support full HOCON syntax to emulate TypeSafe config library.

appconf.jl's Issues

Package uses AbstractString, which is not available on Julia 0.3

Any user that intalls this package on Julia 0.3 will not get a working version of the package, because of the use of the Julia 0.4 AbstractString. One solution would be to use the Compat.jl package so the package works on both, and then tagging a new release.

Unicode support

In order to allow unicode variables to be used I had to change
the findeq function in AppConf.jl by a minor amount.

We just use the chr2ind() function to make sure the index we use corresponds to
the position i the unicode string.
Like so:

function findeq(ln::AbstractString)
for i = 1:length(ln)
c = chr2ind(ln, i);
if ln[c] == '='
return c
end
end
return -1
end

This way parameters such as
γ= 1.66667

now also work.

From my testing so far this seems to work well .

Info about upcoming removal of packages in the General registry

As described in https://discourse.julialang.org/t/ann-plans-for-removing-packages-that-do-not-yet-support-1-0-from-the-general-registry/ we are planning on removing packages that do not support 1.0 from the General registry. This package has been detected to not support 1.0 and is thus slated to be removed. The removal of packages from the registry will happen approximately a month after this issue is open.

To transition to the new Pkg system using Project.toml, see https://github.com/JuliaRegistries/Registrator.jl#transitioning-from-require-to-projecttoml.
To then tag a new version of the package, see https://github.com/JuliaRegistries/Registrator.jl#via-the-github-app.

If you believe this package has erroneously been detected as not supporting 1.0 or have any other questions, don't hesitate to discuss it here or in the thread linked at the top of this post.