Looking for example of custom module

[marekkon]

Hi,
can someone show me some (preferably complicated) example of custom module configuration?

I tried to use custom module to create functionality similar to #1192. I did it like this:

[custom.dirty]
command = "echo '*'"  # I want to show asterisk next to branch name
symbol = "*"          # I don't know which works command or symbol
when = "git-changes"  # bash script (function) execution (don't know if I should use """)
style = "fg:red"

but it doesn't work. Actually even example from documentation doesn't work, that's why I'd really like to see some working example.

Another idea I have about a custom module is to display the name VIRTUAL_ENV, at least until this function is added to the python module.

[matchai]

Hey @marekkon 👋

It looks to me like what you're doing should work.
I added the following config and it was working as expected:

[custom.dirty]
command = "echo '*'"
when = "true"           # Returns a `0` status code
style = "fg:red"
shell = "bash"

To make sure the custom module is running as expected, you can run it using the logger environment variable:

RUST_LOG=starship starship prompt

[marekkon]

With som tweaks it finally worked, thanks.

Your last command should be in a prominent place in the documentation. It saves lives (and time) 😌.

[andytom]

Another idea I have about a custom module is to display the name VIRTUAL_ENV, at least until this function is added to the python module.

Hi @marekkon, just to add this should already be supported by the python module at the moment although having just checked the docs this might not be obvious from the docs 😞 but I'll try to sort that.

[marekkon]

@andytom great news. And yes I can see it in source, but don't know how to turn it on. So any update in documentation is greatly appreciated. Thanks.

[andytom]

So it looks like it should be displayed by default, we did fix a bug in the most recent release that was stopping it from being displayed sometimes but that should be fixed in the most recent version (https://github.com/starship/starship/releases/tag/v0.41.0). If it is not working for you with the most recent version would you mind opening a bu so we can investigate this more?

[marekkon]

@andytom it works, nice. I don't see the option to hide the python version (or display only $VIRTUAL_ENV), so I'll create a feature request.
Thanks for the info.