Skip to content
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.

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

Indicate zshenv is to be used when configuring ZSH version managers #2239

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

Conversation

justinbburris
Copy link

Motivation

Closes #2202

When configuring your ZSH based shell, we want to make sure the right file is indicated.

Implementation

Tested the tool via booting up the extension in VS Code.

Automated Tests

They're just readme changes, so modification of features.

Manual Tests

(I used rbenv for as my ruby version manager)

  • Enable your ruby version manager in ZSH, using zshrc, and open VS Code. You'll see the extension fail to initialize
  • Enable your ruby version manager in ZSH, using zshenv, and open VS Code. You'll see the extension initialize

@justinbburris justinbburris requested a review from a team as a code owner July 1, 2024 13:47
@@ -8,18 +8,18 @@ with the same Ruby version as your projects, we need to properly set these envir
invoking your Ruby version manager.

The extension runs a command using your shell's interactive mode, so that version managers configured in files such as
`~/.zshrc` are picked up automatically. The command then exports the environment information into JSON, so that we can
`~/.zshenv` are picked up automatically. The command then exports the environment information into JSON, so that we can
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a zsh user. Does this file always exist? Or could there be users that don't have this file and only have ~/.zshrc?

I'm trying to understand if this is a recommendation that would work for everyone or if it might require extra steps.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's dependent of your ZSH setup. I run ZSH with Prezto. My ruby is sourced in ~/.zshrc with Mise and it works. So i'm not sure the doc change cover all cases.

@vinistock vinistock added the documentation Improvements or additions to documentation label Jul 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-needed documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Visual Studio Code 0.7.4 appears to be unable to initialize rbenv
3 participants