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

Set up subcommands for non-core tasks #107

Open
dhruvkb opened this issue Sep 12, 2024 · 0 comments
Open

Set up subcommands for non-core tasks #107

dhruvkb opened this issue Sep 12, 2024 · 0 comments
Labels
🕹 aspect: interface Concerns end-users' experience with the software 🌟 goal: addition Addition of new feature 🟨 priority: medium Not blocking but should be fixed soon 🦀 tech: rust Requires familiarity with Rust

Comments

@dhruvkb
Copy link
Member

dhruvkb commented Sep 12, 2024

Problem

pls is currently one command that does the core job. We should structure it to accept subcommands to do non-core jobs like the following:

  • check for updates

    This should only check if a newer version is available. There is no need to automatically update the application, we let the package manager handle this. To be fair, most package managers will automatically install the update too.

  • show help

    This should show the help that is currently triggered by --help. Help is technically a separate action and, conceptually, should not be an option within the main command.

  • open the docs

    We have expansive in-depth documentation at https://pls.cli.rs. This command should print this URL, in a manner that terminals recognise as links, and also support opening the web documentation in the user's default browser.

  • check the config

    This command should verify the pls config file to check if there are syntax errors, and unrecognised or deprecated keys (suggesting fixes for those).

  • print diagnostic info

    This command should print some diagnostic information such as the pls version, the OS name and version and other dependencies like Git and the current Terminal emulator. This makes it easier to reproduce bugs reported by users.

Description

Add pls subcommands to do the above mentioned things.

@dhruvkb dhruvkb added 🟨 priority: medium Not blocking but should be fixed soon 🌟 goal: addition Addition of new feature 🕹 aspect: interface Concerns end-users' experience with the software 🦀 tech: rust Requires familiarity with Rust labels Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🕹 aspect: interface Concerns end-users' experience with the software 🌟 goal: addition Addition of new feature 🟨 priority: medium Not blocking but should be fixed soon 🦀 tech: rust Requires familiarity with Rust
Projects
None yet
Development

No branches or pull requests

1 participant