Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dubisdev/cerebro-command-router
A tool for CerebroApp developers
https://github.com/dubisdev/cerebro-command-router
cerebro-plugin cerebroapp tool
Last synced: about 1 month ago
JSON representation
A tool for CerebroApp developers
- Host: GitHub
- URL: https://github.com/dubisdev/cerebro-command-router
- Owner: dubisdev
- License: mit
- Created: 2021-07-22T16:45:58.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-07-06T14:14:37.000Z (over 2 years ago)
- Last Synced: 2024-11-09T10:33:07.492Z (about 2 months ago)
- Topics: cerebro-plugin, cerebroapp, tool
- Language: TypeScript
- Homepage:
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cerebro-Command-Router
> A tool for CerebroApp developers
## What's cerebro-command-router?
This is a utility for developing cerebro plugins.
## Install & Use
### Install the package in your project:
```sh
npm install cerebro-command-router
# or
yarn add cerebro-command-router
```
## Initial configuration
### **Import the CerebroRouter utility:**
```jsx
import CerebroRouter from "cerebro-command-router";
//or
const CerebroRouter = require("cerebro-command-router");
```
### **Configure the router by creating an instance with:**
- `command: string` - The main command of your app (one word)
- `term: string` - The complete string query (view Cerebro documentation)
- `display: function` - The cerebro display function (view Cerebro documentation)
```js
const myRouter = new CerebroRouter({
command: "your_command_here",
term,
display,
});
```
### **Create the routes for your subcommands**
```js
/*
CerebroRouter.route(command: string,
displayElement: see_cerebro_documentation,
options: object)
*/
myRouter.route("your_first_subcommand", {
icon: icon,
title: `Your title here`,
getPreview: () => ,
});
myRouter.route("your_second_subcommand", {
icon: icon,
title: `Other title here too :)`,
getPreview: () => ,
});
```
### The "Options" object.
For now, you can configure one interesting parameter: the autocompletion when you use the `tab key`. By default, when the subcommand is written with subcommand text, if `tab key` is pressed nothing will happen (term = term), but if `autocompleteAll: false` the result when `tab key` is pressed will be only command + subcommand.
#### Example:
#### With autocompleteAll default (true):
command + subcommand + some text —> command + subcommand + some text
#### With autocompleteAll false:
command + subcommand + some text —> command + subcommand
## **Invalid subcommand routing**
You can choose whether to show a bad subcommand message or to show nothing. By default, nothing will simply appear. To display a message you can use `CerebroRouter.invalidRoute(displayElement: see_cerebro_documentation)`
```jsx
myRouter.invalidRoute({
icon: icon,
title: `Invalid Command :( `,
});
```
⚠️ This method must be at the end of the plugin (after all the normal subcommand routes)
### **Get the text of a subcommand so that you can work with it**
Sometimes, to work with a subcommand, you will need to know the rest of the text that the user has written. For example, in the cerebro-todoist plugin, after the command "tds new << rest of text >>", the rest of the text is added to a note. To do this, you can use the "getSubCommandText" function that you can import from the package itself.
```jsx
import { getSubCommandText } from "cerebro-command-router";
//or
const { getSubCommandText } = require("cerebro-command-router");
console.log(getSubCommandText("ex com1 text and emoji 💫")); //"text and emoji 💫"
```
### Full Example
Some examples are available in the "Examples" folder.
Another real example can be found in the [cerebro-todoist plugin repository](https://github.com/dubisdev/cerebro-todoist)
## Related
- [Cerebro](http://github.com/cerebroapp/cerebro) – main repo for Cerebro app
- [Cerebro Plugin Documentation](https://github.com/cerebroapp/cerebro/blob/master/docs/plugins.md)
## License
MIT © [David Jiménez](https://dubis.dev)