cordejs / corde Goto Github PK

View Code? Open in Web Editor NEW

117.0 2.0 9.0 37.52 MB

🤖 A simple e2e library for testing Discord Bots 🚀

Home Page: https://cordejs.org

License: MIT License

JavaScript 3.04% TypeScript 77.21% Shell 0.24% CSS 0.37% Batchfile 0.01% C# 0.14% Markdown 18.98%

discord-bot corde automated-testing e2e nodejs discordbot discordjs

corde's Introduction

👀 About

Corde is a small testing library for Discord.js. As there is a tool to create bots for Discord, it's cool to also have a tool to test them. Corde objective is to be simple, fast, and readable to developers.

Documentation

The bellow documentation is a resume of what you can find in Corde's site

🚀 Getting started

Node.js 14.0 or newer is required

Starting to create tests with Corde is simple. First, install it locally with npm npm i -D corde or yarn yarn add -D corde.

After installed, add the file corde.config.json in the root of your application with the following structure:

{
   "cordeBotToken":  "<tokenForCordeBot>",
   "botTestId":  "<yourBotId>",
   "guildId":  "<guildId>",
   "channelId":  "<channelId>",
   "botPrefix":  "!",
   "testMatches":  ["./test/**"]
}

Test example:

const { group, test, command, beforeStart, afterAll } = require("corde");
const { client, loginBot } = require("..");

beforeStart(async () => {
  await loginBot();
});

group("main commands", () => {
  test("ping command must return... Ping?!!", () => {
    expect("ping").toReturn("Ping?");
  });
});

afterAll(() => {
  client.destroy();
});

corde's People

Contributors

Stargazers

Watchers

Forkers

pedrohf360 spiiralol randergabriel luizppa erlanbazarov frangyt raulsteleac-healx ucsengun 1duljanatzo

corde's Issues

rename configuration "testFilesDir" to "testFiles" and make it a array instead of plain string

Build error

Add command to check corde version

create toDeleteMessage command.

With this command, user can delete the last message sent by the bot(default) but can also delete the message by id or by order.
It also has some options

interface DeleteOption {
  /**
   * How many messages to delete
   */
  amount?: number;
  /**
   * Defines its positions.
   * @example
   *
   * // Supose that we have these messages:
   *
   *  "Hi",
   *  "Hello",
   *  "Good morning"
   * 
   * // If is passaed 0, 2
   * // Messages "Good morning" and "Hi" will be deleted
   */
  positions?: number | number[];
  /**
   * Deletes messages by its content
   */
  content?: string | string[];
}

export function mustDeleteMessage(...content: string[]): void;
export function mustDeleteMessage(content: string | string[] | number | DeleteOption): void;

I.E:

command("delete").mustDeleteMessage() // Deletes last bot message sent
command("delete").mustDeleteMessage(1) // Deletes last bot message sent also
command("delete").mustDeleteMessage(2) // Deletes last 2 bot messages sent
command("delete").mustDeleteMessage({ amount: 10}) // Deletes last 10 bot messages sent
command("delete").mustDeleteMessage({ positions: [0, 2]}) // Deletes last and thirt message sent
command("delete").mustDeleteMessage({ content: ["Hi", "Hello" ]}) // Deletes Messages Hi and Hello

create beforeStart command

Dependabot can't parse your package-lock.json

Dependabot couldn't parse the package-lock.json found at /package-lock.json.

The error Dependabot encountered was:

Dependabot::DependencyFileNotParseable

Coverage must be in 95% at least

coverage 60% in v2
coverage 80% in v3

create afterEnd command

create toChangeGuildAfkChannel command

Strucure

mustSetAFKChannel(channel: ChannelResolvable)

Migrate the CLI to commander

Add command to init corde.json

Payment required

🚨 You privatised your repo. 🚨

Hello!
You have set your repository to private. From now on Greenkeeper is no longer free. We have disabled your repo for now.
Please enter your payment information at account.greenkeeper.io.
For pricing information, please visit https://greenkeeper.io/#pricing.

create toDeleteChannel

Structure

export function mustDeleteChannel(id: string)

Restrict corde to use node v12 or newer

This must be done due to Discord.js accept only node v12 or newer

Create validate command to check data of configs

create toRemoveReaction command

Your .dependabot/config.yml contained invalid details

Dependabot encountered the following error when parsing your .dependabot/config.yml:

The property '#/update_configs/0' did not contain a required property of 'directory'

Please update the config file to conform with Dependabot's specification using our docs and online validator.

/**
 * Declare a bunch of code that will be executed **after each** test.
 *
 * More than one declaration of this code results in a list
 * of functions to run, following a sequence of files
 * reads and the positions of each `afterEach` call.
 *
 * @param fn code that will be executed **after each** tests finish
 */
export function afterEach(fn: () => void)

create createsVoiceChannel command