Skip to content

docs(settings): prefer assignment form for set examples#10271

Merged
jdx merged 1 commit into
mainfrom
codex/settings-set-assignment-docs
Jun 8, 2026
Merged

docs(settings): prefer assignment form for set examples#10271
jdx merged 1 commit into
mainfrom
codex/settings-set-assignment-docs

Conversation

@jdx

@jdx jdx commented Jun 8, 2026

Copy link
Copy Markdown
Owner

Summary

  • use mise settings set key=value in docs and CLI hints where it shortens examples
  • keep settings add user-facing examples in the clearer append-style form
  • exercise settings add key=value for idiomatic_version_file_enable_tools in e2e coverage

Tests

  • mise run test:e2e e2e/cli/test_settings_set e2e/cli/test_settings_add

This PR was generated by an AI coding assistant.


Note

Low Risk
Copy-only and documentation changes with no settings CLI logic modified in this diff.

Overview
Documentation and in-app hints now show mise settings set key=value instead of space-separated key value, including the shared “Settings” boilerplate on backend/lang pages, GitHub token and age encryption guides, and dotnet/python examples.

Runtime messages in the node and python core plugins were updated to match (e.g. node.flavor=<flavor>, python.compile=false). E2e test_settings_add now exercises settings add idiomatic_version_file_enable_tools=python (and comma lists) alongside the existing append-style add cases.

Reviewed by Cursor Bugbot for commit e4e3f71. Bugbot is set up for automated code reviews on this repo. Configure here.

Summary by CodeRabbit

  • Documentation

    • Updated command examples across backend and language documentation to use key=value syntax format for settings configuration.
  • Tests

    • Updated tests to align with settings command syntax changes.

@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

All documentation examples and user-facing messages across backends, language plugins, and environment configuration guides are standardized to use key=value syntax for mise settings set commands instead of space-separated arguments. Test expectations are aligned with the new syntax.

Changes

Standardize mise settings command syntax

Layer / File(s) Summary
Backend documentation syntax updates
docs/dev-tools/backends/cargo.md, conda.md, dotnet.md, gem.md, npm.md, pipx.md
Settings sections updated to show mise settings set VARIABLE=VALUE format in all backend tool documentation.
Language and environment documentation syntax updates
docs/dev-tools/github-tokens.md, docs/environments/secrets/age.md, docs/lang/dotnet.md, docs/lang/python.md
Configuration examples for Python, .NET, GitHub tokens, and age secrets updated to demonstrate VARIABLE=VALUE command syntax.
Test expectations and user-facing messages
e2e/cli/test_settings_add, src/plugins/core/node.rs, src/plugins/core/python.rs
End-to-end test assertions and warning messages updated to expect and instruct the new key=value syntax for settings commands.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 Commands once spaced, now linked with cheer,
With equals signs, the syntax's clear!
From docs to tests, a unified way,
mise settings set, hooray, hooray! 🎉

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs(settings): prefer assignment form for set examples' accurately summarizes the main change - updating documentation and CLI hints to use assignment syntax for settings commands.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/settings-set-assignment-docs

Comment @coderabbitai help to get the list of available commands and usage tips.

@greptile-apps

greptile-apps Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR standardizes mise settings set examples across docs and CLI hint/warning messages to use the key=value assignment form instead of space-separated key value, and adds e2e coverage for mise settings add key=value on idiomatic_version_file_enable_tools.

  • Docs (10 files): All occurrences of mise settings set [VARIABLE] [VALUE] and concrete shell examples updated to mise settings set [VARIABLE]=[VALUE] consistently.
  • Rust sources: Two runtime messages (node.rs flavor hint, python.rs compile warning) updated to reflect the preferred syntax.
  • E2E test: Two assertions in test_settings_add switched to key=value form while retaining a neighboring space-form assertion, confirming both variants are accepted by settings add.

Confidence Score: 5/5

Safe to merge — all changes are documentation and message string updates with no logic modifications.

Every change is a mechanical string replacement from space-separated to assignment-form syntax in docs, CLI hints, and e2e assertions. The e2e test intentionally mixes both forms on adjacent lines to confirm backward compatibility, so no regressions are expected.

No files require special attention.

Important Files Changed

Filename Overview
e2e/cli/test_settings_add E2E test: two assertions switched to key=value form for idiomatic_version_file_enable_tools, exercising the assignment syntax alongside the pre-existing space-form assertion on line 11.
src/plugins/core/node.rs Runtime hint message updated to use assignment form for node.flavor setting.
src/plugins/core/python.rs Warning message updated to use assignment form for python.compile setting.
docs/dev-tools/github-tokens.md Documentation: two shell examples updated to assignment form, including one with a subshell-expanded value; shell quoting remains correct.
docs/lang/dotnet.md Documentation: two examples updated to assignment form for idiomatic version file and isolated mode settings.
docs/dev-tools/backends/cargo.md Documentation: updated settings command syntax from space-separated to assignment form.
docs/dev-tools/backends/conda.md Documentation: updated settings command syntax from space-separated to assignment form.
docs/dev-tools/backends/dotnet.md Documentation: updated settings command syntax from space-separated to assignment form.
docs/dev-tools/backends/gem.md Documentation: updated settings command syntax from space-separated to assignment form.
docs/dev-tools/backends/npm.md Documentation: updated settings command syntax from space-separated to assignment form.
docs/dev-tools/backends/pipx.md Documentation: updated settings command syntax from space-separated to assignment form.
docs/environments/secrets/age.md Documentation: two examples updated to assignment form for enabling experimental features and disabling strict mode.
docs/lang/python.md Documentation: settings syntax description updated to assignment form.

Reviews (1): Last reviewed commit: "docs(settings): prefer assignment form f..." | Re-trigger Greptile

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown

Hyperfine Performance

mise x -- echo

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.6.1 x -- echo 22.3 ± 1.6 19.4 28.9 1.00
mise x -- echo 22.7 ± 2.0 19.6 47.1 1.02 ± 0.12

mise env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.6.1 env 20.5 ± 1.3 18.2 25.3 1.00
mise env 21.2 ± 1.3 18.5 27.8 1.04 ± 0.09

mise hook-env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.6.1 hook-env 21.8 ± 1.3 18.8 26.1 1.00
mise hook-env 22.8 ± 1.4 19.7 30.9 1.04 ± 0.09

mise ls

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.6.1 ls 18.2 ± 1.3 15.0 23.2 1.00
mise ls 18.4 ± 1.4 15.5 25.2 1.01 ± 0.10

xtasks/test/perf

Command mise-2026.6.1 mise Variance
install (cached) 153ms 154ms +0%
ls (cached) 70ms 68ms +2%
bin-paths (cached) 76ms 76ms +0%
task-ls (cached) 147ms 146ms +0%

@jdx jdx merged commit df2790a into main Jun 8, 2026
33 of 35 checks passed
@jdx jdx deleted the codex/settings-set-assignment-docs branch June 8, 2026 21:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant