Add: Prompt

[MuiseDestiny]

I add a Prompt class. Different addons can register some commands that they themselves defined in this Prompt. The UI interface deeply mimics Obsidian, but its short key is Shift + P instead of Ctrl + P (Obsidian's short key). Because pressing Ctrl when a item is selected will hightlight item's collections.

This Prompt will extend Zotero's interaction, it is a new arena. I define four application types, including Default, CreateView, SetValue, SelectValue.

• Default type will execute a predefined function and no new view is generated , such as Split Vertaically .
• CreateView type is same as Default but generate a new view, like Fig. 1.
• SetValue type can receives the value entered by the user, like Fig. 2.
• SelectValue type can receives the value selected by the user, like Fig. 3.

Fig. 1

Fig. 2

Fig. 3

I registered different commands by calling Prompt.register() in both plugins and the tests worked fine. But there are still some problems when it is used by developers, for example, the Enumeration type TaskType cannot be read by developers.

In the end, allow me to introduce the parameters received by the regeister function, Command[].

interface Command {
  name: string;
  label?: string;
  when?: () => Boolean;
  task: DefaultTask | CreateViewTask | SetValueTask | SelectValueTask | Command[];
}

A Commad contains:

• name, it is command's name;
• label, it can pass Addon's name or command's short key;
• when, it can hide command when it return false (such as Split Vertically command should be hidden when selected Tab is not a Reader Tab);
• task, in addition to the four application types mentioned above, Command[] is also included. So it allows for multi-level commands. And this is the biggest difference from Obsidian.

Finally, Happy New Year!

[windingwind]

Thanks!

More comments and descriptions for APIs would be nice. It would be perfect if users can understand the methods through information in code hints, without reading the source code. I noticed these parts do not have a description and thus leave empty in the compiled docs:

• Prompt class;
• Methods: clear, createItem, enter, escape, refresh, registerExample, showEmpty, unregister;
• All properties.

Thanks for this exciting work!

[MuiseDestiny]

I change the interface Command, so now developers can see the code hints of types.

interface Command {
  name: string;
  label?: string;
  when?: () => Boolean;
  task: {
    Default?: Function;
    CreateView?: Function;
    SetValue?: {
      values: { intro: string, check: (text: string) => boolean }[],
      get?: () => boolean | string | number | undefined;
      set: (values) => void,
    };
    SelectValue?: {
      values: string[],
      set: (value: string) => void,
      get: () => boolean | string | number | undefined;
    };
    Commands?: Command[];
  }
}

But I admit it's not concise. @windingwind @volatile-static, Is there a better form of interface with code hinting? Looking forward to your answers, thank you.