docs: added source code links

jdx · Oct 27, 2024 · aca3036 · aca3036
1 parent 615a28c
commit aca3036
Show file tree

Hide file tree

Showing 79 changed files with 275 additions and 117 deletions.
diff --git a/.mise.toml b/.mise.toml
@@ -24,7 +24,7 @@ direnv = "latest"
 actionlint = "latest"
 ripgrep = "latest"
 "pipx:toml-sort" = "latest"
-usage = "latest"
+usage = "0.12.1"
 #python = { version = "latest", virtualenv = "{{env.HOME}}/.cache/venv" }
 #ruby = "3.1"
 

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -118,7 +118,7 @@ toml_edit = { version = "0.22", features = ["parse"] }
 ubi = { version = "0.2", default-features = false }
 url = "2"
 # usage-lib = { path = "../usage/lib", features = ["clap", "docs"] }
-usage-lib = { version = "0.11", features = ["clap", "docs"] }
+usage-lib = { version = "0.12", features = ["clap", "docs"] }
 versions = { version = "6", features = ["serde"] }
 # vfox = { path="../vfox.rs" }
 vfox = "0.2"

diff --git a/docs/cli/activate.md b/docs/cli/activate.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise activate [--shims] [-q --quiet] [SHELL_TYPE]`
 
+**Source code**: [`src/cli/activate.rs`](https://github.com/jdx/mise/blob/main/src/cli/activate.rs)
+
 Initializes mise in the current shell session
 
 This should go into your shell's rc file.

diff --git a/docs/cli/alias.md b/docs/cli/alias.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise alias [-p --plugin <PLUGIN>] [--no-header] <SUBCOMMAND>`
 
