API Reference

module ProjectRoot

This module provides a macro to build paths relative to the root directory of the project.

@projectroot(args...)

This macro returns a path relative to the root directory of the project.

using ProjectRoot

@projectroot("dir", "file")

@projectroot() can also be used in the REPL, in which case it constructs a path relative to the current working directory.

julia> using ProjectRoot;
julia> @projectroot("dir") == joinpath(pwd(), "dir")
true