Skip to content

Commit e80f211

Browse files
authored
docs: rename legacy version files to idiomatic version files (jdx#3216)
* docs: rename legacy version files to idiomatic version files * Delete .python-versions
1 parent fd7d8d1 commit e80f211

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+211
-162
lines changed

.prettierignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
CHANGELOG.md
22
.venv
3-
registry/
3+
aqua-registry/
44
docs/cli
55
docs/environments.md
66
docs/registry.md

docs/cache-behavior.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ to be updating, this is a good place to start.
1010
## Plugin/Runtime Cache
1111

1212
Each plugin has a cache that's stored in `~/$MISE_CACHE_DIR/<PLUGIN>`. It stores
13-
the list of versions available for that plugin (`mise ls-remote <PLUGIN>`), the legacy filenames (see below),
13+
the list of versions available for that plugin (`mise ls-remote <PLUGIN>`), the idiomatic filenames (see below),
1414
the list of aliases, the bin directories within each runtime installation, and the result of
1515
running `exec-env` after the runtime was installed.
1616

docs/cli/direnv.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Output direnv function to use mise inside direnv
77

88
See <https://mise.jdx.dev/direnv.html> for more information
99

10-
Because this generates the legacy files based on currently installed plugins,
10+
Because this generates the idiomatic files based on currently installed plugins,
1111
you should run this command after installing new plugins. Otherwise
12-
direnv may not know to update environment variables when legacy file versions change.
12+
direnv may not know to update environment variables when idiomatic file versions change.
1313

1414
## Subcommands
1515

docs/cli/direnv/activate.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Output direnv function to use mise inside direnv
77

88
See <https://mise.jdx.dev/direnv.html> for more information
99

10-
Because this generates the legacy files based on currently installed plugins,
10+
Because this generates the idiomatic files based on currently installed plugins,
1111
you should run this command after installing new plugins. Otherwise
12-
direnv may not know to update environment variables when legacy file versions change.
12+
direnv may not know to update environment variables when idiomatic file versions change.
1313

1414
Examples:
1515

docs/cli/settings/get.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ Use the local config file instead of the global one
2424

2525
Examples:
2626

27-
$ mise settings get legacy_version_file
27+
$ mise settings get idiomatic_version_file
2828
true

docs/cli/settings/ls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Only display key names for each setting
3030
Examples:
3131

3232
$ mise settings ls
33-
legacy_version_file = false
33+
idiomatic_version_file = false
3434
...
3535

3636
$ mise settings ls python

docs/cli/settings/set.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ Use the local config file instead of the global one
2626

2727
Examples:
2828

29-
mise settings legacy_version_file=true
29+
mise settings idiomatic_version_file=true

docs/cli/settings/unset.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ Use the local config file instead of the global one
2222

2323
Examples:
2424

25-
mise settings unset legacy_version_file
25+
mise settings unset idiomatic_version_file

docs/configuration.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,8 @@ python = ['3.10', '3.11']
157157
[settings]
158158
# plugins can read the versions files used by other version managers (if enabled by the plugin)
159159
# for example, .nvmrc in the case of node's nvm
160-
legacy_version_file = true # enabled by default (unlike asdf)
161-
legacy_version_file_disable_tools = ['python'] # disable for specific tools
160+
idiomatic_version_file = true # enabled by default (unlike asdf)
161+
idiomatic_version_file_disable_tools = ['python'] # disable for specific tools
162162

163163
# configure `mise install` to always keep the downloaded archive
164164
always_keep_download = false # deleted after install by default
@@ -240,38 +240,38 @@ Both `.mise.toml` and `.tool-versions` support "scopes" which modify the behavio
240240
be used to express something like "2 versions behind lts" such as `sub-2:lts`. Or 1 minor
241241
version behind the latest version: `sub-0.1:latest`.
242242

243-
## Legacy version files
243+
## Idiomatic version files
244244

245-
mise supports "legacy version files" just like asdf. They're language-specific files
245+
mise supports "idiomatic version files" just like asdf. They're language-specific files
246246
like `.node-version`
247247
and `.python-version`. These are ideal for setting the runtime version of a project without forcing
248248
other developers to use a specific tool like mise/asdf.
249249

250250
They support aliases, which means you can have an `.nvmrc` file with `lts/hydrogen` and it will work
251-
in mise and nvm. Here are some of the supported legacy version files:
251+
in mise and nvm. Here are some of the supported idiomatic version files:
252252

253-
| Plugin | "Legacy" (Idiomatic) Files |
253+
| Plugin | Idiomatic Files |
254254
| --------- | -------------------------------------------------- |
255255
| crystal | `.crystal-version` |
256256
| elixir | `.exenv-version` |
257257
| go | `.go-version`, `go.mod` |
258258
| java | `.java-version`, `.sdkmanrc` |
259259
| node | `.nvmrc`, `.node-version` |
260-
| python | `.python-version` |
260+
| python | `.python-version`, `.python-versions` |
261261
| ruby | `.ruby-version`, `Gemfile` |
262262
| terraform | `.terraform-version`, `.packer-version`, `main.tf` |
263263
| yarn | `.yarnrc` |
264264

265265
In mise these are enabled by default. You can disable them
266-
with `mise settings legacy_version_file=false`.
266+
with `mise settings idiomatic_version_file=false`.
267267
There is a performance cost to having these when they're parsed as it's performed by the plugin in
268-
`bin/parse-version-file`. However these are [cached](/cache-behavior) so it's not a huge deal.
268+
`bin/parse-version-file`. However, these are [cached](/cache-behavior) so it's not a huge deal.
269269
You may not even notice.
270270

271271
::: info
272-
asdf calls these "legacy version files" so we do too. I think this is a bad name since it implies
272+
asdf called these "legacy version files". I think this was a bad name since it implies
273273
that they shouldn't be used—which is definitely not the case IMO. I prefer the term "idiomatic"
274-
version files since they're version files not specific to asdf/mise and can be used by other tools.
274+
version files since they are version files not specific to asdf/mise and can be used by other tools.
275275
(`.nvmrc` being a notable exception, which is tied to a specific tool.)
276276
:::
277277

docs/lang/java.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@ sudo ln -s ~/.local/share/mise/installs/java/openjdk-21/Contents /Library/Java/J
5858

5959
> Note: Not all distributions of the Java SDK support this integration (e.g liberica).
6060
61-
## Legacy version files
61+
## Idiomatic version files
6262

63-
The Java core plugin supports the legacy version files `.java-version` and `.sdkmanrc`.
63+
The Java core plugin supports the idiomatic version files `.java-version` and `.sdkmanrc`.
6464

6565
For `.sdkmanrc` files, mise will try to map the vendor and version to the appropriate version
6666
string. For example, the version `20.0.2-tem` will be mapped to `temurin-20.0.2`. Due to Azul's Zulu

0 commit comments

Comments
 (0)