README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# saperlipopette

<!-- badges: start -->
[![R-CMD-check](https://github.com/maelle/saperlipopette/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/maelle/saperlipopette/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The goal of saperlipopette is to hold functions creating Git messes, that users 
would then solve, to follow https://ohshitgit.com/.

## Installation

You can install the development version of saperlipopette like so:

``` r
pak::pak("maelle/saperlipopette")
```

You'll also need

- a [Git installation](https://happygitwithr.com/install-git), but if you made it here you probably already use Git at least a bit.
- [basic Git knowledge](#recommended-resources-about-git), in particular being able to examine the Git history, be it with [git log](https://git-scm.com/book/en/v2/Git-Basics-Viewing-the-Commit-History) or a tool in your IDE.
- a directory where to store the exercises folder. In all examples we use a temporary directory but if you prefer, you could use a dedicated "scratch directory".

## Why this name?

This package is intended to be a companion to https://ohshitgit.com/,
so its name had to honour the exclamation.
"saperlipopette" is an [old-fashioned French exclamation](https://en.wiktionary.org/wiki/saperlipopette).
You can say "Saperlipopette, Git!".

## Example

This is a basic example which shows you how to solve a common problem:

```{r example}
library("saperlipopette")
parent_path <- withr::local_tempdir()
path <- exo_one_small_change(parent_path)
# what's in path
fs::dir_tree(path)
# with Git in a command line: git log
# or the gert R package
gert::git_log(repo = path)
```

At this stage, the user would open the newly created R project and launch an R session,
where messages would indicate them what to do, 
and which URL to follow, to find the corresponding ohshitgit entry.
In practice here the user would change a file, then Git add it, then run `git commit --amend --no-edit`.
The user would examine the [Git history](https://git-scm.com/book/en/v2/Git-Basics-Viewing-the-Commit-History) before and after this.

```{r, echo=FALSE}
source(system.file("exo_one_small_change-Rprofile.R", package = "saperlipopette"))
```

If they need more instructions than what is initially provided, the user can run:

```{r}
tip()
```

That interface relies on adding an `.Rprofile` to the newly created project,
with instructions formatted with the cli package.

We've set the Git author, committer and date so that the automatic commits get the same 
hashes, which can be useful when teaching a group: everyone should be looking at the same hashes on their machine, except for those commits they create themselves.

Below we use `gert::git_log()`, as opposed to `git log` in a command line, because that integrates better with R Markdown that we use for building documentation.

```{r example2}
parent_path <- withr::local_tempdir()
path <- exo_one_small_change(parent_path)
gert::git_log(repo = path)
parent_path2 <- withr::local_tempdir()
path2 <- exo_one_small_change(parent_path2)
gert::git_log(repo = path2)
```



### Recommended resources about Git

For beginners:

- [Happy Git with R](https://happygitwithr.com/)
- [Learn Git branching](https://learngitbranching.js.org/)

For users less new to Git:

- [Git in Practice by Mike McQuaid](https://masalmon.eu/2023/11/01/reading-notes-git-in-practice/)
- [Pro Git by Scott Chacon](https://masalmon.eu/2024/01/19/pro-git-scott-chacon-reading-notes/)