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

Implement set-project subcommand #3656

Merged
merged 1 commit into from
Jun 19, 2024
Merged

Implement set-project subcommand #3656

merged 1 commit into from
Jun 19, 2024

Conversation

JAORMX
Copy link
Contributor

@JAORMX JAORMX commented Jun 19, 2024

Summary

This allows us to easily switch between projects using the ID. Note that
there a further PR will allow us to switch between projects using the
name of an immediate child.

For usability, this adds the minder sp and minder cd aliases (note that set-project is what shows up in the help text).

Change Type

Mark the type of change your PR introduces:

  • Bug fix (resolves an issue without affecting existing features)
  • Feature (adds new functionality without breaking changes)
  • Breaking change (may impact existing functionalities or require documentation updates)
  • Documentation (updates or additions to documentation)
  • Refactoring or test improvements (no bug fixes or new functionality)

Testing

Outline how the changes were tested, including steps to reproduce and any relevant configurations.
Attach screenshots if helpful.

Review Checklist:

  • Reviewed my own code for quality and clarity.
  • Added comments to complex or tricky code sections.
  • Updated any affected documentation.
  • Included tests that validate the fix or feature.
  • Checked that related changes are merged.

Copy link
Contributor

@dmjb dmjb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While we have an internal mental model of the project hierarchy working like a directory structure, I wonder if it would be better to use a subcommand that describes what is actually happening - i.e. using set-project instead of cd

@JAORMX
Copy link
Contributor Author

JAORMX commented Jun 19, 2024

@dmjb minder sp could work as well. The intention is to have something ergonomic and easy to use, so I thought mimicking the Linux command line could be a way to go. I'm open to creating a set-project with an sp alias though, if you have a strong opinion.

I was planning on implementing an ls command as well.

@dmjb
Copy link
Contributor

dmjb commented Jun 19, 2024

@dmjb minder sp could work as well. The intention is to have something ergonomic and easy to use, so I thought mimicking the Linux command line could be a way to go. I'm open to creating a set-project with an sp alias though, if you have a strong opinion.

I was planning on implementing an ls command as well.

If it's possible to allow either sp or set-project, that would be great. If we can only have sp I think that is fine.

ls has a lot of precedent for listing things in CLI utilities (not just directories) so that seems like a good choice. I am just concerned that cd could be a bit unintuitive for new users.

@JAORMX JAORMX changed the title Implement cd subcommand Implement set-project subcommand Jun 19, 2024
@JAORMX JAORMX requested a review from dmjb June 19, 2024 09:33
@JAORMX
Copy link
Contributor Author

JAORMX commented Jun 19, 2024

@dmjb done

This allows us to easily switch between projects using the ID. Note that
there a further PR will allow us to switch between projects using the
name of an immediate child.

Signed-off-by: Juan Antonio Osorio <ozz@stacklok.com>
@JAORMX JAORMX merged commit 29d4ad9 into main Jun 19, 2024
21 checks passed
@JAORMX JAORMX deleted the minder-cd branch June 19, 2024 11:16
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.

2 participants