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

Introduce a terminal UI to explore your Tool Kit setup #325

Draft
wants to merge 16 commits into
base: main
Choose a base branch
from

Conversation

ivomurrell
Copy link
Contributor

Description

I'm leaving this as a draft for now as I should make a proper README to describe the functionality but the code should be feature-complete now. I've already given a demo to the Platforms team but you can try it out for yourself by navigating to a Tool Kit configured project and running the bin/run script in this package.

Checklist:

  • My branch has been rebased onto the latest commit on main (don't merge main into your branch)
  • My commit messages are conventional commits, for example: feat(circleci): add support for nightly workflows, fix: set Heroku app name for staging apps too

Created a prototype Tool Kit TUI for innovation day.
…cally

ink-tab was used to display which section of the app you were currently
looking at (plugins, hooks, or tasks). It also allowed you to switch
between tabs with the TAB key. However, we can also switch between tabs
by selecting an item in a details page. ink-tab has no provision to
allow us to update the tab programmatically, so the tab view would lag
behind the actual pages if you jumped from one tab to another. There's
no way to get around this with the library's API, so let's just
reimplement it ourselves seeing as its used functionality is relatively
simple.
We're no longer being held back in order to support ink-tab now that
we've implemented its functionality ourselves.
The validated config object has a slightly different structure than the
config object but we don't seem to have been touching any of the fields
that are changed in our codebase until the TUI was added so the bug
slipped under the radar.
Credit to Serena, I think this analogy works slightly better when
spelled out.
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