+**Source code**: [`src/cli/alias.rs`](https://github.com/jdx/mise/blob/main/src/cli/alias.rs)
+
 **Aliases**: `a`
 
 Manage aliases
@@ -18,7 +20,7 @@ Don't show table header
 
 ## Subcommands
 
-* [`mise alias get <PLUGIN> <ALIAS>`](/cli/alias/get.md)
-* [`mise alias ls [--no-header] [PLUGIN]`](/cli/alias/ls.md)
-* [`mise alias set <ARGS>…`](/cli/alias/set.md)
-* [`mise alias unset <PLUGIN> <ALIAS>`](/cli/alias/unset.md)
+- [`mise alias get <PLUGIN> <ALIAS>`](/cli/alias/get.md)
+- [`mise alias ls [--no-header] [PLUGIN]`](/cli/alias/ls.md)
+- [`mise alias set <ARGS>…`](/cli/alias/set.md)
+- [`mise alias unset <PLUGIN> <ALIAS>`](/cli/alias/unset.md)
diff --git a/docs/cli/alias/get.md b/docs/cli/alias/get.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise alias get <PLUGIN> <ALIAS>`
 
+**Source code**: [`src/cli/alias/get.rs`](https://github.com/jdx/mise/blob/main/src/cli/alias/get.rs)
+
 Show an alias for a plugin
 
 This is the contents of an alias.&lt;PLUGIN> entry in ~/.config/mise/config.toml

diff --git a/docs/cli/alias/ls.md b/docs/cli/alias/ls.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise alias ls [--no-header] [PLUGIN]`
 
+**Source code**: [`src/cli/alias/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/alias/ls.rs)
+
 **Aliases**: `list`
 
 List aliases

diff --git a/docs/cli/alias/set.md b/docs/cli/alias/set.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise alias set <ARGS>…`
 
+**Source code**: [`src/cli/alias/set.rs`](https://github.com/jdx/mise/blob/main/src/cli/alias/set.rs)
+
 **Aliases**: `add`, `create`
 
 Add/update an alias for a plugin

diff --git a/docs/cli/alias/unset.md b/docs/cli/alias/unset.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise alias unset <PLUGIN> <ALIAS>`
 
+**Source code**: [`src/cli/alias/unset.rs`](https://github.com/jdx/mise/blob/main/src/cli/alias/unset.rs)
+
 **Aliases**: `rm`, `remove`, `delete`, `del`
 
 Clears an alias for a plugin

diff --git a/docs/cli/backends.md b/docs/cli/backends.md
@@ -2,10 +2,12 @@
 
 **Usage**: `mise backends <SUBCOMMAND>`
 
+**Source code**: [`src/cli/backends.rs`](https://github.com/jdx/mise/blob/main/src/cli/backends.rs)
+
 **Aliases**: `b`
 
 Manage backends
 
 ## Subcommands
 
-* [`mise backends ls`](/cli/backends/ls.md)
+- [`mise backends ls`](/cli/backends/ls.md)
diff --git a/docs/cli/backends/ls.md b/docs/cli/backends/ls.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise backends ls`
 
+**Source code**: [`src/cli/backends/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/backends/ls.rs)
+
 **Aliases**: `list`
 
 List built-in backends

diff --git a/docs/cli/bin-paths.md b/docs/cli/bin-paths.md
@@ -2,4 +2,6 @@
 
 **Usage**: `mise bin-paths`
 
+**Source code**: [`src/cli/bin-paths.rs`](https://github.com/jdx/mise/blob/main/src/cli/bin-paths.rs)
+
 List all the active runtime bin paths
diff --git a/docs/cli/cache.md b/docs/cli/cache.md
@@ -2,11 +2,13 @@
 
 **Usage**: `mise cache <SUBCOMMAND>`
 
+**Source code**: [`src/cli/cache.rs`](https://github.com/jdx/mise/blob/main/src/cli/cache.rs)
+
 Manage the mise cache
 
 Run `mise cache` with no args to view the current cache directory.
 
 ## Subcommands
 
-* [`mise cache clear [PLUGIN]...`](/cli/cache/clear.md)
-* [`mise cache prune [--dry-run] [-v --verbose...] [PLUGIN]...`](/cli/cache/prune.md)
+- [`mise cache clear [PLUGIN]...`](/cli/cache/clear.md)
+- [`mise cache prune [--dry-run] [-v --verbose...] [PLUGIN]...`](/cli/cache/prune.md)
diff --git a/docs/cli/cache/clear.md b/docs/cli/cache/clear.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise cache clear [PLUGIN]...`
 
+**Source code**: [`src/cli/cache/clear.rs`](https://github.com/jdx/mise/blob/main/src/cli/cache/clear.rs)
+
 **Aliases**: `c`
 
 Deletes all cache files in mise

diff --git a/docs/cli/cache/prune.md b/docs/cli/cache/prune.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise cache prune [--dry-run] [-v --verbose...] [PLUGIN]...`
 
+**Source code**: [`src/cli/cache/prune.rs`](https://github.com/jdx/mise/blob/main/src/cli/cache/prune.rs)
+
 **Aliases**: `p`
 
 Removes stale mise cache files

diff --git a/docs/cli/completion.md b/docs/cli/completion.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise completion [SHELL]`
 
+**Source code**: [`src/cli/completion.rs`](https://github.com/jdx/mise/blob/main/src/cli/completion.rs)
+
 Generate shell completions
 
 ## Arguments

diff --git a/docs/cli/config.md b/docs/cli/config.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise config [--no-header] [-J --json] <SUBCOMMAND>`
 
+**Source code**: [`src/cli/config.rs`](https://github.com/jdx/mise/blob/main/src/cli/config.rs)
+
 **Aliases**: `cfg`
 
 Manage config files
@@ -18,7 +20,7 @@ Output in JSON format
 
 ## Subcommands
 
-* [`mise config generate [-o --output <OUTPUT>]`](/cli/config/generate.md)
-* [`mise config get [-f --file <FILE>] [KEY]`](/cli/config/get.md)
-* [`mise config ls [--no-header] [-J --json]`](/cli/config/ls.md)
-* [`mise config set [-f --file <FILE>] [-t --type <TYPE>] <KEY> <VALUE>`](/cli/config/set.md)
+- [`mise config generate [-o --output <OUTPUT>]`](/cli/config/generate.md)
+- [`mise config get [-f --file <FILE>] [KEY]`](/cli/config/get.md)
+- [`mise config ls [--no-header] [-J --json]`](/cli/config/ls.md)
+- [`mise config set [-f --file <FILE>] [-t --type <TYPE>] <KEY> <VALUE>`](/cli/config/set.md)
diff --git a/docs/cli/config/generate.md b/docs/cli/config/generate.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise config generate [-o --output <OUTPUT>]`
 
+**Source code**: [`src/cli/config/generate.rs`](https://github.com/jdx/mise/blob/main/src/cli/config/generate.rs)
+
 **Aliases**: `g`
 
 [experimental] Generate a mise.toml file

diff --git a/docs/cli/config/get.md b/docs/cli/config/get.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise config get [-f --file <FILE>] [KEY]`
 
+**Source code**: [`src/cli/config/get.rs`](https://github.com/jdx/mise/blob/main/src/cli/config/get.rs)
+
 Display the value of a setting in a mise.toml file
 
 ## Arguments

diff --git a/docs/cli/config/ls.md b/docs/cli/config/ls.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise config ls [--no-header] [-J --json]`
 
+**Source code**: [`src/cli/config/ls.rs`](https://github.com/jdx/mise/blob/main/src/cli/config/ls.rs)
+
 List config files currently in use
 
 ## Flags

diff --git a/docs/cli/config/set.md b/docs/cli/config/set.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise config set [-f --file <FILE>] [-t --type <TYPE>] <KEY> <VALUE>`
 
+**Source code**: [`src/cli/config/set.rs`](https://github.com/jdx/mise/blob/main/src/cli/config/set.rs)
+
 Display the value of a setting in a mise.toml file
 
 ## Arguments

diff --git a/docs/cli/deactivate.md b/docs/cli/deactivate.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise deactivate`
 
+**Source code**: [`src/cli/deactivate.rs`](https://github.com/jdx/mise/blob/main/src/cli/deactivate.rs)
+
 Disable mise for current shell session
 
 This can be used to temporarily disable mise in a shell session.

diff --git a/docs/cli/direnv.md b/docs/cli/direnv.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise direnv <SUBCOMMAND>`
 
+**Source code**: [`src/cli/direnv.rs`](https://github.com/jdx/mise/blob/main/src/cli/direnv.rs)
+
 Output direnv function to use mise inside direnv
 
 See <https://mise.jdx.dev/direnv.html> for more information
@@ -12,4 +14,4 @@ direnv may not know to update environment variables when legacy file versions ch
 
 ## Subcommands
 
-* [`mise direnv activate`](/cli/direnv/activate.md)
+- [`mise direnv activate`](/cli/direnv/activate.md)
diff --git a/docs/cli/direnv/activate.md b/docs/cli/direnv/activate.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise direnv activate`
 
+**Source code**: [`src/cli/direnv/activate.rs`](https://github.com/jdx/mise/blob/main/src/cli/direnv/activate.rs)
+
 Output direnv function to use mise inside direnv
 
 See <https://mise.jdx.dev/direnv.html> for more information

diff --git a/docs/cli/doctor.md b/docs/cli/doctor.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise doctor`
 
+**Source code**: [`src/cli/doctor.rs`](https://github.com/jdx/mise/blob/main/src/cli/doctor.rs)
+
 **Aliases**: `dr`
 
 Check mise installation for possible problems

diff --git a/docs/cli/env.md b/docs/cli/env.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise env [-J --json] [-s --shell <SHELL>] [TOOL@VERSION]...`
 
+**Source code**: [`src/cli/env.rs`](https://github.com/jdx/mise/blob/main/src/cli/env.rs)
+
 **Aliases**: `e`
 
 Exports env vars to activate mise a single time

diff --git a/docs/cli/exec.md b/docs/cli/exec.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise exec [FLAGS] [TOOL@VERSION]... [COMMAND]...`
 
+**Source code**: [`src/cli/exec.rs`](https://github.com/jdx/mise/blob/main/src/cli/exec.rs)
+
 **Aliases**: `x`
 
 Execute a command with tool(s) set

diff --git a/docs/cli/generate.md b/docs/cli/generate.md
@@ -2,12 +2,14 @@
 
 **Usage**: `mise generate <SUBCOMMAND>`
 
+**Source code**: [`src/cli/generate.rs`](https://github.com/jdx/mise/blob/main/src/cli/generate.rs)
+
 **Aliases**: `g`
 
 [experimental] Generate files for various tools/services
 
 ## Subcommands
 
-* [`mise generate git-pre-commit [FLAGS]`](/cli/generate/git-pre-commit.md)
-* [`mise generate github-action [FLAGS]`](/cli/generate/github-action.md)
-* [`mise generate task-docs [FLAGS]`](/cli/generate/task-docs.md)
+- [`mise generate git-pre-commit [FLAGS]`](/cli/generate/git-pre-commit.md)
+- [`mise generate github-action [FLAGS]`](/cli/generate/github-action.md)
+- [`mise generate task-docs [FLAGS]`](/cli/generate/task-docs.md)
diff --git a/docs/cli/generate/git-pre-commit.md b/docs/cli/generate/git-pre-commit.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise generate git-pre-commit [FLAGS]`
 
+**Source code**: [`src/cli/generate/git-pre-commit.rs`](https://github.com/jdx/mise/blob/main/src/cli/generate/git-pre-commit.rs)
+
 **Aliases**: `pre-commit`
 
 [experimental] Generate a git pre-commit hook

diff --git a/docs/cli/generate/github-action.md b/docs/cli/generate/github-action.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise generate github-action [FLAGS]`
 
+**Source code**: [`src/cli/generate/github-action.rs`](https://github.com/jdx/mise/blob/main/src/cli/generate/github-action.rs)
+
 [experimental] Generate a GitHub Action workflow file
 
 This command generates a GitHub Action workflow file that runs a mise task like `mise run ci`

diff --git a/docs/cli/generate/task-docs.md b/docs/cli/generate/task-docs.md
@@ -2,6 +2,8 @@
 
 **Usage**: `mise generate task-docs [FLAGS]`
 
+**Source code**: [`src/cli/generate/task-docs.rs`](https://github.com/jdx/mise/blob/main/src/cli/generate/task-docs.rs)
+
 [experimental] Generate documentation for tasks in a project
 
 ## Flags
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,6 @@

		Usage: `mise bin-paths`

		Source code: [`src/cli/bin-paths.rs`](https://github.com/jdx/mise/blob/main/src/cli/bin-paths.rs)

		List all the active runtime bin paths