packagePath and/or modulePath to the project's .gitignoreR/setupProject.R
setupGitIgnore.RdHelper that keeps the .gitignore of a project under git control in sync
with the project's resolved paths.
setupGitIgnore(
paths,
gitignore = getOption("SpaDES.project.gitignore", TRUE),
verbose
)a list with named elements, specifically, modulePath, projectPath,
packagePath and all others that are in SpaDES.core::setPaths()
(i.e., inputPath, outputPath, scratchPath, cachePath, rasterTmpDir).
Each of these has a sensible default, which will be overridden but any user
supplied values.
See setup.
Logical. Only has an effect if the paths$projectPath
is a git repositories without submodules. This case is ambiguous what a user
wants. If TRUE, the default, then paths$modulePath will be added to
the .gitignore file. Can be controled with options(SpadES.project.gitignore = ...).
Numeric or logical indicating how verbose should the function
be. If -1 or -2, then as little verbosity as possible. If 0 or FALSE,
then minimal outputs; if 1 or TRUE, more outputs; 2 even more. NOTE: in
Require function, when verbose >= 2, also returns details as if
returnDetails = TRUE (for backwards compatibility).
setupGitIgnore is run for its side effects, i.e., adding either paths$packagePath
and/or paths$modulePath to the
.gitignore file. It will check whether packagePath is located inside the
paths$projectPath and will add this folder to the .gitignore if TRUE.
If the project is a git repository with git submodules, then it will add nothing else.
If the project is a git repository without git submodules, then the paths$modulePath
will be added to the .gitignore file. It is assumed that these modules are
used in a read only manner.
setupGitIgnore will add the relevant paths to .gitignore.
setupProject() for the high-level wrapper, setup_family for an overview.