Pre-Commit-Hook für Devtools :: Dokument

Question

Ich möchte einen Pre-Commit Hook für devtools::document einrichten und das Commit fehlschlagen, wenn devtools::document ändert nichts. Ich überprüfte die devtools::document Quelle und es gibt invisible() zurück, so dass es nicht möglich ist, einen Beendigungscode bedingt zurückzugeben.

Gibt es clevere Möglichkeiten, das Commit zu stoppen, wenn devtools::document funktioniert?

Answer 1

Mit der Funktion capture.output können wir die Nachrichten fangen devtools::documents sendet, wenn es eine Datei ändert:

Writing getScore.Rd 

Also, wenn wir laufen:

results <- capture.output(devtools::document()) 

Wenn ein Dokument aktualisiert wird (für dieses Beispiel, Ich entfernte eine meiner .Rd-Dateien, die Ergebnisse sehen wie folgt aus:

Wenn nichts geschrieben wird, results leer ist:

> results 
character(0) 

Es ist leicht, von hier gehen Ich denke :)

Das OP, erstellt @BobJansen das folgende Skript, das das obige Verfahren läuft und gibt ein status = 0, wenn keine Dateien wurden bearbeitet und ein status = 100 falls vorhanden, wo:

#!/usr/bin/Rscript 

source("packrat/init.R") 

lines <- capture.output(devtools::document(), type = 'output') 
if (length(lines) > 0) { 
    print(lines) 
    q(save = 'no', status = 100) 
} else { 
    q(save = 'no', status = 0) 
}