feat(lib/omb-prompt-base): Add support for distrobox

[anthqiu]

Distrobox is "a container wrapping layer that allows the user to install containerised versions of Linux that are different to the host while providing tight integration with the host allowing the use of binaries designed for one distribution to run on another (Arch wiki)".

This pull request implements the basic function to get the distrobox container name and modifies the default font theme to add a distrobox information field.

[akinomyoga]

I'm not familiar with this field, so I don't have a way to tell whether the suggested change does the right thing. My naive question is whether the environment variable CONTAINER_ID is really specific to the Distrobox container. A quick search seems to suggest that CONTAINER_ID is not the variable provided by Distrobox but a more general variable associated with Docker. Wouldn't this show the prompt information also for a Docker container that is not managed by Distrobox?

[akinomyoga]

ChatGPT says CONTAINER_ID is not a signal for Distrobox: ChatGPT-CONTAINER_ID.pdf, but I'm not sure.

[akinomyoga]

Another thing is whether the Distrobox information in a prompt has a significant demand by a large number of users. For example, Starship (which provides a wide range of options to show various information) doesn't seem to offer a module for Distrobox. Instead, Starship seems to include module container. This module seems to inspect /run/* and /proc/* to identify the container information without relying on environment variables. However, I'm not sure if what Starship's container tries to achieve is consistent with what this PR tries to achieve.

[akinomyoga]

If we decide to include the suggested Distrobox information, small adjustments are needed.

• Could you check the use of OMB_PROMPT_SHOW_SPACK_ENV and prepare a similar variable for the Distrobox information? We don't want to change the default behavior of the font theme as long as the old default doesn't cause problems. In the present case, we haven't shown the Distrobox information by default, and the existing users of the font theme might not want to show the Distrobox information in the prompt. If the font theme starts to show it by default and there is not way to turn off, it could be a trouble for existing users. To avoid such a conflict, we want to introduce a variable to enable/disable the prompt information.

[akinomyoga]

Suggested change

	_omb_prompt_format distrobox_container "$distrobox_container" OMB_PROMPT_DISTROBOX:DISTROBOX_THEME_PROMPT
	_omb_prompt_format distrobox_container "$distrobox_container" OMB_PROMPT_DISTROBOX

The name after : is used to process a deprecated form of the format specifier <name>_PREFIX and <name>_SUFFIX. However, this prompt information is a new one and there hasn't been deprecated variables DISTROBOX_THEME_PROMPT_PREFIX and DISTROBOX_THEME_PROMPT_SUFFIX. We don't want to add new deprecated variables that have never been used.

[anthqiu]

I'm not familiar with this field, so I don't have a way to tell whether the suggested change does the right thing. My naive question is whether the environment variable CONTAINER_ID is really specific to the Distrobox container. A quick search seems to suggest that CONTAINER_ID is not the variable provided by Distrobox but a more general variable associated with Docker. Wouldn't this show the prompt information also for a Docker container that is not managed by Distrobox?

I'm no expert either and am new to both distrobox and oh-my-bash. From my research CONTAINER_ID was indeed created by distrobox, however I'm not sure if other services utilize this variable as well.

Another thing is whether the Distrobox information in a prompt has a significant demand by a large number of users.

This might be a problem... From GitHub stars count there is a considerable user base to distrobox but not that much. Would you recommend moving the implementation into a plugin instead of the base lib?

[akinomyoga]

I'm no expert either and am new to both distrobox and oh-my-bash. From my research CONTAINER_ID was indeed created by distrobox, however I'm not sure if other services utilize this variable as well.

OK. It seems to be the convention for Docker managers to create the variable CONTAINER_ID. This means that other tools may also define CONTAINER_ID. We can say CONTAINER_ID is defined if Distrobox is used, but we cannot say Distrobox is used if CONTAINER_ID is used; in short, "Distrobox ⇒ CONTAINER_ID" but "Distrobox ⇍ CONTAINER_ID".

One option is to rename this to a more general name, container. Or do you want to show the information exclusively for Distrobox (but not for any other container managers)? The fact that Starship seems to provide a similar module container seems to suggest a certain extent of the demand for a more general "container" information.

[izaac]

This would be really helpful. The same it is already for pyenvs with OMB_PROMPT_SHOW_PYTHON_VENV