feat: support shell completions in `tedge` cli #3332

jarhodes314 · 2025-01-15T18:06:05Z

Proposed changes

This adds shell completions (bash, zsh, fish) to the tedge CLI. It should be fairly self explanatory, and the documentation added in the PR should explain how you can enable the feature for testing locally.

Types of changes

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
Documentation Update (if none of the other choices apply)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue

Generate shell completions for tedge CLI #3331

Checklist

I have read the CONTRIBUTING doc
I have signed the CLA (in all commits with git commit -s)
I ran cargo fmt as mentioned in CODING_GUIDELINES
I used cargo clippy as mentioned in CODING_GUIDELINES
I have added tests that prove my fix is effective or that my feature works
I have added necessary documentation (if appropriate)

Further comments

docs/src/install/index.md

codecov · 2025-01-15T18:18:39Z

Codecov Report

Attention: Patch coverage is 48.78049% with 63 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
crates/core/tedge/src/cli/completions.rs	0.00%	33 Missing ⚠️
crates/core/tedge/src/cli/common.rs	0.00%	12 Missing ⚠️
crates/common/tedge_config/src/cli.rs	0.00%	7 Missing ⚠️
crates/core/tedge/src/cli/mqtt/cli.rs	0.00%	7 Missing ⚠️
...mon/tedge_config_macros/impl/src/input/validate.rs	91.30%	2 Missing ⚠️
crates/core/tedge/src/cli/mod.rs	0.00%	2 Missing ⚠️

Additional details and impacted files

📢 Thoughts on this report? Let us know!

github-actions · 2025-01-16T09:43:54Z

Robot Results

✅ Passed	❌ Failed	⏭️ Skipped	Total	Pass %	⏱️ Duration
552	0	2	552	100	1h28m42.141327999s

didier-wenzek

Testing this PR with zsh I noticed some weirdness, however overall completion is working nicely.

Completion on tedge config set is fantastic!

The weirdness seems to be due to the overly complicated argument logic of thin-edge.

e.g. --config-dir, --debug, --log-level are never proposed for completion

didier-wenzek · 2025-01-16T09:27:21Z

crates/core/tedge/src/cli/mqtt/cli.rs

+fn qos_completions() -> Vec<CompletionCandidate> {
+    vec![
+        CompletionCandidate::new("0").help(Some("At most once".into())),
+        CompletionCandidate::new("1").help(Some("At least once".into())),
+        CompletionCandidate::new("2").help(Some("Exactly once".into())),
+    ]
+}
+


Really nice

$ tedge mqtt pub --qos <TAB> 0 -- At most once 1 -- At least once 2 -- Exactly once

didier-wenzek · 2025-01-16T09:33:56Z

crates/core/tedge/src/cli/certificate/cli.rs

+        #[clap(long = "output-path", global = true, value_hint = ValueHint::FilePath)]
        output_path: Option<Utf8PathBuf>,


We might have to add this hint for other path (e.g. --config-dir ).

Good point, I also need to make a modification to support the global arguments

Added the hint and fixed the issue where the global arguments weren't completed

Any chance to get the --log-level value also completed? e.g. tedge --log-level <TAB><TAB>

Perfect, works as expected

docs/src/install/index.md

jarhodes314 · 2025-01-16T16:48:22Z

The weirdness seems to be due to the overly complicated argument logic of thin-edge.

e.g. --config-dir, --debug, --log-level are never proposed for completion

Now fixed

Signed-off-by: James Rhodes <[email protected]>

reubenmiller

Approving (from a UX point of view). Still wait for a Rust review.

Really nice addition. We can work out any packaging aspects in a follow up PR

didier-wenzek

Approved. Quickly and nicely done.

didier-wenzek · 2025-01-16T19:41:21Z

crates/core/tedge/src/cli/common.rs

+/// This will infer the profile names from the various cloud configurations.
+/// It would be significantly more complicated to try and do per-cloud
+/// completions, and would likely provide no real value to anyone.


That seems reasonable.

jarhodes314 requested review from didier-wenzek, albinsuresh, rina23q and reubenmiller as code owners January 15, 2025 18:06

jarhodes314 temporarily deployed to Test Pull Request January 15, 2025 18:06 — with GitHub Actions Inactive

jarhodes314 commented Jan 15, 2025

View reviewed changes

docs/src/install/index.md Outdated Show resolved Hide resolved

jarhodes314 had a problem deploying to Test Auto January 16, 2025 09:27 — with GitHub Actions Failure

didier-wenzek reviewed Jan 16, 2025

View reviewed changes

