Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tauri CLI 2.0 DX Improvements #7572

Closed
1 of 4 tasks
Tracked by #1344
tauri-bot opened this issue Aug 9, 2023 · 1 comment
Closed
1 of 4 tasks
Tracked by #1344

Tauri CLI 2.0 DX Improvements #7572

tauri-bot opened this issue Aug 9, 2023 · 1 comment

Comments

@tauri-bot
Copy link

tauri-bot commented Aug 9, 2023

This issue has been upstreamed from tauri-apps/tauri-docs#1373

Issues related to tauri-apps/tauri-docs#1365

Could we adjust a few things in the Tauri CLI to improve the DX:

  • Add this (or similar) to help for dev:

This command will open the WebView in development mode. It makes use of the build.devPath property from your tauri.conf.json file.
If you have entered a command to the build.beforeDevCommand property, this one will be executed before the dev command.

  • Add this (or similar) to help for info:

tauri info shows a concise list of information about the environment, Rust, Node.js and their versions as well as a few relevant project configurations.

  • Add better copy for completions command:

The Tauri CLI can generate shell completions for Bash, Zsh, PowerShell and Fish.

Are there any instructions after running this command on how to actually make it kick into place? If so could we include those in either the help comments or log them out so the user isn't confused on why things aren't working? @FabianLars wrote some amazing things here that I think belongs in the CLI instead.

We've talked about this on a few places and I've not heard anything against this, but open to discussion if needed. Basically let's simplify this stuff as much as possible. End users don't care so much about if it's a plugin, they care about the functionality.

@simonhyll
Copy link
Contributor

simonhyll commented Aug 9, 2023

Add better copy for completions command:
Are there any instructions after running this command on how to actually make it kick into place?

Not really, completions is a pretty well known concept and command for CLI tools to have. There's plenty of resources online on how to install them. Though I suppose we could probably make a --install flag for it that attempts to set it up for you. The issue with that is just that on some systems (mainly Linux afaik) there's an extra dependency to be installed in order for completions to work, so unless you want the --install flag to also handle installing such dependencies I think it might be best to let the users who want completions to simply Google "how to install [THEIR_SHELL] completions"

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

No branches or pull requests

2 participants