git_sshripped_repository 0.1.4

Repository domain for git-sshripped
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

# git_sshripped_repository

Repository metadata persistence and Git integration for git-sshripped.

## Overview

This crate provides read/write operations for the `.git-sshripped/` metadata
directory. It handles TOML serialization of the repository manifest, GitHub
source registry, and local configuration. It also installs the `.gitattributes`
filter patterns and configures the local Git clean/smudge/diff/process filter
drivers via `git config`.

## Key Functions

- `metadata_dir(repo_root)` -- returns the `.git-sshripped/` path.
- `read_manifest()` / `write_manifest()` -- TOML persistence for the
  repository manifest.
- `read_github_sources()` / `write_github_sources()` -- TOML persistence for
  the GitHub source registry.
- `read_local_config()` / `write_local_config()` -- TOML persistence for
  local (non-committed) settings.
- `install_gitattributes(repo_root, patterns)` -- appends filter/diff
  attributes to `.gitattributes`.
- `install_git_filters(repo_root, bin)` -- sets up Git filter configuration
  via `git config --local`.

## Usage

Part of the [git-sshripped](https://github.com/BSteffaniak/git-sshripped)
workspace. This crate is not intended for standalone use.