Skip to content

Config #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bartman merged 4 commits into from
May 18, 2026
Merged

Config #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
318f182
git wip save -t
bartman May 18, 2026
cfb8bf9
git wip save reads defaults from gitconfig
bartman May 18, 2026
09e9cd8
update docs
bartman May 18, 2026
710ec04
missing config .cpp .hpp
bartman May 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,7 @@ RUN "$GIT_WIP" save "message with spaces" # WRONG — splits into tokens
src/
main.cpp # arg dispatch; no-args → save "WIP"
command.hpp # abstract Command base class
config.hpp/cpp # generic git config wrapper (libgit2)
git_guards.hpp # RAII wrappers for libgit2 handles + git_error_str()
cmd_save.hpp/cpp # save command
cmd_log.hpp/cpp # log command
Expand All @@ -230,6 +231,7 @@ test/cli/
test_status2.sh # status after work-branch advance
test_save_file.sh # save with explicit file arguments
test_log.sh # log command tests
test_save_config.sh # git config options for save command
CMakeLists.txt # registers each test_*.sh with ctest
```

Expand Down Expand Up @@ -404,7 +406,23 @@ The vim plugin runs `git wip -h` to check if git-wip is installed. This should:
| log | cmd_log.hpp | cmd_log.cpp | **Implemented** — libgit2 range, spawns `git log` |
| status | cmd_status.hpp | cmd_status.cpp | **Implemented** — libgit2 revwalk, `-l`/`-f` flags |
| delete | cmd_delete.hpp | cmd_delete.cpp | **Implemented** — delete one/current/cleanup orphaned wip refs |
| config | — | — | Not implemented |

### config.hpp/cpp — generic git config wrapper

`Config` is a generic wrapper around libgit2's `git_config` API. It provides
typed accessors for reading configuration values from `.gitconfig`:

```cpp
Config cfg(repo);
auto str_val = cfg.get_string("git-wip.save"); // std::optional<std::string>
auto bool_val = cfg.get_bool("git-wip.gpg-sign"); // std::optional<bool>
auto int_val = cfg.get_int("some.key"); // std::optional<int>
auto i64_val = cfg.get_int64("some.key"); // std::optional<int64_t>
```

Each accessor returns `std::nullopt` if the key is not found or on error.
Commands use `Config` to read their specific settings and interpret the values
themselves.

### git_guards.hpp — RAII wrappers

Expand Down
32 changes: 32 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,38 @@ does not exist).

---

## Configuration

`git-wip` reads settings from your `.gitconfig` under the `[git-wip]` section.
These provide defaults that can be overridden by command-line flags.

```ini
[git-wip]
save = untracked # which files to capture: tracked | untracked | ignored | all
gpg-sign = false # whether to GPG-sign WIP commits
```

### `git-wip.save`

Controls which files are captured by `git wip save`:

| Value | Description |
|---|---|
| `tracked` | Only tracked files (default behaviour) |
| `untracked` | Tracked files plus untracked files (equivalent to `-u`) |
| `ignored` | Tracked files plus ignored files (equivalent to `-i`) |
| `all` | Everything: tracked, untracked, and ignored (equivalent to `-a`) |

Command-line flags (`--untracked`, `--no-untracked`, `--ignored`, `--no-ignored`,
`--all`, `--only-tracked`) override this setting.

### `git-wip.gpg-sign`

Boolean. If `true`, WIP commits will be GPG-signed (not yet implemented).
`--gpg-sign` and `--no-gpg-sign` override this setting.

---

## Building

Requires: a C++23 compiler, CMake ≥ 3.26, Ninja, and `libgit2-dev`.
Expand Down
1 change: 1 addition & 0 deletions src/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ endif()

add_executable(git-wip
color.cpp
config.cpp
main.cpp
cmd_delete.cpp
cmd_list.cpp
Expand Down
147 changes: 101 additions & 46 deletions src/cmd_save.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#include "cmd_save.hpp"
#include "config.hpp"
#include "git_guards.hpp"
#include "git_helpers.hpp"
#include "string_helpers.hpp"
Expand All @@ -13,17 +14,91 @@
#include <string>
#include <vector>

// Helper to parse git-wip.save spec into add_untracked/add_ignored flags
static void parse_save_spec(const std::string &spec, bool &add_untracked, bool &add_ignored) {
if (spec == "tracked") {
add_untracked = false;
add_ignored = false;
} else if (spec == "untracked") {
add_untracked = true;
add_ignored = false;
} else if (spec == "ignored") {
add_untracked = false;
add_ignored = true;
} else if (spec == "all") {
add_untracked = true;
add_ignored = true;
} else {
spdlog::warn("git-wip.save: unknown value '{}', ignoring", spec);
}
}

int SaveCmd::run(int argc, char *argv[]) {
// -----------------------------------------------------------------------
// 1. Parse arguments
// 1. Check for --help early (before opening repo)
// -----------------------------------------------------------------------
for (int i = 1; i < argc; ++i) {
std::string a = argv[i];
if (a == "--help" || a == "-h") {
std::println("Usage: git-wip save [<message>] [--editor|-e] [--[no-]untracked|-u|-U] [--[no-]ignored|-i|-I] [--[no-]gpg-sign] [-- <file>...]\n");
// - #
std::println(" <message> # use this message (defaults to \"WIP\")");
std::println(" -e, --editor # queit when there are no changes (called from editor)");
std::println(" -u, --untracked # enable capture of changes to untracked files");
std::println(" -U, --no-untracked # disable capture of changes to untracked files");
std::println(" -i, --ignored # enable capture of changes to ignored files");
std::println(" -I, --no-ignored # disable capture of changes to ignored files");
std::println(" -a, --all # same as --untracked and --ignored");
std::println(" -t, --only-tracked # same as --no-untracked and --no-ignored");
std::println(" --gpg-sign # enable signing of commits");
std::println(" --no-gpg-sign # disable signing of commits");
std::println(" <file>... # filter on changes to specific file(s)\n");
return 0;
}
}

// -----------------------------------------------------------------------
// 2. Open repository
// -----------------------------------------------------------------------
GitLibGuard git_lib_guard;

GitRepoGuard repo_guard;
if (git_repository_open_ext(repo_guard.ptr(), ".", 0, nullptr) < 0) {
spdlog::error("not a git repository: {}", git_error_str());
return 1;
}
git_repository *repo = repo_guard.get();

// -----------------------------------------------------------------------
// 3. Load defaults from git config
//
// [git-wip]
// save = tracked | untracked | ignored | all
// gpg-sign = true | false
// -----------------------------------------------------------------------
bool editor_mode = false;
bool add_untracked = false;
bool add_ignored = false;
bool gpg_sign = false; // TODO: not implemented yet
bool gpg_sign = false;
std::string message = "WIP";
std::vector<std::string> files;

{
Config cfg(repo);
if (auto spec = cfg.get_string("git-wip.save"); spec) {
parse_save_spec(*spec, add_untracked, add_ignored);
}
if (auto val = cfg.get_bool("git-wip.gpg-sign"); val) {
gpg_sign = *val;
}
}

spdlog::debug("save: config defaults: untracked={} ignored={} gpg_sign={}",
add_untracked, add_ignored, gpg_sign);

// -----------------------------------------------------------------------
// 4. Parse command line arguments (override config defaults)
// -----------------------------------------------------------------------
std::vector<std::string> args;
for (int i = 1; i < argc; ++i)
args.emplace_back(argv[i]);
Expand All @@ -48,23 +123,15 @@ int SaveCmd::run(int argc, char *argv[]) {
} else if (a == "--all" || a == "-a") {
add_untracked = true;
add_ignored = true;
} else if (a == "--only-tracked" || a == "-t") {
add_untracked = false;
add_ignored = false;
} else if (a == "--gpg-sign") {
gpg_sign = true;
} else if (a == "--no-gpg-sign") {
gpg_sign = false;
} else if (a == "--help" || a == "-h") {
std::println("Usage: git-wip save [<message>] [--editor|-e] [--[no-]untracked|-u|-U] [--[no-]ignored|-i|-I] [--[no-]gpg-sign] [-- <file>...]\n");
// - #
std::println(" <message> # use this message (defaults to \"WIP\")");
std::println(" -e, --editor # queit when there are no changes (called from editor)");
std::println(" -u, --untracked # enable capture of changes to untracked files");
std::println(" -U, --no-untracked # disable capture of changes to untracked files");
std::println(" -i, --ignored # enable capture of changes to ignored files");
std::println(" -I, --no-ignored # disable capture of changes to ignored files");
std::println(" -a, --all # same as --untracked and --ignored");
std::println(" --gpg-sign # enable signing of commits");
std::println(" --no-gpg-sign # disable signing of commits");
std::println(" <file>... # filter on changes to specific file(s)\n");
// Already handled above, but keep for completeness
return 0;
} else if (!a.empty() && a[0] == '-') {
spdlog::error("git-wip save: unknown option '{}'", a);
Expand All @@ -77,31 +144,19 @@ int SaveCmd::run(int argc, char *argv[]) {
}
}

spdlog::debug("save: message='{}' editor={} untracked={} ignored={} gpg_sign={} files={}",
spdlog::debug("save: final: message='{}' editor={} untracked={} ignored={} gpg_sign={} files={}",
message, editor_mode, add_untracked, add_ignored, gpg_sign, files.size());

if (gpg_sign)
spdlog::warn("git-wip sign --gpg-sign is not implemented yet");

// -----------------------------------------------------------------------
// 2. Open repository
// -----------------------------------------------------------------------
GitLibGuard git_lib_guard;

GitRepoGuard repo_guard;
if (git_repository_open_ext(repo_guard.ptr(), ".", 0, nullptr) < 0) {
spdlog::error("not a git repository: {}", git_error_str());
return 1;
}
git_repository *repo = repo_guard.get();
spdlog::warn("git-wip save --gpg-sign is not implemented yet");

// -----------------------------------------------------------------------
// 2b. Normalise file paths to be relative to the workdir root.
// 5. Normalise file paths to be relative to the workdir root.
//
// git_index_add_all() resolves pathspecs against the workdir root,
// but the paths supplied on the command line are relative to the
// current working directory (which may be a subdirectory). Convert
// each path: cwd/file → absolute → workdir-relative.
// git_index_add_all() resolves pathspecs against the workdir root,
// but the paths supplied on the command line are relative to the
// current working directory (which may be a subdirectory). Convert
// each path: cwd/file → absolute → workdir-relative.
// -----------------------------------------------------------------------
if (!files.empty()) {
const char *workdir_cstr = git_repository_workdir(repo);
Expand All @@ -127,7 +182,7 @@ int SaveCmd::run(int argc, char *argv[]) {
}

// -----------------------------------------------------------------------
// 3. Resolve branch names
// 6. Resolve branch names
// -----------------------------------------------------------------------
auto bn = resolve_branch_names(repo);
if (!bn) {
Expand All @@ -139,12 +194,12 @@ int SaveCmd::run(int argc, char *argv[]) {
spdlog::debug("save: work_branch='{}' wip_ref='{}'", bn->work_branch, bn->wip_ref);

// -----------------------------------------------------------------------
// 4. Ensure reflog directory exists for the wip branch
// 7. Ensure reflog directory exists for the wip branch
// -----------------------------------------------------------------------
ensure_reflog_dir(repo, bn->wip_ref);

// -----------------------------------------------------------------------
// 5. Resolve work_last
// 8. Resolve work_last
// -----------------------------------------------------------------------
auto work_last = resolve_oid(repo, bn->work_ref);
if (!work_last) {
Expand All @@ -156,7 +211,7 @@ int SaveCmd::run(int argc, char *argv[]) {
spdlog::debug("save: work_last={}", oid_to_hex(&*work_last));

// -----------------------------------------------------------------------
// 6. Determine wip_parent
// 9. Determine wip_parent
// -----------------------------------------------------------------------
auto wip_last = resolve_oid(repo, bn->wip_ref); // nullopt if no wip branch yet

Expand All @@ -173,13 +228,13 @@ int SaveCmd::run(int argc, char *argv[]) {
spdlog::debug("save: wip_parent={}", oid_to_hex(&*wip_parent));

// -----------------------------------------------------------------------
// 7. Build new tree (in-memory; never writes to the on-disk index)
// 10. Build new tree (in-memory; never writes to the on-disk index)
//
// Steps:
// a) Load the parent commit's tree into the repo's in-memory index
// b) Stage changes from the working directory on top
// c) Write the tree object to the ODB
// d) Restore the real on-disk index
// Steps:
// a) Load the parent commit's tree into the repo's in-memory index
// b) Stage changes from the working directory on top
// c) Write the tree object to the ODB
// d) Restore the real on-disk index
// -----------------------------------------------------------------------
git_oid new_tree_oid{};
{
Expand Down Expand Up @@ -244,7 +299,7 @@ int SaveCmd::run(int argc, char *argv[]) {
}

// -----------------------------------------------------------------------
// 8. Check for changes
// 11. Check for changes
// -----------------------------------------------------------------------
{
GitCommitGuard parent_commit;
Expand All @@ -262,7 +317,7 @@ int SaveCmd::run(int argc, char *argv[]) {
spdlog::debug("save: has changes, creating commit");

// -----------------------------------------------------------------------
// 9. Create the WIP commit
// 12. Create the WIP commit
// -----------------------------------------------------------------------
GitTreeGuard new_tree_obj;
if (git_tree_lookup(new_tree_obj.ptr(), repo, &new_tree_oid) < 0) {
Expand Down Expand Up @@ -295,7 +350,7 @@ int SaveCmd::run(int argc, char *argv[]) {
spdlog::debug("save: new_wip={}", oid_to_hex(&new_commit_oid));

// -----------------------------------------------------------------------
// 10. Update the wip ref
// 13. Update the wip ref
// -----------------------------------------------------------------------
{
std::string reflog_msg = "git-wip: " + first_line(message.c_str());
Expand Down
Loading
Loading