feat: Add xonsh support

[vladimyr]

Description

Adds xonsh init script.

Motivation and Context

Closes #272

Screenshots (if appropriate):

How Has This Been Tested?

• I have tested using MacOS
• I have tested using Linux
• I have tested using Windows

Checklist:

• I have updated the documentation accordingly.
• I have updated the tests accordingly.

[matchai]

The PR looks great to me! Thank you for taking the time to add docs everywhere they're needed. 😄

Unfortunately, I seem to be having issues getting starship working, following the provided instructions.
I appear to get the following error after editing ~/.xonshrc or running execx($(starship init xonsh)) directly:

NameError: name 'get_next_job_number' is not defined

I see the get_next_job_number function is clearly imported at the start of your init file, but I'm not familiar enough with xonsh to know where to start troubleshooting.

I have installed xonsh directly from Brew (xonsh/0.9.18) if that's of any help.
If I can provide any details to help troubleshoot, let me know. If you'd prefer more synchronous communication while troubleshooting, I'm always available on the project Discord: https://discord.gg/8Jzqu3T

[vladimyr]

The PR looks great to me! Thank you for taking the time to add docs everywhere they're needed. 😄

I'm giving my best 😁

I have installed xonsh directly from Brew (xonsh/0.9.18) if that's of any help.

Well, we took different routes. I've installed it using pipx. I'll try with Homebrew and let you know.

If you'd prefer more synchronous communication while troubleshooting, I'm always available on the project Discord: discord.gg/8Jzqu3T

Sure, I'll join 👍

[vladimyr]

Well, this reached a dead end 😞

The main difference between Homebrew and pip/x install of xonsh is that Homebrew installs optional prompt-toolkit too. Without it, xonsh simply uses readline and works fine with ANSI escape sequences. With prompt-toolkit in use, things go wrong xonsh/xonsh#1403 so even if I figure out import error there is still a bigger wall to hit. With that being said and because I'm not a python expert and don't have enough time/knowledge to dive deep into xonsh/ptk internals I think it is fair to give up here. I'm sorry, I hope I put up a good fight ⚔️

[anki-code]

I've ported starship as xontrib-prompt-starship

[vladimyr]

The main difference between Homebrew and pip/x install of xonsh is that Homebrew installs optional prompt-toolkit too. Without it, xonsh simply uses readline and works fine with ANSI escape sequences. With prompt-toolkit in use, things go wrong xonsh/xonsh#1403

This is not true anymore. Xonsh now properly supports escape sequences with prompt-toolkit being used as demonstrated here: #272 (comment)

Kudos to @anki-code for following xonsh/xonsh#1403 and bringing this to my attention 👍

Thus restarting this effort...

[djmattyg007]

What would it take to get this PR merged? 🙏

[jeremyschlatter]

I fixed the merge conflicts and the NameError in a new PR: #2807