npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cerebro-command-router

v2.0.0

Published

Tool for CerebroApp developers that allows to work with subcommands

Downloads

24

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:

npm install cerebro-command-router
or
yarn add cerebro-command-router

Initial configuration

Import the CerebroRouter utility:

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)
const myRouter = new CerebroRouter({
	command: "your_command_here",
	term,
	display,
});

Create the routes for your subcommands

/*
CerebroRouter.route(command: string,
			displayElement: see_cerebro_documentation,
			options: object)
*/

myRouter.route("your_first_subcommand", {
	icon: icon,
	title: `Your title here`,
	getPreview: () => <OneGreatReactComponent />,
});

myRouter.route("your_second_subcommand", {
	icon: icon,
	title: `Other title here too :)`,
	getPreview: () => <OtherGreatReactComponent />,
});

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 deafult (true):

command + subcommand + some text —> command + subcommand + some text

Text written by user

Untitled

tab key pressed Resultant text

Untitled

With autocompleteAll false:

command + subcommand + some text —> command + subcommand

Text written by user

Untitled

tab key pressed

Resultant text

Untitled

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)

myRouter.invalidRoute({
	icon: icon,
	title: `Invalid Command :( `,
});

Untitled

⚠️ 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.

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

You can consult a complete example in the "Examples" folder. Another real example can be found in the cerebro-todoist plugin repository

Related

License

MIT © Dubisdev