jnoortheen / xontrib-term-integrations Goto Github PK

View Code? Open in Web Editor NEW

14.0 4.0 1.0 50 KB

Shell integration for Xonsh

License: MIT License

Python 100.00%

xonsh xontrib iterm2 kitty terminal

xontrib-term-integrations's Introduction

Terminal Emulators integration

Shell integration for Xonsh.

The following terminal emulators are supported

iTerm2
kitty
WezTerm with CWD; Input, Output, and Prompt zones; and User Vars for tracking additional shell state

Note: If identifying current terminal fails, iTerm2 hooks are loaded.

PRs welcome on improving the support to more terminal programs :)

Installation

To install use pip:

xpip install xontrib-term-integrations
# or: xpip install -U git+https://github.com/jnoortheen/xontrib-term-integrations

Usage

# this modifies the $PROMPT function. So load it after setting $PROMPT if you have a custom value
xontrib load term_integration

(WezTerm) Set user vars¹ via the helper set_user_var function:

# via a xonsh alias
set_wezterm_user_var 'my_term_user_var' 'value_of_my_term_user_var'

# or an explicit Python import
from xontrib_term_integrations.utils import set_user_var
set_user_var('my_term_user_var','value_of_my_term_user_var')

You can disable registering the alias with a $XONTRIB_TERM_INTEGRATIONS_SKIP_ALIAS = True

Contributing

Please make sure that you

Document the purpose of functions and classes.
When adding a new feature, please mention it in the README.md. Use screenshots when applicable.
Conventional Commit style should be used for commit messages as it is used to generate changelog.
Please use pre-commit to run qa checks. Configure it with

pre-commit install-hooks

Known issues

(WezTerm) Multiline prompt is partially supported:
- every continuation line is semantically marked by default:
```
if True:
#↓ continuation prompt
.....     echo 1
#     ↑ input
```
  so you can select echo 1 as a SemanticZone with a mouse multiclick, but you can't select both lines as one zone (and would need to map some combo of commands to hack around it)
- if you set $MULTILINE_PROMPT_PRE='', $MULTILINE_PROMPT_POS='', then continuation lines won't be marked, you'd be able to select all the lines as one SemanticZone (unles the right prompt interferes), but that will also include .. continuation markers (so you'd either need to disable them in Xonsh or add some extra WezTerm lua parsing hack to trim them)
  (follow this WezTerm discussion for updates)
(WezTerm) Semantic right prompt not separated from the next-line left prompt (issue)
WezTerm is not recognized in root shells due to this issue

Variables associated with a given pane rather than a process. WezTerm, iTerm2 ↩

xontrib-term-integrations's People

Contributors

Stargazers

Watchers

Forkers

eugenesvk

xontrib-term-integrations's Issues

Bizzare crashes with `kitty`

See kovidgoyal/kitty#4582

Output that seems suspicious from kitty when running as a subprocess:

027 20:43:05.886534] [PARSE ERROR] Unknown OSC code: 1337
[027 20:43:05.886550] [PARSE ERROR] Unknown OSC code: 1337

Is OSC code: 1337 not a valid escape code for kitty?

Escape characters shown in prompt

Hi, excited to see this project and been looking forward to a working xonsh successfully integrated with iterm2 (MacOS).
I tried this and not certain if this is something I've missed or any other obvious settings at my end, but when having this loaded (with or without powerline2) it looks that there are some reoccurring escape-characters..

In such case I can supply anything that would help look into this or any advice what to try next..?

With xontrib-term-integration loaded

Without xontrib-term-integration loaded

Kind regards,
Daniel

vscode terminal support

https://code.visualstudio.com/docs/terminal/shell-integration

Error trying to install source checkout with `pip install -e`

Obtaining file:///Users/techcable/git/xontrib-term-integrations
  Installing build dependencies ... done
  Checking if build backend supports build_editable ... done
ERROR: Project file:///Users/techcable/git/xontrib-term-integrations has a 'pyproject.toml' and its build backend is missing the 'build_editable' hook. Since it does not have a 'setup.py' nor a 'setup.cfg', it cannot be installed in editable mode. Consider using a build backend that supports PEP 660.

Could you please add a setup.cfg or setup.py ❤️

Update requirements after new xonsh version is released with multiline prompt support

iTerm now works from release

xonsh release 0.12.0 and higher now includes the PR mentioned in the README so you do not need to install from github.

The README should be altered to reflect that.

How would we combine iterm/kitty integration?

Hi! Came here from xonsh/xonsh#4623 :)

As far as I'm aware, kitty's requirements for escape sequences are a subset of iTerm2's. The only extra thing needed is $PS2.

The prompt marking sequences are the same except that kityt needs less (more dont do any harm) and it marks PS2 which iterm doesnt.

Given how much overlap there seems to be, I think it makes the most sense to combine the kitty/iterm integration wherever possible.

Does it make more sense to:

Turn this into a common plugin that supports both (maybe called fancy-term or term-integration or something?)
Have separate xontribs for both, but move common code into a library (this is probably better)

It seems you already have the bulk of the work done for iTerm2. That's amazing 😄

I'm not super familiar with how "xontrib libraries" would work. What are your thoughts on this?