Skip to content

[RFC] Handle "$ cmd" to run "cmd", and display "$ cmd" as prompt #1

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[RFC] Handle "$ cmd" to run "cmd", and display "$ cmd" as prompt #1

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
16 changes: 13 additions & 3 deletions sphinxcontrib/runcmd/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,15 +76,25 @@ def run(self):
# Grab a cache singleton instance
cache = CMDCache()

# Handle "$ foo" to run "foo", but display it as prompt (enabled
# "prompt" flag).
if self.arguments[0] in ("$", "%"):
command = " ".join(self.arguments[1:])
prompt = " ".join(self.arguments)
else:
command = " ".join(self.arguments)
if "prompt" in self.options:
prompt = command
else:
prompt = False

# Get the command output
command = " ".join(self.arguments)
output = cache.get(command)

# Grab our custom commands
syntax = self.options.get("syntax", "text")
replace = self.options.get("replace", "")
reader = csv.reader([replace], delimiter=",", escapechar="\\")
prompt = "prompt" in self.options
dedent_output = self.options.get("dedent-output", 0)

# Dedent the output if required
Expand All @@ -93,7 +103,7 @@ def run(self):

# Add the prompt to our output if required
if prompt:
output = "{}\n{}".format(command, output)
output = "{}\n{}".format(prompt, output)

# Do our "replace" syntax on the command output
for items in reader:
Expand Down