Skip to content

rename envbuilder.MagicDir to envbuilder.WorkingDir #184

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

Closed
johnstcn opened this issue May 13, 2024 · 3 comments · Fixed by #389
Closed

rename envbuilder.MagicDir to envbuilder.WorkingDir #184

johnstcn opened this issue May 13, 2024 · 3 comments · Fixed by #389
Assignees
Labels
good first issue Good for newcomers

Comments

@johnstcn
Copy link
Member

          Not introduced by your PR but I want to point out that `MagicDir` is kinda unhelpful as a name; perhaps `EnvbuilderWorkingDir` would be more explicit?

Originally posted by @dannykopping in #183 (comment)

@leo-oliveira2
Copy link

Hello, can I do this?

@SasSwart
Copy link
Contributor

I've submitted an initial PR to get us most of the way to closing this issue. I have a few questions that I would like to verify:

  1. Do we include a CLI change to rename the MagicDirBase option to WorkingDirBase in the scope for this issue? (please verify @johnstcn). I'm happy to do so. I just want the scope verified.
  2. I see the term magic used elsewhere in the code in relation to magic files, magic images and magic directives. Some of these come from the package I just renamed. Does magic have a specific definition that I'm unaware of? I fear that we might introduce confusion if the term magic somehow coupled these concepts.

@johnstcn
Copy link
Member Author

johnstcn commented Oct 15, 2024

  1. Do we include a CLI change to rename the MagicDirBase option to WorkingDirBase in the scope for this issue? (please verify @johnstcn). I'm happy to do so. I just want the scope verified.

I would consider this in scope of this issue. It's not really a "CLI" change as such, as it's not an exposed CLI option. Only users who import coder/envbuilder would be affected by this.

  1. I see the term magic used elsewhere in the code in relation to magic files, magic images and magic directives. Some of these come from the package I just renamed. Does magic have a specific definition that I'm unaware of? I fear that we might introduce confusion if the term magic somehow coupled these concepts.

It's just semantic bleed from MagicDir. If those can be renamed without any external effects, we could do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants