Project

The saule.config of the code being run, as the loader read it at startup.

Name	Type	What it holds
Project.name	string	The project’s name:
Project.version	string	Its version: — the version of your code
Project.root	string	Absolute path of the directory holding saule.config
Project.srcDirs	table<string>	The src_dirs: roots as absolute paths, resolved against root — not the relative spellings the config used

-- In a project whose saule.config reads:
--   name: "bf"   version: "0.1.0"   src_dirs: ["src"]
--
-- Project.name      is "bf"
-- Project.version   is "0.1.0"
-- Project.root      is /home/you/code/bf
-- #Project.srcDirs  is 1
--
-- Run as a single file, there is no project, so every field is empty:
println(Project.name == "")          -- true
println(Project.version == "")       -- true
println(#Project.srcDirs)            -- 0

Three things worth knowing.

They are snapshots, taken at startup. There is no setter, and writing to the srcDirs table changes your copy rather than anything the module loader will consult.

Every field is a plain string, never string?. In single-file mode — saule run script.sau, with no saule.config above it — there is no project, and each field is the empty string, with srcDirs an empty table. A nullable type would push a ?? onto every use of a value that is almost always there; an empty string is falsy enough to test directly:

if Project.name == "" then
    println("running as a single file")   -- running as a single file
end

Project mode is what saule run ., saule run <dir> and a bare saule run select; naming a file directly is single-file mode even when that file sits inside a project.

It needs no import. Like every other stdlib module, Project is in scope everywhere. For the config file’s own keys, and which of them are required, see Language guide §Project Configuration.