reubenmiller reviewed Jan 16, 2025

View reviewed changes

docs/src/install/index.md Outdated Show resolved Hide resolved

reubenmiller reviewed Jan 16, 2025

View reviewed changes

docs/src/install/index.md Outdated Show resolved Hide resolved

reubenmiller reviewed Jan 16, 2025

View reviewed changes

docs/src/install/index.md Outdated Show resolved Hide resolved

reubenmiller added theme:cli Theme: cli related topics theme:developer-exp and removed theme:developer-exp labels Jan 16, 2025

jarhodes314 temporarily deployed to Test Auto January 16, 2025 14:38 — with GitHub Actions Inactive

jarhodes314 requested a deployment to Test Pull Request January 16, 2025 16:47 — with GitHub Actions Waiting

jarhodes314 force-pushed the feat/shell-completions branch from 7a2c5b8 to 3e2332b Compare January 16, 2025 16:58

jarhodes314 requested a deployment to Test Pull Request January 16, 2025 16:58 — with GitHub Actions Waiting

feat: support shell completions in tedge cli

1cf7710

Signed-off-by: James Rhodes <[email protected]>

jarhodes314 force-pushed the feat/shell-completions branch from 3e2332b to 1cf7710 Compare January 16, 2025 16:59

jarhodes314 temporarily deployed to Test Pull Request January 16, 2025 16:59 — with GitHub Actions Inactive

jarhodes314 requested review from reubenmiller and didier-wenzek January 16, 2025 17:01

jarhodes314 temporarily deployed to Test Auto January 16, 2025 17:09 — with GitHub Actions Inactive

Add tab completions for --log-level

166b1a9

jarhodes314 temporarily deployed to Test Pull Request January 16, 2025 17:56 — with GitHub Actions Inactive

jarhodes314 temporarily deployed to Test Auto January 16, 2025 18:04 — with GitHub Actions Inactive

reubenmiller approved these changes Jan 16, 2025

View reviewed changes

didier-wenzek approved these changes Jan 16, 2025

View reviewed changes

jarhodes314 added this pull request to the merge queue Jan 16, 2025

Merged via the queue into thin-edge:main with commit 03b0756 Jan 16, 2025
33 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support shell completions in `tedge` cli #3332

feat: support shell completions in `tedge` cli #3332

jarhodes314 commented Jan 15, 2025 •

edited by reubenmiller

Loading

codecov bot commented Jan 15, 2025 •

edited

Loading

github-actions bot commented Jan 16, 2025 •

edited

Loading

didier-wenzek left a comment

didier-wenzek Jan 16, 2025

didier-wenzek Jan 16, 2025

jarhodes314 Jan 16, 2025

jarhodes314 Jan 16, 2025

reubenmiller Jan 16, 2025

reubenmiller Jan 16, 2025

jarhodes314 commented Jan 16, 2025

reubenmiller left a comment

didier-wenzek left a comment

didier-wenzek Jan 16, 2025

		#[clap(long = "output-path", global = true, value_hint = ValueHint::FilePath)]
		output_path: Option<Utf8PathBuf>,

feat: support shell completions in tedge cli #3332

feat: support shell completions in tedge cli #3332

Conversation

jarhodes314 commented Jan 15, 2025 • edited by reubenmiller Loading

Proposed changes

Types of changes

Paste Link to the issue

Checklist

Further comments

codecov bot commented Jan 15, 2025 • edited Loading

Codecov Report

github-actions bot commented Jan 16, 2025 • edited Loading

Robot Results

didier-wenzek left a comment

Choose a reason for hiding this comment

didier-wenzek Jan 16, 2025

Choose a reason for hiding this comment

didier-wenzek Jan 16, 2025

Choose a reason for hiding this comment

jarhodes314 Jan 16, 2025

Choose a reason for hiding this comment

jarhodes314 Jan 16, 2025

Choose a reason for hiding this comment

reubenmiller Jan 16, 2025

Choose a reason for hiding this comment

reubenmiller Jan 16, 2025

Choose a reason for hiding this comment

jarhodes314 commented Jan 16, 2025

reubenmiller left a comment

Choose a reason for hiding this comment

didier-wenzek left a comment

Choose a reason for hiding this comment

didier-wenzek Jan 16, 2025

Choose a reason for hiding this comment

feat: support shell completions in `tedge` cli #3332

feat: support shell completions in `tedge` cli #3332

jarhodes314 commented Jan 15, 2025 •

edited by reubenmiller

Loading

codecov bot commented Jan 15, 2025 •

edited

Loading

github-actions bot commented Jan 16, 2025 •

edited

Loading