Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Emit terminal hyperlinks #19

Merged
merged 1 commit into from
Aug 24, 2024
+31 −13
Merged

Emit terminal hyperlinks #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 31 additions & 13 deletions src/stack_pr/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ def base(self, base: str):
def has_missing_info(self) -> bool:
return None in (self._pr, self._head, self._base)

def pprint(self):
def pprint(self, links: bool):
s = b(self.commit.commit_id()[:8])
pr_string = None
if self.has_pr():
Expand All @@ -290,10 +290,14 @@ def pprint(self):
if pr_string or branch_string:
s += ")"
s += ": " + self.commit.title()

if links and self.has_pr():
s = link(self.pr, s)

return s

def __repr__(self):
return self.pprint()
return self.pprint(False)

def read_metadata(self):
self.commit.commit_msg()
Expand Down Expand Up @@ -341,6 +345,16 @@ def red(s: str):
return bcolors.FAIL + s + bcolors.ENDC


# https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
def link(location: str, text: str):
"""
Emits a link to the terminal using the terminal hyperlink specification.

Does not properly implement file URIs. Only use with web URIs.
"""
return f"\033]8;;{location}\033\\{text}\033]8;;\033\\"


def error(msg):
print(red("\nERROR: ") + msg)

Expand Down Expand Up @@ -470,10 +484,10 @@ def verify(st: List[StackEntry], check_base: bool = False):
raise RuntimeError


def print_stack(st: List[StackEntry], level=1):
def print_stack(st: List[StackEntry], links: bool, level=1):
log(b("Stack:"), level=level)
for e in reversed(st):
log(" * " + e.pprint(), level=level)
log(" * " + e.pprint(links), level=level)


def draft_bitmask_type(value: str) -> List[bool]:
Expand Down Expand Up @@ -722,10 +736,11 @@ class CommonArgs(NamedTuple):
head: str
remote: str
target: str
hyperlinks: bool

@classmethod
def from_args(cls, args: argparse.Namespace) -> "CommonArgs":
return cls(args.base, args.head, args.remote, args.target)
return cls(args.base, args.head, args.remote, args.target, args.hyperlinks)


# If the base isn't explicitly specified, find the merge base between
Expand All @@ -745,7 +760,7 @@ def deduce_base(args: CommonArgs) -> CommonArgs:
deduced_base = get_command_output(
["git", "merge-base", args.head, f"{args.remote}/{args.target}"]
)
return CommonArgs(deduced_base, args.head, args.remote, args.target)
return CommonArgs(deduced_base, args.head, args.remote, args.target, args.hyperlinks)


def print_tips_after_export(st: List[StackEntry], args: CommonArgs):
Expand Down Expand Up @@ -797,7 +812,7 @@ def command_submit(
# elements
init_local_branches(st, args.remote)
set_base_branches(st, args.target)
print_stack(st)
print_stack(st, args.hyperlinks)

# If the current branch contains commits from the stack, we will need to
# rebase it in the end since the commits will be modified.
Expand Down Expand Up @@ -857,7 +872,7 @@ def command_submit(
# LAND
# ===----------------------------------------------------------------------=== #
def rebase_pr(e: StackEntry, remote: str, target: str):
log(b("Rebasing ") + e.pprint(), level=2)
log(b("Rebasing ") + e.pprint(False), level=2)
# Rebase the head branch to the most recent 'origin/main'
run_shell_command(["git", "fetch", "--prune", remote])
cmd = ["git", "checkout", f"{remote}/{e.head}", "-B", e.head]
Expand All @@ -883,7 +898,7 @@ def rebase_pr(e: StackEntry, remote: str, target: str):


def land_pr(e: StackEntry, remote: str, target: str):
log(b("Landing ") + e.pprint(), level=2)
log(b("Landing ") + e.pprint(False), level=2)
# Rebase the head branch to the most recent 'origin/main'
run_shell_command(["git", "fetch", "--prune", remote])
cmd = ["git", "checkout", f"{remote}/{e.head}", "-B", e.head]
Expand Down Expand Up @@ -965,7 +980,7 @@ def command_land(args: CommonArgs):
# already be there from the metadata that commits need to have by that
# point.
set_base_branches(st, args.target)
print_stack(st)
print_stack(st, args.hyperlinks)

# Verify that the stack is correct before trying to land it.
verify(st, check_base=True)
Expand All @@ -977,7 +992,7 @@ def command_land(args: CommonArgs):
if len(st) > 1:
log(h("Rebasing the rest of the stack"), level=1)
prs_to_rebase = st[1:]
print_stack(prs_to_rebase)
print_stack(prs_to_rebase, args.hyperlinks)
for e in prs_to_rebase:
rebase_pr(e, args.remote, args.target)
# Change the target of the new bottom-most PR in the stack to 'target'
Expand Down Expand Up @@ -1028,7 +1043,7 @@ def command_abandon(args: CommonArgs):

init_local_branches(st, args.remote)
set_base_branches(st, args.target)
print_stack(st)
print_stack(st, args.hyperlinks)

log(h("Stripping stack metadata from commit messages"), level=1)

Expand Down Expand Up @@ -1106,7 +1121,7 @@ def command_view(args: CommonArgs):

set_head_branches(st, args.remote)
set_base_branches(st, args.target)
print_stack(st)
print_stack(st, args.hyperlinks)
print_tips_after_view(st, args)
log(h(blue("SUCCESS!")), level=1)

Expand All @@ -1128,6 +1143,9 @@ def create_argparser() -> argparse.ArgumentParser:
common_parser.add_argument(
"-T", "--target", default="main", help="Remote target branch"
)
common_parser.add_argument(
"--hyperlinks", action=argparse.BooleanOptionalAction, default=True, help="Enable or disable hyperlink support."
)

parser_submit = subparsers.add_parser(
"submit",
Expand Down