TorsExperimentalTools

add_default_args!(s::ArgParseSettings)

Add generally applicable arguments to s.

In particular, it adds the following arguments:

• --ignore-commit
• --verbose

available_runs(; prefix=nothing, commit=nothing, full_path=false)

Return available runs.

Keyword arguments

• prefix: filters based on the prefix of the runs.
• commit: filters based on the commit id from which the run is produced.
• full_path: if true, the full path to each run will be returned rather than only their directory names.

default_name(mod; include_commit_id=false)

Construct a name from either repo information or package version of mod.

If the path of mod is a git-repo, return name of current branch, joined with the commit id if include_commit_id is true.

If path of mod is not a git-repo, it is assumed to be a release, resulting in a name of the form release-VERSION.

generate_name([rng::Random.AbstractRNG]; kwargs...)

Generate a random name.

Keyword arguments

• rng: A random number generator. Default: Random.default_rng().
• already_taken: A set of names that are already taken. Default: Set{String}().
• prefix: A prefix to the name. Default: "".
• suffix: A suffix to the name. Default: "".

getcommit(repo::LibGit2.GitRepo)

Return the commit ID of HEAD for repo.

getcommit(run)

Return the commit ID from the run name.

Assumes name came form default_name.

interactive_checkout_maybe(source, repodir=projectdir())
interactive_checkout_maybe(source_commit::LibGit2.GitHash, repodir=projectdir())

Check if commit of source matches current HEAD of repodir.

If source is specified instead of source_commit, then getcommit(source) is used.

pkgversion(m::Module)

Return version of module m as listed in its Project.toml.

run_from_args(mod::Module, args)

Return a Run created from mod and args.

@default_argparse_rules

Add generally applicable rules to ArgParseSettings.

In particular, it adds the following rules:

• ::Type{Date}: Date(x, dateformat"y-m-d")

@parse_args s
@parse_args s _args

Calls parse_args on s and _args, with _args = ARGS if _args is not defined.

This is convenient when wanting to run a script using include instead of from the command line, for example allowing temporary halting of a long-running process to save some results, and then resume.