git-review-workflow 0.1.0

package/completions/git-review-workflow.bash

@@ -0,0 +1,143 @@
+# Bash completion for git-review-workflow.
+#
+# All commands live under the `git review <verb>` dispatcher, so a single
+# `_git_review` completer drives them: it offers the verbs, then dispatches to a
+# per-verb helper for that verb's options and arguments.
+#
+# Requires git's own bash completion to be loaded first (it provides the
+# __gitcomp* / __git_* helpers and the $cur variable). Source this file after it:
+#
+#     source /path/to/completions/git-review-workflow.bash
+#
+# zsh users: run `autoload -U +X bashcompinit && bashcompinit` first, then
+# source this file.
+
+# Source branches with a saved review (review-saved/*), for `continue` and
+# `forget --saved`.
+__grw_saved_branches() {
+	git for-each-ref --format='%(refname:short)' refs/heads/review-saved/ 2>/dev/null |
+		sed -n 's#^review-saved/##p'
+}
+
+# review/* branches with the prefix stripped, for `clean`.
+__grw_review_branches() {
+	git for-each-ref --format='%(refname:short)' refs/heads/review/ 2>/dev/null |
+		sed -n 's#^review/##p'
+}
+
+# Source branches that have a recorded --delta marker. These outlive the
+# review/* branches, so they — not local heads — are what `forget --delta` acts on.
+__grw_marked_branches() {
+	# Both marker sections, reviewworkflow.* (remote) and reviewworkflowlocal.*
+	# (--local). A branch reviewed both ways collapses to one entry via sort -u, so
+	# it is offered once by its plain name (`forget --delta <branch>` clears both).
+	{
+		git config --get-regexp '^reviewworkflow\..*\.reviewed$' 2>/dev/null
+		git config --get-regexp '^reviewworkflowlocal\..*\.reviewed$' 2>/dev/null
+	} | sed -n -e 's/^reviewworkflowlocal\.//' -e 's/^reviewworkflow\.//' \
+		-e 's/\.reviewed .*//p' | sort -u
+}
+
+_git_review_start() {
+	case "$cur" in
+	--*)
+		__gitcomp "--base --delta --from --step --local --h"
+		;;
+	*)
+		__gitcomp_nl "$(__git_refs)"
+		;;
+	esac
+}
+
+_git_review_compare() {
+	case "$cur" in
+	--*)
+		__gitcomp "--step --h"
+		;;
+	*)
+		__gitcomp_nl "$(__git_refs)"
+		;;
+	esac
+}
+
+_git_review_finish() {
+	__gitcomp "--onto-source --resume --abort --force --h"
+}
+
+_git_review_preview() {
+	__gitcomp "--stat --h"
+}
+
+_git_review_continue() {
+	case "$cur" in
+	--*)
+		__gitcomp "--h"
+		;;
+	*)
+		__gitcomp_nl "$(__grw_saved_branches)"
+		;;
+	esac
+}
+
+_git_review_clean() {
+	case "$cur" in
+	--*)
+		__gitcomp "--h"
+		;;
+	*)
+		__gitcomp_nl "$(__grw_review_branches)"
+		;;
+	esac
+}
+
+# forget has two modes: --delta (acts on the recorded markers) and --saved
+# (acts on review-saved/* branches). Offer the relevant flags and candidates once a
+# mode word is on the line; before that, just the two modes.
+_git_review_forget() {
+	case " ${COMP_WORDS[*]} " in
+	*" --saved "*)
+		case "$cur" in
+		--*) __gitcomp "--all --dry-run --h" ;;
+		*) __gitcomp_nl "$(__grw_saved_branches)" ;;
+		esac
+		;;
+	*" --delta "*)
+		case "$cur" in
+		--*) __gitcomp "--all --stale --dry-run --h" ;;
+		*) __gitcomp_nl "$(__grw_marked_branches)" ;;
+		esac
+		;;
+	*)
+		__gitcomp "--delta --saved --h"
+		;;
+	esac
+}
+
+# Entry point: git's bash completion calls this for `git review ...`. Find the
+# verb already on the line; if none yet, complete the verb list (or the
+# dispatcher's own -h/--version). Otherwise dispatch to the verb's helper —
+# verbs with no options beyond --h fall through to the default.
+_git_review() {
+	local subcommands="start compare next prev status list preview finish save continue abort clean forget"
+	local subcommand
+	subcommand="$(__git_find_on_cmdline "$subcommands")"
+
+	if [ -z "$subcommand" ]; then
+		case "$cur" in
+		-*) __gitcomp "--h --version" ;;
+		*) __gitcomp "$subcommands" ;;
+		esac
+		return
+	fi
+
+	case "$subcommand" in
+	start) _git_review_start ;;
+	compare) _git_review_compare ;;
+	finish) _git_review_finish ;;
+	preview) _git_review_preview ;;
+	continue) _git_review_continue ;;
+	clean) _git_review_clean ;;
+	forget) _git_review_forget ;;
+	*) __gitcomp "--h" ;;
+	esac
+}

package/completions/git-review-workflow.fish

@@ -0,0 +1,140 @@
+# Fish completion for git-review-workflow.
+#
+# Every command lives under the `git review <verb>` dispatcher, so these
+# completions offer the verbs after `git review`, then each verb's own options
+# and arguments.
+#
+# Install by copying (or symlinking) this file into your fish completions dir:
+#
+#     ln -s /path/to/git-review-workflow/completions/git-review-workflow.fish \
+#         ~/.config/fish/completions/
+
+# Echo the git-review verb on the command line (the first non-option token after
+# `review`), or fail with no output if none has been typed yet.
+function __grw_review_verb
+    set -l tokens (commandline -opc)
+    test (count $tokens) -ge 2; and test $tokens[1] = git; and test $tokens[2] = review
+    or return 1
+    for t in $tokens[3..-1]
+        switch $t
+            case '-*'
+                continue
+            case '*'
+                echo $t
+                return 0
+        end
+    end
+    return 1
+end
+
+# True on `git review` before any verb is chosen — when to offer the verb list.
+function __grw_review_bare
+    not __grw_review_verb >/dev/null 2>&1
+    and begin
+        set -l tokens (commandline -opc)
+        test (count $tokens) -ge 2; and test $tokens[1] = git; and test $tokens[2] = review
+    end
+end
+
+# True when the chosen verb equals $verb.
+function __grw_review_using -a verb
+    test (__grw_review_verb 2>/dev/null) = $verb
+end
+
+# Local + remote branch names, for branch/commit-ish arguments.
+function __grw_branches
+    git for-each-ref --format='%(refname:short)' refs/heads refs/remotes 2>/dev/null
+end
+
+# review/* branches with the prefix stripped, for clean.
+function __grw_review_branches
+    git for-each-ref --format='%(refname:short)' refs/heads/review/ 2>/dev/null \
+        | string replace -r '^review/' ''
+end
+
+# Source branches that have a recorded --delta marker, for forget --delta. The
+# markers outlive the review/* branches, so this is the right candidate set.
+function __grw_marked_branches
+    # Both marker sections, reviewworkflow.* (remote) and reviewworkflowlocal.*
+    # (--local). A branch reviewed both ways collapses to one entry via sort -u, so
+    # it shows once by its plain name (forget --delta <branch> clears both).
+    begin
+        git config --get-regexp '^reviewworkflow\..*\.reviewed$' 2>/dev/null
+        git config --get-regexp '^reviewworkflowlocal\..*\.reviewed$' 2>/dev/null
+    end \
+        | string replace -r '^reviewworkflow(local)?\.(.*)\.reviewed .*$' '$2' \
+        | sort -u
+end
+
+# Source branches with a saved review (review-saved/*), for continue and
+# forget --saved.
+function __grw_saved_branches
+    git for-each-ref --format='%(refname:short)' refs/heads/review-saved/ 2>/dev/null \
+        | string replace -r '^review-saved/' ''
+end
+
+# ── git review (no verb yet): dispatcher flags + the verb list ────────────────
+complete -c git -n '__grw_review_bare' -f -l h -d 'list all available commands'
+complete -c git -n '__grw_review_bare' -f -s V -l version -d 'print the installed version'
+complete -c git -n '__grw_review_bare' -f -a start -d 'stage a PR diff on a new review/<branch> branch'
+complete -c git -n '__grw_review_bare' -f -a compare -d 'stage the diff between two commit-ish, read-only'
+complete -c git -n '__grw_review_bare' -f -a next -d 'advance a commit-by-commit review to the next commit'
+complete -c git -n '__grw_review_bare' -f -a prev -d 'step a commit-by-commit review back to the previous commit'
+complete -c git -n '__grw_review_bare' -f -a status -d 'show the state of the review on the current branch'
+complete -c git -n '__grw_review_bare' -f -a list -d 'list every review/* branch in progress'
+complete -c git -n '__grw_review_bare' -f -a preview -d 'show your edits so far without committing or switching'
+complete -c git -n '__grw_review_bare' -f -a finish -d 'extract your edits onto review-fixes/<branch>'
+complete -c git -n '__grw_review_bare' -f -a save -d 'pause the current review and return to where you started'
+complete -c git -n '__grw_review_bare' -f -a continue -d 'resume a review paused with git review save'
+complete -c git -n '__grw_review_bare' -f -a abort -d 'cancel the current review and return to where you started'
+complete -c git -n '__grw_review_bare' -f -a clean -d 'delete review/* and review-fixes/* branches'
+complete -c git -n '__grw_review_bare' -f -a forget -d "discard a review's persistent state (delta markers or a saved review)"
+
+# ── git review start ──────────────────────────────────────────────────────────
+complete -c git -n '__grw_review_using start' -f -r -l base -d 'base to diff against when the branch is omitted'
+complete -c git -n '__grw_review_using start' -f -l delta -d 'review only commits since your last review'
+complete -c git -n '__grw_review_using start' -f -l from -d 'review only commits after <commit>'
+complete -c git -n '__grw_review_using start' -f -l step -d 'review one commit at a time'
+complete -c git -n '__grw_review_using start' -f -l local -d 'review your local branches directly, without fetching'
+complete -c git -n '__grw_review_using start' -f -l h -d 'show help'
+complete -c git -n '__grw_review_using start' -f -a '(__grw_branches)'
+
+# ── git review compare ────────────────────────────────────────────────────────
+complete -c git -n '__grw_review_using compare' -f -l step -d 'review one commit at a time'
+complete -c git -n '__grw_review_using compare' -f -l h -d 'show help'
+complete -c git -n '__grw_review_using compare' -f -a '(__grw_branches)'
+
+# ── git review finish ─────────────────────────────────────────────────────────
+complete -c git -n '__grw_review_using finish' -f -l onto-source -d 'stage edits on the PR branch itself'
+complete -c git -n '__grw_review_using finish' -f -l resume -d 'continue after resolving replay conflicts'
+complete -c git -n '__grw_review_using finish' -f -l abort -d 'undo the last finish and return to editing'
+complete -c git -n '__grw_review_using finish' -f -l force -d 'with --abort, discard changes made to the finish branch'
+complete -c git -n '__grw_review_using finish' -f -l h -d 'show help'
+
+# ── git review preview ────────────────────────────────────────────────────────
+complete -c git -n '__grw_review_using preview' -f -l stat -d 'show a diffstat summary instead of the full diff'
+complete -c git -n '__grw_review_using preview' -f -l h -d 'show help'
+
+# ── git review continue ───────────────────────────────────────────────────────
+complete -c git -n '__grw_review_using continue' -f -l h -d 'show help'
+complete -c git -n '__grw_review_using continue' -f -a '(__grw_saved_branches)'
+
+# ── git review clean ──────────────────────────────────────────────────────────
+complete -c git -n '__grw_review_using clean' -f -l h -d 'show help'
+complete -c git -n '__grw_review_using clean' -f -a '(__grw_review_branches)'
+
+# ── git review forget (--delta acts on markers, --saved on review-saved/*) ─────
+complete -c git -n '__grw_review_using forget' -f -l delta -d 'forget the --delta markers recorded by git review start'
+complete -c git -n '__grw_review_using forget' -f -l saved -d 'discard a review paused with git review save'
+complete -c git -n '__grw_review_using forget' -f -l all -d 'every marker (--delta) or every saved review (--saved)'
+complete -c git -n '__grw_review_using forget' -f -l stale -d 'with --delta, forget markers whose branch is gone'
+complete -c git -n '__grw_review_using forget' -f -l dry-run -d 'list what would be forgotten without forgetting it'
+complete -c git -n '__grw_review_using forget' -f -l h -d 'show help'
+# Offer saved branches once --saved is on the line, marked branches otherwise.
+complete -c git -n '__grw_review_using forget; and __fish_contains_opt saved' -f -a '(__grw_saved_branches)'
+complete -c git -n '__grw_review_using forget; and not __fish_contains_opt saved' -f -a '(__grw_marked_branches)'
+
+# ── Verbs that take no arguments beyond --h ───────────────────────────────────
+for verb in next prev status list abort save
+    complete -c git -n "__grw_review_using $verb" -f -l h -d 'show help'
+end

