github-diff

#!/usr/bin/env python3


################################################################################
#
#   Description:
#   ------------
#       Converts the git-diff output into an expandable GitHub comment form, and
#       puts into the system clipboard to allow for easy pasting into the GitHub
#       comment.
#
#   Usage:
#   ------
#   (first place this script in one of the directories in $PATH)
#       $> cd path/to/repo/where/you/want/to/diff
#       $> PAGER= git diff [commits range] | github-diff
#       now go to GitHub and paste into the comment box
#
################################################################################


import os
import sys
import tempfile


def die(msg):
    print(msg)
    sys.exit(1)


tmp_file = tempfile.NamedTemporaryFile(mode='w')
tmp_file.write('<details>\n')
tmp_file.write('<summary>Diff</summary>\n')

# A blank line is necessary after the summary to make sure that the details
# section gets properly formatted
tmp_file.write('\n')

tmp_file.write('```diff\n')

diff_has_something = False

for line in sys.stdin:
    diff_has_something = True
    tmp_file.write(line)

if not diff_has_something:
    die('Empty diff, nothing to do')

tmp_file.write('```')

# TODO: find out why seeking to the beginning is necessary. If I don't do this,
# I see that only a part of the file (starting from the beginning however) gets
# copied to the clipboard
# Seek to the beginning
tmp_file.seek(0)

os.system("cat '{}' | xclip -selection clipboard".format(tmp_file.name))

print("GitHub comment-friendly diff copied to clipboard")