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

[feat] Add the command usage syntax hint #48

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

shubhdevelop
Copy link
Contributor

closes #36

This PR adds a new feature that shows command usage hint as the user type in the command

  • Adds command syntax map, currently it only have 3 command will create another issue in order to add the command to the commandSyntaxMap, as currently we have only support three commands SET GET DEL

Development Tested

Screencast.from.2024-10-06.02-45-22.mp4

@shubhdevelop shubhdevelop marked this pull request as draft October 5, 2024 21:31
@shubhdevelop shubhdevelop marked this pull request as ready for review October 6, 2024 00:20
parts: SyntaxPart[];
};

export type SyntaxMap = {
Copy link
Contributor

Choose a reason for hiding this comment

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

Can't we utilise existing? It won't be feasible to maintain two separate maps in same repo.

export interface DiceCmdMeta {
  title: string;
  syntax: string;
  body: string;
  url?: string;
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was thinking of migrating from this CmdMeta to later format only. But in a separate issue, it gives us more control.

I don't want to maintain two metaData as well, I'm leaving the previous cmdMeta for now, because I don't want anything to break while we transition to the other format.

we can extend my format in a way that it will be compatible with search functionality as well

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@lucifercr07 do we agree on this?

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.

[feat] Real Time Command Usage Hint in the terminal
2 participants