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

simillar-commands

v1.0.2

Published

A simple npm utility module for obtaining similar commands in Discord Bots projects.

Downloads

3

Readme

Installation

  • npm install simillar-commands

Usage

Basic Example Get an array with all simillar commands

// Import the Simillar Commands function
const { simillarCommands } = require('simillar-commands');

// Create an array of commands
const commands = [
	'ping',
	'say',
	//....
	'unsay'
];

// Get simillar commands
simillarCommands(commands, 'ping'); // ['ping']
simillarCommands(commands, 'pin');  // ['ping']
simillarCommands(commands, 'pong'); // ['ping']
simillarCommands(commands, 'sâY');  // ['say']
simillarCommands(commands, 'nsay'); // ['say', 'unsay']
simillarCommands(commands, 'foo');  // []

Normalize Commands Normalize commands before use to prevent errors

// Import the Normalize function
const { normalize } = require('simillar-commands');

const command = 'CômmandExàmplê';

normalize(command); // commandexample

// Case insensitive usage
normalize(command, false); // CommandExample

Basic Bot 'Did you mean?' system Show a react Embed to suggest a simillar command

// Import the Simillar Command and Normalize function
const { simillarCommand, normalize } = require('simillar-commands');

// Setup Discord Bot and Creates a Collection/Array of Commands
const Discord = require('discord.js');
const client = new Discord.Client();
const prefix = '!';

client.commands = new Discord.Collection();

client.commands.set('ping', {
	name:'ping',
	run: msg => msg.reply('pong!')
});

client.commands.set('say', {
	name:'say',
	run: msg => msg.reply(msg.content.split(' ').slice(1).join(' '))
});

// Creates a Command Handler
client.on('message', async(msg) => {
	if(!msg.guild || !msg.content.startsWith(prefix) || msg.author.bot) return;
	const cmd = normalize(msg.content.slice(prefix.length).split(' ')[0]);

	let command = client.commands.get(cmd);
	
	if(command) { // Run command normally
		command.run(msg);
	} else { // Search for simillar command
		const simillar = simillarCommand(client.commands, cmd);

        // Creates a Embed
		const embed = new Discord.MessageEmbed()
			.setDescription(`Did you mean **${simillar}**?`);
		
		const msgEmbed = await msg.reply(embed);
        msgEmbed.react('✅');

        // Setup the Reaction Collector
        const filter = (reaction, user) => {
			if(reaction.emoji.name != '✅') return false;
			return(user.id == msg.author.id)
		}

		msgEmbed.createReactionCollector(filter, { max: 1 })
			.on('collect', () => { // Run command normally
				command = client.commands.get(simillar);
				command.run(msg);
			});
	}
});

// Start Bot
client.login('TOKEN');

Case Insensitive You can also add a param to not ignore the case.

// Import module functions
const { normalize, simillarCommands, simillarCommand } = require('simillar-commands');

normalize('CômmÁnD');        // command
normalize('CômmÁnD', false); // CommAnD

const commands = ['ban', 'unban', 'BaN' , 'ping'];

simillarCommands(commands, 'bam');          // ['ban', 'BaN']
simillarCommands(commands, 'bam', false);   // ['ban']
simillarCommands(commands, 'BaM', false);   // ['BaN']
simillarCommands(commands, 'nban');         // ['ban, 'unban', 'BaN']
simillarCommands(commands, 'nBaN', false);  // ['BaN']