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

rename "legacy files" -> "idiomatic files" #3212

Open
jdx opened this issue Nov 26, 2024 · 0 comments
Open

rename "legacy files" -> "idiomatic files" #3212

jdx opened this issue Nov 26, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@jdx
Copy link
Owner

jdx commented Nov 26, 2024

In the docs I describe this in regards to legacy files:

asdf calls these "legacy version files" so we do too. I think this is a bad name since it implies that they shouldn't be used—which is definitely not the case IMO. I prefer the term "idiomatic" version files since they're version files not specific to asdf/mise and can be used by other tools. (.nvmrc being a notable exception, which is tied to a specific tool.)

I think we should invert this and always refer to them as "idiomatic version files" as it's a better name except in this one place where we can mention that's what asdf referred to them as.

At the time of that writing this made sense because mise was new and most people were coming from asdf so the familiarity was important, however now there are as many if not more users coming to mise not via asdf so sticking to this poor naming convention is something we should avoid. As the docs describe, calling them "legacy" implies they shouldn't be used but I certainly don't think that is the case with these files.

This is more than just a docs change, the code and error messages also need to be updated.

@jdx jdx added the enhancement New feature or request label Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant