-
Notifications
You must be signed in to change notification settings - Fork 369
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revert "docs: set prose-wrap with prettier (#4038)"
This reverts commit 2fba8b0.
- Loading branch information
Showing
73 changed files
with
1,860 additions
and
1,590 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,3 @@ | ||
# mise-docs | ||
|
||
This repository contains the documentation website for the runtime executor [mise](https://github.com/jdx/mise). The | ||
website is powered by [VitePress](https://vitepress.dev/). | ||
This repository contains the documentation website for the runtime executor [mise](https://github.com/jdx/mise). The website is powered by [VitePress](https://vitepress.dev/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,42 @@ | ||
# About | ||
|
||
`mise` (pronounced "meez") or "mise-en-place" is a development environment setup tool. The name refers to a French | ||
culinary phrase that roughly translates to "setup" or "put in place". The idea is that before one begins cooking, they | ||
should have all their utensils and ingredients ready to go in their place. | ||
`mise` (pronounced "meez") or "mise-en-place" is a development environment setup tool. | ||
The name refers to a French culinary phrase that roughly translates to "setup" or "put in place". | ||
The idea is that before one begins cooking, they should have all their utensils and ingredients | ||
ready to go in their place. | ||
|
||
`mise` does the same for your projects. Using its `mise.toml` config file, you'll have a consistent way to setup and | ||
interact with your projects no matter what language they're written in. | ||
`mise` does the same for your projects. Using its `mise.toml` config file, | ||
you'll have a consistent way to setup and interact with your projects no matter what | ||
language they're written in. | ||
|
||
Its functionality is grouped into 3 categories described below. | ||
|
||
`mise` installs and manages dev tools/runtimes like node, python, or terraform both simplifying installing these tools | ||
and allowing you to specify which version of these tools to use in different projects. `mise` supports | ||
[hundreds](/plugins.md) of dev tools. | ||
`mise` installs and manages dev tools/runtimes like node, python, or terraform both | ||
simplifying installing these tools and allowing you to specify which version of these | ||
tools to use in different projects. `mise` supports [hundreds](/plugins.md) of dev tools. | ||
|
||
`mise` manages environment variables letting you specify configuration like `AWS_ACCESS_KEY_ID` that may differ between | ||
projects. It can also be used to automatically activate a [Python virtualenv](/lang/python) when entering projects too. | ||
`mise` manages environment variables letting you specify configuration like | ||
`AWS_ACCESS_KEY_ID` that may differ between projects. It can also be used to | ||
automatically activate a [Python virtualenv](/lang/python) when entering projects too. | ||
|
||
`mise` is a task runner that can be used to share common tasks within a project among developers and make things like | ||
running tasks on file changes easy. | ||
`mise` is a task runner that can be used to share common tasks within | ||
a project among developers and make things like running tasks on file changes | ||
easy. | ||
|
||
## Contact | ||
|
||
`mise` is mostly built and maintained by me, [Jeff Dickey](https://jdx.dev). The goal is to make local development of | ||
software easy and consistent across languages. I have spent many years building dev tools and thinking about the | ||
problems that `mise` addresses. | ||
|
||
I try to use the first-person in these docs since the reality is it's generally me writing them and I think it makes it | ||
more interesting having a bit of my personality in the text. | ||
|
||
This project is simply a labor of love. I am making it because I want to make your life as a developer easier. I hope | ||
you find it useful. Feedback is a massive driver for me. If you have anything positive or negative to say-even if it's | ||
just to say hi-please reach out to me either on [Twitter](https://twitter.com/jdxcode), | ||
[Mastodon](https://fosstodon.org/@jdx), [Discord](https://discord.gg/UBa7pJUN7Z), or `jdx at this domain`. | ||
`mise` is mostly built and maintained by me, [Jeff Dickey](https://jdx.dev). The goal is | ||
to make local development of software easy and consistent across languages. I | ||
have spent many years building dev tools and thinking about the problems that `mise` | ||
addresses. | ||
|
||
I try to use the first-person in these docs since the reality is it's generally me | ||
writing them and I think it makes it more interesting having a bit of my personality | ||
in the text. | ||
|
||
This project is simply a labor of love. I am making it because I want to make | ||
your life as a developer easier. I hope you find it useful. Feedback is a massive | ||
driver for me. If you have anything positive or negative to say-even if it's just | ||
to say hi-please reach out to me either on [Twitter](https://twitter.com/jdxcode), | ||
[Mastodon](https://fosstodon.org/@jdx), [Discord](https://discord.gg/UBa7pJUN7Z), | ||
or `jdx at this domain`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,31 @@ | ||
# Cache Behavior | ||
|
||
mise makes use of caching in many places in order to be efficient. The details about how long to keep cache for should | ||
eventually all be configurable. There may be gaps in the current behavior where things are hardcoded, but I'm happy to | ||
add more settings to cover whatever config is needed. | ||
mise makes use of caching in many places in order to be efficient. The details about how long to keep | ||
cache for should eventually all be configurable. There may be gaps in the current behavior where | ||
things are hardcoded, but I'm happy to add more settings to cover whatever config is needed. | ||
|
||
Below I explain the behavior it uses around caching. If you're seeing behavior where things don't appear to be updating, | ||
this is a good place to start. | ||
Below I explain the behavior it uses around caching. If you're seeing behavior where things don't appear | ||
to be updating, this is a good place to start. | ||
|
||
## Plugin/Runtime Cache | ||
|
||
Each plugin has a cache that's stored in `~/$MISE_CACHE_DIR/<PLUGIN>`. It stores the list of versions available for that | ||
plugin (`mise ls-remote <PLUGIN>`), the idiomatic filenames (see below), the list of aliases, the bin directories within | ||
each runtime installation, and the result of running `exec-env` after the runtime was installed. | ||
Each plugin has a cache that's stored in `~/$MISE_CACHE_DIR/<PLUGIN>`. It stores | ||
the list of versions available for that plugin (`mise ls-remote <PLUGIN>`), the idiomatic filenames (see below), | ||
the list of aliases, the bin directories within each runtime installation, and the result of | ||
running `exec-env` after the runtime was installed. | ||
|
||
Remote versions are updated daily by default. The file is zlib messagepack, if you want to view it you can run the | ||
following (requires [msgpack-cli](https://github.com/msgpack/msgpack-cli)). | ||
Remote versions are updated daily by default. The file is zlib messagepack, if you want to view it you can | ||
run the following (requires [msgpack-cli](https://github.com/msgpack/msgpack-cli)). | ||
|
||
```sh | ||
cat ~/$MISE_CACHE_DIR/node/remote_versions.msgpack.z | perl -e 'use Compress::Raw::Zlib;my $d=new Compress::Raw::Zlib::Inflate();my $o;undef $/;$d->inflate(<>,$o);print $o;' | msgpack-cli decode | ||
``` | ||
|
||
Note that the caching of `exec-env` may be problematic if the script isn't simply exporting static values. The vast | ||
majority of `exec-env` scripts only export static values, but if you're working with a plugin that has a dynamic | ||
`exec-env` submit a ticket and we can try to figure out what to do. | ||
Note that the caching of `exec-env` may be problematic if the script isn't simply exporting | ||
static values. The vast majority of `exec-env` scripts only export static values, but if you're | ||
working with a plugin that has a dynamic `exec-env` submit | ||
a ticket and we can try to figure out what to do. | ||
|
||
Caching `exec-env` massively improved the performance of mise since it requires calling bash every time mise is | ||
initialized. Ideally, we can keep this behavior. | ||
Caching `exec-env` massively improved the performance of mise since it requires calling bash | ||
every time mise is initialized. Ideally, we can keep this | ||
behavior. |
Oops, something went wrong.