package/completions/git-review-workflow.zsh

@@ -0,0 +1,153 @@
+#compdef -value-,GIT_REVIEW_WORKFLOW,-default-
+#
+# Native zsh completion for git-review-workflow.
+#
+# Every command lives under the `git review <verb>` dispatcher, so zsh's git
+# completion only ever dispatches `git review` to `_git-review`; this file makes
+# that one function offer the verbs and then complete each verb's own options and
+# arguments (the `git bisect` idiom).
+#
+# Install: put this file on your $fpath (or source it after compinit), e.g.
+#
+#     fpath=(/path/to/git-review-workflow/completions $fpath)
+#     autoload -Uz compinit && compinit
+#
+# or simply:
+#
+#     source /path/to/git-review-workflow/completions/git-review-workflow.zsh
+
+# Helpers per verb. Named with underscores (not `_git-review-<verb>`) so zsh's
+# git dispatcher never mistakes one for the completer of a `git review-<verb>`
+# subcommand — there is no such subcommand any more.
+
+_git_review_start() {
+	_arguments -S \
+		'(-h --h)'{-h,--h}'[show help]' \
+		'--base[base to diff against when the branch is omitted]:base:__git_revisions' \
+		'(--from)--delta[review only the commits added since your last review]' \
+		'(--delta)--from[review only the commits after <commit>]:commit:__git_commits' \
+		'--step[review one commit at a time]' \
+		'--local[review your local branches directly, without fetching]' \
+		'*: :__git_revisions'
+}
+
+_git_review_compare() {
+	_arguments -S \
+		'(-h --h)'{-h,--h}'[show help]' \
+		'--step[review one commit at a time]' \
+		'*:commit-ish:__git_revisions'
+}
+
+_git_review_finish() {
+	_arguments -S \
+		'(-h --h)'{-h,--h}'[show help]' \
+		'--onto-source[stage your edits on the PR branch itself]' \
+		'--resume[continue after resolving replay conflicts]' \
+		'--abort[undo the last finish and return to editing]' \
+		'--force[with --abort, discard changes made to the finish branch]'
+}
+
+_git_review_preview() {
+	_arguments -S \
+		'(-h --h)'{-h,--h}'[show help]' \
+		'--stat[show a diffstat summary instead of the full diff]'
+}
+
+_git_review_continue() {
+	local state
+	_arguments -S \
+		'(-h --h)'{-h,--h}'[show help]' \
+		'*: :->savedbranches'
+
+	if [ "$state" = savedbranches ]; then
+		local -a names
+		names=(${(f)"$(git for-each-ref --format='%(refname:short)' refs/heads/review-saved/ 2>/dev/null | sed 's#^review-saved/##')"})
+		_describe 'saved review' names
+	fi
+}
+
+_git_review_clean() {
+	local state
+	_arguments -S \
+		'(-h --h)'{-h,--h}'[show help]' \
+		'*: :->reviewbranches'
+
+	if [ "$state" = reviewbranches ]; then
+		local -a names
+		names=(${(f)"$(git for-each-ref --format='%(refname:short)' refs/heads/review/ 2>/dev/null | sed 's#^review/##')"})
+		_describe 'review branch' names
+	fi
+}
+
+_git_review_forget() {
+	local state
+	_arguments -S \
+		'(-h --h)'{-h,--h}'[show help]' \
+		'(--saved)--delta[forget the --delta markers recorded by git review start]' \
+		'(--delta)--stale[(--delta) forget markers whose branch no longer exists]' \
+		'(--delta --saved)--saved[discard a review paused with git review save]' \
+		'--all[every marker (--delta) or every saved review (--saved)]' \
+		'--dry-run[list what would be forgotten without forgetting it]' \
+		'*: :->forgetbranches'
+
+	# With --saved, complete from review-saved/* branches; otherwise from the
+	# recorded --delta markers (which outlive the review/* branches).
+	if [ "$state" = forgetbranches ]; then
+		local -a names
+		if (( ${words[(I)--saved]} )); then
+			names=(${(f)"$(git for-each-ref --format='%(refname:short)' refs/heads/review-saved/ 2>/dev/null | sed 's#^review-saved/##')"})
+			_describe 'saved review' names
+		else
+			names=(${(f)"$({ git config --get-regexp '^reviewworkflow\..*\.reviewed$' 2>/dev/null; git config --get-regexp '^reviewworkflowlocal\..*\.reviewed$' 2>/dev/null; } | sed -n -e 's/^reviewworkflowlocal\.//' -e 's/^reviewworkflow\.//' -e 's/\.reviewed .*//p' | sort -u)"})
+			_describe 'marked branch' names
+		fi
+	fi
+}
+
+_git-review() {
+	local curcontext="$curcontext" state line
+	typeset -A opt_args
+
+	_arguments -C \
+		'(-h --h)'{-h,--h}'[list all available commands]' \
+		'(-V --version)'{-V,--version}'[print the installed version]' \
+		': :->verb' \
+		'*:: :->args'
+
+	case "$state" in
+	verb)
+		local -a verbs
+		verbs=(
+			'start:stage a PR diff on a new review/<branch> branch'
+			'compare:stage the diff between two commit-ish, read-only'
+			'next:advance a commit-by-commit review to the next commit'
+			'prev:step a commit-by-commit review back to the previous commit'
+			'status:show the state of the review on the current branch'
+			'list:list every review/* branch in progress'
+			'preview:show your edits so far without committing or switching'
+			'finish:extract your edits onto review-fixes/<branch>'
+			'save:pause the current review and return to where you started'
+			'continue:resume a review paused with git review save'
+			'abort:cancel the current review and return to where you started'
+			'clean:delete review/* and review-fixes/* branches'
+			'forget:discard a review'\''s persistent state (delta markers or a saved review)'
+		)
+		_describe -t verbs 'git review verb' verbs
+		;;
+	args)
+		curcontext="${curcontext%:*:*}:git-review-$line[1]:"
+		case "$line[1]" in
+		start) _git_review_start ;;
+		compare) _git_review_compare ;;
+		finish) _git_review_finish ;;
+		preview) _git_review_preview ;;
+		continue) _git_review_continue ;;
+		clean) _git_review_clean ;;
+		forget) _git_review_forget ;;
+		next|prev|status|list|save|abort)
+			_arguments '(-h --h)'{-h,--h}'[show help]'
+			;;
+		esac
+		;;
+	esac
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "git-review-workflow",
+  "version": "0.1.0",
+  "description": "Git commands to review a pull request branch locally as one staged diff",
+  "keywords": [
+    "git",
+    "git-subcommand",
+    "review",
+    "code-review",
+    "pull-request",
+    "pr",
+    "cli",
+    "workflow"
+  ],
+  "homepage": "https://github.com/EzeVillo/git-review-workflow#readme",
+  "bugs": {
+    "url": "https://github.com/EzeVillo/git-review-workflow/issues"
+  },
+  "license": "MIT",
+  "author": "EzeVillo <ezevillodev@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/EzeVillo/git-review-workflow.git"
+  },
+  "bin": {
+    "git-review": "bin/git-review"
+  },
+  "files": [
+    "bin/",
+    "completions/",
+    "VERSION",
+    "LICENSE",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}